@boostxyz/sdk 0.0.0-alpha.10

package/dist/utils.js

@@ -0,0 +1,30 @@
+import { waitForTransactionReceipt as n } from "@wagmi/core";
+import { slice as s, isHex as I, keccak256 as c, toHex as d } from "viem";
+import { NoContractAddressUponReceiptError as e } from "./errors.js";
+function u(t) {
+  return s(I(t) ? c(t) : c(d(t)), 0, 4);
+}
+async function E(t, a, r) {
+  const o = await n(t, {
+    ...r,
+    hash: await a
+  });
+  if (!o.contractAddress)
+    throw new e(o);
+  return o.contractAddress;
+}
+async function N(t, a, r) {
+  const { hash: o, result: A } = await a;
+  return await n(t, {
+    ...r,
+    hash: o
+  }), A;
+}
+var i = /* @__PURE__ */ ((t) => (t[t.ACTION = 0] = "ACTION", t[t.ALLOW_LIST = 1] = "ALLOW_LIST", t[t.BUDGET = 2] = "BUDGET", t[t.INCENTIVE = 3] = "INCENTIVE", t[t.VALIDATOR = 4] = "VALIDATOR", t))(i || {});
+export {
+  i as RegistryType,
+  N as awaitResult,
+  u as bytes4,
+  E as getDeployedContractAddress
+};
+//# sourceMappingURL=utils.js.map

