@boostxyz/sdk 0.0.0-alpha.7 → 0.0.0-alpha.9

package/src/Actions/ERC721MintAction.ts

@@ -8,24 +8,37 @@ import {
   writeErc721MintActionValidate,
 } from '@boostxyz/evm';
 import { bytecode } from '@boostxyz/evm/artifacts/contracts/actions/ERC721MintAction.sol/ERC721MintAction.json';
-import type { Address, ContractEventName, Hex } from 'viem';
+import {
+  type Address,
+  type ContractEventName,
+  type Hex,
+  encodeAbiParameters,
+  toHex,
+} from 'viem';
 import type {
   DeployableOptions,
   GenericDeployableParams,
 } from '../Deployable/Deployable';
 import {
-  type ERC721MintActionPayload,
   type GenericLog,
   type ReadParams,
   RegistryType,
   type WriteParams,
-  prepareERC721MintActionPayload,
-  prepareERC721MintActionValidate,
 } from '../utils';
-import { ContractAction } from './ContractAction';
+import {
+  ContractAction,
+  type ContractActionPayload,
+  prepareContractActionPayload,
+} from './ContractAction';
 
-export { erc721MintActionAbi, prepareERC721MintActionPayload };
-export type { ERC721MintActionPayload };
+export { erc721MintActionAbi };
+/**
+ * `ERC721MintActionPayload` is a re-exported `ContractActionPayload`
+ *
+ * @export
+ * @typedef {ERC721MintActionPayload}
+ */
+export type ERC721MintActionPayload = ContractActionPayload;
 
 /**
  * A generic `viem.Log` event with support for `ERC721MintAction` event types.
@@ -91,7 +104,7 @@ export class ERC721MintAction extends ContractAction<
     token: bigint,
     params?: ReadParams<typeof erc721MintActionAbi, 'validated'>,
   ) {
-    return readErc721MintActionValidated(this._config, {
+    return await readErc721MintActionValidated(this._config, {
       address: this.assertValidAddress(),
       ...this.optionallyAttachAccount(),
       // biome-ignore lint/suspicious/noExplicitAny: Accept any shape of valid wagmi/viem parameters, wagmi does the same thing internally
@@ -113,7 +126,7 @@ export class ERC721MintAction extends ContractAction<
     data: Hex,
     params?: WriteParams<typeof erc721MintActionAbi, 'execute'>,
   ) {
-    return this.awaitResult(this.executeRaw(data, params));
+    return await this.awaitResult(this.executeRaw(data, params));
   }
 
   /**
@@ -156,7 +169,7 @@ export class ERC721MintAction extends ContractAction<
     data: Hex,
     params?: ReadParams<typeof erc721MintActionAbi, 'prepare'>,
   ) {
-    return readErc721MintActionPrepare(this._config, {
+    return await readErc721MintActionPrepare(this._config, {
       address: this.assertValidAddress(),
       args: [data],
       ...this.optionallyAttachAccount(),
@@ -166,34 +179,34 @@ export class ERC721MintAction extends ContractAction<
   }
 
   /**
-   * Validate that the action has been completed successfully
+   * Validate that the action has been completed successfully. This API is protected to prevent accidental signature burning.
    *
-   * @public
+   * @protected
    * @async
    * @param {Address} holder - The holder
    * @param {BigInt} tokenId - The token ID
    * @param {?WriteParams<typeof erc721MintActionAbi, 'validate'>} [params]
    * @returns {Promise<{ hash: `0x${string}`; result: boolean; }>} - True if the action has been validated for the user
    */
