tempo.ts 0.7.6 → 0.8.0

package/src/ox/SignatureEnvelope.ts

@@ -1,3 +1,4 @@
+import type * as Address from 'ox/Address'
 import * as Errors from 'ox/Errors'
 import * as Hex from 'ox/Hex'
 import * as Json from 'ox/Json'
@@ -10,11 +11,13 @@ import type {
   IsNarrowable,
   OneOf,
   PartialBy,
+  UnionPartialBy,
 } from '../internal/types.js'
 
 /** Signature type identifiers for encoding/decoding */
 const serializedP256Type = '0x01'
 const serializedWebAuthnType = '0x02'
+const serializedKeychainType = '0x03'
 
 /**
  * Statically determines the signature type of an envelope at compile time.
@@ -53,7 +56,11 @@ export type GetType<
                 signature: { r: bigint; s: bigint; yParity: number }
               }
             ? 'secp256k1'
-            : never
+            : envelope extends {
+                  userAddress: Address.Address
+                }
+              ? 'keychain'
+              : never
 
 /**
  * Represents a signature envelope that can contain different signature types.
@@ -67,12 +74,29 @@ export type SignatureEnvelope<bigintType = bigint, numberType = number> = OneOf<
   | Secp256k1<bigintType, numberType>
   | P256<bigintType, numberType>
   | WebAuthn<bigintType, numberType>
+  | Keychain<bigintType, numberType>
 >
 
 /**
  * RPC-formatted signature envelope.
  */
-export type SignatureEnvelopeRpc = OneOf<Secp256k1Rpc | P256Rpc | WebAuthnRpc>
+export type SignatureEnvelopeRpc = OneOf<
+  Secp256k1Rpc | P256Rpc | WebAuthnRpc | KeychainRpc
+>
+
+export type Keychain<bigintType = bigint, numberType = number> = {
+  /** Root account address that this transaction is being executed for */
+  userAddress: Address.Address
+  /** The actual signature from the access key (can be Secp256k1, P256, or WebAuthn) */
+  inner: SignatureEnvelope<bigintType, numberType>
+  type: 'keychain'
+}
+
+export type KeychainRpc = {
+  type: 'keychain'
+  userAddress: Address.Address
+  signature: SignatureEnvelopeRpc
+}
 
 export type P256<bigintType = bigint, numberType = number> = {
   prehash: boolean
@@ -159,7 +183,8 @@ export function assert(envelope: PartialBy<SignatureEnvelope, 'type'>): void {
   const type = getType(envelope)
 
   if (type === 'secp256k1') {
-    Signature.assert(envelope.signature)
+    const secp256k1 = envelope as Secp256k1
+    Signature.assert(secp256k1.signature)
     return
   }
 
@@ -204,6 +229,12 @@ export function assert(envelope: PartialBy<SignatureEnvelope, 'type'>): void {
       throw new MissingPropertiesError({ envelope, missing, type: 'webAuthn' })
     return
   }
+
+  if (type === 'keychain') {
+    const keychain = envelope as Keychain
+    assert(keychain.inner)
+    return
+  }
 }
 
 export declare namespace assert {
@@ -233,7 +264,7 @@ export function deserialize(serialized: Serialized): SignatureEnvelope {
   if (size === 65) {
     const signature = Signature.fromHex(serialized)
     Signature.assert(signature)
-    return { signature, type: 'secp256k1' }
+    return { signature, type: 'secp256k1' } satisfies Secp256k1
   }
 
   // For all other lengths, first byte is the type identifier
@@ -261,7 +292,7 @@ export function deserialize(serialized: Serialized): SignatureEnvelope {
         s: Hex.toBigInt(Hex.slice(data, 32, 64)),
       },
       type: 'p256',
-    } as P256
+    } satisfies P256
   }
 
   if (typeId === serializedWebAuthnType) {
@@ -325,7 +356,18 @@ export function deserialize(serialized: Serialized): SignatureEnvelope {
         ),
       },
       type: 'webAuthn',
-    } as WebAuthn
+    } satisfies WebAuthn
+  }
+
+  if (typeId === serializedKeychainType) {
+    const userAddress = Hex.slice(data, 0, 20)
+    const inner = deserialize(Hex.slice(data, 20))
+
+    return {
+      userAddress,
+      inner,
+      type: 'keychain',
+    } satisfies Keychain
   }
 
   throw new InvalidSerializedError({
@@ -361,7 +403,10 @@ export function from<const value extends from.Value>(
 }
 
 export declare namespace from {
-  type Value = PartialBy<SignatureEnvelope, 'type'> | Secp256k1Flat | Serialized
+  type Value =
+    | UnionPartialBy<SignatureEnvelope, 'type'>
+    | Secp256k1Flat
+    | Serialized
 
   type ReturnValue<value extends Value> = Compute<
     OneOf<
@@ -451,6 +496,16 @@ export function fromRpc(envelope: SignatureEnvelopeRpc): SignatureEnvelope {
     }
   }
 
+  if (
+    envelope.type === 'keychain' ||
+    ('userAddress' in envelope && 'signature' in envelope)
+  )
+    return {
+      type: 'keychain',
+      userAddress: envelope.userAddress,
+      inner: fromRpc(envelope.signature),
+    }
+
   throw new CoercionError({ envelope })
 }
 
@@ -513,6 +568,10 @@ export function getType<
   )
     return 'webAuthn' as never
 
