Skip to content

Commit

Permalink
Add explantion of the recovery_id to the doc
Browse files Browse the repository at this point in the history
  • Loading branch information
jayz22 committed Apr 2, 2024
1 parent 55da48a commit fec3bd7
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion soroban-env-common/env.json
Original file line number Diff line number Diff line change
Expand Up @@ -2000,7 +2000,7 @@
}
],
"return": "BytesObject",
"docs": "Recovers the SEC-1-encoded ECDSA secp256k1 public key that produced a given 64-byte `signature` over a given 32-byte `msg_digest` (produced by applying a secure cryptographic hash function on the message), for a given `recovery_id` byte. The `signature` is the ECDSA signature `(r, s)` serialized as fixed-size big endian scalar values, both `r`, `s` must be non-zero and `s` must be in the lower range. Returns a `BytesObject` containing 65-bytes representing SEC-1 encoded point in uncompressed format."
"docs": "Recovers the SEC-1-encoded ECDSA secp256k1 public key that produced a given 64-byte `signature` over a given 32-byte `msg_digest` (produced by applying a secure cryptographic hash function on the message), for a given `recovery_id` byte. The `signature` is the ECDSA signature `(r, s)` serialized as fixed-size big endian scalar values, both `r`, `s` must be non-zero and `s` must be in the lower range. Returns a `BytesObject` containing 65-bytes representing SEC-1 encoded point in uncompressed format. The `recovery_id` is an integer value `0`, `1`, `2`, or `3`, the low bit (0/1) indicates the parity of the y-coordinate of the `public_key` (even/odd) and the high bit (3/4) indicate if the `r` (x-coordinate of `k x G`) has overflown during its computation."
},
{
"export": "3",
Expand Down

0 comments on commit fec3bd7

Please sign in to comment.