package/dist/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sources":["../src/utils.ts"],"sourcesContent":["import {\n  type Config,\n  type ReadContractParameters,\n  type WatchContractEventParameters,\n  type WriteContractParameters,\n  waitForTransactionReceipt,\n} from '@wagmi/core';\nimport type { ExtractAbiEvent } from 'abitype';\nimport type {\n  Abi,\n  AbiEvent,\n  ContractEventName,\n  ContractFunctionName,\n  GetLogsParameters,\n  Hash,\n  Hex,\n  Log,\n  WaitForTransactionReceiptParameters,\n} from 'viem';\nimport { isHex, keccak256, slice, toHex } from 'viem';\nimport { NoContractAddressUponReceiptError } from './errors';\n\nexport type Overwrite<T, U> = Pick<T, Exclude<keyof T, keyof U>> & U;\n\n/**\n * Helper type that encapsulates common writeContract parameters without fields like `abi`, `args`, `functionName`, `address` that are expected to be provided the SDK.\n * See (writeContract)[https://viem.sh/docs/contract/writeContract]\n *\n * @export\n * @typedef {WriteParams}\n * @template {Abi} abi\n * @template {ContractFunctionName<abi>} functionName\n */\nexport type WriteParams<\n  abi extends Abi,\n  functionName extends ContractFunctionName<abi>,\n> = Partial<\n  Omit<\n    WriteContractParameters<abi, functionName>,\n    'address' | 'args' | 'functionName' | 'abi'\n  >\n>;\n\n/**\n * Helper type that encapsulates common readContract parameters without fields like `abi`, `args`, `functionName`, `address` that are expected to be provided the SDK.\n * See (readContract)[https://viem.sh/docs/contract/readContract]\n *\n * @export\n * @typedef {ReadParams}\n * @template {Abi} abi\n * @template {ContractFunctionName<abi>} functionName\n */\nexport type ReadParams<\n  abi extends Abi,\n  functionName extends ContractFunctionName<abi>,\n> = Partial<\n  Omit<\n    ReadContractParameters<abi, functionName>,\n    'address' | 'args' | 'functionName' | 'abi'\n  >\n>;\n\n/**\n * Helper type that encapsulates common `watchContractEvent` parameters without fields like `address`, and `abi` that are expected to be provided the SDK.\n * See (watchContractEvent)[https://wagmi.sh/core/api/actions/watchContractEvent]\n *\n * @export\n * @typedef {WatchParams}\n * @template {Abi} abi\n * @template {ContractEventName<abi> | undefined} [eventName=undefined]\n */\nexport type WatchParams<\n  abi extends Abi,\n  eventName extends ContractEventName<abi> | undefined = undefined,\n> = Partial<\n  Omit<WatchContractEventParameters<abi, eventName>, 'address' | 'abi'>\n>;\n\n/**\n * Helper type that encapsulates common `getLogs` parameters without fields like `address` that are expected to be provided the SDK.\n * See (getLogs)[https://viem.sh/docs/actions/public/getLogs#getlogs]\n *\n * @export\n * @typedef {GetLogsParams}\n * @template {Abi} abi\n * @template {ContractEventName<abi>} event\n * @template {ExtractAbiEvent<abi, event>} [abiEvent=ExtractAbiEvent<abi, event>]\n * @template {| readonly AbiEvent[]\n *     | readonly unknown[]\n *     | undefined} [abiEvents=abiEvent extends AbiEvent ? [abiEvent] : undefined]\n */\nexport type GetLogsParams<\n  abi extends Abi,\n  event extends ContractEventName<abi>,\n  abiEvent extends ExtractAbiEvent<abi, event> = ExtractAbiEvent<abi, event>,\n  abiEvents extends\n    | readonly AbiEvent[]\n    | readonly unknown[]\n    | undefined = abiEvent extends AbiEvent ? [abiEvent] : undefined,\n> = Partial<Omit<GetLogsParameters<abiEvent, abiEvents>, 'address'>> & {\n  chainId?: number | undefined;\n};\n\n/**\n * A generic `viem.Log` event with typed `args` support via a given `Abi` and `ContractEventName`\n *\n * @export\n * @typedef {GenericLog}\n * @template {Abi} abi\n * @template {ContractEventName<abi>} [event=ContractEventName<abi>]\n */\nexport type GenericLog<\n  abi extends Abi,\n  event extends ContractEventName<abi> = ContractEventName<abi>,\n> = Log<bigint, number, false, ExtractAbiEvent<abi, event>, false>;\n\n/**\n * Helper utility to convert a string to a `bytes4` type\n *\n * @export\n * @param {string} input\n * @returns {Hex}\n */\nexport function bytes4(input: string) {\n  return slice(isHex(input) ? keccak256(input) : keccak256(toHex(input)), 0, 4);\n}\n\n/**\n * Utility function to wait for a transaction receipt, and extract the contractAddress\n *\n * @export\n * @async\n * @param {WagmiConfig} config - [Wagmi Configuration](https://wagmi.sh/core/api/createConfig)\n * @param {Promise<Hash>} hash - A transaction hash promise\n * @param {?Omit<WaitForTransactionReceiptParameters, 'hash'>} [waitParams] - @see {@link WaitForTransactionReceiptParameters}\n * @returns {unknown}\n * @throws {@link NoContractAddressUponReceiptError} if no `contractAddress` exists after the transaction has been received\n */\nexport async function getDeployedContractAddress(\n  config: Config,\n  hash: Promise<Hash>,\n  waitParams?: Omit<WaitForTransactionReceiptParameters, 'hash'>,\n) {\n  const receipt = await waitForTransactionReceipt(config, {\n    ...waitParams,\n    hash: await hash,\n  });\n  if (!receipt.contractAddress)\n    throw new NoContractAddressUponReceiptError(receipt);\n  return receipt.contractAddress;\n}\n\n/**\n * Utility type to encapsulate a transaction hash, and the simulated result prior to submitting the transaction.\n *\n * @export\n * @typedef {HashAndSimulatedResult}\n * @template [T=unknown]\n */\nexport type HashAndSimulatedResult<T = unknown> = { hash: Hash; result: T };\n\n/**\n * Helper function to wait for a transaction receipt given a hash promise.\n *\n * @export\n * @async\n * @template [Result=unknown]\n * @param {WagmiConfig} config\n * @param {Promise<HashAndSimulatedResult<Result>>} hashPromise\n * @param {?Omit<WaitForTransactionReceiptParameters, 'hash'>} [waitParams]\n * @returns {Promise<Result>}\n */\nexport async function awaitResult<Result = unknown>(\n  config: Config,\n  hashPromise: Promise<HashAndSimulatedResult<Result>>,\n  waitParams?: Omit<WaitForTransactionReceiptParameters, 'hash'>,\n): Promise<Result> {\n  const { hash, result } = await hashPromise;\n  await waitForTransactionReceipt(config, {\n    ...waitParams,\n    hash,\n  });\n  return result;\n}\n\n/**\n * Enum encapsulating all the different types of targets used in the Boost V2 Protocol.\n *\n * @export\n * @enum {number}\n */\nexport enum RegistryType {\n  ACTION = 0,\n  ALLOW_LIST = 1,\n  BUDGET = 2,\n  INCENTIVE = 3,\n  VALIDATOR = 4,\n}\n"],"names":["bytes4","input","slice","isHex","keccak256","toHex","getDeployedContractAddress","config","hash","waitParams","receipt","waitForTransactionReceipt","NoContractAddressUponReceiptError","awaitResult","hashPromise","result","RegistryType"],"mappings":";;;AA2HO,SAASA,EAAOC,GAAe;AACpC,SAAOC,EAAMC,EAAMF,CAAK,IAAIG,EAAUH,CAAK,IAAIG,EAAUC,EAAMJ,CAAK,CAAC,GAAG,GAAG,CAAC;AAC9E;AAasB,eAAAK,EACpBC,GACAC,GACAC,GACA;AACM,QAAAC,IAAU,MAAMC,EAA0BJ,GAAQ;AAAA,IACtD,GAAGE;AAAA,IACH,MAAM,MAAMD;AAAA,EAAA,CACb;AACD,MAAI,CAACE,EAAQ;AACL,UAAA,IAAIE,EAAkCF,CAAO;AACrD,SAAOA,EAAQ;AACjB;AAsBsB,eAAAG,EACpBN,GACAO,GACAL,GACiB;AACjB,QAAM,EAAE,MAAAD,GAAM,QAAAO,EAAO,IAAI,MAAMD;AAC/B,eAAMH,EAA0BJ,GAAQ;AAAA,IACtC,GAAGE;AAAA,IACH,MAAAD;AAAA,EAAA,CACD,GACMO;AACT;AAQY,IAAAC,sBAAAA,OACVA,EAAAA,EAAA,SAAS,CAAT,IAAA,UACAA,EAAAA,EAAA,aAAa,CAAb,IAAA,cACAA,EAAAA,EAAA,SAAS,CAAT,IAAA,UACAA,EAAAA,EAAA,YAAY,CAAZ,IAAA,aACAA,EAAAA,EAAA,YAAY,CAAZ,IAAA,aALUA,IAAAA,KAAA,CAAA,CAAA;"}

