viem 0.0.0-main.20231026T220458 → 0.0.0-main.20231027T032213

package/chains/celo/serializers.ts

@@ -18,21 +18,27 @@ import {
 import type {
   CeloTransactionSerializable,
   TransactionSerializableCIP42,
+  TransactionSerializableCIP64,
   TransactionSerializedCIP42,
+  TransactionSerializedCIP64,
 } from './types.js'
 
 export const serializeTransactionCelo: SerializeTransactionFn<
   CeloTransactionSerializable
 > = (tx, signature) => {
-  // Handle CIP-42 transactions
-  if (isCIP42(tx))
+  if (isCIP64(tx)) {
+    return serializeTransactionCIP64(
+      tx as TransactionSerializableCIP64,
+      signature,
+    )
+  } else if (isCIP42(tx)) {
     return serializeTransactionCIP42(
       tx as TransactionSerializableCIP42,
       signature,
     )
-
-  // Handle other transaction types
-  return serializeTransaction(tx as TransactionSerializable, signature)
+  } else {
+    return serializeTransaction(tx as TransactionSerializable, signature)
+  }
 }
 
 export const serializersCelo = {
@@ -43,6 +49,7 @@ export const serializersCelo = {
 // Serializers
 
 export type SerializeTransactionCIP42ReturnType = TransactionSerializedCIP42
+export type SerializeTransactionCIP64ReturnType = TransactionSerializedCIP64
 
 // There shall be a typed transaction with the code 0x7c that has the following format:
 // 0x7c || rlp([chain_id, nonce, max_priority_fee_per_gas, max_fee_per_gas, gas_limit, feecurrency, gatewayFeeRecipient, gatewayfee, destination, amount, data, access_list, signature_y_parity, signature_r, signature_s]).
@@ -96,20 +103,83 @@ function serializeTransactionCIP42(
   ]) as SerializeTransactionCIP42ReturnType
 }
 
+function serializeTransactionCIP64(
+  transaction: TransactionSerializableCIP64,
+  signature?: Signature,
+): SerializeTransactionCIP64ReturnType {
+  assertTransactionCIP64(transaction)
+  const {
+    chainId,
+    gas,
+    nonce,
+    to,
+    value,
+    maxFeePerGas,
+    maxPriorityFeePerGas,
+    accessList,
+    feeCurrency,
+    data,
+  } = transaction
+
+  const serializedTransaction = [
+    toHex(chainId),
+    nonce ? toHex(nonce) : '0x',
+    maxPriorityFeePerGas ? toHex(maxPriorityFeePerGas) : '0x',
+    maxFeePerGas ? toHex(maxFeePerGas) : '0x',
+    gas ? toHex(gas) : '0x',
+    to ?? '0x',
+    value ? toHex(value) : '0x',
+    data ?? '0x',
+    serializeAccessList(accessList),
+    feeCurrency ?? '0x',
+  ]
+
+  if (signature) {
+    serializedTransaction.push(
+      signature.v === 27n ? '0x' : toHex(1), // yParity
+      trim(signature.r),
+      trim(signature.s),
+    )
+  }
+
+  return concatHex([
+    '0x7b',
+    toRlp(serializedTransaction),
+  ]) as SerializeTransactionCIP64ReturnType
+}
+
 //////////////////////////////////////////////////////////////////////////////
 // Utilities
 
 // process as CIP42 if any of these fields are present. realistically gatewayfee is not used but is part of spec
-function isCIP42(transaction: CeloTransactionSerializable) {
-  if (
+function isCIP42(transaction: CeloTransactionSerializable): boolean {
+  if (transaction.type === 'cip42') return true
+  // if the type is defined as anything else, assume it is *not* cip42
+  if (transaction.type) return false
+
+  // if the type is undefined, check if the fields match the expectations for cip42
+  return (
     'maxFeePerGas' in transaction &&
     'maxPriorityFeePerGas' in transaction &&
     ('feeCurrency' in transaction ||
       'gatewayFee' in transaction ||
       'gatewayFeeRecipient' in transaction)
   )
-    return true
-  return false
+}
+
+function isCIP64(transaction: CeloTransactionSerializable): boolean {
+  if (transaction.type === 'cip64') return true
+  // if the type is defined as anything else, assume it is *not* cip64
+  if (transaction.type) return false
+
+  // if the type is undefined, check if the fields match the expectations for cip64
+  return (
+    'maxFeePerGas' in transaction &&
+    'maxPriorityFeePerGas' in transaction &&
+    'feeCurrency' in transaction &&
+    !('gatewayFee' in transaction) &&
+    !('gatewayFeeRecipient' in transaction)
+  )
 }
 
 // maxFeePerGas must be less than 2^256 - 1: however writing like that caused exceptions to be raised
@@ -167,3 +237,45 @@ export function assertTransactionCIP42(
     )
   }
 }
+
+export function assertTransactionCIP64(
+  transaction: TransactionSerializableCIP64,
+) {
+  const {
+    chainId,
+    maxPriorityFeePerGas,
+    gasPrice,
+    maxFeePerGas,
+    to,
+    feeCurrency,
+  } = transaction
+
+  if (chainId <= 0) throw new InvalidChainIdError({ chainId })
+  if (to && !isAddress(to)) throw new InvalidAddressError({ address: to })
+
+  if (gasPrice)
+    throw new BaseError(
+      '`gasPrice` is not a valid CIP-64 Transaction attribute.',
+    )
+
+  if (maxFeePerGas && maxFeePerGas > MAX_MAX_FEE_PER_GAS)
+    throw new FeeCapTooHighError({ maxFeePerGas })
+  if (
+    maxPriorityFeePerGas &&
+    maxFeePerGas &&
+    maxPriorityFeePerGas > maxFeePerGas
+  )
+    throw new TipAboveFeeCapError({ maxFeePerGas, maxPriorityFeePerGas })
+
+  if (feeCurrency && !feeCurrency?.startsWith('0x')) {
+    throw new BaseError(
+      '`feeCurrency` MUST be a token address for CIP-64 transactions.',
+    )
+  }
+
+  if (!feeCurrency) {
+    throw new BaseError(
+      '`feeCurrency` must be provided for CIP-64 transactions.',
+    )
+  }
+}

package/chains/celo/types.ts

@@ -75,6 +75,7 @@ export type CeloRpcBlock<
 export type CeloRpcTransaction<TPending extends boolean = boolean> =
   | RpcTransaction<TPending>
   | RpcTransactionCIP42<TPending>
+  | RpcTransactionCIP64<TPending>
 
 export type CeloRpcTransactionReceiptOverrides = {
   feeCurrency: Address | null
@@ -87,10 +88,12 @@ export type CeloRpcTransactionReceipt = RpcTransactionReceipt &
 export type CeloRpcTransactionRequest =
   | RpcTransactionRequest
   | RpcTransactionRequestCIP42
+  | RpcTransactionRequestCIP64
 
 export type CeloTransaction<TPending extends boolean = boolean> =
   | Transaction<TPending>
   | TransactionCIP42<TPending>
+  | TransactionCIP64<TPending>
 
 export type CeloTransactionReceiptOverrides = {
   feeCurrency: Address | null
@@ -103,16 +106,21 @@ export type CeloTransactionReceipt = TransactionReceipt &
 export type CeloTransactionRequest =
   | TransactionRequest
   | TransactionRequestCIP42
+  | TransactionRequestCIP64
 
 export type CeloTransactionSerializable =
   | TransactionSerializableCIP42
+  | TransactionSerializableCIP64
   | TransactionSerializable
 
 export type CeloTransactionSerialized<
   TType extends CeloTransactionType = 'legacy',
-> = TransactionSerialized<TType> | TransactionSerializedCIP42
+> =
+  | TransactionSerialized<TType>
+  | TransactionSerializedCIP42
+  | TransactionSerializedCIP64
 
-export type CeloTransactionType = TransactionType | 'cip42'
+export type CeloTransactionType = TransactionType | 'cip42' | 'cip64'
 
 type RpcTransaction<TPending extends boolean = boolean> =
   RpcTransaction_<TPending> & {
@@ -136,6 +144,13 @@ export type RpcTransactionCIP42<TPending extends boolean = boolean> =
       type: '0x7c'
     }
 
+export type RpcTransactionCIP64<TPending extends boolean = boolean> =
+  TransactionBase<Quantity, Index, TPending> &
+    FeeValuesEIP1559<Quantity> & {
+      feeCurrency: Address | null
+      type: '0x7b'
+    }
+
 export type RpcTransactionRequestCIP42 = TransactionRequestBase<
   Quantity,
   Index
@@ -148,6 +163,18 @@ export type RpcTransactionRequestCIP42 = TransactionRequestBase<
     type?: '0x7c'
   }
 
+export type RpcTransactionRequestCIP64 = TransactionRequestBase<
+  Quantity,
+  Index
+> &
+  Partial<FeeValuesEIP1559<Quantity>> & {
+    accessList?: AccessList
+    feeCurrency?: Address
+    gatewayFee?: undefined
+    gatewayFeeRecipient?: undefined
+    type?: '0x7b'
+  }
+
 type Transaction<TPending extends boolean = boolean> = Transaction_<
   bigint,
   number,
@@ -167,6 +194,15 @@ export type TransactionCIP42<TPending extends boolean = boolean> =
       type: 'cip42'
     }
 
+export type TransactionCIP64<TPending extends boolean = boolean> =
+  TransactionBase<bigint, number, TPending> &
+    FeeValuesEIP1559 & {
+      feeCurrency: Address | null
+      gatewayFee?: undefined
+      gatewayFeeRecipient?: undefined
+      type: 'cip64'
+    }
+
 type TransactionRequest = TransactionRequest_ & {
   feeCurrency?: Address
   gatewayFee?: bigint
@@ -182,6 +218,15 @@ export type TransactionRequestCIP42 = TransactionRequestBase &
     type?: 'cip42'
   }
 
+export type TransactionRequestCIP64 = TransactionRequestBase &
+  Partial<FeeValuesEIP1559> & {
+    accessList?: AccessList
+    feeCurrency?: Address
+    gatewayFee?: undefined
+    gatewayFeeRecipient?: undefined
+    type?: 'cip64'
+  }
+
 export type TransactionSerializableCIP42<
   TQuantity = bigint,
   TIndex = number,
@@ -196,4 +241,17 @@ export type TransactionSerializableCIP42<
     type?: 'cip42'
   }
 