-  public async validate(
+  protected async validate(
     holder: Address,
     tokenId: bigint,
     params?: WriteParams<typeof erc721MintActionAbi, 'validate'>,
   ) {
-    return this.awaitResult(this.validateRaw(holder, tokenId, params));
+    return await this.awaitResult(this.validateRaw(holder, tokenId, params));
   }
 
   /**
    * Validate that the action has been completed successfully
    *
-   * @public
+   * @protected
    * @async
    * @param {Address} holder - The holder
    * @param {BigInt} tokenId - The token ID
    * @param {?WriteParams<typeof erc721MintActionAbi, 'validate'>} [params]
    * @returns {Promise<{ hash: `0x${string}`; result: boolean; }>} - True if the action has been validated for the user
    */
-  public async validateRaw(
+  protected async validateRaw(
     holder: Address,
     tokenId: bigint,
     params?: WriteParams<typeof erc721MintActionAbi, 'validate'>,
@@ -236,3 +249,44 @@ export class ERC721MintAction extends ContractAction<
     };
   }
 }
+
+/**
+ * Encodes a payload to validate that an action has been completed successfully.
+ *
+ *
+ * @export
+ * @param {Address} holder - The holder address
+ * @param {bigint} payload - The token ID
+ * @returns {Hex} - The first 20 bytes of the payload will be the holder address and the remaining bytes must be an encoded token ID (uint256)
+ */
+export function prepareERC721MintActionValidate(
+  holder: Address,
+  payload: bigint,
+) {
+  return encodeAbiParameters(
+    [
+      { type: 'address', name: 'holder' },
+      { type: 'bytes', name: 'payload' },
+    ],
+    [holder, toHex(payload)],
+  );
+}
+
+/**
+ * Given a {@link ContractActionPayload}, properly encode a `ContractAction.InitPayload` for use with {@link ERC721MintAction} initialization.
+ *
+ * @param {ContractActionPayload} param0
+ * @param {bigint} param0.chainId - The chain ID on which the target exists
+ * @param {Address} param0.target - The target contract address
+ * @param {Hex} param0.selector - The selector for the function to be called
+ * @param {bigint} param0.value - The native token value to send with the function call
+ * @returns {*}
+ */
+export function prepareERC721MintActionPayload({
+  chainId,
+  target,
+  selector,
+  value,
+}: ContractActionPayload) {
+  return prepareContractActionPayload({ chainId, target, selector, value });
+}

package/src/Actions/EventAction.test.ts

@@ -1,8 +1,4 @@
-import {
-  readAActionGetComponentInterface,
-  readEventActionGetComponentInterface,
-} from '@boostxyz/evm';
-import { selectors } from '@boostxyz/signatures/events';
+import { selectors as eventSelectors } from '@boostxyz/signatures/events';
 import { loadFixture } from '@nomicfoundation/hardhat-network-helpers';
 import { type Hex, type Log, isAddress } from 'viem';
 import { beforeAll, beforeEach, describe, expect, test } from 'vitest';
@@ -15,12 +11,12 @@ import {
   fundErc721,
 } from '../../test/helpers';
 import {
+  EventAction,
   type EventActionPayloadSimple,
   FilterType,
   PrimitiveType,
   SignatureType,
-} from '../utils';
-import { EventAction } from './EventAction';
+} from './EventAction';
 
 let fixtures: Fixtures, erc721: MockERC721;
 