package/package.json

@@ -0,0 +1,211 @@
+{
+  "name": "@boostxyz/sdk",
+  "version": "0.0.0-alpha.10",
+  "license": "GPL-3.0-or-later",
+  "type": "module",
+  "files": [
+    "dist",
+    "src"
+  ],
+  "repository": "https://github.com/rabbitholegg/boost-protocol",
+  "author": "Boost Team<boost-team@boost.xyz>",
+  "access": "public",
+  "private": false,
+  "browserslist": [
+    "node >=14",
+    "edge >=88",
+    "firefox >=78",
+    "chrome >=87",
+    "safari >=14"
+  ],
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "typings": "./dist/index.d.ts",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "require": "./dist/index.cjs",
+      "import": "./dist/index.js",
+      "node": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    },
+    "./errors": {
+      "require": "./dist/errors.cjs",
+      "import": "./dist/errors.js",
+      "node": "./dist/errors.js",
+      "types": "./dist/errors.d.ts"
+    },
+    "./utils": {
+      "require": "./dist/utils.cjs",
+      "import": "./dist/utils.js",
+      "node": "./dist/utils.js",
+      "types": "./dist/utils.d.ts"
+    },
+    "./claiming": {
+      "require": "./dist/claiming.cjs",
+      "import": "./dist/claiming.js",
+      "node": "./dist/claiming.js",
+      "types": "./dist/claiming.d.ts"
+    },
+    "./transfers": {
+      "require": "./dist/transfers.cjs",
+      "import": "./dist/transfers.js",
+      "node": "./dist/transfers.js",
+      "types": "./dist/transfers.d.ts"
+    },
+    "./Boost": {
+      "require": "./dist/Boost.cjs",
+      "import": "./dist/Boost.js",
+      "node": "./dist/Boost.js",
+      "types": "./dist/Boost.d.ts"
+    },
+    "./BoostRegistry": {
+      "require": "./dist/BoostRegistry.cjs",
+      "import": "./dist/BoostRegistry.js",
+      "node": "./dist/BoostRegistry.js",
+      "types": "./dist/BoostRegistry.d.ts"
+    },
+    "./BoostCore": {
+      "require": "./dist/BoostCore.cjs",
+      "import": "./dist/BoostCore.js",
+      "node": "./dist/BoostCore.js",
+      "types": "./dist/BoostCore.d.ts"
+    },
+    "./Auth/Auth": {
+      "require": "./dist/Auth/Auth.cjs",
+      "import": "./dist/Auth/Auth.js",
+      "node": "./dist/Auth/Auth.js",
+      "types": "./dist/Auth/Auth.d.ts"
+    },
+    "./Auth/PassthroughAuth": {
+      "require": "./dist/Auth/PassthroughAuth.cjs",
+      "import": "./dist/Auth/PassthroughAuth.js",
+      "node": "./dist/Auth/PassthroughAuth.js",
+      "types": "./dist/Auth/PassthroughAuth.d.ts"
+    },
+    "./Deployable/Deployable": {
+      "require": "./dist/Deployable/Deployable.cjs",
+      "import": "./dist/Deployable/Deployable.js",
+      "node": "./dist/Deployable/Deployable.js",
+      "types": "./dist/Deployable/Deployable.d.ts"
+    },
+    "./Deployable/DeployableTarget": {
+      "require": "./dist/Deployable/DeployableTarget.cjs",
+      "import": "./dist/Deployable/DeployableTarget.js",
+      "node": "./dist/Deployable/DeployableTarget.js",
+      "types": "./dist/Deployable/DeployableTarget.d.ts"
+    },
+    "./Deployable/Contract": {
+      "require": "./dist/Deployable/Contract.cjs",
+      "import": "./dist/Deployable/Contract.js",
+      "node": "./dist/Deployable/Contract.js",
+      "types": "./dist/Deployable/Contract.d.ts"
+    },
+    "./Actions/Action": {
+      "require": "./dist/Actions/Action.cjs",
+      "import": "./dist/Actions/Action.js",
+      "node": "./dist/Actions/Action.js",
+      "types": "./dist/Actions/Action.d.ts"
+    },
+    "./Actions/EventAction": {
+      "require": "./dist/Actions/EventAction.cjs",
+      "import": "./dist/Actions/EventAction.js",
+      "node": "./dist/Actions/EventAction.js",
+      "types": "./dist/Actions/EventAction.d.ts"
+    },
+    "./AllowLists/AllowList": {
+      "require": "./dist/AllowLists/AllowList.cjs",
+      "import": "./dist/AllowLists/AllowList.js",
+      "node": "./dist/AllowLists/AllowList.js",
+      "types": "./dist/AllowLists/AllowList.d.ts"
+    },
+    "./AllowLists/SimpleAllowList": {
+      "require": "./dist/AllowLists/SimpleAllowList.cjs",
+      "import": "./dist/AllowLists/SimpleAllowList.js",
+      "node": "./dist/AllowLists/SimpleAllowList.js",
+      "types": "./dist/AllowLists/SimpleAllowList.d.ts"
+    },
+    "./AllowLists/SimpleDenyList": {
+      "require": "./dist/AllowLists/SimpleDenyList.cjs",
+      "import": "./dist/AllowLists/SimpleDenyList.js",
+      "node": "./dist/AllowLists/SimpleDenyList.js",
+      "types": "./dist/AllowLists/SimpleDenyList.d.ts"
+    },
+    "./Budgets/Budget": {
+      "require": "./dist/Budgets/Budget.cjs",
+      "import": "./dist/Budgets/Budget.js",
+      "node": "./dist/Budgets/Budget.js",
+      "types": "./dist/Budgets/Budget.d.ts"
+    },
+    "./Budgets/ManagedBudget": {
+      "require": "./dist/Budgets/ManagedBudget.cjs",
+      "import": "./dist/Budgets/ManagedBudget.js",
+      "node": "./dist/Budgets/ManagedBudget.js",
+      "types": "./dist/Budgets/ManagedBudget.d.ts"
+    },
+    "./Incentives/AllowListIncentive": {
+      "require": "./dist/Incentives/AllowListIncentive.cjs",
+      "import": "./dist/Incentives/AllowListIncentive.js",
+      "node": "./dist/Incentives/AllowListIncentive.js",
+      "types": "./dist/Incentives/AllowListIncentive.d.ts"
+    },
+    "./Incentives/CGDAIncentive": {
+      "require": "./dist/Incentives/CGDAIncentive.cjs",
+      "import": "./dist/Incentives/CGDAIncentive.js",
+      "node": "./dist/Incentives/CGDAIncentive.js",
+      "types": "./dist/Incentives/CGDAIncentive.d.ts"
+    },
+    "./Incentives/ERC20Incentive": {
+      "require": "./dist/Incentives/ERC20Incentive.cjs",
+      "import": "./dist/Incentives/ERC20Incentive.js",
+      "node": "./dist/Incentives/ERC20Incentive.js",
+      "types": "./dist/Incentives/ERC20Incentive.d.ts"
+    },
+    "./Incentives/Incentive": {
+      "require": "./dist/Incentives/Incentive.cjs",
+      "import": "./dist/Incentives/Incentive.js",
+      "node": "./dist/Incentives/Incentive.js",
+      "types": "./dist/Incentives/Incentive.d.ts"
+    },
+    "./Incentives/PointsIncentive": {
+      "require": "./dist/Incentives/PointsIncentive.cjs",
+      "import": "./dist/Incentives/PointsIncentive.js",
+      "node": "./dist/Incentives/PointsIncentive.js",
+      "types": "./dist/Incentives/PointsIncentive.d.ts"
+    },
+    "./Validators/Validator": {
+      "require": "./dist/Validators/Validator.cjs",
+      "import": "./dist/Validators/Validator.js",
+      "node": "./dist/Validators/Validator.js",
+      "types": "./dist/Validators/Validator.d.ts"
+    },
+    "./Validators/SignerValidator": {
+      "require": "./dist/Validators/SignerValidator.cjs",
+      "import": "./dist/Validators/SignerValidator.js",
+      "node": "./dist/Validators/SignerValidator.js",
+      "types": "./dist/Validators/SignerValidator.d.ts"
+    }
+  },
+  "optionalDependencies": {
+    "@boostxyz/evm": "0.0.0-alpha.1",
+    "@boostxyz/signatures": "0.0.0-alpha.2"
+  },
+  "peerDependencies": {
+    "@wagmi/core": "2",
+    "viem": "2",
+    "abitype": "1"
+  },
+  "scripts": {
+    "build": "vite build && tsc --build --emitDeclarationOnly --declaration --declarationMap --force",
+    "lint:ci": "npx biome ci",
+    "lint": "npx biome check",
+    "bench": "vitest bench",
+    "bench:ci": "CI=true vitest bench",
+    "clean": "rm -rf dist",
+    "dev": "vite build --watch",
+    "test": "vitest dev",
+    "test:ci": "CI=true vitest --coverage",
+    "typedoc": "npx typedoc --sort required-first --sort visibility --sort kind"
+  }
+}

