ox 1.7.2 → 1.7.4

package/src/tempo/MultisigOperation.ts

@@ -15,14 +15,10 @@ export type Base<quantity = bigint> = {
   approvals: readonly Hex.Hex[]
   /** Root configuration used to verify approvals. */
   config: MultisigConfig.Config<quantity>
-  /** Root configuration version. */
-  configVersion: quantity
   /** Unix creation time in milliseconds. */
   createdAt: number
   /** Deterministic multisig operation hash. */
   hash: Hex.Hex
-  /** Whether the operation initializes the root multisig account. */
-  init: boolean
   /** Number of approvals selected for quorum evaluation. */
   signatureCount: number
   /** Required root owner weight. */
@@ -73,9 +69,6 @@ export type KeyAuthorizationRpc = KeyAuthorizationOperation<Hex.Hex>
 /** JSON-RPC multisig operation. */
 export type Rpc = Operation<Hex.Hex>
 
-/** Maximum supported multisig configuration version. */
-const maxConfigVersion = 2n ** 64n - 1n
-
 /**
  * Derives the deterministic hash for a multisig operation.
  *
@@ -86,7 +79,7 @@ const maxConfigVersion = 2n ** 64n - 1n
  *
  * const hash = MultisigOperation.getHash({
  *   account,
- *   configVersion: 1n,
+ *   config,
  *   transaction,
  *   type: 'transaction'
  * })
@@ -96,7 +89,7 @@ const maxConfigVersion = 2n ** 64n - 1n
  * @returns The operation hash signed by each owner.
  */
 export function getHash(options: getHash.Options): Hex.Hex {
-  const { account, configVersion } = options
+  const { account, config } = options
   const payload =
     options.type === 'transaction'
       ? TxEnvelopeTempo.getSignPayload(
@@ -107,7 +100,7 @@ export function getHash(options: getHash.Options): Hex.Hex {
         )
   return MultisigConfig.getSignPayload({
     account,
-    config: { version: configVersion },
+    config,
     payload,
   })
 }
@@ -117,8 +110,8 @@ export declare namespace getHash {
   export type Options = {
     /** Root multisig account. */
     account: Address.Address
-    /** Root configuration version. */
-    configVersion: bigint
+    /** Complete root multisig configuration witness. */
+    config: MultisigConfig.Config
   } & (
     | {
         /** Canonical serialized key authorization. */
@@ -160,8 +153,7 @@ export declare namespace getHash {
  *   account,
  *   approvals,
  *   config,
- *   hash,
- *   resolveConfig
+ *   hash
  * })
  * ```
  *
@@ -171,18 +163,25 @@ export declare namespace getHash {
 export async function selectApprovals(
   options: selectApprovals.Options,
 ): Promise<selectApprovals.ReturnValue> {
-  const { account, approvals, hash, resolveConfig } = options
+  const { account, approvals, hash } = options
   if (!Address.validate(account) || Hex.toBigInt(account) === 0n)
     throw new InvalidApprovalError({ reason: 'account is invalid' })
   if (!Hash.validate(hash))
     throw new InvalidApprovalError({ reason: 'hash is invalid' })
+  const config = MultisigConfig.from(options.config)
+  if (
+    config.version === 0n &&
+    !Address.isEqual(MultisigConfig.getAddress(config), account)
+  )
+    throw new InvalidApprovalError({
+      reason: 'initial config does not derive the root multisig account',
+    })
   return selectApprovals_internal(
     {
       account,
       approvals,
-      config: MultisigConfig.from(options.config),
+      config,
       hash,
-      resolveConfig,
     },
     [account.toLowerCase()],
   )
@@ -199,27 +198,6 @@ export declare namespace selectApprovals {
     config: MultisigConfig.Config
     /** Deterministic operation hash approved by root owners. */
     hash: Hex.Hex
-    /** Resolves the current configuration of a nested multisig owner. */
-    resolveConfig?: ResolveConfig | undefined
-  }
-
-  /** Resolves an initialized nested multisig configuration. */
-  export type ResolveConfig = (
-    options: ResolveConfigOptions,
-  ) => ResolvedConfig | Promise<ResolvedConfig>
-
-  /** Nested multisig configuration lookup parameters. */
-  export type ResolveConfigOptions = {
-    /** Nested multisig account. */
-    account: Address.Address
-  }
-
-  /** Resolved nested multisig configuration. */
-  export type ResolvedConfig = {
-    /** Current nested multisig configuration. */
-    config: MultisigConfig.Config
-    /** Current nested multisig configuration version. */
-    version: bigint
   }
 
   /** Result of validating and selecting approvals. */
@@ -248,6 +226,90 @@ export declare namespace selectApprovals {
     | Errors.GlobalErrorType
 }
 
+/**
+ * Serializes a key authorization with selected multisig owner approvals.
+ *
+ * @example
+ * ```ts twoslash
+ * // @noErrors
+ * import { MultisigOperation } from 'ox/tempo'
+ *
+ * const authorization =
+ *   MultisigOperation.serializeKeyAuthorization(
+ *     keyAuthorization,
+ *     {
+ *       account,
+ *       approvals: selection.selectedApprovals,
+ *       config
+ *     }
+ *   )
+ * ```
+ *
+ * @param keyAuthorization - Canonical serialized unsigned key authorization.
+ * @param options - Multisig account, config, and selected approvals.
+ * @returns The signed serialized key authorization.
+ */
+export function serializeKeyAuthorization(
+  keyAuthorization: Hex.Hex,
+  options: serializeKeyAuthorization.Options,
+): Hex.Hex {
+  const authorization = KeyAuthorization_.deserialize(keyAuthorization)
+  if (authorization.signature)
+    throw new InvalidOperationError({
+      reason: 'keyAuthorization must not contain a signature',
+    })
+  if (
+    KeyAuthorization_.serialize(authorization).toLowerCase() !==
+    keyAuthorization.toLowerCase()
+  )
+    throw new InvalidOperationError({
+      reason: 'keyAuthorization is not canonically serialized',
+    })
+  const config = MultisigConfig.from(options.config)
+  const signatures = SignatureEnvelope.sortMultisigApprovals({
+    account: options.account,
+    config,
+    payload: KeyAuthorization_.getSignPayload(authorization),
+    signatures: options.approvals.map((approval) =>
+      SignatureEnvelope.deserialize(approval),
+    ),
+  })
+  return KeyAuthorization_.serialize(
+    KeyAuthorization_.from(authorization, {
+      signature: SignatureEnvelope.from({
+        account: options.account,
+        config,
+        signatures,
+      }),
+    }),
+  )
+}
+
+export declare namespace serializeKeyAuthorization {
+  /** Options for `serializeKeyAuthorization`. */
+  export type Options = {
+    /** Root multisig account. */
+    account: Address.Address
+    /** Selected serialized owner approvals. */
+    approvals: readonly SignatureEnvelope.Serialized[]
+    /** Complete applicable root multisig config. */
+    config: MultisigConfig.Config
+  }
+
+  /** Error type for `serializeKeyAuthorization`. */
+  export type ErrorType =
+    | InvalidOperationError
+    | KeyAuthorization_.deserialize.ErrorType
+    | KeyAuthorization_.from.ErrorType
+    | KeyAuthorization_.getSignPayload.ErrorType
+    | KeyAuthorization_.serialize.ErrorType
+    | MultisigConfig.assert.ErrorType
+    | SignatureEnvelope.assert.ErrorType
+    | SignatureEnvelope.InvalidSerializedError
+    | SignatureEnvelope.sortMultisigApprovals.ErrorType
+    | Errors.GlobalErrorType
+}
+
 /**
  * Serializes a multisig transaction operation with selected owner approvals.
  *
@@ -340,10 +402,6 @@ export function from<const operation extends Operation>(
 ): from.ReturnValue<operation> {
   try {
     const config = MultisigConfig.from(operation.config)
-    if (config.version !== operation.configVersion)
-      throw new InvalidOperationError({
-        reason: 'config.version must equal configVersion',
-      })
     if (
       typeof config.threshold !== 'number' ||
       config.owners.some((owner) => typeof owner.weight !== 'number')
@@ -393,22 +451,19 @@ export function fromRpc<const operation extends Rpc>(
   operation: operation,
 ): fromRpc.ReturnValue<operation> {
   try {
-    if (
-      typeof operation.configVersion !== 'string' ||
-      !Hex.validate(operation.configVersion)
-    )
+    const version = operation.config?.version
+    if (typeof version !== 'string' || !Hex.validate(version))
       throw new InvalidOperationError({
-        reason: 'configVersion must be a hexadecimal quantity',
+        reason: 'config.version must be a hexadecimal quantity',
       })
-    const configVersion = Hex.toBigInt(operation.configVersion)
-    if (Hex.fromNumber(configVersion) !== operation.configVersion)
+    const version_ = Hex.toBigInt(version)
+    if (Hex.fromNumber(version_) !== version)
       throw new InvalidOperationError({
-        reason: 'configVersion must use canonical quantity encoding',
+        reason: 'config.version must use canonical quantity encoding',
       })
     return from({
       ...operation,
       config: MultisigConfig.fromRpc(operation.config),
-      configVersion,
     } as Operation) as never
   } catch (cause) {
     if (cause instanceof InvalidOperationError) throw cause
@@ -448,7 +503,6 @@ export function toRpc<const operation extends Operation>(
   return {
     ...value,
     config: MultisigConfig.toRpc(value.config),
-    configVersion: Hex.fromNumber(value.configVersion),
   } as never
 }
 
@@ -460,7 +514,7 @@ export declare namespace toRpc {
       : KeyAuthorizationRpc
 
   /** Error type for `toRpc`. */
-  export type ErrorType = from.ErrorType | Hex.fromNumber.ErrorType
+  export type ErrorType = from.ErrorType | MultisigConfig.toRpc.ErrorType
 }
 
 /**
@@ -526,15 +580,17 @@ async function selectApprovals_internal(
         throw new InvalidApprovalError({
           reason: `nested multisig owner ${group.address} is invalid`,
         })
-      if (!options.resolveConfig)
+      const config = MultisigConfig.from(nested[0]!.config)
+      if (nested.some((signature) => !sameConfig(signature.config, config)))
         throw new InvalidApprovalError({
-          reason: `nested multisig owner ${group.address} requires a config resolver`,
+          reason: `nested multisig owner ${group.address} has conflicting config witnesses`,
         })
-      const resolved = await options.resolveConfig({ account: group.address })
-      const config = MultisigConfig.from(resolved.config)
-      if (config.version !== resolved.version)
+      if (
+        config.version === 0n &&
+        !Address.isEqual(MultisigConfig.getAddress(config), group.address)
+      )
         throw new InvalidApprovalError({
-          reason: `resolved config.version must equal version for nested multisig owner ${group.address}`,
+          reason: `initial config does not derive nested multisig owner ${group.address}`,
         })
       const selected = await selectApprovals_internal(
         {
@@ -550,7 +606,6 @@ async function selectApprovals_internal(
             config,
             payload: options.hash,
           }),
-          resolveConfig: options.resolveConfig,
         },
         [...path, group.address.toLowerCase()],
       )
@@ -692,16 +747,6 @@ function assertBase(operation: Operation, config: MultisigConfig.Config): void {
     throw new InvalidOperationError({ reason: 'account cannot be zero' })
   if (!Hash.validate(operation.hash))
     throw new InvalidOperationError({ reason: 'hash is invalid' })
-  if (typeof operation.init !== 'boolean')
-    throw new InvalidOperationError({ reason: 'init must be a boolean' })
-  if (
-    typeof operation.configVersion !== 'bigint' ||
-    operation.configVersion < 0n ||
-    operation.configVersion > maxConfigVersion
-  )
-    throw new InvalidOperationError({
-      reason: 'configVersion must be an unsigned 64-bit integer',
-    })
   assertInteger(operation.createdAt, 'createdAt')
   assertInteger(operation.updatedAt, 'updatedAt')
   if (operation.updatedAt < operation.createdAt)
@@ -781,19 +826,13 @@ function assertBase(operation: Operation, config: MultisigConfig.Config): void {
       reason:
         'weight is not reachable by signatureCount retained owner approvals',
     })
-  if (operation.init) {
-    if (operation.configVersion !== 0n)
-      throw new InvalidOperationError({
-        reason: 'bootstrap operations must use config version zero',
-      })
-    if (
-      MultisigConfig.getAddress(config).toLowerCase() !==
-      operation.account.toLowerCase()
-    )
-      throw new InvalidOperationError({
-        reason: 'bootstrap config does not derive the operation account',
-      })
-  }
+  if (
+    config.version === 0n &&
+    !Address.isEqual(MultisigConfig.getAddress(config), operation.account)
+  )
+    throw new InvalidOperationError({
+      reason: 'initial config does not derive the operation account',
+    })
 }
 
 /**

package/src/tempo/MultisigSimulation.test-d.ts

@@ -0,0 +1,33 @@
+import { expectTypeOf, test } from 'vp/test'
+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>()
+})

package/src/tempo/MultisigSimulation.test.ts

@@ -0,0 +1,283 @@
+import { MultisigConfig, MultisigSimulation } from 'ox/tempo'
+import { describe, expect, test } from 'vp/test'
+
+const config =
+  '0xf852a011111111111111111111111111111111111111111111111111111111111111118002eed694111111111111111111111111111111111111111101d694bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb01' as const
+const nestedConfig =
+  '0xf83ba022222222222222222222222222222222222222222222222222222222222222220101d7d694222222222222222222222222222222222222222201' as const
+const rpc = {
+  account: '0xaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa',
+  approvals: [
+    {
+      keyData: '0x0102030405',
+      keyType: 'webAuthn',
+      owner: '0x1111111111111111111111111111111111111111',
+      type: 'primitive',
+    },
+    {
+      spec: {
+        account: '0xbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb',
+        approvals: [
+          {
+            keyData: '0x010203040506',
+            keyType: 'secp256k1',
+            owner: '0x2222222222222222222222222222222222222222',
+          },
+        ],
+        config: nestedConfig,
+      },
+      type: 'multisig',
+    },
+  ],
+  config,
+} as const satisfies MultisigSimulation.Rpc
+
+describe('fromRpc', () => {
+  test('behavior: decodes root and nested configurations', () => {
+    expect(MultisigSimulation.fromRpc(rpc)).toMatchInlineSnapshot(`
+      {
+        "account": "0xaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+        "approvals": [
+          {
+            "keyData": "0x0102030405",
+            "keyType": "webAuthn",
+            "owner": "0x1111111111111111111111111111111111111111",
+            "type": "primitive",
+          },
+          {
+            "spec": {
+              "account": "0xbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb",
+              "approvals": [
+                {
+                  "keyData": "0x010203040506",
+                  "keyType": "secp256k1",
+                  "owner": "0x2222222222222222222222222222222222222222",
+                },
+              ],
+              "config": {
+                "owners": [
+                  {
+                    "owner": "0x2222222222222222222222222222222222222222",
+                    "weight": 1,
+                  },
+                ],
+                "salt": "0x2222222222222222222222222222222222222222222222222222222222222222",
+                "threshold": 1,
+                "version": 1n,
+              },
+            },
+            "type": "multisig",
+          },
+        ],
+        "config": {
+          "owners": [
+            {
+              "owner": "0x1111111111111111111111111111111111111111",
+              "weight": 1,
+            },
+            {
+              "owner": "0xbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb",
+              "weight": 1,
+            },
+          ],
+          "salt": "0x1111111111111111111111111111111111111111111111111111111111111111",
+          "threshold": 2,
+          "version": 0n,
+        },
+      }
+    `)
+  })
+
+  test('behavior: preserves the maximum uint64 configuration version', () => {
+    const config =
+      '0xf843a0000000000000000000000000000000000000000000000000000000000000000088ffffffffffffffff01d7d694111111111111111111111111111111111111111101' as const
+
+    expect(
+      MultisigSimulation.fromRpc({ ...rpc, approvals: [], config }).config
+        .version,
+    ).toMatchInlineSnapshot(`18446744073709551615n`)
+  })
+
+  test('error: rejects excess root approvals', () => {
+    expect(() =>
+      MultisigSimulation.fromRpc({
+        ...rpc,
+        approvals: Array.from({ length: 9 }, () => rpc.approvals[0]),
+      }),
+    ).toThrowErrorMatchingInlineSnapshot(
+      `[MultisigSimulation.InvalidSimulationError: Invalid multisig simulation: approval count exceeds 8.]`,
+    )
+  })
+
+  test('error: rejects excess nested approvals', () => {
+    expect(() =>
+      MultisigSimulation.fromRpc({
+        ...rpc,
+        approvals: [
+          {
+            ...rpc.approvals[1],
+            spec: {
+              ...rpc.approvals[1].spec,
+              approvals: Array.from(
+                { length: 9 },
+                () => rpc.approvals[1].spec.approvals[0],
+              ),
+            },
+          },
+        ],
+      }),
+    ).toThrowErrorMatchingInlineSnapshot(
+      `[MultisigSimulation.InvalidSimulationError: Invalid multisig simulation: approval count exceeds 8.]`,
+    )
+  })
+
+  test('error: rejects trailing configuration bytes', () => {
+    expect(() =>
+      MultisigSimulation.fromRpc({ ...rpc, config: `${config}00` }),
+    ).toThrowErrorMatchingInlineSnapshot(
+      `[Rlp.TrailingBytesError: RLP payload encodes a single item, but \`1\` trailing byte remains.]`,
+    )
+  })
+
+  test('error: rejects malformed configuration RLP', () => {
+    expect(() =>
+      MultisigSimulation.fromRpc({ ...rpc, config: '0xf8' }),
+    ).toThrowErrorMatchingInlineSnapshot(
+      `[Cursor.PositionOutOfBoundsError: Position \`1\` is out of bounds (\`0 < position < 1\`).]`,
+    )
+  })
+
+  test('error: rejects a non-list configuration', () => {
+    expect(() =>
+      MultisigSimulation.fromRpc({ ...rpc, config: '0x01' }),
+    ).toThrowErrorMatchingInlineSnapshot(
+      `[MultisigSimulation.InvalidSimulationError: Invalid multisig simulation: invalid config encoding.]`,
+    )
+  })
+
+  test('error: rejects noncanonical configuration integers', () => {
+    const noncanonical = config
+      .replace('0xf852', '0xf853')
+      .replace('118002', '11810002') as `0x${string}`
+
+    expect(() =>
+      MultisigSimulation.fromRpc({ ...rpc, config: noncanonical }),
+    ).toThrowErrorMatchingInlineSnapshot(
+      `[MultisigSimulation.InvalidSimulationError: Invalid multisig simulation: invalid config encoding.]`,
+    )
+  })
+})
+
+describe('toRpc', () => {
+  test('behavior: encodes configurations and shims long key data', () => {
+    expect(MultisigSimulation.toRpc(MultisigSimulation.fromRpc(rpc)))
+      .toMatchInlineSnapshot(`
+      {
+        "account": "0xaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+        "approvals": [
+          {
+            "keyData": "0x0005",
+            "keyType": "webAuthn",
+            "owner": "0x1111111111111111111111111111111111111111",
+            "type": "primitive",
+          },
+          {
+            "spec": {
+              "account": "0xbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb",
+              "approvals": [
+                {
+                  "keyData": "0x0006",
+                  "keyType": "secp256k1",
+                  "owner": "0x2222222222222222222222222222222222222222",
+                },
+              ],
+              "config": "${nestedConfig}",
+            },
+            "type": "multisig",
+          },
+        ],
+        "config": "${config}",
+      }
+    `)
+  })
+
+  test('behavior: preserves short key data', () => {
+    const spec = MultisigSimulation.fromRpc({
+      ...rpc,
+      approvals: [{ ...rpc.approvals[0], keyData: '0x0102' }],
+    })
+
+    expect(MultisigSimulation.toRpc(spec).approvals).toMatchInlineSnapshot(`
+      [
+        {
+          "keyData": "0x0102",
+          "keyType": "webAuthn",
+          "owner": "0x1111111111111111111111111111111111111111",
+          "type": "primitive",
+        },
+      ]
+    `)
+  })
+
+  test('behavior: encodes the maximum uint64 configuration version', () => {
+    const spec = MultisigSimulation.fromRpc(rpc)
+
+    expect(
+      MultisigSimulation.toRpc({
+        ...spec,
+        approvals: [],
+        config: MultisigConfig.from({
+          owners: [
+            {
+              owner: '0x1111111111111111111111111111111111111111',
+              weight: 1,
+            },
+          ],
+          threshold: 1,
+          version: MultisigConfig.maxVersion,
+        }),
+      }).config,
+    ).toMatchInlineSnapshot(
+      `"0xf843a0000000000000000000000000000000000000000000000000000000000000000088ffffffffffffffff01d7d694111111111111111111111111111111111111111101"`,
+    )
+  })
+
+  test('error: rejects excess root approvals', () => {
+    const spec = MultisigSimulation.fromRpc(rpc)
+
+    expect(() =>
+      MultisigSimulation.toRpc({
+        ...spec,
+        approvals: Array.from({ length: 9 }, () => spec.approvals[0]!),
+      }),
+    ).toThrowErrorMatchingInlineSnapshot(
+      `[MultisigSimulation.InvalidSimulationError: Invalid multisig simulation: approval count exceeds 8.]`,
+    )
+  })
+
+  test('error: rejects excess nested approvals', () => {
+    const spec = MultisigSimulation.fromRpc(rpc)
+    const nested = spec.approvals[1]!
+    if (nested.type !== 'multisig') throw new Error('unreachable')
+
+    expect(() =>
+      MultisigSimulation.toRpc({
+        ...spec,
+        approvals: [
+          {
+            ...nested,
+            spec: {
+              ...nested.spec,
+              approvals: Array.from(
+                { length: 9 },
+                () => nested.spec.approvals[0]!,
+              ),
+            },
+          },
+        ],
+      }),
+    ).toThrowErrorMatchingInlineSnapshot(
+      `[MultisigSimulation.InvalidSimulationError: Invalid multisig simulation: approval count exceeds 8.]`,
+    )
+  })
+})