@@ -34,26 +30,56 @@ function basicErc721TransferAction(
   return {
     actionClaimant: {
       signatureType: SignatureType.EVENT,
-      signature: selectors['Transfer(address,address,uint256)'] as Hex,
+      signature: eventSelectors['Transfer(address,address,uint256)'] as Hex,
       fieldIndex: 2,
       targetContract: erc721.assertValidAddress(),
+      chainid: defaultOptions.config.chains[0].id,
     },
     actionSteps: [
       {
-        signature: selectors['Transfer(address,address,uint256)'] as Hex,
+        signature: eventSelectors['Transfer(address,address,uint256)'] as Hex,
         signatureType: SignatureType.EVENT,
+        targetContract: erc721.assertValidAddress(),
+        chainid: defaultOptions.config.chains[0].id,
+        actionParameter: {
+          filterType: FilterType.EQUAL,
+          fieldType: PrimitiveType.ADDRESS,
+          fieldIndex: 2,
+          filterData: accounts[1].account,
+        },
+      },
+    ],
+  };
+}
+
+/*
+function basicErc721MintFuncAction(
+  erc721: MockERC721,
+): EventActionPayloadSimple {
+  return {
+    actionClaimant: {
+      signatureType: SignatureType.FUNC,
+      signature: funcSelectors['mint(address)'] as Hex,
+      fieldIndex: 0,
+      targetContract: erc721.assertValidAddress(),
+    },
+    actionSteps: [
+      {
+        signature: funcSelectors['mint(address)'] as Hex,
+        signatureType: SignatureType.FUNC,
         actionType: 0,
         targetContract: erc721.assertValidAddress(),
         actionParameter: {
           filterType: FilterType.EQUAL,
           fieldType: PrimitiveType.ADDRESS,
           fieldIndex: 2,
-          filterData: accounts.at(1)!.account,
+          filterData: accounts[1].account,
         },
       },
     ],
   };
 }
+*/
 
 function cloneEventAction(fixtures: Fixtures, erc721: MockERC721) {
   return function cloneEventAction() {
@@ -89,7 +115,7 @@ describe('EventAction', () => {
     step.actionParameter.filterData =
       step.actionParameter.filterData.toUpperCase() as Hex;
     expect(step).toMatchObject({
-      signature: selectors['Transfer(address,address,uint256)'] as Hex,
+      signature: eventSelectors['Transfer(address,address,uint256)'] as Hex,
       signatureType: SignatureType.EVENT,
       actionType: 0,
       targetContract: erc721.assertValidAddress().toUpperCase(),
@@ -97,7 +123,7 @@ describe('EventAction', () => {
         filterType: FilterType.EQUAL,
         fieldType: PrimitiveType.ADDRESS,
         fieldIndex: 2,
-        filterData: accounts.at(1)!.account.toUpperCase(),
+        filterData: accounts[1].account.toUpperCase(),
       },
     });
   });
@@ -106,12 +132,12 @@ describe('EventAction', () => {
     const action = await loadFixture(cloneEventAction(fixtures, erc721));
     const steps = await action.getActionSteps();
     expect(steps.length).toBe(1);
-    const step = steps.at(0)!;
+    const step = steps[0]!;
     step.targetContract = step.targetContract.toUpperCase() as Hex;
     step.actionParameter.filterData =
       step.actionParameter.filterData.toUpperCase() as Hex;
     expect(step).toMatchObject({
-      signature: selectors['Transfer(address,address,uint256)'] as Hex,
+      signature: eventSelectors['Transfer(address,address,uint256)'] as Hex,
       signatureType: SignatureType.EVENT,
       actionType: 0,
       targetContract: erc721.assertValidAddress().toUpperCase(),
@@ -119,7 +145,7 @@ describe('EventAction', () => {
         filterType: FilterType.EQUAL,
         fieldType: PrimitiveType.ADDRESS,
         fieldIndex: 2,
-        filterData: accounts.at(1)!.account.toUpperCase(),
+        filterData: accounts[1].account.toUpperCase(),
       },
     });
   });
@@ -136,7 +162,7 @@ describe('EventAction', () => {
     claimant.targetContract = claimant.targetContract.toUpperCase() as Hex;
     expect(claimant).toMatchObject({
       signatureType: SignatureType.EVENT,
-      signature: selectors['Transfer(address,address,uint256)'] as Hex,
+      signature: eventSelectors['Transfer(address,address,uint256)'] as Hex,
       fieldIndex: 2,
       targetContract: erc721.assertValidAddress().toUpperCase(),
     });
@@ -149,7 +175,7 @@ describe('EventAction', () => {
 
   test('with a correct log, validates', async () => {
     const action = await loadFixture(cloneEventAction(fixtures, erc721));
-    const recipient = accounts.at(1)!.account;
+    const recipient = accounts[1].account;
     await erc721.approve(recipient, 1n);
     await erc721.transferFrom(defaultOptions.account.address, recipient, 1n);
     expect(await action.validateActionSteps()).toBe(true);