package/src/Actions/Action.test.ts

@@ -0,0 +1,75 @@
+import { selectors } from '@boostxyz/signatures/events';
+import { loadFixture } from '@nomicfoundation/hardhat-toolbox-viem/network-helpers';
+import type { Hex } from 'viem';
+import { beforeAll, beforeEach, describe, expect, test } from 'vitest';
+import type { MockERC721 } from '../../test/MockERC721';
+import { accounts } from '../../test/accounts';
+import {
+  type Fixtures,
+  defaultOptions,
+  deployFixtures,
+  fundErc721,
+} from '../../test/helpers';
+import { EventAction, actionFromAddress } from './Action';
+import {
+  type EventActionPayloadSimple,
+  FilterType,
+  PrimitiveType,
+  SignatureType,
+} from './EventAction';
+
+let fixtures: Fixtures, erc721: MockERC721;
+
+export function basicErc721TransferAction(
+  erc721: MockERC721,
+): EventActionPayloadSimple {
+  return {
+    actionClaimant: {
+      chainid: 31337,
+      signatureType: SignatureType.EVENT,
+      signature: selectors['Transfer(address,address,uint256)'] as Hex,
+      fieldIndex: 2,
+      targetContract: erc721.assertValidAddress(),
+    },
+    actionSteps: [
+      {
+        chainid: 31337,
+        signature: selectors['Transfer(address,address,uint256)'] as Hex,
+        signatureType: SignatureType.EVENT,
+        targetContract: erc721.assertValidAddress(),
+        actionParameter: {
+          filterType: FilterType.EQUAL,
+          fieldType: PrimitiveType.ADDRESS,
+          fieldIndex: 2,
+          filterData: accounts[1].account,
+        },
+      },
+    ],
+  };
+}
+
+export function cloneEventAction(fixtures: Fixtures, erc721: MockERC721) {
+  return function cloneEventAction() {
+    return fixtures.registry.clone(
+      crypto.randomUUID(),
+      fixtures.core.EventAction(basicErc721TransferAction(erc721)),
+    );
+  };
+}
+
+beforeAll(async () => {
+  fixtures = await loadFixture(deployFixtures);
+});
+
+describe('Action', () => {
+  beforeEach(async () => {
+    erc721 = await loadFixture(fundErc721(defaultOptions));
+  });
+
+  test('can automatically instantiate EventAction given an address', async () => {
+    const _action = await loadFixture(cloneEventAction(fixtures, erc721));
+    expect(
+      await actionFromAddress(defaultOptions, _action.assertValidAddress()),
+    ).toBeInstanceOf(EventAction);
+  });
+});