+  // Detect Keychain signature
+  if ('userAddress' in envelope && 'inner' in envelope)
+    return 'keychain' as never
+
   throw new CoercionError({
     envelope,
   })
@@ -531,12 +590,15 @@ export function getType<
  * @throws {CoercionError} If the envelope cannot be serialized.
  */
 export function serialize(
-  envelope: PartialBy<SignatureEnvelope, 'prehash'>,
+  envelope: UnionPartialBy<SignatureEnvelope, 'prehash'>,
 ): Serialized {
   const type = getType(envelope)
 
   // Backward compatibility: no type identifier for secp256k1
-  if (type === 'secp256k1') return Signature.toHex(envelope.signature)
+  if (type === 'secp256k1') {
+    const secp256k1 = envelope as Secp256k1
+    return Signature.toHex(secp256k1.signature)
+  }
 
   if (type === 'p256') {
     const p256 = envelope as P256
@@ -569,6 +631,15 @@ export function serialize(
     )
   }
 
+  if (type === 'keychain') {
+    const keychain = envelope as Keychain
+    return Hex.concat(
+      serializedKeychainType,
+      keychain.userAddress,
+      serialize(keychain.inner),
+    )
+  }
+
   throw new CoercionError({ envelope })
 }
 
@@ -618,6 +689,15 @@ export function toRpc(envelope: SignatureEnvelope): SignatureEnvelopeRpc {
     }
   }
 
+  if (type === 'keychain') {
+    const keychain = envelope as Keychain
+    return {
+      type: 'keychain',
+      userAddress: keychain.userAddress,
+      signature: toRpc(keychain.inner),
+    }
+  }
+
   throw new CoercionError({ envelope })
 }
 

package/src/ox/Transaction.test.ts

@@ -152,6 +152,113 @@ describe('fromRpc', () => {
       }
     `)
   })
+
+  test('with keyAuthorization', () => {
+    const transaction = Transaction.fromRpc({
+      accessList: [],
+      calls: [
+        {
+          input: '0xdeadbeef',
+          to: '0x3fc91a3afd70395cd496c647d5a6cc9d4b2b7fad',
+          value: '0x9b6e64a8ec60000',
+        },
+      ],
+      keyAuthorization: {
+        expiry: '0xffffffffffff',
+        keyId: '0xbe95c3f554e9fc85ec51be69a3d807a0d55bcf2c',
+        keyType: 'secp256k1',
+        limits: [
+          {
+            token: '0x20c0000000000000000000000000000000000001',
+            limit: '0x8ac7230489e80000',
+          },
+        ],
+        signature: {
+          r: '0x635dc2033e60185bb36709c29c75d64ea51dfbd91c32ef4be198e4ceb169fb4d',
+          s: '0x50c2667ac4c771072746acfdcf1f1483336dcca8bd2df47cd83175dbe60f0540',
+          type: 'secp256k1',
+          yParity: '0x0',
+        },
+      },
+      maxFeePerGas: '0x2',
+      maxPriorityFeePerGas: '0x1',
+      hash: '0x353fdfc38a2f26115daadee9f5b8392ce62b84f410957967e2ed56b35338cdd0',
+      nonce: '0x357',
+      blockHash:
+        '0xc350d807505fb835650f0013632c5515592987ba169bbc6626d9fc54d91f0f0b',
+      blockNumber: '0x12f296f',
+      transactionIndex: '0x2',
+      feeToken: '0x20c0000000000000000000000000000000000000',
+      from: '0x814e5e0e31016b9a7f138c76b7e7b2bb5c1ab6a6',
+      gas: '0x43f5d',
+      gasPrice: '0x2ca6ae494',
+      signature: {
+        r: '0x635dc2033e60185bb36709c29c75d64ea51dfbd91c32ef4be198e4ceb169fb4d',
+        s: '0x50c2667ac4c771072746acfdcf1f1483336dcca8bd2df47cd83175dbe60f0540',
+        v: '0x0',
+        type: 'secp256k1',
+        yParity: '0x0',
+      },
+      chainId: '0x1',
+      type: '0x76',
+    })
+
+    expect(transaction).toMatchInlineSnapshot(`
+      {
+        "accessList": [],
+        "blockHash": "0xc350d807505fb835650f0013632c5515592987ba169bbc6626d9fc54d91f0f0b",
+        "blockNumber": 19868015n,
+        "calls": [
+          {
+            "data": "0xdeadbeef",
+            "to": "0x3fc91a3afd70395cd496c647d5a6cc9d4b2b7fad",
+            "value": 700000000000000000n,
+          },
+        ],
+        "chainId": 1,
+        "data": undefined,
+        "feeToken": "0x20c0000000000000000000000000000000000000",
+        "from": "0x814e5e0e31016b9a7f138c76b7e7b2bb5c1ab6a6",
+        "gas": 278365n,
+        "gasPrice": 11985937556n,
+        "hash": "0x353fdfc38a2f26115daadee9f5b8392ce62b84f410957967e2ed56b35338cdd0",
+        "keyAuthorization": {
+          "address": "0xbe95c3f554e9fc85ec51be69a3d807a0d55bcf2c",
+          "chainId": 0n,
+          "expiry": 281474976710655,
+          "limits": [
+            {
+              "limit": 10000000000000000000n,
+              "token": "0x20c0000000000000000000000000000000000001",
+            },
+          ],
+          "signature": {
+            "signature": {
+              "r": 44944627813007772897391531230081695102703289123332187696115181104739239197517n,
+              "s": 36528503505192438307355164441104001310566505351980369085208178712678799181120n,
+              "yParity": 0,
+            },
+            "type": "secp256k1",
+          },
+          "type": "secp256k1",
+        },
+        "maxFeePerGas": 2n,
+        "maxPriorityFeePerGas": 1n,
+        "nonce": 855n,
+        "signature": {
+          "signature": {
+            "r": 44944627813007772897391531230081695102703289123332187696115181104739239197517n,
+            "s": 36528503505192438307355164441104001310566505351980369085208178712678799181120n,
+            "yParity": 0,
+          },
+          "type": "secp256k1",
+        },
+        "transactionIndex": 2,
+        "type": "aa",
+        "value": 0n,
+      }
+    `)
+  })
 })
 
 describe('toRpc', () => {
@@ -306,4 +413,111 @@ describe('toRpc', () => {
       }
     `)
   })
