chore: Signature + PublicKey tweaks

wevm · Nov 3, 2024 · 3320493 · 3320493
1 parent e492184
commit 3320493
Show file tree

Hide file tree

Showing 11 changed files with 463 additions and 287 deletions.
diff --git a/examples/webauthn-p256/src/App.tsx b/examples/webauthn-p256/src/App.tsx
@@ -37,7 +37,7 @@ export function App() {
           <pre>{Json.stringify(credential.publicKey, null, 2)}</pre>
           <strong>Public Key (serialized): </strong>
           <br />
-          <pre>{PublicKey.serialize(credential.publicKey)}</pre>
+          <pre>{PublicKey.toHex(credential.publicKey)}</pre>
         </div>
       )}
       <br />

diff --git a/site/pages/guides/ecdsa.md b/site/pages/guides/ecdsa.md
@@ -226,7 +226,7 @@ It is important to note that `yParity` (recovery bit) may not be present in _all
 
 ### Serializing
 
-You may need to serialize a Signature into Hex or Bytes format for specific use cases. You can do this using the [`Signature.serialize`](/api/Signature/serialize) function:
+You may need to serialize a Signature into Hex or Bytes format for specific use cases. You can do this using the [`Signature.toHex`](/api/Signature/toHex) or [`Signature.toBytes`](/api/Signature/toBytes) functions:
 
 ```ts twoslash
 import { Signature } from 'ox'
@@ -236,11 +236,11 @@ const signature = Signature.from({
   s: 33726695977844476214676913201140481102225469284307016937915595756355928419768n,
   yParity: 0,
 })
-const serialized = Signature.serialize(signature)
+const serialized = Signature.toHex(signature)
 //    ^?
 
 
-const serialized_bytes = Signature.serialize(signature, { as: 'Bytes' })
+const serialized_bytes = Signature.toBytes(signature)
 //    ^?
 
 
@@ -277,7 +277,7 @@ const publicKey_2 = PublicKey.from({
 
 ### Serializing
 
-You may need to serialize a Public Key into Hex or Bytes format for specific use cases. You can do this using the [`PublicKey.serialize`](/api/PublicKey/serialize) function:
+You may need to serialize a Public Key into Hex or Bytes format for specific use cases. You can do this using the [`PublicKey.toHex`](/api/PublicKey/toHex) or [`PublicKey.toBytes`](/api/PublicKey/toBytes) functions:
 
 ```ts twoslash
 import { PublicKey } from 'ox'
@@ -286,11 +286,11 @@ const publicKey = PublicKey.from({
   x: 49782753348462494199823712700004552394425719014458918871452329774910450607807n,
   y: 24099691209996290925259367678540227198235484593389470330605641003500238088869n,
 })
-const serialized = PublicKey.serialize(publicKey)
+const serialized = PublicKey.toHex(publicKey)
 //    ^?
 
 
-const serialized_bytes = PublicKey.serialize(publicKey, { as: 'Bytes' })
+const serialized_bytes = PublicKey.toBytes(publicKey)
 //    ^?
 
 

diff --git a/src/Address.ts b/src/Address.ts
@@ -200,7 +200,7 @@ export function fromPublicKey(
   options: fromPublicKey.Options = {},
 ): Address {
   const address = Hash.keccak256(
-    `0x${PublicKey.serialize(publicKey).slice(4)}`,
+    `0x${PublicKey.toHex(publicKey).slice(4)}`,
   ).substring(26)
   return from(`0x${address}`, options)
 }
@@ -217,7 +217,7 @@ export declare namespace fromPublicKey {
 
   type ErrorType =
     | Hash.keccak256.ErrorType
-    | PublicKey.serialize.ErrorType
+    | PublicKey.toHex.ErrorType
     | Errors.GlobalErrorType
 }
 

diff --git a/src/P256.ts b/src/P256.ts
@@ -203,7 +203,7 @@ export function verify(options: verify.Options): boolean {
   return secp256r1.verify(
     signature,
     payload instanceof Uint8Array ? payload : Bytes.fromHex(payload),
-    PublicKey.serialize(publicKey).substring(2),
+    PublicKey.toHex(publicKey).substring(2),
     ...(hash ? [{ prehash: true, lowS: true }] : []),
   )
 }