package/src/Actions/Action.ts

@@ -0,0 +1,61 @@
+import { aActionAbi } from '@boostxyz/evm';
+import { AEventAction } from '@boostxyz/evm/deploys/componentInterfaces.json';
+import { readContract } from '@wagmi/core';
+import type { Address, Hex } from 'viem';
+import type { DeployableOptions } from '../Deployable/Deployable';
+import { InvalidComponentInterfaceError } from '../errors';
+import { EventAction } from './EventAction';
+
+export {
+  // ContractAction,
+  // ERC721MintAction,
+  EventAction,
+};
+
+/**
+ * A union type representing all valid protocol Action implementations
+ *
+ * @export
+ * @typedef {Action}
+ */
+export type Action = EventAction; // | ContractAction | ERC721MintAction
+
+/**
+ * A map of Action component interfaces to their constructors.
+ *
+ * @type {{ "0x7687b0ed": EventAction; }}
+ */
+export const ActionByComponentInterface = {
+  // ['0x6c3129aa']: ContractAction,
+  // ['0x97e083eb']: ERC721MintAction,
+  [AEventAction as Hex]: EventAction,
+};
+
+/**
+ * A function that will read a contract's component interface using `getComponentInterface` and return the correct instantiated instance.
+ *
+ * @export
+ * @async
+ * @param {DeployableOptions} options
+ * @param {Address} address
+ * @returns {Promise<EventAction>}
+ * @throws {@link InvalidComponentInterfaceError}
+ */
+export async function actionFromAddress(
+  options: DeployableOptions,
+  address: Address,
+) {
+  const interfaceId = (await readContract(options.config, {
+    abi: aActionAbi,
+    functionName: 'getComponentInterface',
+    address,
+  })) as keyof typeof ActionByComponentInterface;
+  const Ctor = ActionByComponentInterface[interfaceId];
+  if (!Ctor) {
+    throw new InvalidComponentInterfaceError(
+      Object.keys(ActionByComponentInterface) as Hex[],
+      interfaceId as Hex,
+    );
+  }
+  return new Ctor(options, address);
+}