+
+  test('with keyAuthorization', () => {
+    const transaction = Transaction.toRpc({
+      accessList: [],
+      blockHash:
+        '0xc350d807505fb835650f0013632c5515592987ba169bbc6626d9fc54d91f0f0b',
+      blockNumber: 19868015n,
+      calls: [
+        {
+          data: '0xdeadbeef',
+          to: '0x3fc91a3afd70395cd496c647d5a6cc9d4b2b7fad',
+          value: 700000000000000000n,
+        },
+      ],
+      chainId: 1,
+      data: undefined,
+      keyAuthorization: {
+        address: '0xbe95c3f554e9fc85ec51be69a3d807a0d55bcf2c',
+        expiry: 281474976710655,
+        type: 'secp256k1',
+        limits: [
+          {
+            limit: 10000000000000000000n,
+            token: '0x20c0000000000000000000000000000000000001',
+          },
+        ],
+        signature: {
+          signature: {
+            r: 44944627813007772897391531230081695102703289123332187696115181104739239197517n,
+            s: 36528503505192438307355164441104001310566505351980369085208178712678799181120n,
+            yParity: 0,
+          },
+          type: 'secp256k1',
+        },
+      },
+      feeToken: '0x20c0000000000000000000000000000000000000',
+      from: '0x814e5e0e31016b9a7f138c76b7e7b2bb5c1ab6a6',
+      gas: 278365n,
+      gasPrice: 11985937556n,
+      hash: '0x353fdfc38a2f26115daadee9f5b8392ce62b84f410957967e2ed56b35338cdd0',
+      maxFeePerGas: 2n,
+      maxPriorityFeePerGas: 1n,
+      nonce: 855n,
+      signature: {
+        signature: {
+          r: 44944627813007772897391531230081695102703289123332187696115181104739239197517n,
+          s: 36528503505192438307355164441104001310566505351980369085208178712678799181120n,
+          yParity: 0,
+        },
+        type: 'secp256k1',
+      },
+      transactionIndex: 2,
+      type: 'aa',
+    })
+    expect(transaction).toMatchInlineSnapshot(`
+      {
+        "accessList": [],
+        "blockHash": "0xc350d807505fb835650f0013632c5515592987ba169bbc6626d9fc54d91f0f0b",
+        "blockNumber": "0x12f296f",
+        "calls": [
+          {
+            "data": "0xdeadbeef",
+            "to": "0x3fc91a3afd70395cd496c647d5a6cc9d4b2b7fad",
+            "value": "0x9b6e64a8ec60000",
+          },
+        ],
+        "chainId": "0x1",
+        "feeToken": "0x20c0000000000000000000000000000000000000",
+        "from": "0x814e5e0e31016b9a7f138c76b7e7b2bb5c1ab6a6",
+        "gas": "0x43f5d",
+        "gasPrice": "0x2ca6ae494",
+        "hash": "0x353fdfc38a2f26115daadee9f5b8392ce62b84f410957967e2ed56b35338cdd0",
+        "input": undefined,
+        "keyAuthorization": {
+          "chainId": "0x",
+          "expiry": "0xffffffffffff",
+          "keyId": "0xbe95c3f554e9fc85ec51be69a3d807a0d55bcf2c",
+          "keyType": "secp256k1",
+          "limits": [
+            {
+              "limit": "0x8ac7230489e80000",
+              "token": "0x20c0000000000000000000000000000000000001",
+            },
+          ],
+          "signature": {
+            "r": "0x635dc2033e60185bb36709c29c75d64ea51dfbd91c32ef4be198e4ceb169fb4d",
+            "s": "0x50c2667ac4c771072746acfdcf1f1483336dcca8bd2df47cd83175dbe60f0540",
+            "type": "secp256k1",
+            "yParity": "0x0",
+          },
+        },
+        "maxFeePerGas": "0x2",
+        "maxPriorityFeePerGas": "0x1",
+        "nonce": "0x357",
+        "signature": {
+          "r": "0x635dc2033e60185bb36709c29c75d64ea51dfbd91c32ef4be198e4ceb169fb4d",
+          "s": "0x50c2667ac4c771072746acfdcf1f1483336dcca8bd2df47cd83175dbe60f0540",
+          "type": "secp256k1",
+          "yParity": "0x0",
+        },
+        "to": undefined,
+        "transactionIndex": "0x2",
+        "type": "0x76",
+        "value": "0x0",
+      }
+    `)
+  })
 })