+export type TransactionSerializableCIP64<
+  TQuantity = bigint,
+  TIndex = number,
+> = TransactionSerializableBase<TQuantity, TIndex> &
+  FeeValuesEIP1559<TQuantity> & {
+    accessList?: AccessList
+    gasPrice?: never
+    feeCurrency?: Address
+    chainId: number
+    type?: 'cip64'
+  }
+
 export type TransactionSerializedCIP42 = `0x7c${string}`
+export type TransactionSerializedCIP64 = `0x7b${string}`

package/chains/utils/index.ts

@@ -21,11 +21,17 @@ export type {
   CeloTransactionSerialized,
   CeloTransactionType,
   RpcTransactionCIP42,
+  RpcTransactionCIP64,
   RpcTransactionRequestCIP42,
+  RpcTransactionRequestCIP64,
   TransactionCIP42,
+  TransactionCIP64,
   TransactionRequestCIP42,
+  TransactionRequestCIP64,
   TransactionSerializableCIP42,
+  TransactionSerializableCIP64,
   TransactionSerializedCIP42,
+  TransactionSerializedCIP64,
 } from '../celo/types.js'
 
 export { formattersOptimism } from '../optimism/formatters.js'

package/errors/version.ts

@@ -1 +1 @@
-export const version = '0.0.0-main.20231026T220458'
+export const version = '0.0.0-main.20231027T032213'

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "viem",
   "description": "TypeScript Interface for Ethereum",
-  "version": "0.0.0-main.20231026T220458",
+  "version": "0.0.0-main.20231027T032213",
   "type": "module",
   "main": "./_cjs/index.js",
   "module": "./_esm/index.js",