package/src/Actions/ContractAction.test.ts

@@ -0,0 +1,197 @@
+import { mockErc20Abi, readMockErc20BalanceOf } from '@boostxyz/evm';
+import { loadFixture } from '@nomicfoundation/hardhat-network-helpers';
+import {
+  ContractFunctionExecutionError,
+  encodeAbiParameters,
+  encodeFunctionData,
+  isAddress,
+  parseEther,
+  toFunctionSelector,
+  zeroAddress,
+} from 'viem';
+import { beforeAll, beforeEach, describe, expect, test } from 'vitest';
+import type { MockERC20 } from '../../test/MockERC20';
+import { accounts } from '../../test/accounts';
+import {
+  type Fixtures,
+  defaultOptions,
+  deployFixtures,
+  fundErc20,
+} from '../../test/helpers';
+import { ContractAction } from './ContractAction';
+
+let fixtures: Fixtures, erc20: MockERC20;
+
+beforeAll(async () => {
+  fixtures = await loadFixture(deployFixtures);
+});
+
+const mintPayableSelector = toFunctionSelector(
+  'function mintPayable(address to, uint256 amount)',
+);
+
+const mintSelector = toFunctionSelector(
+  'function mint(address to, uint256 amount)',
+);
+
+function payableContractAction(fixtures: Fixtures, erc20: MockERC20) {
+  return function payableContractAction() {
+    return fixtures.registry.clone(
+      crypto.randomUUID(),
+      fixtures.core.ContractAction({
+        chainId: BigInt(31_337),
+        target: erc20.assertValidAddress(),
+        selector: mintPayableSelector,
+        value: parseEther('0.1'),
+      }),
+    );
+  };
+}
+
+function nonPayableAction(fixtures: Fixtures, erc20: MockERC20) {
+  return function nonPayableAction() {
+    return fixtures.registry.clone(
+      crypto.randomUUID(),
+      fixtures.core.ContractAction({
+        chainId: BigInt(31_337),
+        target: erc20.assertValidAddress(),
+        selector: mintSelector,
+        value: 0n,
+      }),
+    );
+  };
+}
+
+function otherAction(fixtures: Fixtures, erc20: MockERC20) {
+  return function nonPayableAction() {
+    return fixtures.registry.clone(
+      crypto.randomUUID(),
+      fixtures.core.ContractAction({
+        chainId: BigInt(31_337) + 1n,
+        target: erc20.assertValidAddress(),
+        selector: mintSelector,
+        value: parseEther('0.1'),
+      }),
+    );
+  };
+}
+
+describe.skip('ContractAction', () => {
+  beforeEach(async () => {
+    erc20 = await loadFixture(fundErc20(defaultOptions));
+  });
+
+  test('can successfully be deployed', async () => {
+    const action = new ContractAction(defaultOptions, {
+      chainId: BigInt(31_337),
+      target: zeroAddress,
+      selector: '0xdeadbeef',
+      value: 2n,
+    });
+    await action.deploy();
+    expect(isAddress(action.assertValidAddress())).toBe(true);
+  });
+
+  test('can read chain id', async () => {
+    const action = await loadFixture(payableContractAction(fixtures, erc20));
+    expect(await action.chainId()).toBe(BigInt(31_337));
+  });
+
+  test('can read target', async () => {
+    const action = await loadFixture(payableContractAction(fixtures, erc20));
+    expect((await action.target()).toLowerCase()).toBe(
+      erc20.assertValidAddress().toLowerCase(),
+    );
+  });
+
+  test('can read selector', async () => {
+    const action = await loadFixture(payableContractAction(fixtures, erc20));
+    expect(await action.selector()).toBe(mintPayableSelector);
+  });
+
+  test('can read value', async () => {
+    const action = await loadFixture(payableContractAction(fixtures, erc20));
+    expect(await action.value()).toBe(parseEther('0.1'));
+  });
+
+  test('prepare will properly encode execution payload', async () => {
+    const action = await loadFixture(payableContractAction(fixtures, erc20));
+    const { account } = accounts[1];
+    const payload = await action.prepare(
+      encodeAbiParameters(
+        [
+          { type: 'address', name: 'address' },
+          { type: 'uint256', name: 'value' },
+        ],
+        [account, parseEther('100')],
+      ),
+    );
+    expect(payload).toBe(
+      encodeFunctionData({
+        abi: mockErc20Abi,
+        functionName: 'mintPayable',
+        args: [account, parseEther('100')],
+      }),
+    );
+  });
+
+  test('payable execute', async () => {
+    const action = await loadFixture(payableContractAction(fixtures, erc20));
+    const { account } = accounts[1];
+    await action.execute(
+      encodeAbiParameters(
+        [
+          { type: 'address', name: 'to' },
+          { type: 'uint256', name: 'amount' },
+        ],
+        [account, parseEther('0.1')],
+      ),
+      { value: parseEther('0.1') },
+    );
+    expect(
+      await readMockErc20BalanceOf(defaultOptions.config, {
+        address: erc20.assertValidAddress(),
+        args: [account],
+      }),
+    ).toBe(parseEther('0.1'));
+  });
+
+  test('nonpayable execute', async () => {
+    const action = await loadFixture(nonPayableAction(fixtures, erc20));
+    const { account } = accounts[1];
+    const [success] = await action.execute(
+      encodeAbiParameters(
+        [
+          { type: 'address', name: 'to' },
+          { type: 'uint256', name: 'amount' },
+        ],
+        [account, parseEther('100')],
+      ),
+    );
+    expect(success).toBe(true);
+    expect(
+      await readMockErc20BalanceOf(defaultOptions.config, {
+        address: erc20.assertValidAddress(),
+        args: [account],
+      }),
+    ).toBe(parseEther('100'));
+  });
+
+  test('different chain id should throw', async () => {
+    const action = await loadFixture(otherAction(fixtures, erc20));
+    const { account } = accounts[1];
+    try {
+      await action.execute(
+        encodeAbiParameters(
+          [
+            { type: 'address', name: 'to' },
+            { type: 'uint256', name: 'amount' },
+          ],
+          [account, parseEther('100')],
+        ),
+      );
+    } catch (e) {
+      expect(e).toBeInstanceOf(ContractFunctionExecutionError);
+    }
+  });
+});