package/src/ox/Transaction.ts

@@ -6,6 +6,7 @@ import * as Hex from 'ox/Hex'
 import * as Signature from 'ox/Signature'
 import * as ox_Transaction from 'ox/Transaction'
 import type { Compute, OneOf, UnionCompute } from '../internal/types.js'
+import * as KeyAuthorization from './KeyAuthorization.js'
 import * as SignatureEnvelope from './SignatureEnvelope.js'
 import type { Call } from './TransactionEnvelopeAA.js'
 
@@ -69,6 +70,10 @@ export type AA<
     feeToken: Address.Address
     /** Effective gas price paid by the sender in wei. */
     gasPrice?: bigintType | undefined
+    /** Key authorization for provisioning a new access key. */
+    keyAuthorization?:
+      | KeyAuthorization.KeyAuthorization<true, bigintType, numberType>
+      | undefined
     /** Total fee per gas in wei (gasPrice/baseFeePerGas + maxPriorityFeePerGas). */
     maxFeePerGas: bigintType
     /** Max priority fee per gas (in wei). */
@@ -90,7 +95,7 @@ export type AA<
 export type AARpc<pending extends boolean = false> = Compute<
   Omit<
     AA<pending, Hex.Hex, Hex.Hex, ToRpcType['aa']>,
-    'calls' | 'signature'
+    'calls' | 'keyAuthorization' | 'signature'
   > & {
     calls:
       | readonly {
@@ -99,6 +104,7 @@ export type AARpc<pending extends boolean = false> = Compute<
           value?: Hex.Hex | undefined
         }[]
       | undefined
+    keyAuthorization?: KeyAuthorization.Rpc | undefined
     signature: SignatureEnvelope.SignatureEnvelopeRpc
   }
 >
@@ -200,6 +206,10 @@ export function fromRpc<
     transaction_.validAfter = Number(transaction.validAfter)
   if (transaction.validBefore)
     transaction_.validBefore = Number(transaction.validBefore)
+  if (transaction.keyAuthorization)
+    transaction_.keyAuthorization = KeyAuthorization.fromRpc(
+      transaction.keyAuthorization,
+    )
   if (transaction.feePayerSignature) {
     transaction_.feePayerSignature = Signature.fromRpc(
       transaction.feePayerSignature,
@@ -282,6 +292,8 @@ export function toRpc<pending extends boolean = false>(
       data: call.data,
     }))
   if (transaction.feeToken) rpc.feeToken = transaction.feeToken
+  if (transaction.keyAuthorization)
+    rpc.keyAuthorization = KeyAuthorization.toRpc(transaction.keyAuthorization)
   if (transaction.feePayerSignature) {
     rpc.feePayerSignature = Signature.toRpc(
       transaction.feePayerSignature,