@aa-sdk/core 4.0.0-alpha.9 → 4.0.0-beta.1

package/dist/esm/transport/split.js

@@ -1,4 +1,36 @@
 import { custom } from "viem";
+/**
+ * The Split Transport allows you to split RPC traffic for specific methods across
+ * different RPC providers. This is done by specifying the methods you want handled
+ * specially as overrides and providing a fallback transport for all other methods.
+ *
+ * @example
+ * ```ts
+ * import { createPublicClient, http } from "viem";
+ * import { split } from "@aa-sdk/core";
+ *
+ * const bundlerMethods = [
+ *  "eth_sendUserOperation",
+ *  "eth_estimateUserOperationGas",
+ *  "eth_getUserOperationReceipt",
+ *  "eth_getUserOperationByHash",
+ *  "eth_supportedEntryPoints"
+ * ];
+ *
+ * const clientWithSplit = createPublicClient({
+ *  transport: split({
+ *      overrides: [{
+ *          methods: bundlerMethods,
+ *          transport: http(BUNDLER_RPC_URL)
+ *      }],
+ *      fallback: http(OTHER_RPC_URL)
+ *  }),
+ * });
+ * ```
+ *
+ * @param {SplitTransportParams} params split transport configuration containing the methods overrides and fallback transport
+ * @returns {CustomTransport} a viem Transport that splits traffic
+ */
 export const split = (params) => {
     const overrideMap = params.overrides.reduce((accum, curr) => {
         curr.methods.forEach((method) => {

package/dist/esm/transport/split.js.map

@@ -1 +1 @@
-{"version":3,"file":"split.js","sourceRoot":"","sources":["../../../src/transport/split.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAwC,MAAM,MAAM,CAAC;AA0CpE,MAAM,CAAC,MAAM,KAAK,GAAG,CAAC,MAA4B,EAAmB,EAAE;IACrE,MAAM,WAAW,GAAG,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE;QAC1D,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;YAC9B,IAAI,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,IAAI,CAAC,SAAS,EAAE,CAAC;gBAC9D,MAAM,IAAI,KAAK,CACb,uDAAuD,CACxD,CAAC;YACJ,CAAC;YAED,KAAK,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;QACpC,CAAC,CAAC,CAAC;QAEH,OAAO,KAAK,CAAC;IACf,CAAC,EAAE,IAAI,GAAG,EAAqB,CAAC,CAAC;IAEjC,OAAO,CAAC,IAAI,EAAE,EAAE,CACd,MAAM,CAAC;QACL,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;YACtB,MAAM,iBAAiB,GAAG,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YACvD,IAAI,iBAAiB,IAAI,IAAI,EAAE,CAAC;gBAC9B,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YAC/C,CAAC;YAED,OAAO,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC7C,CAAC;KACF,CAAC,CAAC,IAAI,CAAC,CAAC;AACb,CAAC,CAAC","sourcesContent":["import { custom, type CustomTransport, type Transport } from \"viem\";\n\nexport interface SplitTransportParams {\n  overrides: {\n    methods: string[];\n    transport: Transport;\n  }[];\n  fallback: Transport;\n}\n\n/**\n * The Split Transport allows you to split RPC traffic for specific methods across\n * different RPC providers. This is done by specifying the methods you want handled\n * specially as overrides and providing a fallback transport for all other methods.\n *\n * @example\n * ```ts\n * import { createPublicClient, http } from \"viem\";\n * import { split } from \"@aa-sdk/core\";\n *\n * const bundlerMethods = [\n *  \"eth_sendUserOperation\",\n *  \"eth_estimateUserOperationGas\",\n *  \"eth_getUserOperationReceipt\",\n *  \"eth_getUserOperationByHash\",\n *  \"eth_supportedEntryPoints\"\n * ];\n *\n * const clientWithSplit = createPublicClient({\n *  transport: split({\n *      overrides: [{\n *          methods: bundlerMethods,\n *          transport: http(BUNDLER_RPC_URL)\n *      }]\n *      fallback: http(OTHER_RPC_URL)\n *  }),\n * });\n * ```\n *\n * @param {SplitTransportParams} params split transport configuration containing the methods overrides and fallback transport\n * @returns {CustomTransport} a viem Transport that splits traffic\n */\nexport const split = (params: SplitTransportParams): CustomTransport => {\n  const overrideMap = params.overrides.reduce((accum, curr) => {\n    curr.methods.forEach((method) => {\n      if (accum.has(method) && accum.get(method) !== curr.transport) {\n        throw new Error(\n          \"A method cannot be handled by more than one transport\"\n        );\n      }\n\n      accum.set(method, curr.transport);\n    });\n\n    return accum;\n  }, new Map<string, Transport>());\n\n  return (opts) =>\n    custom({\n      request: async (args) => {\n        const transportOverride = overrideMap.get(args.method);\n        if (transportOverride != null) {\n          return transportOverride(opts).request(args);\n        }\n\n        return params.fallback(opts).request(args);\n      },\n    })(opts);\n};\n"]}
+{"version":3,"file":"split.js","sourceRoot":"","sources":["../../../src/transport/split.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAwC,MAAM,MAAM,CAAC;AAUpE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,MAAM,CAAC,MAAM,KAAK,GAAG,CAAC,MAA4B,EAAmB,EAAE;IACrE,MAAM,WAAW,GAAG,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE;QAC1D,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;YAC9B,IAAI,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,IAAI,CAAC,SAAS,EAAE,CAAC;gBAC9D,MAAM,IAAI,KAAK,CACb,uDAAuD,CACxD,CAAC;YACJ,CAAC;YAED,KAAK,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;QACpC,CAAC,CAAC,CAAC;QAEH,OAAO,KAAK,CAAC;IACf,CAAC,EAAE,IAAI,GAAG,EAAqB,CAAC,CAAC;IAEjC,OAAO,CAAC,IAAI,EAAE,EAAE,CACd,MAAM,CAAC;QACL,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;YACtB,MAAM,iBAAiB,GAAG,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YACvD,IAAI,iBAAiB,IAAI,IAAI,EAAE,CAAC;gBAC9B,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YAC/C,CAAC;YAED,OAAO,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC7C,CAAC;KACF,CAAC,CAAC,IAAI,CAAC,CAAC;AACb,CAAC,CAAC","sourcesContent":["import { custom, type CustomTransport, type Transport } from \"viem\";\n\nexport interface SplitTransportParams {\n  overrides: {\n    methods: string[];\n    transport: Transport;\n  }[];\n  fallback: Transport;\n}\n\n/**\n * The Split Transport allows you to split RPC traffic for specific methods across\n * different RPC providers. This is done by specifying the methods you want handled\n * specially as overrides and providing a fallback transport for all other methods.\n *\n * @example\n * ```ts\n * import { createPublicClient, http } from \"viem\";\n * import { split } from \"@aa-sdk/core\";\n *\n * const bundlerMethods = [\n *  \"eth_sendUserOperation\",\n *  \"eth_estimateUserOperationGas\",\n *  \"eth_getUserOperationReceipt\",\n *  \"eth_getUserOperationByHash\",\n *  \"eth_supportedEntryPoints\"\n * ];\n *\n * const clientWithSplit = createPublicClient({\n *  transport: split({\n *      overrides: [{\n *          methods: bundlerMethods,\n *          transport: http(BUNDLER_RPC_URL)\n *      }],\n *      fallback: http(OTHER_RPC_URL)\n *  }),\n * });\n * ```\n *\n * @param {SplitTransportParams} params split transport configuration containing the methods overrides and fallback transport\n * @returns {CustomTransport} a viem Transport that splits traffic\n */\nexport const split = (params: SplitTransportParams): CustomTransport => {\n  const overrideMap = params.overrides.reduce((accum, curr) => {\n    curr.methods.forEach((method) => {\n      if (accum.has(method) && accum.get(method) !== curr.transport) {\n        throw new Error(\n          \"A method cannot be handled by more than one transport\"\n        );\n      }\n\n      accum.set(method, curr.transport);\n    });\n\n    return accum;\n  }, new Map<string, Transport>());\n\n  return (opts) =>\n    custom({\n      request: async (args) => {\n        const transportOverride = overrideMap.get(args.method);\n        if (transportOverride != null) {\n          return transportOverride(opts).request(args);\n        }\n\n        return params.fallback(opts).request(args);\n      },\n    })(opts);\n};\n"]}

package/dist/esm/types.d.ts

@@ -37,7 +37,22 @@ export type UserOperationOverrides<TEntryPointVersion extends EntryPointVersion
     maxPriorityFeePerGas: UserOperationStruct<TEntryPointVersion>["maxPriorityFeePerGas"] | Multiplier;
     preVerificationGas: UserOperationStruct<TEntryPointVersion>["preVerificationGas"] | Multiplier;
     verificationGasLimit: UserOperationStruct<TEntryPointVersion>["verificationGasLimit"] | Multiplier;
+    /**
+     * This can be used to override the key used when calling `entryPoint.getNonce`
+     * It is useful when you want to use parallel nonces for user operations
+     *
+     * NOTE: not all bundlers fully support this feature and it could be that your bundler will still only include
+     * one user operation for your account in a bundle
+     */
     nonceKey: bigint;
+    /**
+     * The same state overrides for
+     * [`eth_call`](https://geth.ethereum.org/docs/interacting-with-geth/rpc/ns-eth#eth-call) method.
+     * An address-to-state mapping, where each entry specifies some state to be ephemerally overridden
+     * prior to executing the call. State overrides allow you to customize the network state for
+     * the purpose of the simulation, so this feature is useful when you need to estimate gas
+     * for user operation scenarios under conditions that aren’t currently present on the live network.
+     */
     stateOverride: StateOverride;
 } & UserOperationPaymasterOverrides<TEntryPointVersion>>;
 export interface UserOperationRequest_v6 {
@@ -97,6 +112,7 @@ export interface UserOperationReceipt {
     logs: string[];
     receipt: TransactionReceipt;
 }
+/** @deprecated use viem type TransactionReceipt instead */
 export interface UserOperationReceiptObject {
     blockHash: Hash;
     blockNumber: BigNumberish;
@@ -114,6 +130,7 @@ export interface UserOperationReceiptObject {
     effectiveGasPrice: BigNumberish;
     type: string;
 }
+/** @deprecated use viem type Log instead */
 export interface UserOperationReceiptLog {
     blockHash: Hash;
     blockNumber: BigNumberish;

package/dist/esm/types.js

@@ -1,2 +1,3 @@
 import {} from "viem";
+// [!endregion UserOperationStruct]
 //# sourceMappingURL=types.js.map

package/dist/esm/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAMN,MAAM,MAAM,CAAC","sourcesContent":["import {\n  type Address,\n  type Hash,\n  type Hex,\n  type StateOverride,\n  type TransactionReceipt,\n} from \"viem\";\nimport type { z } from \"zod\";\nimport type {\n  UserOperationFeeOptionsFieldSchema,\n  UserOperationFeeOptionsSchema,\n  UserOperationFeeOptionsSchema_v6,\n  UserOperationFeeOptionsSchema_v7,\n} from \"./client/schema\";\nimport type { EntryPointVersion } from \"./entrypoint/types\";\nimport type {\n  BigNumberishRangeSchema,\n  BigNumberishSchema,\n  MultiplierSchema,\n  NoUndefined,\n} from \"./utils\";\n\nexport type EmptyHex = `0x`;\nexport type NullAddress = `0x0`;\n\n// based on @account-abstraction/common\nexport type PromiseOrValue<T> = T | Promise<T>;\nexport type BytesLike = Uint8Array | Hex;\nexport type Multiplier = z.input<typeof MultiplierSchema>;\n\nexport type BigNumberish = z.input<typeof BigNumberishSchema>;\nexport type BigNumberishRange = z.input<typeof BigNumberishRangeSchema>;\n\n// [!region UserOperationCallData]\nexport type UserOperationCallData =\n  | {\n      /* the target of the call */\n      target: Address;\n      /* the data passed to the target */\n      data: Hex;\n      /* the amount of native token to send to the target (default: 0) */\n      value?: bigint;\n    }\n  | Hex;\n// [!endregion UserOperationCallData]\n\n// [!region BatchUserOperationCallData]\nexport type BatchUserOperationCallData = Exclude<UserOperationCallData, Hex>[];\n// [!endregion BatchUserOperationCallData]\n\nexport type UserOperationFeeOptionsField = z.input<\n  typeof UserOperationFeeOptionsFieldSchema\n>;\n\nexport type UserOperationFeeOptions<\n  TEntryPointVersion extends EntryPointVersion = EntryPointVersion\n> = TEntryPointVersion extends \"0.6.0\"\n  ? z.input<typeof UserOperationFeeOptionsSchema_v6>\n  : TEntryPointVersion extends \"0.7.0\"\n  ? z.input<typeof UserOperationFeeOptionsSchema_v7>\n  : z.input<typeof UserOperationFeeOptionsSchema>;\n\nexport type UserOperationOverridesParameter<\n  TEntryPointVersion extends EntryPointVersion = EntryPointVersion,\n  Required extends boolean = false\n> = Required extends true\n  ? { overrides: UserOperationOverrides<TEntryPointVersion> }\n  : { overrides?: UserOperationOverrides<TEntryPointVersion> };\n\n// [!region UserOperationPaymasterOverrides]\nexport type UserOperationPaymasterOverrides<\n  TEntryPointVersion extends EntryPointVersion = EntryPointVersion\n> = TEntryPointVersion extends \"0.6.0\"\n  ? {\n      // paymasterData overrides to bypass paymaster middleware\n      paymasterAndData: Hex;\n    }\n  : TEntryPointVersion extends \"0.7.0\"\n  ? {\n      // paymasterData overrides to bypass paymaster middleware\n      // if set to '0x', all paymaster related fields are omitted from the user op request\n      paymasterData: Hex;\n      paymaster: Address;\n      paymasterVerificationGasLimit:\n        | NoUndefined<\n            UserOperationStruct<\"0.7.0\">[\"paymasterVerificationGasLimit\"]\n          >\n        | Multiplier;\n      paymasterPostOpGasLimit:\n        | NoUndefined<UserOperationStruct<\"0.7.0\">[\"paymasterPostOpGasLimit\"]>\n        | Multiplier;\n    }\n  : {};\n// [!endregion UserOperationOverridesParameter]\n\n// [!region UserOperationOverrides]\nexport type UserOperationOverrides<\n  TEntryPointVersion extends EntryPointVersion = EntryPointVersion\n> = Partial<\n  {\n    callGasLimit:\n      | UserOperationStruct<TEntryPointVersion>[\"callGasLimit\"]\n      | Multiplier;\n    maxFeePerGas:\n      | UserOperationStruct<TEntryPointVersion>[\"maxFeePerGas\"]\n      | Multiplier;\n    maxPriorityFeePerGas:\n      | UserOperationStruct<TEntryPointVersion>[\"maxPriorityFeePerGas\"]\n      | Multiplier;\n    preVerificationGas:\n      | UserOperationStruct<TEntryPointVersion>[\"preVerificationGas\"]\n      | Multiplier;\n    verificationGasLimit:\n      | UserOperationStruct<TEntryPointVersion>[\"verificationGasLimit\"]\n      | Multiplier;\n    /**\n     * This can be used to override the key used when calling `entryPoint.getNonce`\n     * It is useful when you want to use parallel nonces for user operations\n     *\n     * NOTE: not all bundlers fully support this feature and it could be that your bundler will still only include\n     * one user operation for your account in a bundle\n     */\n    nonceKey: bigint;\n\n    /**\n     * The same state overrides for\n     * [`eth_call`](https://geth.ethereum.org/docs/interacting-with-geth/rpc/ns-eth#eth-call) method.\n     * An address-to-state mapping, where each entry specifies some state to be ephemerally overridden\n     * prior to executing the call. State overrides allow you to customize the network state for\n     * the purpose of the simulation, so this feature is useful when you need to estimate gas\n     * for user operation scenarios under conditions that aren’t currently present on the live network.\n     */\n    stateOverride: StateOverride;\n  } & UserOperationPaymasterOverrides<TEntryPointVersion>\n>;\n// [!endregion UserOperationOverrides]\n\n// [!region UserOperationRequest_v6]\n// represents the request as it needs to be formatted for v0.6 RPC requests\n// Reference: https://github.com/ethereum/ERCs/blob/8dd085d159cb123f545c272c0d871a5339550e79/ERCS/erc-4337.md#definitions\nexport interface UserOperationRequest_v6 {\n  /* the origin of the request */\n  sender: Address;\n  /* nonce (as hex) of the transaction, returned from the entry point for this Address */\n  nonce: Hex;\n  /* the initCode for creating the sender if it does not exist yet, otherwise \"0x\" */\n  initCode: Hex | EmptyHex;\n  /* the callData passed to the target */\n  callData: Hex;\n  /* Gas value (as hex) used by inner account execution */\n  callGasLimit: Hex;\n  /* Actual gas (as hex) used by the validation of this UserOperation */\n  verificationGasLimit: Hex;\n  /* Gas overhead (as hex) of this UserOperation */\n  preVerificationGas: Hex;\n  /* Maximum fee per gas (similar to EIP-1559 max_fee_per_gas) (as hex)*/\n  maxFeePerGas: Hex;\n  /* Maximum priority fee per gas (similar to EIP-1559 max_priority_fee_per_gas) (as hex)*/\n  maxPriorityFeePerGas: Hex;\n  /* Address of paymaster sponsoring the transaction, followed by extra data to send to the paymaster (\"0x\" for self-sponsored transaction) */\n  paymasterAndData: Hex | EmptyHex;\n  /* Data passed into the account along with the nonce during the verification step */\n  signature: Hex;\n}\n// [!endregion UserOperationRequest_v6]\n\n// [!region UserOperationRequest_v7]\n// represents the request as it needs to be formatted for v0.7 RPC requests\n// Reference: https://eips.ethereum.org/EIPS/eip-4337#definitions\nexport interface UserOperationRequest_v7 {\n  /* the account making the operation */\n  sender: Address;\n  /* anti-replay parameter. nonce of the transaction, returned from the entry point for this address */\n  nonce: Hex;\n  /* account factory, only for new accounts */\n  factory?: Address;\n  /* data for account factory (only if account factory exists) */\n  factoryData?: Hex;\n  /* the data to pass to the sender during the main execution call */\n  callData: Hex;\n  /* the amount of gas to allocate the main execution call */\n  callGasLimit: Hex;\n  /* the amount of gas to allocate for the verification step */\n  verificationGasLimit: Hex;\n  /* extra gas to pay the bunder */\n  preVerificationGas: Hex;\n  /* maximum fee per gas (similar to EIP-1559 max_fee_per_gas) */\n  maxFeePerGas: Hex;\n  /* maximum priority fee per gas (similar to EIP-1559 max_priority_fee_per_gas) */\n  maxPriorityFeePerGas: Hex;\n  /* address of paymaster contract, (or empty, if account pays for itself) */\n  paymaster?: Address;\n  /* the amount of gas to allocate for the paymaster validation code */\n  paymasterVerificationGasLimit?: Hex;\n  /* the amount of gas to allocate for the paymaster post-operation code */\n  paymasterPostOpGasLimit?: Hex;\n  /* data for paymaster (only if paymaster exists) */\n  paymasterData?: Hex;\n  /* data passed into the account to verify authorization */\n  signature: Hex;\n}\n// [!endregion UserOperationRequest_v7]\n\n// [!region UserOperationRequest]\n// Reference: https://eips.ethereum.org/EIPS/eip-4337#definitions\nexport type UserOperationRequest<\n  TEntryPointVersion extends EntryPointVersion = EntryPointVersion\n> = TEntryPointVersion extends \"0.6.0\"\n  ? UserOperationRequest_v6\n  : TEntryPointVersion extends \"0.7.0\"\n  ? UserOperationRequest_v7\n  : never;\n\n// [!endregion UserOperationRequest]\n\n// [!region UserOperationEstimateGasResponse]\nexport interface UserOperationEstimateGasResponse<\n  TEntryPointVersion extends EntryPointVersion = EntryPointVersion\n> {\n  /* Gas overhead of this UserOperation */\n  preVerificationGas: BigNumberish;\n  /* Actual gas used by the validation of this UserOperation */\n  verificationGasLimit: BigNumberish;\n  /* Value used by inner account execution */\n  callGasLimit: BigNumberish;\n  /*\n   * EntryPoint v0.7.0 operations only.\n   * The amount of gas to allocate for the paymaster validation code.\n   * Note: `eth_estimateUserOperationGas` does not return paymasterPostOpGasLimit.\n   */\n  paymasterVerificationGasLimit: TEntryPointVersion extends \"0.7.0\"\n    ? BigNumberish | undefined\n    : never;\n}\n// [!endregion UserOperationEstimateGasResponse]\n\n// [!region UserOperationResponse]\nexport interface UserOperationResponse<\n  TEntryPointVersion extends EntryPointVersion = EntryPointVersion\n> {\n  /* the User Operation */\n  userOperation: UserOperationRequest<TEntryPointVersion>;\n  /* the address of the entry point contract that executed the user operation */\n  entryPoint: Address;\n  /* the block number the user operation was included in */\n  blockNumber: BigNumberish;\n  /* the hash of the block the user operation was included in */\n  blockHash: Hash;\n  /* the hash of the transaction that included the user operation */\n  transactionHash: Hash;\n}\n// [!endregion UserOperationResponse]\n\n// [!region UserOperationReceipt]\nexport interface UserOperationReceipt {\n  /* The request hash of the UserOperation. */\n  userOpHash: Hash;\n  /* The entry point address used for the UserOperation. */\n  entryPoint: Address;\n  /* The account initiating the UserOperation. */\n  sender: Address;\n  /* The nonce used in the UserOperation. */\n  nonce: BigNumberish;\n  /* The paymaster used for this UserOperation (or empty). */\n  paymaster?: Address;\n  /* The actual amount paid (by account or paymaster) for this UserOperation. */\n  actualGasCost: BigNumberish;\n  /* The total gas used by this UserOperation (including preVerification, creation, validation, and execution). */\n  actualGasUsed: BigNumberish;\n  /* Indicates whether the execution completed without reverting. */\n  success: boolean;\n  /* In case of revert, this is the revert reason. */\n  reason?: string;\n  /* The logs generated by this UserOperation (not including logs of other UserOperations in the same bundle). */\n  logs: string[];\n  /* The TransactionReceipt object for the entire bundle, not only for this UserOperation. */\n  receipt: TransactionReceipt;\n}\n// [!endregion UserOperationReceipt]\n\n/** @deprecated use viem type TransactionReceipt instead */\nexport interface UserOperationReceiptObject {\n  /* 32 Bytes - hash of the block where this log was in. null when its pending. null when its pending log */\n  blockHash: Hash;\n  /* The block number where this log was in. null when its pending. null when its pending log. */\n  blockNumber: BigNumberish;\n  /* The index of the transaction within the block. */\n  transactionIndex: BigNumberish;\n  /* 32 Bytes - hash of the transaction. null when its pending. */\n  transactionHash: Hash;\n  /* 20 Bytes - address of the sender */\n  from: Address;\n  /* 20 Bytes - address of the receiver. null when its a contract creation transaction */\n  to: Address;\n  /* The total amount of gas used when this transaction was executed in the block. */\n  cumulativeGasUsed: BigNumberish;\n  /* The amount of gas used by this specific transaction alone */\n  gasUsed: BigNumberish;\n  /* 20 Bytes - The contract address created, if the transaction was a contract creation, otherwise null */\n  contractAddress: Address;\n  logs: UserOperationReceiptLog[];\n  /* 256 Bytes - Bloom filter for light clients to quickly retrieve related logs */\n  logsBloom: Hex;\n  /* 32 bytes of post-transaction stateroot. (pre Byzantium hard fork at block 4,370,000) */\n  root: Hex;\n  /* Either 1 (success) or 0 (failure). (post Byzantium hard fork at block 4,370,000) */\n  status: number;\n  /* The cumulative gas used in the block containing this UserOperation. */\n  effectiveGasPrice: BigNumberish;\n  /* The type of the recipt object */\n  type: string;\n}\n\n/** @deprecated use viem type Log instead */\n/* https://github.com/wevm/viem/blob/6ef4ac131a878bf1dc4b335f5dc127e62618dda0/src/types/log.ts#L15 */\nexport interface UserOperationReceiptLog {\n  /* The hash of the block where the given transaction was included. */\n  blockHash: Hash;\n  /* The number of the block where the given transaction was included. */\n  blockNumber: BigNumberish;\n  /* The index of the transaction within the block. */\n  transactionIndex: BigNumberish;\n  /* 20 Bytes - address from which this log originated. */\n  address: Address;\n  /* Integer of the log index position in the block. null when its pending log. */\n  logIndex: BigNumberish;\n  /* Contains one or more 32 Bytes non-indexed arguments of the log. */\n  data: Hex;\n  /* true when the log was removed, due to a chain reorganization. false if its a valid log. */\n  removed: boolean;\n  /* Array of zero to four 32 Bytes DATA of indexed log arguments. */\n  topics: string[];\n  /* hash of the transaction */\n  transactionHash: Hash;\n}\n\n// [!region UserOperationStruct_v6]\n// https://github.com/eth-infinitism/account-abstraction/blob/releases/v0.6/test/UserOperation.ts\n// this is used for building requests for v0.6 entry point contract\nexport interface UserOperationStruct_v6 {\n  /* the origin of the request */\n  sender: string;\n  /* nonce of the transaction, returned from the entry point for this address */\n  nonce: BigNumberish;\n  /* the initCode for creating the sender if it does not exist yet, otherwise \"0x\" */\n  initCode: BytesLike | \"0x\";\n  /* the callData passed to the target */\n  callData: BytesLike;\n  /* Value used by inner account execution */\n  callGasLimit?: BigNumberish;\n  /* Actual gas used by the validation of this UserOperation */\n  verificationGasLimit?: BigNumberish;\n  /* Gas overhead of this UserOperation */\n  preVerificationGas?: BigNumberish;\n  /* Maximum fee per gas (similar to EIP-1559 max_fee_per_gas) */\n  maxFeePerGas?: BigNumberish;\n  /* Maximum priority fee per gas (similar to EIP-1559 max_priority_fee_per_gas) */\n  maxPriorityFeePerGas?: BigNumberish;\n  /* Address of paymaster sponsoring the transaction, followed by extra data to send to the paymaster (\"0x\" for self-sponsored transaction) */\n  paymasterAndData: BytesLike | \"0x\";\n  /* Data passed into the account along with the nonce during the verification step */\n  signature: BytesLike;\n}\n// [!endregion UserOperationStruct_v6]\n\n// [!region UserOperationStruct_v7]\n// based on https://github.com/eth-infinitism/account-abstraction/blob/releases/v0.7/test/UserOperation.ts\n// this is used for building requests for v0.7 entry point contract\nexport interface UserOperationStruct_v7 {\n  /* the account making the operation */\n  sender: string;\n  /* anti-replay parameter. nonce of the transaction, returned from the entry point for this address */\n  nonce: BigNumberish;\n  /* account factory, only for new accounts */\n  factory?: string;\n  /* data for account factory (only if account factory exists) */\n  factoryData?: BytesLike;\n  /* the data to pass to the sender during the main execution call */\n  callData: BytesLike;\n  /* the amount of gas to allocate the main execution call */\n  callGasLimit?: BigNumberish;\n  /* the amount of gas to allocate for the verification step */\n  verificationGasLimit?: BigNumberish;\n  /* extra gas to pay the bunder */\n  preVerificationGas?: BigNumberish;\n  /* maximum fee per gas (similar to EIP-1559 max_fee_per_gas) */\n  maxFeePerGas?: BigNumberish;\n  /* maximum priority fee per gas (similar to EIP-1559 max_priority_fee_per_gas) */\n  maxPriorityFeePerGas?: BigNumberish;\n  /* address of paymaster contract, (or empty, if account pays for itself) */\n  paymaster?: string;\n  /* the amount of gas to allocate for the paymaster validation code */\n  paymasterVerificationGasLimit?: BigNumberish;\n  /* the amount of gas to allocate for the paymaster post-operation code */\n  paymasterPostOpGasLimit?: BigNumberish;\n  /* data for paymaster (only if paymaster exists) */\n  paymasterData?: BytesLike;\n  /* data passed into the account to verify authorization */\n  signature: BytesLike;\n}\n// [!endregion UserOperationStruct_v7]\n\n// [!region UserOperationStruct]\nexport type UserOperationStruct<\n  TEntryPointVersion extends EntryPointVersion = EntryPointVersion\n> = TEntryPointVersion extends \"0.6.0\"\n  ? UserOperationStruct_v6\n  : TEntryPointVersion extends \"0.7.0\"\n  ? UserOperationStruct_v7\n  : never;\n// [!endregion UserOperationStruct]\n"]}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAMN,MAAM,MAAM,CAAC;AAoZd,mCAAmC","sourcesContent":["import {\n  type Address,\n  type Hash,\n  type Hex,\n  type StateOverride,\n  type TransactionReceipt,\n} from \"viem\";\nimport type { z } from \"zod\";\nimport type {\n  UserOperationFeeOptionsFieldSchema,\n  UserOperationFeeOptionsSchema,\n  UserOperationFeeOptionsSchema_v6,\n  UserOperationFeeOptionsSchema_v7,\n} from \"./client/schema\";\nimport type { EntryPointVersion } from \"./entrypoint/types\";\nimport type {\n  BigNumberishRangeSchema,\n  BigNumberishSchema,\n  MultiplierSchema,\n  NoUndefined,\n} from \"./utils\";\n\nexport type EmptyHex = `0x`;\nexport type NullAddress = `0x0`;\n\n// based on @account-abstraction/common\nexport type PromiseOrValue<T> = T | Promise<T>;\nexport type BytesLike = Uint8Array | Hex;\nexport type Multiplier = z.input<typeof MultiplierSchema>;\n\nexport type BigNumberish = z.input<typeof BigNumberishSchema>;\nexport type BigNumberishRange = z.input<typeof BigNumberishRangeSchema>;\n\n// [!region UserOperationCallData]\nexport type UserOperationCallData =\n  | {\n      /* the target of the call */\n      target: Address;\n      /* the data passed to the target */\n      data: Hex;\n      /* the amount of native token to send to the target (default: 0) */\n      value?: bigint;\n    }\n  | Hex;\n// [!endregion UserOperationCallData]\n\n// [!region BatchUserOperationCallData]\nexport type BatchUserOperationCallData = Exclude<UserOperationCallData, Hex>[];\n// [!endregion BatchUserOperationCallData]\n\nexport type UserOperationFeeOptionsField = z.input<\n  typeof UserOperationFeeOptionsFieldSchema\n>;\n\nexport type UserOperationFeeOptions<\n  TEntryPointVersion extends EntryPointVersion = EntryPointVersion\n> = TEntryPointVersion extends \"0.6.0\"\n  ? z.input<typeof UserOperationFeeOptionsSchema_v6>\n  : TEntryPointVersion extends \"0.7.0\"\n  ? z.input<typeof UserOperationFeeOptionsSchema_v7>\n  : z.input<typeof UserOperationFeeOptionsSchema>;\n\nexport type UserOperationOverridesParameter<\n  TEntryPointVersion extends EntryPointVersion = EntryPointVersion,\n  Required extends boolean = false\n> = Required extends true\n  ? { overrides: UserOperationOverrides<TEntryPointVersion> }\n  : { overrides?: UserOperationOverrides<TEntryPointVersion> };\n\n// [!region UserOperationPaymasterOverrides]\nexport type UserOperationPaymasterOverrides<\n  TEntryPointVersion extends EntryPointVersion = EntryPointVersion\n> = TEntryPointVersion extends \"0.6.0\"\n  ? {\n      // paymasterData overrides to bypass paymaster middleware\n      paymasterAndData: Hex;\n    }\n  : TEntryPointVersion extends \"0.7.0\"\n  ? {\n      // paymasterData overrides to bypass paymaster middleware\n      // if set to '0x', all paymaster related fields are omitted from the user op request\n      paymasterData: Hex;\n      paymaster: Address;\n      paymasterVerificationGasLimit:\n        | NoUndefined<\n            UserOperationStruct<\"0.7.0\">[\"paymasterVerificationGasLimit\"]\n          >\n        | Multiplier;\n      paymasterPostOpGasLimit:\n        | NoUndefined<UserOperationStruct<\"0.7.0\">[\"paymasterPostOpGasLimit\"]>\n        | Multiplier;\n    }\n  : {};\n// [!endregion UserOperationOverridesParameter]\n\n// [!region UserOperationOverrides]\nexport type UserOperationOverrides<\n  TEntryPointVersion extends EntryPointVersion = EntryPointVersion\n> = Partial<\n  {\n    callGasLimit:\n      | UserOperationStruct<TEntryPointVersion>[\"callGasLimit\"]\n      | Multiplier;\n    maxFeePerGas:\n      | UserOperationStruct<TEntryPointVersion>[\"maxFeePerGas\"]\n      | Multiplier;\n    maxPriorityFeePerGas:\n      | UserOperationStruct<TEntryPointVersion>[\"maxPriorityFeePerGas\"]\n      | Multiplier;\n    preVerificationGas:\n      | UserOperationStruct<TEntryPointVersion>[\"preVerificationGas\"]\n      | Multiplier;\n    verificationGasLimit:\n      | UserOperationStruct<TEntryPointVersion>[\"verificationGasLimit\"]\n      | Multiplier;\n    /**\n     * This can be used to override the key used when calling `entryPoint.getNonce`\n     * It is useful when you want to use parallel nonces for user operations\n     *\n     * NOTE: not all bundlers fully support this feature and it could be that your bundler will still only include\n     * one user operation for your account in a bundle\n     */\n    nonceKey: bigint;\n\n    /**\n     * The same state overrides for\n     * [`eth_call`](https://geth.ethereum.org/docs/interacting-with-geth/rpc/ns-eth#eth-call) method.\n     * An address-to-state mapping, where each entry specifies some state to be ephemerally overridden\n     * prior to executing the call. State overrides allow you to customize the network state for\n     * the purpose of the simulation, so this feature is useful when you need to estimate gas\n     * for user operation scenarios under conditions that aren’t currently present on the live network.\n     */\n    stateOverride: StateOverride;\n  } & UserOperationPaymasterOverrides<TEntryPointVersion>\n>;\n// [!endregion UserOperationOverrides]\n\n// [!region UserOperationRequest_v6]\n// represents the request as it needs to be formatted for v0.6 RPC requests\n// Reference: https://github.com/ethereum/ERCs/blob/8dd085d159cb123f545c272c0d871a5339550e79/ERCS/erc-4337.md#definitions\nexport interface UserOperationRequest_v6 {\n  /* the origin of the request */\n  sender: Address;\n  /* nonce (as hex) of the transaction, returned from the entry point for this Address */\n  nonce: Hex;\n  /* the initCode for creating the sender if it does not exist yet, otherwise \"0x\" */\n  initCode: Hex | EmptyHex;\n  /* the callData passed to the target */\n  callData: Hex;\n  /* Gas value (as hex) used by inner account execution */\n  callGasLimit: Hex;\n  /* Actual gas (as hex) used by the validation of this UserOperation */\n  verificationGasLimit: Hex;\n  /* Gas overhead (as hex) of this UserOperation */\n  preVerificationGas: Hex;\n  /* Maximum fee per gas (similar to EIP-1559 max_fee_per_gas) (as hex)*/\n  maxFeePerGas: Hex;\n  /* Maximum priority fee per gas (similar to EIP-1559 max_priority_fee_per_gas) (as hex)*/\n  maxPriorityFeePerGas: Hex;\n  /* Address of paymaster sponsoring the transaction, followed by extra data to send to the paymaster (\"0x\" for self-sponsored transaction) */\n  paymasterAndData: Hex | EmptyHex;\n  /* Data passed into the account along with the nonce during the verification step */\n  signature: Hex;\n}\n// [!endregion UserOperationRequest_v6]\n\n// [!region UserOperationRequest_v7]\n// represents the request as it needs to be formatted for v0.7 RPC requests\n// Reference: https://eips.ethereum.org/EIPS/eip-4337#definitions\nexport interface UserOperationRequest_v7 {\n  /* the account making the operation */\n  sender: Address;\n  /* anti-replay parameter. nonce of the transaction, returned from the entry point for this address */\n  nonce: Hex;\n  /* account factory, only for new accounts */\n  factory?: Address;\n  /* data for account factory (only if account factory exists) */\n  factoryData?: Hex;\n  /* the data to pass to the sender during the main execution call */\n  callData: Hex;\n  /* the amount of gas to allocate the main execution call */\n  callGasLimit: Hex;\n  /* the amount of gas to allocate for the verification step */\n  verificationGasLimit: Hex;\n  /* extra gas to pay the bunder */\n  preVerificationGas: Hex;\n  /* maximum fee per gas (similar to EIP-1559 max_fee_per_gas) */\n  maxFeePerGas: Hex;\n  /* maximum priority fee per gas (similar to EIP-1559 max_priority_fee_per_gas) */\n  maxPriorityFeePerGas: Hex;\n  /* address of paymaster contract, (or empty, if account pays for itself) */\n  paymaster?: Address;\n  /* the amount of gas to allocate for the paymaster validation code */\n  paymasterVerificationGasLimit?: Hex;\n  /* the amount of gas to allocate for the paymaster post-operation code */\n  paymasterPostOpGasLimit?: Hex;\n  /* data for paymaster (only if paymaster exists) */\n  paymasterData?: Hex;\n  /* data passed into the account to verify authorization */\n  signature: Hex;\n}\n// [!endregion UserOperationRequest_v7]\n\n// [!region UserOperationRequest]\n// Reference: https://eips.ethereum.org/EIPS/eip-4337#definitions\nexport type UserOperationRequest<\n  TEntryPointVersion extends EntryPointVersion = EntryPointVersion\n> = TEntryPointVersion extends \"0.6.0\"\n  ? UserOperationRequest_v6\n  : TEntryPointVersion extends \"0.7.0\"\n  ? UserOperationRequest_v7\n  : never;\n\n// [!endregion UserOperationRequest]\n\n// [!region UserOperationEstimateGasResponse]\nexport interface UserOperationEstimateGasResponse<\n  TEntryPointVersion extends EntryPointVersion = EntryPointVersion\n> {\n  /* Gas overhead of this UserOperation */\n  preVerificationGas: BigNumberish;\n  /* Actual gas used by the validation of this UserOperation */\n  verificationGasLimit: BigNumberish;\n  /* Value used by inner account execution */\n  callGasLimit: BigNumberish;\n  /*\n   * EntryPoint v0.7.0 operations only.\n   * The amount of gas to allocate for the paymaster validation code.\n   * Note: `eth_estimateUserOperationGas` does not return paymasterPostOpGasLimit.\n   */\n  paymasterVerificationGasLimit: TEntryPointVersion extends \"0.7.0\"\n    ? BigNumberish | undefined\n    : never;\n}\n// [!endregion UserOperationEstimateGasResponse]\n\n// [!region UserOperationResponse]\nexport interface UserOperationResponse<\n  TEntryPointVersion extends EntryPointVersion = EntryPointVersion\n> {\n  /* the User Operation */\n  userOperation: UserOperationRequest<TEntryPointVersion>;\n  /* the address of the entry point contract that executed the user operation */\n  entryPoint: Address;\n  /* the block number the user operation was included in */\n  blockNumber: BigNumberish;\n  /* the hash of the block the user operation was included in */\n  blockHash: Hash;\n  /* the hash of the transaction that included the user operation */\n  transactionHash: Hash;\n}\n// [!endregion UserOperationResponse]\n\n// [!region UserOperationReceipt]\nexport interface UserOperationReceipt {\n  /* The request hash of the UserOperation. */\n  userOpHash: Hash;\n  /* The entry point address used for the UserOperation. */\n  entryPoint: Address;\n  /* The account initiating the UserOperation. */\n  sender: Address;\n  /* The nonce used in the UserOperation. */\n  nonce: BigNumberish;\n  /* The paymaster used for this UserOperation (or empty). */\n  paymaster?: Address;\n  /* The actual amount paid (by account or paymaster) for this UserOperation. */\n  actualGasCost: BigNumberish;\n  /* The total gas used by this UserOperation (including preVerification, creation, validation, and execution). */\n  actualGasUsed: BigNumberish;\n  /* Indicates whether the execution completed without reverting. */\n  success: boolean;\n  /* In case of revert, this is the revert reason. */\n  reason?: string;\n  /* The logs generated by this UserOperation (not including logs of other UserOperations in the same bundle). */\n  logs: string[];\n  /* The TransactionReceipt object for the entire bundle, not only for this UserOperation. */\n  receipt: TransactionReceipt;\n}\n// [!endregion UserOperationReceipt]\n\n/** @deprecated use viem type TransactionReceipt instead */\nexport interface UserOperationReceiptObject {\n  /* 32 Bytes - hash of the block where this log was in. null when its pending. null when its pending log */\n  blockHash: Hash;\n  /* The block number where this log was in. null when its pending. null when its pending log. */\n  blockNumber: BigNumberish;\n  /* The index of the transaction within the block. */\n  transactionIndex: BigNumberish;\n  /* 32 Bytes - hash of the transaction. null when its pending. */\n  transactionHash: Hash;\n  /* 20 Bytes - address of the sender */\n  from: Address;\n  /* 20 Bytes - address of the receiver. null when its a contract creation transaction */\n  to: Address;\n  /* The total amount of gas used when this transaction was executed in the block. */\n  cumulativeGasUsed: BigNumberish;\n  /* The amount of gas used by this specific transaction alone */\n  gasUsed: BigNumberish;\n  /* 20 Bytes - The contract address created, if the transaction was a contract creation, otherwise null */\n  contractAddress: Address;\n  logs: UserOperationReceiptLog[];\n  /* 256 Bytes - Bloom filter for light clients to quickly retrieve related logs */\n  logsBloom: Hex;\n  /* 32 bytes of post-transaction stateroot. (pre Byzantium hard fork at block 4,370,000) */\n  root: Hex;\n  /* Either 1 (success) or 0 (failure). (post Byzantium hard fork at block 4,370,000) */\n  status: number;\n  /* The cumulative gas used in the block containing this UserOperation. */\n  effectiveGasPrice: BigNumberish;\n  /* The type of the recipt object */\n  type: string;\n}\n\n/** @deprecated use viem type Log instead */\n/* https://github.com/wevm/viem/blob/6ef4ac131a878bf1dc4b335f5dc127e62618dda0/src/types/log.ts#L15 */\nexport interface UserOperationReceiptLog {\n  /* The hash of the block where the given transaction was included. */\n  blockHash: Hash;\n  /* The number of the block where the given transaction was included. */\n  blockNumber: BigNumberish;\n  /* The index of the transaction within the block. */\n  transactionIndex: BigNumberish;\n  /* 20 Bytes - address from which this log originated. */\n  address: Address;\n  /* Integer of the log index position in the block. null when its pending log. */\n  logIndex: BigNumberish;\n  /* Contains one or more 32 Bytes non-indexed arguments of the log. */\n  data: Hex;\n  /* true when the log was removed, due to a chain reorganization. false if its a valid log. */\n  removed: boolean;\n  /* Array of zero to four 32 Bytes DATA of indexed log arguments. */\n  topics: string[];\n  /* hash of the transaction */\n  transactionHash: Hash;\n}\n\n// [!region UserOperationStruct_v6]\n// https://github.com/eth-infinitism/account-abstraction/blob/releases/v0.6/test/UserOperation.ts\n// this is used for building requests for v0.6 entry point contract\nexport interface UserOperationStruct_v6 {\n  /* the origin of the request */\n  sender: string;\n  /* nonce of the transaction, returned from the entry point for this address */\n  nonce: BigNumberish;\n  /* the initCode for creating the sender if it does not exist yet, otherwise \"0x\" */\n  initCode: BytesLike | \"0x\";\n  /* the callData passed to the target */\n  callData: BytesLike;\n  /* Value used by inner account execution */\n  callGasLimit?: BigNumberish;\n  /* Actual gas used by the validation of this UserOperation */\n  verificationGasLimit?: BigNumberish;\n  /* Gas overhead of this UserOperation */\n  preVerificationGas?: BigNumberish;\n  /* Maximum fee per gas (similar to EIP-1559 max_fee_per_gas) */\n  maxFeePerGas?: BigNumberish;\n  /* Maximum priority fee per gas (similar to EIP-1559 max_priority_fee_per_gas) */\n  maxPriorityFeePerGas?: BigNumberish;\n  /* Address of paymaster sponsoring the transaction, followed by extra data to send to the paymaster (\"0x\" for self-sponsored transaction) */\n  paymasterAndData: BytesLike | \"0x\";\n  /* Data passed into the account along with the nonce during the verification step */\n  signature: BytesLike;\n}\n// [!endregion UserOperationStruct_v6]\n\n// [!region UserOperationStruct_v7]\n// based on https://github.com/eth-infinitism/account-abstraction/blob/releases/v0.7/test/UserOperation.ts\n// this is used for building requests for v0.7 entry point contract\nexport interface UserOperationStruct_v7 {\n  /* the account making the operation */\n  sender: string;\n  /* anti-replay parameter. nonce of the transaction, returned from the entry point for this address */\n  nonce: BigNumberish;\n  /* account factory, only for new accounts */\n  factory?: string;\n  /* data for account factory (only if account factory exists) */\n  factoryData?: BytesLike;\n  /* the data to pass to the sender during the main execution call */\n  callData: BytesLike;\n  /* the amount of gas to allocate the main execution call */\n  callGasLimit?: BigNumberish;\n  /* the amount of gas to allocate for the verification step */\n  verificationGasLimit?: BigNumberish;\n  /* extra gas to pay the bunder */\n  preVerificationGas?: BigNumberish;\n  /* maximum fee per gas (similar to EIP-1559 max_fee_per_gas) */\n  maxFeePerGas?: BigNumberish;\n  /* maximum priority fee per gas (similar to EIP-1559 max_priority_fee_per_gas) */\n  maxPriorityFeePerGas?: BigNumberish;\n  /* address of paymaster contract, (or empty, if account pays for itself) */\n  paymaster?: string;\n  /* the amount of gas to allocate for the paymaster validation code */\n  paymasterVerificationGasLimit?: BigNumberish;\n  /* the amount of gas to allocate for the paymaster post-operation code */\n  paymasterPostOpGasLimit?: BigNumberish;\n  /* data for paymaster (only if paymaster exists) */\n  paymasterData?: BytesLike;\n  /* data passed into the account to verify authorization */\n  signature: BytesLike;\n}\n// [!endregion UserOperationStruct_v7]\n\n// [!region UserOperationStruct]\nexport type UserOperationStruct<\n  TEntryPointVersion extends EntryPointVersion = EntryPointVersion\n> = TEntryPointVersion extends \"0.6.0\"\n  ? UserOperationStruct_v6\n  : TEntryPointVersion extends \"0.7.0\"\n  ? UserOperationStruct_v7\n  : never;\n// [!endregion UserOperationStruct]\n"]}

package/dist/esm/utils/bigint.d.ts

@@ -1,10 +1,55 @@
 import type { BigNumberish, Multiplier } from "../types";
+/**
+ * Returns the max bigint in a list of bigints
+ *
+ * @param {bigint[]} args a list of bigints to get the max of
+ * @returns {bigint} the max bigint in the list
+ */
 export declare const bigIntMax: (...args: bigint[]) => bigint;
+/**
+ * Returns the min bigint in a list of bigints
+ *
+ * @param {bigint[]} args a list of bigints to get the max of
+ * @returns {bigint} the min bigint in the list
+ */
 export declare const bigIntMin: (...args: bigint[]) => bigint;
+/**
+ * Given a bigint and a min-max range, returns the min-max clamped bigint value
+ *
+ * @param {BigNumberish} value a bigint value to clamp
+ * @param {BigNumberish | undefined} lower lower bound min max tuple value
+ * @param {BigNumberish | undefined} upper upper bound min max tuple value
+ * @returns {bigint} the clamped bigint value per given range
+ */
 export declare const bigIntClamp: (value: BigNumberish, lower: BigNumberish | null | undefined, upper: BigNumberish | null | undefined) => bigint;
 export declare enum RoundingMode {
     ROUND_DOWN = 0,
     ROUND_UP = 1
 }
+/**
+ * Given a bigint and a number (which can be a float), returns the bigint value.
+ * Note: this function has loss and will round down to the nearest integer.
+ *
+ * @param {BigNumberish} base - the number to be multiplied
+ * @param {number} multiplier - the amount to multiply by
+ * @param {RoundingMode} roundingMode - the rounding mode to use when calculating the percent. defaults to ROUND_UP
+ * @returns {bigint} the bigint value of the multiplication with the number rounded by the rounding mode
+ */
 export declare const bigIntMultiply: (base: BigNumberish, multiplier: Multiplier["multiplier"], roundingMode?: RoundingMode) => bigint;
+/**
+ * Useful if you want to use a string, such as a user's email address, as salt to generate a unique SmartAccount per user.
+ *
+ * example:
+ * ```
+ * const salt = stringToIndex("alice@example.com");
+ *
+ * export const account = new SimpleSmartContractAccount({
+ *   index: salt,
+ *   // other args omitted...
+ * });
+ * ```
+ *
+ * @param {string} phrase -- any string value.
+ * @returns {bigint} the bigint value of the hashed string
+ */
 export declare const stringToIndex: (phrase: string) => bigint;

package/dist/esm/utils/bigint.js

@@ -1,17 +1,37 @@
 import { keccak256, toHex } from "viem";
 import { isMultiplier } from "./schema.js";
+/**
+ * Returns the max bigint in a list of bigints
+ *
+ * @param {bigint[]} args a list of bigints to get the max of
+ * @returns {bigint} the max bigint in the list
+ */
 export const bigIntMax = (...args) => {
     if (!args.length) {
         throw new Error("bigIntMax requires at least one argument");
     }
     return args.reduce((m, c) => (m > c ? m : c));
 };
+/**
+ * Returns the min bigint in a list of bigints
+ *
+ * @param {bigint[]} args a list of bigints to get the max of
+ * @returns {bigint} the min bigint in the list
+ */
 export const bigIntMin = (...args) => {
     if (!args.length) {
         throw new Error("bigIntMin requires at least one argument");
     }
     return args.reduce((m, c) => (m < c ? m : c));
 };
+/**
+ * Given a bigint and a min-max range, returns the min-max clamped bigint value
+ *
+ * @param {BigNumberish} value a bigint value to clamp
+ * @param {BigNumberish | undefined} lower lower bound min max tuple value
+ * @param {BigNumberish | undefined} upper upper bound min max tuple value
+ * @returns {bigint} the clamped bigint value per given range
+ */
 export const bigIntClamp = (value, lower, upper) => {
     lower = lower != null ? BigInt(lower) : null;
     upper = upper != null ? BigInt(upper) : null;
@@ -32,10 +52,20 @@ export var RoundingMode;
     RoundingMode[RoundingMode["ROUND_DOWN"] = 0] = "ROUND_DOWN";
     RoundingMode[RoundingMode["ROUND_UP"] = 1] = "ROUND_UP";
 })(RoundingMode || (RoundingMode = {}));
+/**
+ * Given a bigint and a number (which can be a float), returns the bigint value.
+ * Note: this function has loss and will round down to the nearest integer.
+ *
+ * @param {BigNumberish} base - the number to be multiplied
+ * @param {number} multiplier - the amount to multiply by
+ * @param {RoundingMode} roundingMode - the rounding mode to use when calculating the percent. defaults to ROUND_UP
+ * @returns {bigint} the bigint value of the multiplication with the number rounded by the rounding mode
+ */
 export const bigIntMultiply = (base, multiplier, roundingMode = RoundingMode.ROUND_UP) => {
     if (!isMultiplier({ multiplier })) {
         throw new Error("bigIntMultiply requires a multiplier validated number as the second argument");
     }
+    // Get decimal places of b. Max decimal places is defined by the MultiplerSchema.
     const decimalPlaces = multiplier.toString().split(".")[1]?.length ?? 0;
     const val = roundingMode === RoundingMode.ROUND_UP
         ? BigInt(base) * BigInt(multiplier * 10 ** decimalPlaces) +
@@ -43,5 +73,21 @@ export const bigIntMultiply = (base, multiplier, roundingMode = RoundingMode.ROU
         : BigInt(base) * BigInt(multiplier * 10 ** decimalPlaces);
     return val / BigInt(10 ** decimalPlaces);
 };
+/**
+ * Useful if you want to use a string, such as a user's email address, as salt to generate a unique SmartAccount per user.
+ *
+ * example:
+ * ```
+ * const salt = stringToIndex("alice@example.com");
+ *
+ * export const account = new SimpleSmartContractAccount({
+ *   index: salt,
+ *   // other args omitted...
+ * });
+ * ```
+ *
+ * @param {string} phrase -- any string value.
+ * @returns {bigint} the bigint value of the hashed string
+ */
 export const stringToIndex = (phrase) => BigInt(keccak256(toHex(phrase)));
 //# sourceMappingURL=bigint.js.map

package/dist/esm/utils/bigint.js.map

@@ -1 +1 @@
-{"version":3,"file":"bigint.js","sourceRoot":"","sources":["../../../src/utils/bigint.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,MAAM,CAAC;AAExC,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAQ3C,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,GAAG,IAAc,EAAU,EAAE;IACrD,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;QACjB,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC;IAC9D,CAAC;IAED,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAChD,CAAC,CAAC;AAQF,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,GAAG,IAAc,EAAU,EAAE;IACrD,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;QACjB,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC;IAC9D,CAAC;IAED,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAChD,CAAC,CAAC;AAUF,MAAM,CAAC,MAAM,WAAW,GAAG,CACzB,KAAmB,EACnB,KAAsC,EACtC,KAAsC,EAC9B,EAAE;IACV,KAAK,GAAG,KAAK,IAAI,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IAC7C,KAAK,GAAG,KAAK,IAAI,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IAE7C,IAAI,KAAK,IAAI,IAAI,IAAI,KAAK,IAAI,IAAI,IAAI,KAAK,GAAG,KAAK,EAAE,CAAC;QACpD,MAAM,IAAI,KAAK,CACb,8BAA8B,KAAK,6BAA6B,KAAK,EAAE,CACxE,CAAC;IACJ,CAAC;IAED,IAAI,GAAG,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;IACxB,IAAI,KAAK,IAAI,IAAI,IAAI,KAAK,GAAG,GAAG,EAAE,CAAC;QACjC,GAAG,GAAG,KAAK,CAAC;IACd,CAAC;IACD,IAAI,KAAK,IAAI,IAAI,IAAI,KAAK,GAAG,GAAG,EAAE,CAAC;QACjC,GAAG,GAAG,KAAK,CAAC;IACd,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC,CAAC;AAEF,MAAM,CAAN,IAAY,YAGX;AAHD,WAAY,YAAY;IACtB,2DAAc,CAAA;IACd,uDAAY,CAAA;AACd,CAAC,EAHW,YAAY,KAAZ,YAAY,QAGvB;AAWD,MAAM,CAAC,MAAM,cAAc,GAAG,CAC5B,IAAkB,EAClB,UAAoC,EACpC,eAA6B,YAAY,CAAC,QAAQ,EAClD,EAAE;IACF,IAAI,CAAC,YAAY,CAAC,EAAE,UAAU,EAAE,CAAC,EAAE,CAAC;QAClC,MAAM,IAAI,KAAK,CACb,8EAA8E,CAC/E,CAAC;IACJ,CAAC;IAGD,MAAM,aAAa,GAAG,UAAU,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,MAAM,IAAI,CAAC,CAAC;IACvE,MAAM,GAAG,GACP,YAAY,KAAK,YAAY,CAAC,QAAQ;QACpC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,UAAU,GAAG,EAAE,IAAI,aAAa,CAAC;YACvD,MAAM,CAAC,EAAE,IAAI,aAAa,GAAG,CAAC,CAAC;QACjC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,UAAU,GAAG,EAAE,IAAI,aAAa,CAAC,CAAC;IAE9D,OAAO,GAAG,GAAG,MAAM,CAAC,EAAE,IAAI,aAAa,CAAC,CAAC;AAC3C,CAAC,CAAC;AAkBF,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,MAAc,EAAU,EAAE,CACtD,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC","sourcesContent":["import { keccak256, toHex } from \"viem\";\nimport type { BigNumberish, Multiplier } from \"../types\";\nimport { isMultiplier } from \"./schema.js\";\n\n/**\n * Returns the max bigint in a list of bigints\n *\n * @param {bigint[]} args a list of bigints to get the max of\n * @returns {bigint} the max bigint in the list\n */\nexport const bigIntMax = (...args: bigint[]): bigint => {\n  if (!args.length) {\n    throw new Error(\"bigIntMax requires at least one argument\");\n  }\n\n  return args.reduce((m, c) => (m > c ? m : c));\n};\n\n/**\n * Returns the min bigint in a list of bigints\n *\n * @param {bigint[]} args a list of bigints to get the max of\n * @returns {bigint} the min bigint in the list\n */\nexport const bigIntMin = (...args: bigint[]): bigint => {\n  if (!args.length) {\n    throw new Error(\"bigIntMin requires at least one argument\");\n  }\n\n  return args.reduce((m, c) => (m < c ? m : c));\n};\n\n/**\n * Given a bigint and a min-max range, returns the min-max clamped bigint value\n *\n * @param {BigNumberish} value a bigint value to clamp\n * @param {BigNumberish | undefined} lower lower bound min max tuple value\n * @param {BigNumberish | undefined} upper upper bound min max tuple value\n * @returns {bigint} the clamped bigint value per given range\n */\nexport const bigIntClamp = (\n  value: BigNumberish,\n  lower: BigNumberish | null | undefined,\n  upper: BigNumberish | null | undefined\n): bigint => {\n  lower = lower != null ? BigInt(lower) : null;\n  upper = upper != null ? BigInt(upper) : null;\n\n  if (upper != null && lower != null && upper < lower) {\n    throw new Error(\n      `invalid range: upper bound ${upper} is less than lower bound ${lower}`\n    );\n  }\n\n  let ret = BigInt(value);\n  if (lower != null && lower > ret) {\n    ret = lower;\n  }\n  if (upper != null && upper < ret) {\n    ret = upper;\n  }\n  return ret;\n};\n\nexport enum RoundingMode {\n  ROUND_DOWN = 0,\n  ROUND_UP = 1,\n}\n\n/**\n * Given a bigint and a number (which can be a float), returns the bigint value.\n * Note: this function has loss and will round down to the nearest integer.\n *\n * @param {BigNumberish} base - the number to be multiplied\n * @param {number} multiplier - the amount to multiply by\n * @param {RoundingMode} roundingMode - the rounding mode to use when calculating the percent. defaults to ROUND_UP\n * @returns {bigint} the bigint value of the multiplication with the number rounded by the rounding mode\n */\nexport const bigIntMultiply = (\n  base: BigNumberish,\n  multiplier: Multiplier[\"multiplier\"],\n  roundingMode: RoundingMode = RoundingMode.ROUND_UP\n) => {\n  if (!isMultiplier({ multiplier })) {\n    throw new Error(\n      \"bigIntMultiply requires a multiplier validated number as the second argument\"\n    );\n  }\n\n  // Get decimal places of b. Max decimal places is defined by the MultiplerSchema.\n  const decimalPlaces = multiplier.toString().split(\".\")[1]?.length ?? 0;\n  const val =\n    roundingMode === RoundingMode.ROUND_UP\n      ? BigInt(base) * BigInt(multiplier * 10 ** decimalPlaces) +\n        BigInt(10 ** decimalPlaces - 1)\n      : BigInt(base) * BigInt(multiplier * 10 ** decimalPlaces);\n\n  return val / BigInt(10 ** decimalPlaces);\n};\n\n/**\n * Useful if you want to use a string, such as a user's email address, as salt to generate a unique SmartAccount per user.\n *\n * example:\n * ```\n * const salt = stringToIndex(\"alice@example.com\");\n *\n * export const account = new SimpleSmartContractAccount({\n *   index: salt,\n *   // other args omitted...\n * });\n * ```\n *\n * @param {string} phrase -- any string value.\n * @returns {bigint} the bigint value of the hashed string\n */\nexport const stringToIndex = (phrase: string): bigint =>\n  BigInt(keccak256(toHex(phrase)));\n"]}
+{"version":3,"file":"bigint.js","sourceRoot":"","sources":["../../../src/utils/bigint.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,MAAM,CAAC;AAExC,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAE3C;;;;;GAKG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,GAAG,IAAc,EAAU,EAAE;IACrD,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;QACjB,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC;IAC9D,CAAC;IAED,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAChD,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,GAAG,IAAc,EAAU,EAAE;IACrD,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;QACjB,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC;IAC9D,CAAC;IAED,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAChD,CAAC,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CACzB,KAAmB,EACnB,KAAsC,EACtC,KAAsC,EAC9B,EAAE;IACV,KAAK,GAAG,KAAK,IAAI,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IAC7C,KAAK,GAAG,KAAK,IAAI,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IAE7C,IAAI,KAAK,IAAI,IAAI,IAAI,KAAK,IAAI,IAAI,IAAI,KAAK,GAAG,KAAK,EAAE,CAAC;QACpD,MAAM,IAAI,KAAK,CACb,8BAA8B,KAAK,6BAA6B,KAAK,EAAE,CACxE,CAAC;IACJ,CAAC;IAED,IAAI,GAAG,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;IACxB,IAAI,KAAK,IAAI,IAAI,IAAI,KAAK,GAAG,GAAG,EAAE,CAAC;QACjC,GAAG,GAAG,KAAK,CAAC;IACd,CAAC;IACD,IAAI,KAAK,IAAI,IAAI,IAAI,KAAK,GAAG,GAAG,EAAE,CAAC;QACjC,GAAG,GAAG,KAAK,CAAC;IACd,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC,CAAC;AAEF,MAAM,CAAN,IAAY,YAGX;AAHD,WAAY,YAAY;IACtB,2DAAc,CAAA;IACd,uDAAY,CAAA;AACd,CAAC,EAHW,YAAY,KAAZ,YAAY,QAGvB;AAED;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAC5B,IAAkB,EAClB,UAAoC,EACpC,eAA6B,YAAY,CAAC,QAAQ,EAClD,EAAE;IACF,IAAI,CAAC,YAAY,CAAC,EAAE,UAAU,EAAE,CAAC,EAAE,CAAC;QAClC,MAAM,IAAI,KAAK,CACb,8EAA8E,CAC/E,CAAC;IACJ,CAAC;IAED,iFAAiF;IACjF,MAAM,aAAa,GAAG,UAAU,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,MAAM,IAAI,CAAC,CAAC;IACvE,MAAM,GAAG,GACP,YAAY,KAAK,YAAY,CAAC,QAAQ;QACpC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,UAAU,GAAG,EAAE,IAAI,aAAa,CAAC;YACvD,MAAM,CAAC,EAAE,IAAI,aAAa,GAAG,CAAC,CAAC;QACjC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,UAAU,GAAG,EAAE,IAAI,aAAa,CAAC,CAAC;IAE9D,OAAO,GAAG,GAAG,MAAM,CAAC,EAAE,IAAI,aAAa,CAAC,CAAC;AAC3C,CAAC,CAAC;AAEF;;;;;;;;;;;;;;;GAeG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,MAAc,EAAU,EAAE,CACtD,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC","sourcesContent":["import { keccak256, toHex } from \"viem\";\nimport type { BigNumberish, Multiplier } from \"../types\";\nimport { isMultiplier } from \"./schema.js\";\n\n/**\n * Returns the max bigint in a list of bigints\n *\n * @param {bigint[]} args a list of bigints to get the max of\n * @returns {bigint} the max bigint in the list\n */\nexport const bigIntMax = (...args: bigint[]): bigint => {\n  if (!args.length) {\n    throw new Error(\"bigIntMax requires at least one argument\");\n  }\n\n  return args.reduce((m, c) => (m > c ? m : c));\n};\n\n/**\n * Returns the min bigint in a list of bigints\n *\n * @param {bigint[]} args a list of bigints to get the max of\n * @returns {bigint} the min bigint in the list\n */\nexport const bigIntMin = (...args: bigint[]): bigint => {\n  if (!args.length) {\n    throw new Error(\"bigIntMin requires at least one argument\");\n  }\n\n  return args.reduce((m, c) => (m < c ? m : c));\n};\n\n/**\n * Given a bigint and a min-max range, returns the min-max clamped bigint value\n *\n * @param {BigNumberish} value a bigint value to clamp\n * @param {BigNumberish | undefined} lower lower bound min max tuple value\n * @param {BigNumberish | undefined} upper upper bound min max tuple value\n * @returns {bigint} the clamped bigint value per given range\n */\nexport const bigIntClamp = (\n  value: BigNumberish,\n  lower: BigNumberish | null | undefined,\n  upper: BigNumberish | null | undefined\n): bigint => {\n  lower = lower != null ? BigInt(lower) : null;\n  upper = upper != null ? BigInt(upper) : null;\n\n  if (upper != null && lower != null && upper < lower) {\n    throw new Error(\n      `invalid range: upper bound ${upper} is less than lower bound ${lower}`\n    );\n  }\n\n  let ret = BigInt(value);\n  if (lower != null && lower > ret) {\n    ret = lower;\n  }\n  if (upper != null && upper < ret) {\n    ret = upper;\n  }\n  return ret;\n};\n\nexport enum RoundingMode {\n  ROUND_DOWN = 0,\n  ROUND_UP = 1,\n}\n\n/**\n * Given a bigint and a number (which can be a float), returns the bigint value.\n * Note: this function has loss and will round down to the nearest integer.\n *\n * @param {BigNumberish} base - the number to be multiplied\n * @param {number} multiplier - the amount to multiply by\n * @param {RoundingMode} roundingMode - the rounding mode to use when calculating the percent. defaults to ROUND_UP\n * @returns {bigint} the bigint value of the multiplication with the number rounded by the rounding mode\n */\nexport const bigIntMultiply = (\n  base: BigNumberish,\n  multiplier: Multiplier[\"multiplier\"],\n  roundingMode: RoundingMode = RoundingMode.ROUND_UP\n) => {\n  if (!isMultiplier({ multiplier })) {\n    throw new Error(\n      \"bigIntMultiply requires a multiplier validated number as the second argument\"\n    );\n  }\n\n  // Get decimal places of b. Max decimal places is defined by the MultiplerSchema.\n  const decimalPlaces = multiplier.toString().split(\".\")[1]?.length ?? 0;\n  const val =\n    roundingMode === RoundingMode.ROUND_UP\n      ? BigInt(base) * BigInt(multiplier * 10 ** decimalPlaces) +\n        BigInt(10 ** decimalPlaces - 1)\n      : BigInt(base) * BigInt(multiplier * 10 ** decimalPlaces);\n\n  return val / BigInt(10 ** decimalPlaces);\n};\n\n/**\n * Useful if you want to use a string, such as a user's email address, as salt to generate a unique SmartAccount per user.\n *\n * example:\n * ```\n * const salt = stringToIndex(\"alice@example.com\");\n *\n * export const account = new SimpleSmartContractAccount({\n *   index: salt,\n *   // other args omitted...\n * });\n * ```\n *\n * @param {string} phrase -- any string value.\n * @returns {bigint} the bigint value of the hashed string\n */\nexport const stringToIndex = (phrase: string): bigint =>\n  BigInt(keccak256(toHex(phrase)));\n"]}

package/dist/esm/utils/bytes.d.ts

@@ -3,5 +3,14 @@ type TakeBytesOpts = {
     count?: number;
     offset?: number;
 };
+/**
+ * Given a bytes string, returns a slice of the bytes
+ *
+ * @param {Hex} bytes - the hex string representing bytes
+ * @param {TakeBytesOpts} opts - optional parameters for slicing the bytes
+ * @param {number} opts.offset - the offset in bytes to start slicing from
+ * @param {number} opts.count - the number of bytes to slice
+ * @returns {Hex} the sliced bytes
+ */
 export declare const takeBytes: (bytes: Hex, opts?: TakeBytesOpts) => Hex;
 export {};

package/dist/esm/utils/bytes.js

@@ -1,6 +1,15 @@
+/**
+ * Given a bytes string, returns a slice of the bytes
+ *
+ * @param {Hex} bytes - the hex string representing bytes
+ * @param {TakeBytesOpts} opts - optional parameters for slicing the bytes
+ * @param {number} opts.offset - the offset in bytes to start slicing from
+ * @param {number} opts.count - the number of bytes to slice
+ * @returns {Hex} the sliced bytes
+ */
 export const takeBytes = (bytes, opts = {}) => {
     const { offset, count } = opts;
-    const start = (offset ? offset * 2 : 0) + 2;
+    const start = (offset ? offset * 2 : 0) + 2; // add 2 to skip the 0x prefix
     const end = count ? start + count * 2 : undefined;
     return `0x${bytes.slice(start, end)}`;
 };

package/dist/esm/utils/bytes.js.map

@@ -1 +1 @@
-{"version":3,"file":"bytes.js","sourceRoot":"","sources":["../../../src/utils/bytes.ts"],"names":[],"mappings":"AAgBA,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,KAAU,EAAE,OAAsB,EAAE,EAAO,EAAE;IACrE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC;IAC/B,MAAM,KAAK,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;IAC5C,MAAM,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,GAAG,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAElD,OAAO,KAAK,KAAK,CAAC,KAAK,CAAC,KAAK,EAAE,GAAG,CAAC,EAAE,CAAC;AACxC,CAAC,CAAC","sourcesContent":["import type { Hex } from \"viem\";\n\ntype TakeBytesOpts = {\n  count?: number;\n  offset?: number;\n};\n\n/**\n * Given a bytes string, returns a slice of the bytes\n *\n * @param {Hex} bytes - the hex string representing bytes\n * @param {TakeBytesOpts} opts - optional parameters for slicing the bytes\n * @param {number} opts.offset - the offset in bytes to start slicing from\n * @param {number} opts.count - the number of bytes to slice\n * @returns {Hex} the sliced bytes\n */\nexport const takeBytes = (bytes: Hex, opts: TakeBytesOpts = {}): Hex => {\n  const { offset, count } = opts;\n  const start = (offset ? offset * 2 : 0) + 2; // add 2 to skip the 0x prefix\n  const end = count ? start + count * 2 : undefined;\n\n  return `0x${bytes.slice(start, end)}`;\n};\n"]}
+{"version":3,"file":"bytes.js","sourceRoot":"","sources":["../../../src/utils/bytes.ts"],"names":[],"mappings":"AAOA;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,KAAU,EAAE,OAAsB,EAAE,EAAO,EAAE;IACrE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC;IAC/B,MAAM,KAAK,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,8BAA8B;IAC3E,MAAM,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,GAAG,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAElD,OAAO,KAAK,KAAK,CAAC,KAAK,CAAC,KAAK,EAAE,GAAG,CAAC,EAAE,CAAC;AACxC,CAAC,CAAC","sourcesContent":["import type { Hex } from \"viem\";\n\ntype TakeBytesOpts = {\n  count?: number;\n  offset?: number;\n};\n\n/**\n * Given a bytes string, returns a slice of the bytes\n *\n * @param {Hex} bytes - the hex string representing bytes\n * @param {TakeBytesOpts} opts - optional parameters for slicing the bytes\n * @param {number} opts.offset - the offset in bytes to start slicing from\n * @param {number} opts.count - the number of bytes to slice\n * @returns {Hex} the sliced bytes\n */\nexport const takeBytes = (bytes: Hex, opts: TakeBytesOpts = {}): Hex => {\n  const { offset, count } = opts;\n  const start = (offset ? offset * 2 : 0) + 2; // add 2 to skip the 0x prefix\n  const end = count ? start + count * 2 : undefined;\n\n  return `0x${bytes.slice(start, end)}`;\n};\n"]}

package/dist/esm/utils/index.d.ts

@@ -1,15 +1,101 @@
 import type { PromiseOrValue } from "../types.js";
 import type { RecordableKeys } from "./types.js";
+/**
+ * Utility function that allows for piping a series of async functions together
+ *
+ * @param {((s: S, o?: O, f?: F) => Promise<S>)[]} fns - functions to pipe
+ * @returns {S} result of the pipe
+ */
 export declare const asyncPipe: <S, O, F>(...fns: ((s: S, o?: O | undefined, f?: F | undefined) => Promise<S>)[]) => (s: S, o?: O | undefined, f?: F | undefined) => Promise<S>;
 export type Deferrable<T> = {
     [K in keyof T]: PromiseOrValue<T[K]>;
 };
+/**
+ * Await all of the properties of a Deferrable object
+ *
+ * @param {Deferrable<T>} object - a Deferrable object
+ * @returns {Promise<T>} the object with its properties resolved
+ */
 export declare function resolveProperties<T>(object: Deferrable<T>): Promise<T>;
+/**
+ * Recursively converts all values in an object to hex strings
+ *
+ * @param {any} obj - obj to deep hexlify
+ * @returns {any} object with all of its values hexlified
+ */
 export declare function deepHexlify(obj: any): any;
+/**
+ * Filters out properties with undefined or null values from the provided object.
+ *
+ * @example
+ * ```ts
+ * import { filterUndefined } from "@aa-sdk/core";
+ *
+ * const result = filterUndefined({
+ *  foo: undefined,
+ *  bar: null,
+ *  baz: "baz",
+ * }); // { baz: "baz" }
+ * ```
+ *
+ * @param {T} obj the object from which to remove properties with undefined or null values
+ * @returns {T} the object with undefined or null properties removed
+ */
 export declare function filterUndefined<T>(obj: T): T;
+/**
+ * Picks the specified keys from an object and returns a new object containing only those key-value pairs.
+ *
+ * @example
+ * ```ts
+ * import { pick } from "@aa-sdk/core";
+ *
+ * const picked = pick({
+ *  foo: "foo",
+ *  bar: "bar",
+ * }, ["foo"]); // { foo: "foo" }
+ * ```
+ *
+ * @param {Record<string, unknown>} obj The object from which to pick keys
+ * @param {string|string[]} keys A single key or an array of keys to pick from the object
+ * @returns {Record<string, unknown>} A new object containing only the picked key-value pairs
+ */
 export declare function pick(obj: Record<string, unknown>, keys: string | string[]): {};
+/**
+ * Utility method for checking if the passed in values are all equal (strictly)
+ *
+ * @param {...any[]} params - values to check
+ * @returns {boolean} a boolean indicating if all values are the same
+ * @throws if no values are passed in
+ */
 export declare const allEqual: (...params: any[]) => boolean;
+/**
+ * Utility method for checking the condition and return the value if condition holds true, undefined if not.
+ *
+ * @param {Promise<boolean>} condition - condition to check
+ * @param {() => Promise<T>} value - value to return when condition holds true
+ * @returns {Promise<T | undefined>} the value if condition holds true, undefined if not
+ */
 export declare const conditionalReturn: <T>(condition: Promise<boolean>, value: () => Promise<T>) => Promise<T | undefined>;
+/**
+ * Converts an array of objects into a record (object) where each key is determined by the specified selector and the value is determined by the provided function.
+ *
+ * @example
+ * ```ts
+ * import { toRecord } from "@aa-sdk/core";
+ * import { sepolia, mainnet } from "viem/chains";
+ *
+ * const addressesByChain = toRecord(
+ *  [sepolia, mainnet],
+ *  "id",
+ *  () => "0x..."
+ * ); // { [sepolia.id]: "0x...", [mainnet.id]: "0x..." }
+ * ```
+ *
+ * @param {T[]} array The array of objects to convert to a record
+ * @param {K} selector The key used to select the property that will become the record's key
+ * @param {(item: T) => V} fn The function that transforms each item in the array into the record's value
+ * @returns {Record<T[K], V>} The resulting record object
+ */
 export declare const toRecord: <T extends { [K in RecordableKeys<T>]: string | number | symbol; }, K_1 extends RecordableKeys<T>, V>(array: T[], selector: K_1, fn: (item: T) => V) => Record<T[K_1], V>;
 export * from "./bigint.js";
 export * from "./bytes.js";

package/dist/esm/utils/index.js

@@ -1,4 +1,10 @@
 import { toHex } from "viem";
+/**
+ * Utility function that allows for piping a series of async functions together
+ *
+ * @param {((s: S, o?: O, f?: F) => Promise<S>)[]} fns - functions to pipe
+ * @returns {S} result of the pipe
+ */
 export const asyncPipe = (...fns) => async (s, o, f) => {
     let result = s;
     for (const fn of fns) {
@@ -6,6 +12,12 @@ export const asyncPipe = (...fns) => async (s, o, f) => {
     }
     return result;
 };
+/**
+ * Await all of the properties of a Deferrable object
+ *
+ * @param {Deferrable<T>} object - a Deferrable object
+ * @returns {Promise<T>} the object with its properties resolved
+ */
 export async function resolveProperties(object) {
     const promises = Object.keys(object).map((key) => {
         const value = object[key];
@@ -17,6 +29,12 @@ export async function resolveProperties(object) {
         return accum;
     }, {}));
 }
+/**
+ * Recursively converts all values in an object to hex strings
+ *
+ * @param {any} obj - obj to deep hexlify
+ * @returns {any} object with all of its values hexlified
+ */
 export function deepHexlify(obj) {
     if (typeof obj === "function") {
         return undefined;
@@ -38,6 +56,23 @@ export function deepHexlify(obj) {
         [key]: deepHexlify(obj[key]),
     }), {});
 }
+/**
+ * Filters out properties with undefined or null values from the provided object.
+ *
+ * @example
+ * ```ts
+ * import { filterUndefined } from "@aa-sdk/core";
+ *
+ * const result = filterUndefined({
+ *  foo: undefined,
+ *  bar: null,
+ *  baz: "baz",
+ * }); // { baz: "baz" }
+ * ```
+ *
+ * @param {T} obj the object from which to remove properties with undefined or null values
+ * @returns {T} the object with undefined or null properties removed
+ */
 export function filterUndefined(obj) {
     for (const key in obj) {
         if (obj[key] == null) {
@@ -46,18 +81,69 @@ export function filterUndefined(obj) {
     }
     return obj;
 }
+/**
+ * Picks the specified keys from an object and returns a new object containing only those key-value pairs.
+ *
+ * @example
+ * ```ts
+ * import { pick } from "@aa-sdk/core";
+ *
+ * const picked = pick({
+ *  foo: "foo",
+ *  bar: "bar",
+ * }, ["foo"]); // { foo: "foo" }
+ * ```
+ *
+ * @param {Record<string, unknown>} obj The object from which to pick keys
+ * @param {string|string[]} keys A single key or an array of keys to pick from the object
+ * @returns {Record<string, unknown>} A new object containing only the picked key-value pairs
+ */
 export function pick(obj, keys) {
     return Object.keys(obj)
         .filter((k) => keys.includes(k))
         .reduce((res, k) => Object.assign(res, { [k]: obj[k] }), {});
 }
+/**
+ * Utility method for checking if the passed in values are all equal (strictly)
+ *
+ * @param {...any[]} params - values to check
+ * @returns {boolean} a boolean indicating if all values are the same
+ * @throws if no values are passed in
+ */
 export const allEqual = (...params) => {
     if (params.length === 0) {
         throw new Error("no values passed in");
     }
     return params.every((v) => v === params[0]);
 };
+/**
+ * Utility method for checking the condition and return the value if condition holds true, undefined if not.
+ *
+ * @param {Promise<boolean>} condition - condition to check
+ * @param {() => Promise<T>} value - value to return when condition holds true
+ * @returns {Promise<T | undefined>} the value if condition holds true, undefined if not
+ */
 export const conditionalReturn = (condition, value) => condition.then((t) => (t ? value() : undefined));
+/**
+ * Converts an array of objects into a record (object) where each key is determined by the specified selector and the value is determined by the provided function.
+ *
+ * @example
+ * ```ts
+ * import { toRecord } from "@aa-sdk/core";
+ * import { sepolia, mainnet } from "viem/chains";
+ *
+ * const addressesByChain = toRecord(
+ *  [sepolia, mainnet],
+ *  "id",
+ *  () => "0x..."
+ * ); // { [sepolia.id]: "0x...", [mainnet.id]: "0x..." }
+ * ```
+ *
+ * @param {T[]} array The array of objects to convert to a record
+ * @param {K} selector The key used to select the property that will become the record's key
+ * @param {(item: T) => V} fn The function that transforms each item in the array into the record's value
+ * @returns {Record<T[K], V>} The resulting record object
+ */
 export const toRecord = (array, selector, fn) => array.reduce((acc, item) => {
     acc[item[selector]] = fn(item);
     return acc;