feat(tempo): align multisig RPC encoding (#427)

* feat(tempo): align multisig RPC encoding

* fix(tempo): correct multisig tsdoc links

* test(tempo): cover multisig simulation

Author: jxom

.changeset/tidy-rpcs-simulate.md

@@ -0,0 +1,5 @@
+---
+'ox': patch
+---
+
+Aligned Tempo multisig simulation requests and RPC signatures with T12's encoded wire formats.

src/tempo/AuthorizationTempo.test.ts

@@ -326,6 +326,7 @@ describe('fromRpc', () => {
         type: 'p256',
       },
     })
+    if (typeof result.signature === 'string') throw new Error('unreachable')
     expect(result.signature.type).toBe('p256')
     expect(result.signature).toHaveProperty('prehash', true)
     expect(result.signature).toHaveProperty('publicKey')
@@ -348,6 +349,7 @@ describe('fromRpc', () => {
           '0x49960de5880e8c687434170f6476605b8fe4aeb9a28632c7995cf3ba831d976305000000007b2274797065223a22776562617574686e2e676574222c226368616c6c656e6765223a22222c226f726967696e223a2268747470733a2f2f6578616d706c652e636f6d222c2263726f73734f726967696e223a66616c73657d',
       },
     })
+    if (typeof result.signature === 'string') throw new Error('unreachable')
     expect(result.signature.type).toBe('webAuthn')
     expect(result.signature).toHaveProperty('metadata')
     expect(result.signature).toHaveProperty('publicKey')
@@ -949,6 +951,7 @@ describe('toRpc', () => {
         type: 'p256',
       },
     })
+    if (typeof result.signature === 'string') throw new Error('unreachable')
     expect(result.signature.type).toBe('p256')
   })
 
@@ -970,6 +973,7 @@ describe('toRpc', () => {
         type: 'webAuthn',
       },
     })
+    if (typeof result.signature === 'string') throw new Error('unreachable')
     expect(result.signature.type).toBe('webAuthn')
   })
 })

src/tempo/KeyAuthorization.test-d.ts

