ox 0.14.0 → 0.14.1

package/tempo/TxEnvelopeTempo.test.ts

@@ -692,6 +692,32 @@ describe('from', () => {
     }
   })
 
+  test('tempo address input for calls.to', () => {
+    const hexAddr = '0x70997970c51812dc3a010c7d01b50e0d17dc79c8'
+    const tempoAddr = 'tempo1qpcfj7tsc5vp9hp6qyx86qd4pcx30hreeqlrsqqr'
+
+    const envelope = TxEnvelopeTempo.from({
+      chainId: 1,
+      calls: [{ to: tempoAddr }],
+      nonce: 0n,
+      nonceKey: 0n,
+    })
+    expect(envelope.calls[0]!.to).toBe(Address.checksum(hexAddr))
+  })
+
+  test('tempo address input for from', () => {
+    const hexAddr = '0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266'
+    const tempoAddr = 'tempo1qreel4h9r2kc3ah5ee4t3qnj088llwfzvccugvl7'
+
+    const envelope = TxEnvelopeTempo.from({
+      chainId: 1,
+      calls: [{}],
+      nonce: 0n,
+      from: tempoAddr as any,
+    })
+    expect(envelope.from).toBe(Address.checksum(hexAddr))
+  })
+
   test('options: signature', () => {
     const envelope = TxEnvelopeTempo.from(
       {
@@ -1382,6 +1408,29 @@ describe('getSignPayload', () => {
       `"0xe1222a45806457acbe3a13940aae4c34f3180659fa16613b5a45dc183adae07c"`,
     )
   })
+
+  test('tempo address input for from', () => {
+    const hexAddr = '0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266'
+    const tempoAddr = 'tempo1qreel4h9r2kc3ah5ee4t3qnj088llwfzvccugvl7'
+
+    const transaction = TxEnvelopeTempo.from({
+      chainId: 1,
+      calls: [
+        {
+          to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
+        },
+      ],
+      nonce: 0n,
+    })
+
+    const hashHex = TxEnvelopeTempo.getSignPayload(transaction, {
+      from: hexAddr,
+    })
+    const hashTempo = TxEnvelopeTempo.getSignPayload(transaction, {
+      from: tempoAddr,
+    })
+    expect(hashTempo).toBe(hashHex)
+  })
 })
 
 describe('getFeePayerSignPayload', () => {
@@ -1404,6 +1453,29 @@ describe('getFeePayerSignPayload', () => {
     )
   })
 
+  test('tempo address input for sender', () => {
+    const hexAddr = '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266'
+    const tempoAddr = 'tempo1qreel4h9r2kc3ah5ee4t3qnj088llwfzvccugvl7'
+
+    const transaction = TxEnvelopeTempo.from({
+      chainId: 1,
+      calls: [
+        {
+          to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
+        },
+      ],
+      nonce: 0n,
+    })
+
+    const hashHex = TxEnvelopeTempo.getFeePayerSignPayload(transaction, {
+      sender: hexAddr,
+    })
+    const hashTempo = TxEnvelopeTempo.getFeePayerSignPayload(transaction, {
+      sender: tempoAddr,
+    })
+    expect(hashTempo).toBe(hashHex)
+  })
+
   test('with feeToken', () => {
     const transaction = TxEnvelopeTempo.from({
       chainId: 1,

package/tempo/TxEnvelopeTempo.ts

@@ -17,6 +17,7 @@ import * as TransactionEnvelope from '../core/TxEnvelope.js'
 import * as AuthorizationTempo from './AuthorizationTempo.js'
 import * as KeyAuthorization from './KeyAuthorization.js'
 import * as SignatureEnvelope from './SignatureEnvelope.js'
+import * as TempoAddress from './TempoAddress.js'
 import * as TokenId from './TokenId.js'
 
 /**
@@ -26,11 +27,11 @@ import * as TokenId from './TokenId.js'
  *
  * [Batch Calls](https://docs.tempo.xyz/protocol/transactions#batch-calls)
  */
-export type Call<bigintType = bigint> = {
+export type Call<bigintType = bigint, addressType = Address.Address> = {
   /** Call data. */
   data?: Hex.Hex | undefined
   /** The target address or contract creation. */
-  to?: Address.Address | undefined
+  to?: addressType | undefined
   /** Value to send (in wei). */
   value?: bigintType | undefined
 }
@@ -77,11 +78,11 @@ export type TxEnvelopeTempo<
       | AuthorizationTempo.ListSigned<bigintType, numberType>
       | undefined
     /** Array of calls to execute. */
-    calls: readonly Call<bigintType>[]
+    calls: readonly Call<bigintType, TempoAddress.Address>[]
     /** EIP-155 Chain ID. */
     chainId: numberType
     /** Sender of the transaction. */
-    from?: Address.Address | undefined
+    from?: TempoAddress.Address | undefined
     /** Gas provided for transaction execution */
     gas?: bigintType | undefined
     /** Fee payer signature. */
@@ -154,7 +155,7 @@ export type Type = typeof type
  * import { TxEnvelopeTempo } from 'ox/tempo'
  *
  * TxEnvelopeTempo.assert({
- *   calls: [{ to: '0x0000000000000000000000000000000000000000', value: 0n }],
+ *   calls: [{ to: 'tempo1qqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqj97hme', value: 0n }],
  *   chainId: 1,
  *   maxFeePerGas: 1000000000n,
  * })
@@ -413,7 +414,7 @@ export declare namespace deserialize {
  *   chainId: 1, // [!code focus]
  *   calls: [{ // [!code focus]
  *     data: '0xdeadbeef', // [!code focus]
- *     to: '0x0000000000000000000000000000000000000000', // [!code focus]
+ *     to: 'tempo1qqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqj97hme', // [!code focus]
  *   }], // [!code focus]
  *   maxFeePerGas: Value.fromGwei('10'), // [!code focus]
  *   maxPriorityFeePerGas: Value.fromGwei('1'), // [!code focus]
@@ -434,7 +435,7 @@ export declare namespace deserialize {
  *   chainId: 1,
  *   calls: [{
  *     data: '0xdeadbeef',
- *     to: '0x0000000000000000000000000000000000000000',
+ *     to: 'tempo1qqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqj97hme',
  *   }],
  *   maxFeePerGas: Value.fromGwei('10'),
  *   maxPriorityFeePerGas: Value.fromGwei('1'),
@@ -497,6 +498,19 @@ export function from<
     typeof envelope === 'string' ? deserialize(envelope) : envelope
   ) as TxEnvelopeTempo
 
+  // Resolve TempoAddress inputs to hex addresses.
+  if (envelope_.from)
+    envelope_.from = TempoAddress.resolve(
+      envelope_.from as TempoAddress.Address,
+    )
+  if (envelope_.calls)
+    envelope_.calls = (envelope_.calls as readonly Call[]).map((call) => ({
+      ...call,
+      ...(call.to
+        ? { to: TempoAddress.resolve(call.to as TempoAddress.Address) }
+        : {}),
+    })) as readonly Call[]
+
   assert(envelope_)
 
   return {
@@ -559,7 +573,7 @@ export declare namespace from {
  *   chainId: 1,
  *   calls: [{
  *     data: '0xdeadbeef',
- *     to: '0x0000000000000000000000000000000000000000',
+ *     to: 'tempo1qqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqj97hme',
  *   }],
  *   maxFeePerGas: Value.fromGwei('10'),
  * })
@@ -581,7 +595,7 @@ export declare namespace from {
  *   chainId: 1,
  *   calls: [{
  *     data: '0xdeadbeef',
- *     to: '0x0000000000000000000000000000000000000000',
+ *     to: 'tempo1qqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqj97hme',
  *   }],
  *   maxFeePerGas: Value.fromGwei('10'),
  * })
@@ -632,7 +646,7 @@ export function serialize(
 
   // Encode calls as RLP list of [to, value, data] tuples
   const callsTupleList = calls.map((call) => [
-    call.to ?? '0x',
+    call.to ? TempoAddress.resolve(call.to) : '0x',
     call.value ? Hex.fromNumber(call.value) : '0x',
     call.data ?? '0x',
   ])
@@ -766,7 +780,7 @@ export declare namespace serialize {
  *   chainId: 1,
  *   calls: [{
  *     data: '0xdeadbeef',
- *     to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
+ *     to: 'tempo1qpcfj7tsc5vp9hp6qyx86qd4pcx30hreeqlrsqqr',
  *   }],
  *   nonce: 0n,
  *   maxFeePerGas: 1000000000n,
@@ -796,7 +810,7 @@ export declare namespace serialize {
  *   chainId: 1,
  *   calls: [{
  *     data: '0xdeadbeef',
- *     to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
+ *     to: 'tempo1qpcfj7tsc5vp9hp6qyx86qd4pcx30hreeqlrsqqr',
  *   }],
  *   nonce: 0n,
  *   maxFeePerGas: 1000000000n,
@@ -825,7 +839,9 @@ export function getSignPayload(
 ): getSignPayload.ReturnValue {
   const sigHash = hash(envelope, { presign: true })
   if (options.from)
-    return Hash.keccak256(Hex.concat('0x04', sigHash, options.from))
+    return Hash.keccak256(
+      Hex.concat('0x04', sigHash, TempoAddress.resolve(options.from)),
+    )
   return sigHash
 }
 
@@ -837,7 +853,7 @@ export declare namespace getSignPayload {
      * When provided, computes `keccak256(0x04 || sigHash || from)` instead of
      * the raw `sigHash`, binding the access key signature to the specific user account.
      */
-    from?: Address.Address | undefined
+    from?: TempoAddress.Address | undefined
   }
 
   type ReturnValue = Hex.Hex
@@ -858,7 +874,7 @@ export declare namespace getSignPayload {
  *   chainId: 1,
  *   calls: [{
  *     data: '0xdeadbeef',
- *     to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
+ *     to: 'tempo1qpcfj7tsc5vp9hp6qyx86qd4pcx30hreeqlrsqqr',
  *   }],
  *   nonce: 0n,
  *   maxFeePerGas: 1000000000n,
@@ -932,7 +948,7 @@ export declare namespace hash {
  *   chainId: 1,
  *   calls: [{
  *     data: '0xdeadbeef',
- *     to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
+ *     to: 'tempo1qpcfj7tsc5vp9hp6qyx86qd4pcx30hreeqlrsqqr',
  *   }],
  *   nonce: 0n,
  *   maxFeePerGas: 1000000000n,
@@ -940,7 +956,7 @@ export declare namespace hash {
  * })
  *
  * const payload = TxEnvelopeTempo.getFeePayerSignPayload(envelope, {
- *   sender: '0xd8da6bf26964af9d7eed9e03e53415d37aa96045'
+ *   sender: 'tempo1qrvd56ljd9j2l8t7ak0q8ef5zhfh42tqg5kwwrau'
  * }) // [!code focus]
  * // @log: '0x...'
  *
@@ -955,7 +971,7 @@ export function getFeePayerSignPayload(
   envelope: TxEnvelopeTempo,
   options: getFeePayerSignPayload.Options,
 ): getFeePayerSignPayload.ReturnValue {
-  const { sender } = options
+  const sender = TempoAddress.resolve(options.sender)
   const serialized = serialize(
     { ...envelope, signature: undefined },
     {
@@ -971,7 +987,7 @@ export declare namespace getFeePayerSignPayload {
     /**
      * Sender address to cover the fee of.
      */
-    sender: Address.Address
+    sender: TempoAddress.Address
   }
 
   type ReturnValue = Hex.Hex
@@ -989,7 +1005,7 @@ export declare namespace getFeePayerSignPayload {
  * const valid = TxEnvelopeTempo.validate({
  *   calls: [{
  *     data: '0xdeadbeef',
- *     to: '0x0000000000000000000000000000000000000000',
+ *     to: 'tempo1qqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqj97hme',
  *   }],
  *   chainId: 1,
  *   maxFeePerGas: 1000000000n,
@@ -1041,7 +1057,7 @@ export class CallsEmptyError extends Errors.BaseError {
  * import { TxEnvelopeTempo } from 'ox/tempo'
  *
  * TxEnvelopeTempo.assert({
- *   calls: [{ to: '0x0000000000000000000000000000000000000000' }],
+ *   calls: [{ to: 'tempo1qqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqj97hme' }],
  *   chainId: 1,
  *   validBefore: 100,
  *   validAfter: 200,

package/tempo/e2e.test.ts

@@ -9,7 +9,7 @@ import {
 } from 'ox'
 import { getTransactionCount } from 'viem/actions'
 import { beforeEach, describe, expect, test } from 'vitest'
-import { chain, client, fundAddress, nodeEnv } from '../../test/tempo/config.js'
+import { chain, client, fundAddress } from '../../test/tempo/config.js'
 import {
   AuthorizationTempo,
   KeyAuthorization,
@@ -20,8 +20,6 @@ import * as TransactionReceipt from './TransactionReceipt.js'
 import * as TxEnvelopeTempo from './TxEnvelopeTempo.js'
 
 const chainId = chain.id
-// TODO: remove when v2 keychain signatures are deployed to testnet.
-const keychainVersion = nodeEnv === 'localnet' ? 'v2' : undefined
 
 test('behavior: default (secp256k1)', async () => {
   const privateKey = Secp256k1.randomPrivateKey()
@@ -843,7 +841,7 @@ describe('behavior: keyAuthorization', () => {
 
     const signature = Secp256k1.sign({
       payload: TxEnvelopeTempo.getSignPayload(transaction, {
-        from: keychainVersion === 'v2' ? root.address : undefined,
+        from: root.address,
       }),
       privateKey: access.privateKey,
     })
@@ -853,7 +851,6 @@ describe('behavior: keyAuthorization', () => {
         userAddress: root.address,
         inner: SignatureEnvelope.from(signature),
         type: 'keychain',
-        version: keychainVersion,
       }),
     })
 
@@ -985,7 +982,7 @@ describe('behavior: keyAuthorization', () => {
 
       const signature = Secp256k1.sign({
         payload: TxEnvelopeTempo.getSignPayload(transaction, {
-          from: keychainVersion === 'v2' ? root.address : undefined,
+          from: root.address,
         }),
         privateKey: access.privateKey,
       })
@@ -995,7 +992,6 @@ describe('behavior: keyAuthorization', () => {
           userAddress: root.address,
           inner: SignatureEnvelope.from(signature),
           type: 'keychain',
-          version: keychainVersion,
         }),
       })
 
@@ -1056,7 +1052,7 @@ describe('behavior: keyAuthorization', () => {
 
     const signature = P256.sign({
       payload: TxEnvelopeTempo.getSignPayload(transaction, {
-        from: keychainVersion === 'v2' ? root.address : undefined,
+        from: root.address,
       }),
       privateKey: access.privateKey,
     })
@@ -1071,7 +1067,6 @@ describe('behavior: keyAuthorization', () => {
           type: 'p256',
         }),
         type: 'keychain',
-        version: keychainVersion,
       }),
     })
 
@@ -1204,7 +1199,7 @@ describe('behavior: keyAuthorization', () => {
 
       const signature = P256.sign({
         payload: TxEnvelopeTempo.getSignPayload(transaction, {
-          from: keychainVersion === 'v2' ? root.address : undefined,
+          from: root.address,
         }),
         privateKey: access.privateKey,
       })
@@ -1219,7 +1214,6 @@ describe('behavior: keyAuthorization', () => {
             type: 'p256',
           }),
           type: 'keychain',
-          version: keychainVersion,
         }),
       })
 
@@ -1278,7 +1272,7 @@ describe('behavior: keyAuthorization', () => {
 
     const signature = await WebCryptoP256.sign({
       payload: TxEnvelopeTempo.getSignPayload(transaction, {
-        from: keychainVersion === 'v2' ? root.address : undefined,
+        from: root.address,
       }),
       privateKey: keyPair.privateKey,
     })
@@ -1293,7 +1287,6 @@ describe('behavior: keyAuthorization', () => {
           type: 'p256',
         }),
         type: 'keychain',
-        version: keychainVersion,
       }),
     })
 
@@ -1387,7 +1380,7 @@ describe('behavior: keyAuthorization', () => {
 
       const signature = await WebCryptoP256.sign({
         payload: TxEnvelopeTempo.getSignPayload(transaction, {
-          from: keychainVersion === 'v2' ? root.address : undefined,
+          from: root.address,
         }),
         privateKey: keyPair.privateKey,
       })
@@ -1402,7 +1395,6 @@ describe('behavior: keyAuthorization', () => {
             type: 'p256',
           }),
           type: 'keychain',
-          version: keychainVersion,
         }),
       })
 
@@ -1469,7 +1461,7 @@ describe('behavior: keyAuthorization', () => {
 
     const signature = P256.sign({
       payload: TxEnvelopeTempo.getSignPayload(transaction, {
-        from: keychainVersion === 'v2' ? root.address : undefined,
+        from: root.address,
       }),
       privateKey: access.privateKey,
     })
@@ -1484,7 +1476,6 @@ describe('behavior: keyAuthorization', () => {
           type: 'p256',
         }),
         type: 'keychain',
-        version: keychainVersion,
       }),
     })
 
@@ -1566,7 +1557,7 @@ describe('behavior: keyAuthorization', () => {
 
     const signature = Secp256k1.sign({
       payload: TxEnvelopeTempo.getSignPayload(transaction, {
-        from: keychainVersion === 'v2' ? root.address : undefined,
+        from: root.address,
       }),
       privateKey: access.privateKey,
     })
@@ -1576,7 +1567,6 @@ describe('behavior: keyAuthorization', () => {
         userAddress: root.address,
         inner: SignatureEnvelope.from(signature),
         type: 'keychain',
-        version: keychainVersion,
       }),
     })
 
@@ -1653,7 +1643,7 @@ describe('behavior: keyAuthorization', () => {
 
     const signature = Secp256k1.sign({
       payload: TxEnvelopeTempo.getSignPayload(transaction, {
-        from: keychainVersion === 'v2' ? root.address : undefined,
+        from: root.address,
       }),
       privateKey: access.privateKey,
     })
@@ -1663,7 +1653,6 @@ describe('behavior: keyAuthorization', () => {
         userAddress: root.address,
         inner: SignatureEnvelope.from(signature),
         type: 'keychain',
-        version: keychainVersion,
       }),
     })
 

package/tempo/index.ts

@@ -17,7 +17,7 @@ export type {}
  * import { AuthorizationTempo } from 'ox/tempo'
  *
  * const authorization = AuthorizationTempo.from({
- *   address: '0xbe95c3f554e9fc85ec51be69a3d807a0d55bcf2c',
+ *   address: 'tempo1qzlftsl42n5lep0v2xlxng7cq7sd2k709sxlwnsu',
  *   chainId: 1,
  *   nonce: 40n,
  * })
@@ -55,10 +55,11 @@ export * as AuthorizationTempo from './AuthorizationTempo.js'
  *
  * const authorization = KeyAuthorization.from({
  *   address,
+ *   chainId: 4217n,
  *   expiry: 1234567890,
  *   type: 'p256',
  *   limits: [{
- *     token: '0x20c0000000000000000000000000000000000001',
+ *     token: 'tempo1qqsvqqqqqqqqqqqqqqqqqqqqqqqqqqqqqyr9xgnd',
  *     limit: Value.from('10', 6),
  *   }],
  * })
@@ -179,7 +180,7 @@ export * as Tick from './Tick.js'
  *
  * const tokenId = TokenId.from(1n)
  * const address = TokenId.toAddress(1n)
- * // '0x20c0000000000000000000000000000000000001'
+ * // 'tempo1qqsvqqqqqqqqqqqqqqqqqqqqqqqqqqqqqyr9xgnd'
  * ```
  *
  * @category Reference
@@ -231,7 +232,7 @@ export * as TokenRole from './TokenRole.js'
  *       value: '0x9b6e64a8ec60000',
  *     },
  *   ],
- *   feeToken: '0x20c0000000000000000000000000000000000000',
+ *   feeToken: 'tempo1qqsvqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqv0ywuh',
  *   transactionIndex: '0x2',
  *   from: '0x814e5e0e31016b9a7f138c76b7e7b2bb5c1ab6a6',
  *   value: '0x9b6e64a8ec60000',
@@ -270,7 +271,7 @@ export * as Transaction from './Transaction.js'
  * const receipt = TransactionReceipt.fromRpc({
  *   status: '0x1',
  *   feePayer: '0x...',
- *   feeToken: '0x20c0000000000000000000000000000000000001',
+ *   feeToken: 'tempo1qqsvqqqqqqqqqqqqqqqqqqqqqqqqqqqqqyr9xgnd',
  *   // ... other fields
  * } as any)
  * ```
@@ -291,8 +292,8 @@ export * as TransactionReceipt from './TransactionReceipt.js'
  * import { TransactionRequest } from 'ox/tempo'
  *
  * const request = TransactionRequest.toRpc({
- *   calls: [{ to: '0xcafebabecafebabecafebabecafebabecafebabe', data: '0xdeadbeef' }],
- *   feeToken: '0x20c0000000000000000000000000000000000000',
+ *   calls: [{ to: 'tempo1qr90aw47etlt40k2l6atajh7h2lv4l46hcx5uwlp', data: '0xdeadbeef' }],
+ *   feeToken: 'tempo1qqsvqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqv0ywuh',
  * })
  * ```
  *
@@ -314,7 +315,7 @@ export * as TransactionRequest from './TransactionRequest.js'
  *
  * const envelope = TxEnvelopeTempo.from({
  *   chainId: 1,
- *   calls: [{ to: '0x0000000000000000000000000000000000000000', data: '0xdeadbeef' }],
+ *   calls: [{ to: 'tempo1qqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqj97hme', data: '0xdeadbeef' }],
  *   maxFeePerGas: Value.fromGwei('10'),
  * })
  *

package/version.ts

@@ -1,2 +1,2 @@
 /** @internal */
-export const version = '0.14.0'
+export const version = '0.14.1'