@boostxyz/sdk 0.0.0-alpha.9 → 1.1.0-alpha.22

package/src/index.test.ts

@@ -1,40 +1,122 @@
-import { describe, expect, test } from 'vitest';
-import * as SDK from './index';
+import { describe, expect, test } from "vitest";
+import * as SDK from "./index";
 
-describe('sdk exports', () => {
-  test(`should export all public API`, () => {
-    expect(SDK.BoostRegistry).toBeDefined();
-    expect(SDK.BoostCore).toBeDefined();
-    expect(SDK.Boost).toBeDefined();
-
-    // interfaces
-    expect(SDK.PassthroughAuth).toBeDefined();
-    // expect(SDK.ContractAction).toBeDefined();
-    // expect(SDK.ERC721MintAction).toBeDefined();
-    expect(SDK.SimpleAllowList).toBeDefined();
-    expect(SDK.SimpleDenyList).toBeDefined();
-    expect(SDK.ManagedBudget).toBeDefined();
-    // expect(SDK.SimpleBudget).toBeDefined();
-    // expect(SDK.VestingBudget).toBeDefined();
-    expect(SDK.AllowListIncentive).toBeDefined();
-    expect(SDK.CGDAIncentive).toBeDefined();
-    expect(SDK.ERC20Incentive).toBeDefined();
-    // expect(SDK.ERC1155Incentive).toBeDefined();
-    expect(SDK.PointsIncentive).toBeDefined();
-    expect(SDK.SignerValidator).toBeDefined();
+// Please add any public interface you'd like to verify exists on the root export here
+// Types don't exist in .js so only list objects, constants, classes, etc, no interfaces
+const allExports = [
+  "BoostRegistry",
+  "BoostCore",
+  "Boost",
+  "EventAction",
+  "OpenAllowList",
+  "SimpleAllowList",
+  "SimpleDenyList",
+  "ManagedBudget",
+  "Deployable",
+  "Contract",
+  "DeployableTarget",
+  "DeployableTargetWithRBAC",
+  "AllowListIncentive",
+  "CGDAIncentive",
+  "ERC20Incentive",
+  "ERC20VariableIncentive",
+  "ERC20VariableCriteriaIncentive",
+  "PointsIncentive",
+  "SignerValidator",
+  "BoostCoreNoIdentifierEmitted",
+  "ContractAddressRequiredError",
+  "DeployableAlreadyDeployedError",
+  "DeployableBuildParametersUnspecifiedError",
+  "DeployableUnknownOwnerProvidedError",
+  "DeployableWagmiConfigurationRequiredError",
+  "DeployableMissingPayloadError",
+  "NoContractAddressUponReceiptError",
+  "InvalidComponentInterfaceError",
+  "UnparseableAbiParamError",
+  "UnknownTransferPayloadSupplied",
+  "BudgetMustAuthorizeBoostCore",
+  "MustInitializeBudgetError",
+  "IncentiveNotCloneableError",
+  "NoEventActionStepsProvidedError",
+  "TooManyEventActionStepsProvidedError",
+  "ValidationAbiMissingError",
+  "FieldActionValidationError",
+  "DecodedArgsMalformedError",
+  "FieldValueUndefinedError",
+  "InvalidNumericalCriteriaError",
+  "FunctionDataDecodeError",
+  "FieldValueNotComparableError",
+  "UnrecognizedFilterTypeError",
+  "NoConnectedChainIdError",
+  "InvalidProtocolChainIdError",
+  "IncentiveCriteriaNotFoundError",
+  "NoMatchingLogsError",
+  "InvalidCriteriaTypeError",
+  "DecodedArgsError",
+  "PassthroughAuth",
+  "prepareBoostPayload",
+  "actionFromAddress",
+  "isEventActionPayloadSimple",
+  "prepareEventActionPayload",
+  "allowListFromAddress",
+  "prepareSimpleAllowListPayload",
+  "prepareSimpleDenyListPayload",
+  "budgetFromAddress",
+  "isFungibleTransfer",
+  "isERC1155TransferPayload",
+  "prepareTransfer",
+  "prepareManagedBudgetPayload",
+  "prepareAllowListIncentivePayload",
+  "prepareCGDAIncentivePayload",
+  "prepareERC20IncentivePayload",
+  "prepareERC20VariableIncentivePayload",
+  "prepareERC20VariableCriteriaIncentivePayload",
+  "incentiveFromAddress",
+  "preparePointsIncentivePayload",
+  "prepareSignerValidatorClaimDataPayload",
+  "prepareSignerValidatorInputParams",
+  "prepareSignerValidatorPayload",
+  "validatorFromAddress",
+  "bytes4",
+  "getDeployedContractAddress",
+  "awaitResult",
+  "assertValidAddressByChainId",
+  "prepareClaimPayload",
+  "prepareERC1155Payload",
+  "prepareERC1155Transfer",
+  "prepareFungiblePayload",
+  "prepareFungibleTransfer",
+  "prepareTransferPayload",
+  "BOOST_REGISTRY_ADDRESS",
+  "BOOST_REGISTRY_ADDRESSES",
+  "boostCoreAbi",
+  "boostRegistryAbi",
+  "BOOST_CORE_CLAIM_FEE",
+  "BOOST_CORE_ADDRESS",
+  "BOOST_CORE_ADDRESSES",
+  "ActionByComponentInterface",
+  "AllowListByComponentInterface",
+  "simpleAllowListAbi",
+  "LIST_MANAGER_ROLE",
+  "simpleDenyListAbi",
+  "BudgetByComponentInterface",
+  "managedBudgetAbi",
+  "rbacAbi",
+  "allowListIncentiveAbi",
+  "cgdaIncentiveAbi",
+  "erc20IncentiveAbi",
+  "erc20VariableIncentiveAbi",
+  "IncentiveByComponentInterface",
+  "pointsIncentiveAbi",
+  "signerValidatorAbi",
+  "ValidatorByComponentInterface",
+  "passthroughAuthAbi"
+]
 
-    // errors
-    expect(SDK.BoostCoreNoIdentifierEmitted).toBeDefined();
-    expect(SDK.ContractAddressRequiredError).toBeDefined();
-    expect(SDK.DeployableAlreadyDeployedError).toBeDefined();
-    expect(SDK.DeployableBuildParametersUnspecifiedError).toBeDefined();
-    expect(SDK.DeployableUnknownOwnerProvidedError).toBeDefined();
-    expect(SDK.DeployableWagmiConfigurationRequiredError).toBeDefined();
-    expect(SDK.DeployableMissingPayloadError).toBeDefined();
-    expect(SDK.NoContractAddressUponReceiptError).toBeDefined();
-    expect(SDK.InvalidComponentInterfaceError).toBeDefined();
-    expect(SDK.UnknownTransferPayloadSupplied).toBeDefined();
-    expect(SDK.BudgetMustAuthorizeBoostCore).toBeDefined();
-    expect(SDK.IncentiveNotCloneableError).toBeDefined();
+describe("SDK exports", () => {
+  test(`should export all public API`, () => {
+    for(let exp of allExports) {
+      expect((SDK as any)[exp]).toBeDefined()
+    }
   });
 });

package/src/index.ts

@@ -27,12 +27,15 @@ export * from './Budgets/ManagedBudget';
 export * from './Deployable/Deployable';
 export * from './Deployable/Contract';
 export * from './Deployable/DeployableTarget';
+export * from './Deployable/DeployableTargetWithRBAC';
 
 // Incentives
 
 export * from './Incentives/AllowListIncentive';
 export * from './Incentives/CGDAIncentive';
 export * from './Incentives/ERC20Incentive';
+export * from './Incentives/ERC20VariableIncentive';
+export * from './Incentives/ERC20VariableCriteriaIncentive';
 // export * from './Incentives/ERC1155Incentive';
 export * from './Incentives/Incentive';
 export * from './Incentives/PointsIncentive';
@@ -46,6 +49,8 @@ export * from './Validators/Validator';
 
 export * from './errors';
 export * from './utils';
+export * from './claiming';
+export * from './transfers';
 
 // Auth
 

package/src/transfers.ts

@@ -211,7 +211,7 @@ export interface FungiblePayload {
  * @export
  * @param {FungiblePayload} param0
  * @param {bigint} param0.amount - The amount being transferred
- * @returns {*}
+ * @returns {Hex}
  */
 export function prepareFungiblePayload({ amount }: FungiblePayload) {
   return encodeAbiParameters(

package/src/utils.test.ts

@@ -1,8 +1,8 @@
 import { simulateMockErc20Mint, writeMockErc20Mint } from '@boostxyz/evm';
 import { isAddress } from 'viem';
 import { describe, expect, test } from 'vitest';
-import { MockERC20 } from '../test/MockERC20';
-import { defaultOptions } from '../test/helpers';
+import { MockERC20 } from '@boostxyz/test/MockERC20';
+import { defaultOptions } from '@boostxyz/test/helpers';
 import { awaitResult, bytes4, getDeployedContractAddress } from './utils';
 
 describe('bytes4', () => {

package/src/utils.ts

@@ -3,12 +3,15 @@ import {
   type ReadContractParameters,
   type WatchContractEventParameters,
   type WriteContractParameters,
+  getAccount,
+  getClient,
   waitForTransactionReceipt,
 } from '@wagmi/core';
 import type { ExtractAbiEvent } from 'abitype';
 import type {
   Abi,
   AbiEvent,
+  Address,
   ContractEventName,
   ContractFunctionName,
   GetLogsParameters,
@@ -18,10 +21,28 @@ import type {
   WaitForTransactionReceiptParameters,
 } from 'viem';
 import { isHex, keccak256, slice, toHex } from 'viem';
-import { NoContractAddressUponReceiptError } from './errors';
+import {
+  InvalidProtocolChainIdError,
+  NoConnectedChainIdError,
+  NoContractAddressUponReceiptError,
+} from './errors';
 
 export type Overwrite<T, U> = Pick<T, Exclude<keyof T, keyof U>> & U;
 
+/**
+ * Enum encapsulating all the different types of targets used in the Boost V2 Protocol.
+ *
+ * @export
+ * @enum {number}
+ */
+export enum RegistryType {
+  ACTION = 0,
+  ALLOW_LIST = 1,
+  BUDGET = 2,
+  INCENTIVE = 3,
+  VALIDATOR = 4,
+}
+
 /**
  * Helper type that encapsulates common writeContract parameters without fields like `abi`, `args`, `functionName`, `address` that are expected to be provided the SDK.
  * See (writeContract)[https://viem.sh/docs/contract/writeContract]
@@ -32,8 +53,8 @@ export type Overwrite<T, U> = Pick<T, Exclude<keyof T, keyof U>> & U;
  * @template {ContractFunctionName<abi>} functionName
  */
 export type WriteParams<
-  abi extends Abi,
-  functionName extends ContractFunctionName<abi>,
+  abi extends Abi = Abi,
+  functionName extends ContractFunctionName<abi> = ContractFunctionName<abi>,
 > = Partial<
   Omit<
     WriteContractParameters<abi, functionName>,
@@ -133,7 +154,7 @@ export function bytes4(input: string) {
  * @param {WagmiConfig} config - [Wagmi Configuration](https://wagmi.sh/core/api/createConfig)
  * @param {Promise<Hash>} hash - A transaction hash promise
  * @param {?Omit<WaitForTransactionReceiptParameters, 'hash'>} [waitParams] - @see {@link WaitForTransactionReceiptParameters}
- * @returns {unknown}
+ * @returns {Promise<Address>}
  * @throws {@link NoContractAddressUponReceiptError} if no `contractAddress` exists after the transaction has been received
  */
 export async function getDeployedContractAddress(
@@ -184,15 +205,43 @@ export async function awaitResult<Result = unknown>(
 }
 
 /**
- * Enum encapsulating all the different types of targets used in the Boost V2 Protocol.
+ * Given a wagmi config and a map of chain id's to addresses, determine an address/chainId combo that maps to the currently connected chain id, or throw a typed error.
  *
  * @export
- * @enum {number}
+ * @param {Config} config
+ * @param {Record<string, Address>} addressByChainId
+ * @param {number} desiredChainId
+ * @returns {{ chainId: number, address: Address }}
+ * @throws {@link InvalidProtocolChainIdError}
  */
-export enum RegistryType {
-  ACTION = 0,
-  ALLOW_LIST = 1,
-  BUDGET = 2,
-  INCENTIVE = 3,
-  VALIDATOR = 4,
+export function assertValidAddressByChainId(
+  config: Config,
+  addressByChainId: Record<number, Address>,
+  desiredChainId?: number,
+): { chainId: number; address: Address } {
+  let chainId: number | undefined = undefined;
+  const wagmiAccount = getAccount(config);
+  // if manually providing a chain id for some contract operation, try to use it
+  if (desiredChainId !== undefined) {
+    if (addressByChainId[desiredChainId]) chainId = desiredChainId;
+  } else if (wagmiAccount.chainId !== undefined) {
+    // otherwise if we can get the current chain id off the connected account and it matches one of ours, use it
+    if (addressByChainId[wagmiAccount.chainId]) chainId = wagmiAccount.chainId;
+  }
+  // chainId is still undefined, try to get chain id off viem client
+  if (chainId === undefined) {
+    const client = getClient(config);
+    if (client?.chain.id && addressByChainId[client?.chain.id])
+      chainId = client.chain.id;
+  }
+  // if chainId is STILL undefined, use our default addresses
+  // TODO: update this when on prod network
+  if (chainId === undefined) chainId = Number(__DEFAULT_CHAIN_ID__);
+  if (!addressByChainId[chainId])
+    throw new InvalidProtocolChainIdError(
+      chainId,
+      Object.keys(addressByChainId).map(Number),
+    );
+  // biome-ignore lint/style/noNonNullAssertion: this type should be narrowed by the above statement but isn't?
+  return { chainId, address: addressByChainId[chainId]! };
 }

package/dist/Budgets/SimpleBudget.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"SimpleBudget.d.ts","sourceRoot":"","sources":["../../src/Budgets/SimpleBudget.ts"],"names":[],"mappings":"AAAA,OAAO,EAML,eAAe,EAWhB,MAAM,eAAe,CAAC;AAGvB,OAAO,EACL,KAAK,OAAO,EACZ,KAAK,iBAAiB,EAKvB,MAAM,MAAM,CAAC;AACd,OAAO,KAAK,EACV,iBAAiB,EACjB,uBAAuB,EACxB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,gBAAgB,EAAE,MAAM,gCAAgC,CAAC;AAKlE,OAAO,EACL,KAAK,sBAAsB,EAC3B,KAAK,uBAAuB,EAG7B,MAAM,cAAc,CAAC;AACtB,OAAO,EACL,KAAK,UAAU,EACf,KAAK,UAAU,EACf,YAAY,EACZ,KAAK,WAAW,EACjB,MAAM,UAAU,CAAC;AAElB,OAAO,EAAE,eAAe,EAAE,CAAC;AAC3B,YAAY,EAAE,sBAAsB,EAAE,uBAAuB,EAAE,CAAC;AAEhE;;;;;;GAMG;AACH,MAAM,WAAW,mBAAmB;IAClC;;;;OAIG;IACH,KAAK,EAAE,OAAO,CAAC;IACf;;;;OAIG;IACH,UAAU,EAAE,OAAO,EAAE,CAAC;CACvB;AAED;;;;;;;;GAQG;AACH,MAAM,MAAM,eAAe,CACzB,KAAK,SAAS,iBAAiB,CAAC,OAAO,eAAe,CAAC,GAAG,iBAAiB,CACzE,OAAO,eAAe,CACvB,IACC,UAAU,CAAC,OAAO,eAAe,EAAE,KAAK,CAAC,CAAC;AAE9C;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAChC,QAAQ,EAAE,uBAAuB,GAAG,sBAAsB,GACzD,QAAQ,IAAI,uBAAuB,CAErC;AAED;;;;;;GAMG;AACH,wBAAgB,wBAAwB,CACtC,QAAQ,EAAE,uBAAuB,GAAG,sBAAsB,GACzD,QAAQ,IAAI,sBAAsB,CAEpC;AAED;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAC7B,QAAQ,EAAE,uBAAuB,GAAG,sBAAsB,iBAO3D;AAED;;;;;;;;GAQG;AACH,qBAAa,YAAa,SAAQ,gBAAgB,CAChD,mBAAmB,EACnB,OAAO,eAAe,CACvB;IACC,SAAyB,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAAmB;IAC/C;;;;;;OAMG;IACH,OAAuB,IAAI,EAAE,OAAO,CACT;IAC3B;;;;;;OAMG;IACH,OAAuB,YAAY,EAAE,YAAY,CAAuB;IAExE;;;;;;;;;;OAUG;IACU,QAAQ,CACnB,QAAQ,EAAE,uBAAuB,GAAG,sBAAsB,EAC1D,MAAM,CAAC,EAAE,WAAW,CAAC,OAAO,eAAe,EAAE,UAAU,CAAC;IAK1D;;;;;;;;;;OAUG;IACU,WAAW,CACtB,QAAQ,EAAE,uBAAuB,GAAG,sBAAsB,EAC1D,MAAM,CAAC,EAAE,WAAW,CAAC,OAAO,eAAe,EAAE,UAAU,CAAC;;;;IAgB1D;;;;;;;;;;;OAWG;IACU,QAAQ,CACnB,QAAQ,EAAE,uBAAuB,GAAG,sBAAsB,EAC1D,MAAM,CAAC,EAAE,WAAW,CAAC,OAAO,eAAe,EAAE,UAAU,CAAC;IAK1D;;;;;;;;;;;OAWG;IACU,WAAW,CACtB,QAAQ,EAAE,uBAAuB,GAAG,sBAAsB,EAC1D,MAAM,CAAC,EAAE,WAAW,CAAC,OAAO,eAAe,EAAE,UAAU,CAAC;;;;IAgB1D;;;;;;;;;OASG;IACU,QAAQ,CACnB,QAAQ,EAAE,uBAAuB,GAAG,sBAAsB,EAC1D,MAAM,CAAC,EAAE,WAAW,CAAC,OAAO,eAAe,EAAE,UAAU,CAAC;IAK1D;;;;;;;;;OASG;IACU,WAAW,CACtB,QAAQ,EAAE,uBAAuB,GAAG,sBAAsB,EAC1D,MAAM,CAAC,EAAE,WAAW,CAAC,OAAO,eAAe,EAAE,UAAU,CAAC;;;;IAgB1D;;;;;;;;OAQG;IACU,aAAa,CACxB,SAAS,EAAE,KAAK,CAAC,uBAAuB,GAAG,sBAAsB,CAAC,EAClE,MAAM,CAAC,EAAE,WAAW,CAAC,OAAO,eAAe,EAAE,eAAe,CAAC;IAK/D;;;;;;;;OAQG;IACU,gBAAgB,CAC3B,SAAS,EAAE,KAAK,CAAC,uBAAuB,GAAG,sBAAsB,CAAC,EAClE,MAAM,CAAC,EAAE,WAAW,CAAC,OAAO,eAAe,EAAE,eAAe,CAAC;;;;IAgB/D;;;;;;;;;;OAUG;IACU,aAAa,CACxB,SAAS,EAAE,OAAO,EAAE,EACpB,OAAO,EAAE,OAAO,EAAE,EAClB,MAAM,CAAC,EAAE,WAAW,CAAC,OAAO,eAAe,EAAE,eAAe,CAAC;IAO/D;;;;;;;;;;OAUG;IACU,gBAAgB,CAC3B,SAAS,EAAE,OAAO,EAAE,EACpB,OAAO,EAAE,OAAO,EAAE,EAClB,MAAM,CAAC,EAAE,WAAW,CAAC,OAAO,eAAe,EAAE,eAAe,CAAC;;;;IAgB/D;;;;;;;OAOG;IACI,YAAY,CACjB,OAAO,EAAE,OAAO,EAChB,MAAM,CAAC,EAAE,UAAU,CAAC,OAAO,eAAe,EAAE,cAAc,CAAC;IAW7D;;;;;;OAMG;IACI,KAAK,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC,OAAO,eAAe,EAAE,OAAO,CAAC;IASjE;;;;;;;;;OASG;IACI,KAAK,CACV,KAAK,EAAE,OAAO,EACd,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,EAC5B,MAAM,CAAC,EAAE,UAAU,CAAC,OAAO,eAAe,EAAE,OAAO,CAAC;IAUtD;;;;;;;;;OASG;IACI,SAAS,CACd,KAAK,EAAE,OAAO,EACd,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,EAC5B,MAAM,CAAC,EAAE,UAAU,CAAC,OAAO,eAAe,EAAE,WAAW,CAAC;IAU1D;;;;;;;;;OASG;IACI,WAAW,CAChB,KAAK,EAAE,OAAO,EACd,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,EAC5B,MAAM,CAAC,EAAE,UAAU,CAAC,OAAO,eAAe,EAAE,aAAa,CAAC;IAU5D;;;;;;;OAOG;IACa,eAAe,CAC7B,QAAQ,CAAC,EAAE,mBAAmB,EAC9B,QAAQ,CAAC,EAAE,iBAAiB,GAC3B,uBAAuB;CAwB3B;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,0BAA0B,2BAGpC,mBAAmB,kBAQrB,CAAC"}

package/dist/componentInterfaces-CKCBwG16.cjs

@@ -1,2 +0,0 @@
-"use strict";const e="0xa39e44d9",n="0x8c901437",t="0x6060409d",i="0x7687b0ed",c="0xa0109882",A="0xc5b24b8e",o="0xb8ce7b22",s="0x8ba1fc24",a="0x3d30a22c";exports.ACGDAIncentive=e;exports.AERC20Incentive=n;exports.AERC20VariableIncentive=t;exports.AEventAction=i;exports.AManagedBudget=c;exports.APointsIncentive=A;exports.ASignerValidator=o;exports.ASimpleAllowList=s;exports.ASimpleDenyList=a;
-//# sourceMappingURL=componentInterfaces-CKCBwG16.cjs.map

package/dist/componentInterfaces-CKCBwG16.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"componentInterfaces-CKCBwG16.cjs","sources":[],"sourcesContent":[],"names":[],"mappings":""}

package/dist/componentInterfaces-DYkaxBda.js

@@ -1,13 +0,0 @@
-const n = "0xa39e44d9", e = "0x8c901437", s = "0x6060409d", t = "0x7687b0ed", a = "0xa0109882", c = "0xc5b24b8e", o = "0xb8ce7b22", i = "0x8ba1fc24", A = "0x3d30a22c";
-export {
-  t as A,
-  i as a,
-  A as b,
-  a as c,
-  o as d,
-  c as e,
-  e as f,
-  n as g,
-  s as h
-};
-//# sourceMappingURL=componentInterfaces-DYkaxBda.js.map

package/dist/componentInterfaces-DYkaxBda.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"componentInterfaces-DYkaxBda.js","sources":[],"sourcesContent":[],"names":[],"mappings":";"}