@@ -55,18 +55,7 @@ test('accepts multisig signatures', () => {
     KeyAuthorization.Signed['signature']
   >()
 
-  const multisigRpc = {
-    account: multisig.account,
-    config: { ...multisig.config, version: 0 },
-    signatures: [
-      {
-        r: '0x01',
-        s: '0x02',
-        type: 'secp256k1',
-        yParity: '0x0',
-      },
-    ],
-  } as const satisfies SignatureEnvelope.MultisigRpc
+  const multisigRpc = '0xf8' as const satisfies SignatureEnvelope.MultisigRpc
 
   const rpc: KeyAuthorization.Rpc = {
     chainId: '0x1',

src/tempo/KeyAuthorization.test.ts

@@ -69,6 +69,8 @@ const signature_multisig = {
   signatures: [SignatureEnvelope.from(signature_secp256k1)],
   type: 'multisig',
 } as const satisfies SignatureEnvelope.Multisig
+const signature_multisig_rpc =
+  '0xf89794be95c3f554e9fc85ec51be69a3d807a0d55bcf2cf83ba000000000000000000000000000000000000000000000000000000000000000000101d7d694f39fd6e51aad88f6f4ce6ab8827279cfffb9226601f843b841fa78c5905fb0b9d6066ef531f962a62bc6ef0d5eb59ecb134056d206f75aaed7780926ff2601a935c2c79707d9e1799948c9f19dcdde1e090e903b19a07923d01c' as const
 
 const signature_keychain = {
   inner: SignatureEnvelope.from(signature_secp256k1),
@@ -527,16 +529,42 @@ describe('from', () => {
 })
 
 describe('fromRpc', () => {
-  test('multisig', () => {
+  test('behavior: multisig', () => {
     const authorization = KeyAuthorization.fromRpc({
       chainId: '0x1',
       expiry: null,
       keyId: address,
       keyType: 'secp256k1',
-      signature: SignatureEnvelope.toRpc(signature_multisig),
+      signature: signature_multisig_rpc,
     })
 
-    expect(authorization.signature).toEqual(signature_multisig)
+    expect(authorization.signature).toMatchInlineSnapshot(`
+      {
+        "account": "0xbe95c3f554e9fc85ec51be69a3d807a0d55bcf2c",
+        "config": {
+          "owners": [
+            {
+              "owner": "0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266",
+              "weight": 1,
+            },
+          ],
+          "salt": "0x0000000000000000000000000000000000000000000000000000000000000000",
+          "threshold": 1,
+          "version": 1n,
+        },
+        "signatures": [
+          {
+            "signature": {
+              "r": 113291597329930009559670063131885256927775966057121513567941051428123344285399n,
+              "s": 54293712598725100598138577281441749550405991478212695085505730636505228583888n,
+              "yParity": 1,
+            },
+            "type": "secp256k1",
+          },
+        ],
+        "type": "multisig",
+      }
+    `)
   })
 
   test('rejects a keychain signature', () => {
@@ -1340,16 +1368,16 @@ describe('serialize', () => {
 })
 
 describe('toRpc', () => {
-  test('multisig', () => {
+  test('behavior: multisig', () => {
     const authorization = KeyAuthorization.toRpc({
       address,
       chainId: 1n,
       signature: signature_multisig,
       type: 'secp256k1',
     })
 
-    expect(authorization.signature).toEqual(
-      SignatureEnvelope.toRpc(signature_multisig),
+    expect(authorization.signature).toMatchInlineSnapshot(
+      `"${signature_multisig_rpc}"`,
     )
   })
 

src/tempo/KeyAuthorization.ts

@@ -93,9 +93,9 @@ export type Signature<bigintType = bigint, numberType = number> = OneOf<
 >
 
 /** RPC-formatted signature that can authorize an access key. */
-export type SignatureRpc = OneOf<
-  SignatureEnvelope.PrimitiveRpc | SignatureEnvelope.MultisigRpc
->
+export type SignatureRpc =
+  | SignatureEnvelope.MultisigRpc
+  | SignatureEnvelope.PrimitiveRpc
 
 /** Input type for a Key Authorization. */
 export type Input = KeyAuthorization<

src/tempo/MultisigOperation.ts

@@ -287,7 +287,7 @@ export function serializeKeyAuthorization(
 }
 
 export declare namespace serializeKeyAuthorization {
-  /** Options for {@link serializeKeyAuthorization}. */
+  /** Options for `serializeKeyAuthorization`. */
   export type Options = {
     /** Root multisig account. */
     account: Address.Address
@@ -297,7 +297,7 @@ export declare namespace serializeKeyAuthorization {
     config: MultisigConfig.Config
   }
 
-  /** Error type for {@link serializeKeyAuthorization}. */
+  /** Error type for `serializeKeyAuthorization`. */
   export type ErrorType =
     | InvalidOperationError
     | KeyAuthorization_.deserialize.ErrorType

src/tempo/MultisigSimulation.test-d.ts

@@ -0,0 +1,33 @@
+import { expectTypeOf, test } from 'vitest'
+import * as MultisigSimulation from './MultisigSimulation.js'
+
+const rpc = {
+  account: '0x2222222222222222222222222222222222222222',
+  approvals: [
+    {
+      owner: '0x1111111111111111111111111111111111111111',
+      type: 'primitive',
+    },
+  ],
+  config:
+    '0xf83ba000000000000000000000000000000000000000000000000000000000000000008001d7d694111111111111111111111111111111111111111101',
+} as const satisfies MultisigSimulation.Rpc
+
+test('fromRpc returns a domain spec', () => {
+  const spec = MultisigSimulation.fromRpc(rpc)
+
+  expectTypeOf(spec).toEqualTypeOf<MultisigSimulation.Spec>()
+  expectTypeOf(spec.config.version).toEqualTypeOf<bigint>()
+})
+
+test('RPC specs use encoded configurations', () => {
+  expectTypeOf<
+    MultisigSimulation.Rpc['config']
+  >().toEqualTypeOf<`0x${string}`>()
+})
+
+test('toRpc returns an RPC spec', () => {
+  expectTypeOf(
+    MultisigSimulation.toRpc(MultisigSimulation.fromRpc(rpc)),
+  ).toEqualTypeOf<MultisigSimulation.Rpc>()
+})