@boostxyz/sdk 0.0.0-alpha.2

package/dist/Actions/Action.cjs

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const i=require("../generated-BaaleHW-.cjs"),a=require("@wagmi/core"),s=require("../errors.cjs"),c=require("./EventAction.cjs"),e={"0x7687b0ed":c.EventAction};async function f(n,t){const o=await a.readContract(n.config,{abi:i.X,functionName:"getComponentInterface",address:t}),r=e[o];if(!r)throw new s.InvalidComponentInterfaceError(Object.keys(e),o);return new r(n,t)}exports.EventAction=c.EventAction;exports.ActionByComponentInterface=e;exports.actionFromAddress=f;

package/dist/Actions/Action.d.ts

@@ -0,0 +1,31 @@
+import type { Address } from 'viem';
+import type { DeployableOptions } from '../Deployable/Deployable';
+import { EventAction } from './EventAction';
+export { EventAction, };
+/**
+ * A union type representing all valid protocol Action implementations
+ *
+ * @export
+ * @typedef {Action}
+ */
+export type Action = EventAction;
+/**
+ * A map of Action component interfaces to their constructors.
+ *
+ * @type {{ "0x7687b0ed": EventAction; }}
+ */
+export declare const ActionByComponentInterface: {
+    "0x7687b0ed": typeof 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 declare function actionFromAddress(options: DeployableOptions, address: Address): Promise<EventAction>;
+//# sourceMappingURL=Action.d.ts.map

package/dist/Actions/Action.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Action.d.ts","sourceRoot":"","sources":["../../src/Actions/Action.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAO,MAAM,MAAM,CAAC;AACzC,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAElE,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C,OAAO,EAGL,WAAW,GACZ,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,MAAM,GAAG,WAAW,CAAC;AAEjC;;;;GAIG;AACH,eAAO,MAAM,0BAA0B;;CAItC,CAAC;AAEF;;;;;;;;;GASG;AACH,wBAAsB,iBAAiB,CACrC,OAAO,EAAE,iBAAiB,EAC1B,OAAO,EAAE,OAAO,wBAejB"}

package/dist/Actions/Action.js

@@ -0,0 +1,27 @@
+import { X as c } from "../generated-x_abr3Yv.js";
+import { readContract as i } from "@wagmi/core";
+import { InvalidComponentInterfaceError as m } from "../errors.js";
+import { EventAction as a } from "./EventAction.js";
+const e = {
+  // ['0x6c3129aa']: ContractAction,
+  // ['0x97e083eb']: ERC721MintAction,
+  "0x7687b0ed": a
+};
+async function d(t, n) {
+  const o = await i(t.config, {
+    abi: c,
+    functionName: "getComponentInterface",
+    address: n
+  }), r = e[o];
+  if (!r)
+    throw new m(
+      Object.keys(e),
+      o
+    );
+  return new r(t, n);
+}
+export {
+  e as ActionByComponentInterface,
+  a as EventAction,
+  d as actionFromAddress
+};

package/dist/Actions/ContractAction.d.ts

@@ -0,0 +1,327 @@
+import { contractActionAbi } from '@boostxyz/evm';
+import type { Abi, Address, ContractEventName, Hex } from 'viem';
+import type { DeployableOptions, GenericDeployableParams } from '../Deployable/Deployable';
+import { DeployableTarget } from '../Deployable/DeployableTarget';
+import { type ContractActionPayload, type GenericLog, type ReadParams, RegistryType, type WriteParams } from '../utils';
+export { contractActionAbi };
+export type { ContractActionPayload };
+/**
+ * A generic `viem.Log` event with support for `ContractAction` event types.
+ *
+ * @export
+ * @typedef {ContractActionLog}
+ * @template {ContractEventName<typeof contractActionAbi>} [event=ContractEventName<
+ *     typeof contractActionAbi
+ *   >]
+ */
+export type ContractActionLog<event extends ContractEventName<typeof contractActionAbi> = ContractEventName<typeof contractActionAbi>> = GenericLog<typeof contractActionAbi, event>;
+/**
+ * A generic contract action
+ *
+ * @export
+ * @class ContractAction
+ * @typedef {ContractAction}
+ * @extends {DeployableTarget<ContractActionPayload>}
+ */
+export declare class ContractAction<ContractActionAbi extends Abi = typeof contractActionAbi> extends DeployableTarget<ContractActionPayload, ContractActionAbi> {
+    readonly abi: readonly [{
+        readonly type: "constructor";
+        readonly inputs: readonly [];
+        readonly stateMutability: "nonpayable";
+    }, {
+        readonly type: "error";
+        readonly inputs: readonly [];
+        readonly name: "CloneAlreadyInitialized";
+    }, {
+        readonly type: "error";
+        readonly inputs: readonly [];
+        readonly name: "InitializerNotImplemented";
+    }, {
+        readonly type: "error";
+        readonly inputs: readonly [];
+        readonly name: "InvalidInitialization";
+    }, {
+        readonly type: "error";
+        readonly inputs: readonly [];
+        readonly name: "InvalidInitializationData";
+    }, {
+        readonly type: "error";
+        readonly inputs: readonly [];
+        readonly name: "NotInitializing";
+    }, {
+        readonly type: "error";
+        readonly inputs: readonly [{
+            readonly name: "targetChainId";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }];
+        readonly name: "TargetChainUnsupported";
+    }, {
+        readonly type: "event";
+        readonly anonymous: false;
+        readonly inputs: readonly [{
+            readonly name: "executor";
+            readonly internalType: "address";
+            readonly type: "address";
+            readonly indexed: true;
+        }, {
+            readonly name: "caller";
+            readonly internalType: "address";
+            readonly type: "address";
+            readonly indexed: false;
+        }, {
+            readonly name: "success";
+            readonly internalType: "bool";
+            readonly type: "bool";
+            readonly indexed: false;
+        }, {
+            readonly name: "data";
+            readonly internalType: "bytes";
+            readonly type: "bytes";
+            readonly indexed: false;
+        }];
+        readonly name: "ActionExecuted";
+    }, {
+        readonly type: "event";
+        readonly anonymous: false;
+        readonly inputs: readonly [{
+            readonly name: "user";
+            readonly internalType: "address";
+            readonly type: "address";
+            readonly indexed: true;
+        }, {
+            readonly name: "isValidated";
+            readonly internalType: "bool";
+            readonly type: "bool";
+            readonly indexed: false;
+        }, {
+            readonly name: "data";
+            readonly internalType: "bytes";
+            readonly type: "bytes";
+            readonly indexed: false;
+        }];
+        readonly name: "ActionValidated";
+    }, {
+        readonly type: "event";
+        readonly anonymous: false;
+        readonly inputs: readonly [{
+            readonly name: "version";
+            readonly internalType: "uint64";
+            readonly type: "uint64";
+            readonly indexed: false;
+        }];
+        readonly name: "Initialized";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [];
+        readonly name: "VALIDATOR";
+        readonly outputs: readonly [{
+            readonly name: "";
+            readonly internalType: "contract AValidator";
+            readonly type: "address";
+        }];
+        readonly stateMutability: "view";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [];
+        readonly name: "chainId";
+        readonly outputs: readonly [{
+            readonly name: "";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }];
+        readonly stateMutability: "view";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [{
+            readonly name: "data_";
+            readonly internalType: "bytes";
+            readonly type: "bytes";
+        }];
+        readonly name: "execute";
+        readonly outputs: readonly [{
+            readonly name: "";
+            readonly internalType: "bool";
+            readonly type: "bool";
+        }, {
+            readonly name: "";
+            readonly internalType: "bytes";
+            readonly type: "bytes";
+        }];
+        readonly stateMutability: "payable";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [];
+        readonly name: "getComponentInterface";
+        readonly outputs: readonly [{
+            readonly name: "";
+            readonly internalType: "bytes4";
+            readonly type: "bytes4";
+        }];
+        readonly stateMutability: "pure";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [{
+            readonly name: "data_";
+            readonly internalType: "bytes";
+            readonly type: "bytes";
+        }];
+        readonly name: "initialize";
+        readonly outputs: readonly [];
+        readonly stateMutability: "nonpayable";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [{
+            readonly name: "data_";
+            readonly internalType: "bytes";
+            readonly type: "bytes";
+        }];
+        readonly name: "prepare";
+        readonly outputs: readonly [{
+            readonly name: "bytes_";
+            readonly internalType: "bytes";
+            readonly type: "bytes";
+        }];
+        readonly stateMutability: "view";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [];
+        readonly name: "selector";
+        readonly outputs: readonly [{
+            readonly name: "";
+            readonly internalType: "bytes4";
+            readonly type: "bytes4";
+        }];
+        readonly stateMutability: "view";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [{
+            readonly name: "interfaceId";
+            readonly internalType: "bytes4";
+            readonly type: "bytes4";
+        }];
+        readonly name: "supportsInterface";
+        readonly outputs: readonly [{
+            readonly name: "";
+            readonly internalType: "bool";
+            readonly type: "bool";
+        }];
+        readonly stateMutability: "view";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [];
+        readonly name: "target";
+        readonly outputs: readonly [{
+            readonly name: "";
+            readonly internalType: "address";
+            readonly type: "address";
+        }];
+        readonly stateMutability: "view";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [];
+        readonly name: "value";
+        readonly outputs: readonly [{
+            readonly name: "";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }];
+        readonly stateMutability: "view";
+    }];
+    /**
+     * @inheritdoc
+     *
+     * @public
+     * @static
+     * @type {Address}
+     */
+    static base: Address;
+    /**
+     * @inheritdoc
+     *
+     * @public
+     * @static
+     * @type {RegistryType}
+     */
+    static registryType: RegistryType;
+    /**
+     * The target chain ID
+     *
+     * @public
+     * @async
+     * @param {?ReadParams<typeof contractActionAbi, 'chainId'>} [params]
+     * @returns {Promise<bigint>}
+     */
+    chainId(params?: ReadParams<typeof contractActionAbi, 'chainId'>): Promise<bigint>;
+    /**
+     * The target contract
+     *
+     * @public
+     * @async
+     * @param {?ReadParams<typeof contractActionAbi, 'target'>} [params]
+     * @returns {Promise<`0x${string}`>}
+     */
+    target(params?: ReadParams<typeof contractActionAbi, 'target'>): Promise<`0x${string}`>;
+    /**
+     * The selector for the function to be called
+     *
+     * @example `function mint(address to, uint256 amount)`
+     * @public
+     * @async
+     * @param {?ReadParams<typeof contractActionAbi, 'selector'>} [params]
+     * @returns {Promise<`0x${string}`>}
+     */
+    selector(params?: ReadParams<typeof contractActionAbi, 'selector'>): Promise<`0x${string}`>;
+    /**
+     * The native token value to send with the function call
+     *
+     * @public
+     * @async
+     * @param {?ReadParams<typeof contractActionAbi, 'value'>} [params]
+     * @returns {Promise<bigint>}
+     */
+    value(params?: ReadParams<typeof contractActionAbi, 'value'>): Promise<bigint>;
+    /**
+     * Executes a prepared contract action
+     *
+     * @public
+     * @async
+     * @param {Hex} data
+     * @param {?WriteParams<typeof contractActionAbi, 'execute'>} [params]
+     * @returns {Promise<readonly [boolean, `0x${string}`]>}
+     */
+    execute(data: Hex, params?: WriteParams<typeof contractActionAbi, 'execute'>): Promise<readonly [boolean, `0x${string}`]>;
+    /**
+     * Executes a prepared contract action
+     *
+     * @public
+     * @async
+     * @param {Hex} data
+     * @param {?WriteParams<typeof contractActionAbi, 'execute'>} [params]
+     * @returns {unknown}
+     */
+    executeRaw(data: Hex, params?: WriteParams<typeof contractActionAbi, 'execute'>): Promise<{
+        hash: `0x${string}`;
+        result: readonly [boolean, `0x${string}`];
+    }>;
+    /**
+     * The encoded execution payload
+     *
+     * @public
+     * @async
+     * @param {Hex} calldata
+     * @param {?ReadParams<typeof contractActionAbi, 'prepare'>} [params]
+     * @returns {unknown}
+     */
+    prepare(calldata: Hex, params?: ReadParams<typeof contractActionAbi, 'prepare'>): Promise<`0x${string}`>;
+    /**
+     * @inheritdoc
+     *
+     * @public
+     * @param {?ContractActionPayload} [_payload]
+     * @param {?DeployableOptions} [_options]
+     * @returns {GenericDeployableParams}
+     */
+    buildParameters(_payload?: ContractActionPayload, _options?: DeployableOptions): GenericDeployableParams;
+}
+//# sourceMappingURL=ContractAction.d.ts.map

package/dist/Actions/ContractAction.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ContractAction.d.ts","sourceRoot":"","sources":["../../src/Actions/ContractAction.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,iBAAiB,EAQlB,MAAM,eAAe,CAAC;AAEvB,OAAO,KAAK,EAAE,GAAG,EAAE,OAAO,EAAE,iBAAiB,EAAE,GAAG,EAAE,MAAM,MAAM,CAAC;AACjE,OAAO,KAAK,EACV,iBAAiB,EACjB,uBAAuB,EACxB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,gBAAgB,EAAE,MAAM,gCAAgC,CAAC;AAClE,OAAO,EACL,KAAK,qBAAqB,EAC1B,KAAK,UAAU,EACf,KAAK,UAAU,EACf,YAAY,EACZ,KAAK,WAAW,EAEjB,MAAM,UAAU,CAAC;AAElB,OAAO,EAAE,iBAAiB,EAAE,CAAC;AAC7B,YAAY,EAAE,qBAAqB,EAAE,CAAC;AAEtC;;;;;;;;GAQG;AACH,MAAM,MAAM,iBAAiB,CAC3B,KAAK,SAAS,iBAAiB,CAAC,OAAO,iBAAiB,CAAC,GAAG,iBAAiB,CAC3E,OAAO,iBAAiB,CACzB,IACC,UAAU,CAAC,OAAO,iBAAiB,EAAE,KAAK,CAAC,CAAC;AAEhD;;;;;;;GAOG;AACH,qBAAa,cAAc,CACzB,iBAAiB,SAAS,GAAG,GAAG,OAAO,iBAAiB,CACxD,SAAQ,gBAAgB,CAAC,qBAAqB,EAAE,iBAAiB,CAAC;IAElE,SAAyB,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAAqB;IAEjD;;;;;;OAMG;IACH,OAAuB,IAAI,EAAE,OAAO,CACP;IAC7B;;;;;;OAMG;IACH,OAAuB,YAAY,EAAE,YAAY,CAAuB;IAExE;;;;;;;OAOG;IACU,OAAO,CAClB,MAAM,CAAC,EAAE,UAAU,CAAC,OAAO,iBAAiB,EAAE,SAAS,CAAC;IAU1D;;;;;;;OAOG;IACU,MAAM,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC,OAAO,iBAAiB,EAAE,QAAQ,CAAC;IAS3E;;;;;;;;OAQG;IACU,QAAQ,CACnB,MAAM,CAAC,EAAE,UAAU,CAAC,OAAO,iBAAiB,EAAE,UAAU,CAAC;IAU3D;;;;;;;OAOG;IACU,KAAK,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC,OAAO,iBAAiB,EAAE,OAAO,CAAC;IASzE;;;;;;;;OAQG;IACU,OAAO,CAClB,IAAI,EAAE,GAAG,EACT,MAAM,CAAC,EAAE,WAAW,CAAC,OAAO,iBAAiB,EAAE,SAAS,CAAC;IAK3D;;;;;;;;OAQG;IACU,UAAU,CACrB,IAAI,EAAE,GAAG,EACT,MAAM,CAAC,EAAE,WAAW,CAAC,OAAO,iBAAiB,EAAE,SAAS,CAAC;;;;IAgB3D;;;;;;;;OAQG;IACU,OAAO,CAClB,QAAQ,EAAE,GAAG,EACb,MAAM,CAAC,EAAE,UAAU,CAAC,OAAO,iBAAiB,EAAE,SAAS,CAAC;IAW1D;;;;;;;OAOG;IACa,eAAe,CAC7B,QAAQ,CAAC,EAAE,qBAAqB,EAChC,QAAQ,CAAC,EAAE,iBAAiB,GAC3B,uBAAuB;CAY3B"}