ox 0.4.1 → 0.4.3

package/core/AbiParameters.ts

@@ -73,9 +73,12 @@ export function decode<
 export function decode(
   parameters: AbiParameters,
   data: Bytes.Bytes | Hex.Hex,
-  options: { as?: 'Array' | 'Object' | undefined } = {},
+  options: {
+    as?: 'Array' | 'Object' | undefined
+    checksumAddress?: boolean | undefined
+  } = {},
 ): readonly unknown[] | Record<string, unknown> {
-  const { as = 'Array' } = options
+  const { as = 'Array', checksumAddress = false } = options
 
   const bytes = typeof data === 'string' ? Bytes.fromHex(data) : data
   const cursor = Cursor.create(bytes)
@@ -95,6 +98,7 @@ export function decode(
     const param = parameters[i] as Parameter
     cursor.setPosition(consumed)
     const [data, consumed_] = internal.decodeParameter(cursor, param, {
+      checksumAddress,
       staticPosition: 0,
     })
     consumed += consumed_
@@ -112,6 +116,12 @@ export declare namespace decode {
      * @default "Array"
      */
     as?: as | 'Object' | 'Array' | undefined
+    /**
+     * Whether decoded addresses should be checksummed.
+     *
+     * @default false
+     */
+    checksumAddress?: boolean | undefined
   }
 
   type ReturnType<
@@ -175,7 +185,10 @@ export function encode<
   values: parameters extends AbiParameters
     ? internal.ToPrimitiveTypes<parameters>
     : never,
+  options?: encode.Options,
 ): Hex.Hex {
+  const { checksumAddress = false } = options ?? {}
+
   if (parameters.length !== values.length)
     throw new LengthMismatchError({
       expectedLength: parameters.length as number,
@@ -183,6 +196,7 @@ export function encode<
     })
   // Prepare the parameters to determine dynamic types to encode.
   const preparedParameters = internal.prepareParameters({
+    checksumAddress,
     parameters: parameters as readonly Parameter[],
     values: values as any,
   })
@@ -197,6 +211,15 @@ export declare namespace encode {
     | internal.encode.ErrorType
     | internal.prepareParameters.ErrorType
     | Errors.GlobalErrorType
+
+  type Options = {
+    /**
+     * Whether addresses should be checked against their checksum.
+     *
+     * @default false
+     */
+    checksumAddress?: boolean | undefined
+  }
 }
 
 /**

package/core/internal/abiParameters.ts

@@ -63,17 +63,25 @@ export type Tuple = ParameterToPrimitiveType<TupleAbiParameter>
 export function decodeParameter(
   cursor: Cursor.Cursor,
   param: AbiParameters.Parameter,
-  { staticPosition }: { staticPosition: number },
+  options: { checksumAddress?: boolean | undefined; staticPosition: number },
 ) {
+  const { checksumAddress, staticPosition } = options
   const arrayComponents = getArrayComponents(param.type)
   if (arrayComponents) {
     const [length, type] = arrayComponents
-    return decodeArray(cursor, { ...param, type }, { length, staticPosition })
+    return decodeArray(
+      cursor,
+      { ...param, type },
+      { checksumAddress, length, staticPosition },
+    )
   }
   if (param.type === 'tuple')
-    return decodeTuple(cursor, param as TupleAbiParameter, { staticPosition })
-
-  if (param.type === 'address') return decodeAddress(cursor)
+    return decodeTuple(cursor, param as TupleAbiParameter, {
+      checksumAddress,
+      staticPosition,
+    })
+  if (param.type === 'address')
+    return decodeAddress(cursor, { checksum: checksumAddress })
   if (param.type === 'bool') return decodeBool(cursor)
   if (param.type.startsWith('bytes'))
     return decodeBytes(cursor, param, { staticPosition })
@@ -100,9 +108,15 @@ const sizeOfLength = 32
 const sizeOfOffset = 32
 
 /** @internal */
-export function decodeAddress(cursor: Cursor.Cursor) {
+export function decodeAddress(
+  cursor: Cursor.Cursor,
+  options: { checksum?: boolean | undefined } = {},
+) {
+  const { checksum = false } = options
   const value = cursor.readBytes(32)
-  return [Hex.fromBytes(Bytes.slice(value, -20)), 32]
+  const wrap = (address: Hex.Hex) =>
+    checksum ? Address.checksum(address) : address
+  return [wrap(Hex.fromBytes(Bytes.slice(value, -20))), 32]
 }
 
 export declare namespace decodeAddress {
@@ -116,8 +130,14 @@ export declare namespace decodeAddress {
 export function decodeArray(
   cursor: Cursor.Cursor,
   param: AbiParameters.Parameter,
-  { length, staticPosition }: { length: number | null; staticPosition: number },
+  options: {
+    checksumAddress?: boolean | undefined
+    length: number | null
+    staticPosition: number
+  },
 ) {
+  const { checksumAddress, length, staticPosition } = options
+
   // If the length of the array is not known in advance (dynamic array),
   // this means we will need to wonder off to the pointer and decode.
   if (!length) {
@@ -142,6 +162,7 @@ export function decodeArray(
       // Otherwise, elements will be the size of their encoding (consumed bytes).
       cursor.setPosition(startOfData + (dynamicChild ? i * 32 : consumed))
       const [data, consumed_] = decodeParameter(cursor, param, {
+        checksumAddress,
         staticPosition: startOfData,
       })
       consumed += consumed_
@@ -168,6 +189,7 @@ export function decodeArray(
       // Move cursor along to the next slot (next offset pointer).
       cursor.setPosition(start + i * 32)
       const [data] = decodeParameter(cursor, param, {
+        checksumAddress,
         staticPosition: start,
       })
       value.push(data)
@@ -184,6 +206,7 @@ export function decodeArray(
   const value: unknown[] = []
   for (let i = 0; i < length; ++i) {
     const [data, consumed_] = decodeParameter(cursor, param, {
+      checksumAddress,
       staticPosition: staticPosition + consumed,
     })
     consumed += consumed_
@@ -278,8 +301,10 @@ export type TupleAbiParameter = AbiParameters.Parameter & {
 export function decodeTuple(
   cursor: Cursor.Cursor,
   param: TupleAbiParameter,
-  { staticPosition }: { staticPosition: number },
+  options: { checksumAddress?: boolean | undefined; staticPosition: number },
 ) {
+  const { checksumAddress, staticPosition } = options
+
   // Tuples can have unnamed components (i.e. they are arrays), so we must
   // determine whether the tuple is named or unnamed. In the case of a named
   // tuple, the value will be an object where each property is the name of the
@@ -305,6 +330,7 @@ export function decodeTuple(
       const component = param.components[i]!
       cursor.setPosition(start + consumed)
       const [data, consumed_] = decodeParameter(cursor, component, {
+        checksumAddress,
         staticPosition: start,
       })
       consumed += consumed_
@@ -321,6 +347,7 @@ export function decodeTuple(
   for (let i = 0; i < param.components.length; ++i) {
     const component = param.components[i]!
     const [data, consumed_] = decodeParameter(cursor, component, {
+      checksumAddress,
       staticPosition,
     })
     value[hasUnnamedChild ? i : component?.name!] = data
@@ -374,9 +401,11 @@ export declare namespace decodeString {
 export function prepareParameters<
   const parameters extends AbiParameters.AbiParameters,
 >({
+  checksumAddress,
   parameters,
   values,
 }: {
+  checksumAddress?: boolean | undefined
   parameters: parameters
   values: parameters extends AbiParameters.AbiParameters
     ? ToPrimitiveTypes<parameters>
@@ -385,7 +414,11 @@ export function prepareParameters<
   const preparedParameters: PreparedParameter[] = []
   for (let i = 0; i < parameters.length; i++) {
     preparedParameters.push(
-      prepareParameter({ parameter: parameters[i]!, value: values[i] }),
+      prepareParameter({
+        checksumAddress,
+        parameter: parameters[i]!,
+        value: values[i],
+      }),
     )
   }
   return preparedParameters
@@ -400,6 +433,7 @@ export declare namespace prepareParameters {
 export function prepareParameter<
   const parameter extends AbiParameters.Parameter,
 >({
+  checksumAddress = false,
   parameter: parameter_,
   value,
 }: {
@@ -407,6 +441,7 @@ export function prepareParameter<
   value: parameter extends AbiParameters.Parameter
     ? ParameterToPrimitiveType<parameter>
     : never
+  checksumAddress?: boolean | undefined
 }): PreparedParameter {
   const parameter = parameter_ as AbiParameters.Parameter
 
@@ -414,6 +449,7 @@ export function prepareParameter<
   if (arrayComponents) {
     const [length, type] = arrayComponents
     return encodeArray(value, {
+      checksumAddress,
       length,
       parameter: {
         ...parameter,
@@ -423,11 +459,14 @@ export function prepareParameter<
   }
   if (parameter.type === 'tuple') {
     return encodeTuple(value as unknown as Tuple, {
+      checksumAddress,
       parameter: parameter as TupleAbiParameter,
     })
   }
   if (parameter.type === 'address') {
-    return encodeAddress(value as unknown as Hex.Hex)
+    return encodeAddress(value as unknown as Hex.Hex, {
+      checksum: checksumAddress,
+    })
   }
   if (parameter.type === 'bool') {
     return encodeBoolean(value as unknown as boolean)
@@ -503,8 +542,12 @@ export declare namespace encode {
 }
 
 /** @internal */
-export function encodeAddress(value: Hex.Hex): PreparedParameter {
-  Address.assert(value, { strict: false })
+export function encodeAddress(
+  value: Hex.Hex,
+  options: { checksum: boolean },
+): PreparedParameter {
+  const { checksum = false } = options
+  Address.assert(value, { strict: checksum })
   return {
     dynamic: false,
     encoded: Hex.padLeft(value.toLowerCase() as Hex.Hex),
@@ -522,14 +565,14 @@ export declare namespace encodeAddress {
 /** @internal */
 export function encodeArray<const parameter extends AbiParameters.Parameter>(
   value: ParameterToPrimitiveType<parameter>,
-  {
-    length,
-    parameter,
-  }: {
+  options: {
+    checksumAddress?: boolean | undefined
     length: number | null
     parameter: parameter
   },
 ): PreparedParameter {
+  const { checksumAddress, length, parameter } = options
+
   const dynamic = length === null
 
   if (!Array.isArray(value)) throw new AbiParameters.InvalidArrayError(value)
@@ -543,7 +586,11 @@ export function encodeArray<const parameter extends AbiParameters.Parameter>(
   let dynamicChild = false
   const preparedParameters: PreparedParameter[] = []
   for (let i = 0; i < value.length; i++) {
-    const preparedParam = prepareParameter({ parameter, value: value[i] })
+    const preparedParam = prepareParameter({
+      checksumAddress,
+      parameter,
+      value: value[i],
+    })
     if (preparedParam.dynamic) dynamicChild = true
     preparedParameters.push(preparedParam)
   }
@@ -697,14 +744,20 @@ export function encodeTuple<
   },
 >(
   value: ParameterToPrimitiveType<parameter>,
-  { parameter }: { parameter: parameter },
+  options: {
+    checksumAddress?: boolean | undefined
+    parameter: parameter
+  },
 ): PreparedParameter {
+  const { checksumAddress, parameter } = options
+
   let dynamic = false
   const preparedParameters: PreparedParameter[] = []
   for (let i = 0; i < parameter.components.length; i++) {
     const param_ = parameter.components[i]!
     const index = Array.isArray(value) ? i : param_.name
     const preparedParam = prepareParameter({
+      checksumAddress,
       parameter: param_,
       value: (value as any)[index!] as readonly unknown[],
     })

package/erc6492/WrappedSignature/package.json

@@ -1,6 +1,6 @@
 {
   "type": "module",
-  "types": "../_types/erc6492/WrappedSignature.d.ts",
-  "main": "../_cjs/erc6492/WrappedSignature.js",
-  "module": "../_esm/erc6492/WrappedSignature.js"
+  "types": "../../_types/erc6492/WrappedSignature.d.ts",
+  "main": "../../_cjs/erc6492/WrappedSignature.js",
+  "module": "../../_esm/erc6492/WrappedSignature.js"
 }

package/erc6492/WrappedSignature.ts

@@ -1,3 +1,4 @@
+import type * as Abi from '../core/Abi.js'
 import * as AbiParameters from '../core/AbiParameters.js'
 import type * as Address from '../core/Address.js'
 import * as Errors from '../core/Errors.js'
@@ -20,6 +21,62 @@ export type WrappedSignature = {
 export const magicBytes =
   '0x6492649264926492649264926492649264926492649264926492649264926492' as const
 
+/**
+ * Deployless ERC-6492 signature verification bytecode.
+ */
+export const universalSignatureValidatorBytecode =
+  '0x608060405234801561001057600080fd5b5060405161069438038061069483398101604081905261002f9161051e565b600061003c848484610048565b9050806000526001601ff35b60007f64926492649264926492649264926492649264926492649264926492649264926100748361040c565b036101e7576000606080848060200190518101906100929190610577565b60405192955090935091506000906001600160a01b038516906100b69085906105dd565b6000604051808303816000865af19150503d80600081146100f3576040519150601f19603f3d011682016040523d82523d6000602084013e6100f8565b606091505b50509050876001600160a01b03163b60000361016057806101605760405162461bcd60e51b815260206004820152601e60248201527f5369676e617475726556616c696461746f723a206465706c6f796d656e74000060448201526064015b60405180910390fd5b604051630b135d3f60e11b808252906001600160a01b038a1690631626ba7e90610190908b9087906004016105f9565b602060405180830381865afa1580156101ad573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906101d19190610633565b6001600160e01b03191614945050505050610405565b6001600160a01b0384163b1561027a57604051630b135d3f60e11b808252906001600160a01b03861690631626ba7e9061022790879087906004016105f9565b602060405180830381865afa158015610244573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906102689190610633565b6001600160e01b031916149050610405565b81516041146102df5760405162461bcd60e51b815260206004820152603a602482015260008051602061067483398151915260448201527f3a20696e76616c6964207369676e6174757265206c656e6774680000000000006064820152608401610157565b6102e7610425565b5060208201516040808401518451859392600091859190811061030c5761030c61065d565b016020015160f81c9050601b811480159061032b57508060ff16601c14155b1561038c5760405162461bcd60e51b815260206004820152603b602482015260008051602061067483398151915260448201527f3a20696e76616c6964207369676e617475726520762076616c756500000000006064820152608401610157565b60408051600081526020810180835289905260ff83169181019190915260608101849052608081018390526001600160a01b0389169060019060a0016020604051602081039080840390855afa1580156103ea573d6000803e3d6000fd5b505050602060405103516001600160a01b0316149450505050505b9392505050565b600060208251101561041d57600080fd5b508051015190565b60405180606001604052806003906020820280368337509192915050565b6001600160a01b038116811461045857600080fd5b50565b634e487b7160e01b600052604160045260246000fd5b60005b8381101561048c578181015183820152602001610474565b50506000910152565b600082601f8301126104a657600080fd5b81516001600160401b038111156104bf576104bf61045b565b604051601f8201601f19908116603f011681016001600160401b03811182821017156104ed576104ed61045b565b60405281815283820160200185101561050557600080fd5b610516826020830160208701610471565b949350505050565b60008060006060848603121561053357600080fd5b835161053e81610443565b6020850151604086015191945092506001600160401b0381111561056157600080fd5b61056d86828701610495565b9150509250925092565b60008060006060848603121561058c57600080fd5b835161059781610443565b60208501519093506001600160401b038111156105b357600080fd5b6105bf86828701610495565b604086015190935090506001600160401b0381111561056157600080fd5b600082516105ef818460208701610471565b9190910192915050565b828152604060208201526000825180604084015261061e816060850160208701610471565b601f01601f1916919091016060019392505050565b60006020828403121561064557600080fd5b81516001600160e01b03198116811461040557600080fd5b634e487b7160e01b600052603260045260246000fdfe5369676e617475726556616c696461746f72237265636f7665725369676e6572'
+
+/**
+ * ABI for the ERC-6492 universal deployless signature validator contract.
+ *
+ * Constructor return value is `0x1` (valid) or `0x0` (invalid).
+ */
+export const universalSignatureValidatorAbi = [
+  {
+    inputs: [
+      {
+        name: '_signer',
+        type: 'address',
+      },
+      {
+        name: '_hash',
+        type: 'bytes32',
+      },
+      {
+        name: '_signature',
+        type: 'bytes',
+      },
+    ],
+    stateMutability: 'nonpayable',
+    type: 'constructor',
+  },
+  {
+    inputs: [
+      {
+        name: '_signer',
+        type: 'address',
+      },
+      {
+        name: '_hash',
+        type: 'bytes32',
+      },
+      {
+        name: '_signature',
+        type: 'bytes',
+      },
+    ],
+    outputs: [
+      {
+        type: 'bool',
+      },
+    ],
+    stateMutability: 'nonpayable',
+    type: 'function',
+    name: 'isValidSig',
+  },
+] as const satisfies Abi.Abi
+
 /**
  * Asserts that the wrapped signature is valid.
  *

package/index.docs/package.json

@@ -1,6 +1,6 @@
 {
   "type": "module",
-  "types": "../_types/index.docs.d.ts",
-  "main": "../_cjs/index.docs.js",
-  "module": "../_esm/index.docs.js"
+  "types": "../_types/undefined/index.docs.d.ts",
+  "main": "../_cjs/undefined/index.docs.js",
+  "module": "../_esm/undefined/index.docs.js"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "ox",
   "description": "Ethereum Standard Library",
-  "version": "0.4.1",
+  "version": "0.4.3",
   "main": "./_cjs/index.js",
   "module": "./_esm/index.js",
   "types": "./_types/index.d.ts",
@@ -388,11 +388,6 @@
       "import": "./_esm/trusted-setups/index.js",
       "default": "./_cjs/trusted-setups/index.js"
     },
-    "./version": {
-      "types": "./_types/version.d.ts",
-      "import": "./_esm/version.js",
-      "default": "./_cjs/version.js"
-    },
     "./window": {
       "types": "./_types/window/index.d.ts",
       "import": "./_esm/window/index.js",

package/trusted-setups/Paths/package.json

@@ -1,6 +1,6 @@
 {
   "type": "module",
-  "types": "../_types/trusted-setups/Paths.d.ts",
-  "main": "../_cjs/trusted-setups/Paths.js",
-  "module": "../_esm/trusted-setups/Paths.js"
+  "types": "../../_types/trusted-setups/Paths.d.ts",
+  "main": "../../_cjs/trusted-setups/Paths.js",
+  "module": "../../_esm/trusted-setups/Paths.js"
 }

package/version.ts

@@ -1,2 +1,2 @@
 /** @internal */
-export const version = '0.4.1'
+export const version = '0.4.3'

package/version/package.json

@@ -1,6 +0,0 @@
-{
-  "type": "module",
-  "types": "../_types/version.d.ts",
-  "main": "../_cjs/version.js",
-  "module": "../_esm/version.js"
-}