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

package/dist/Budgets/VestingBudget.d.ts

@@ -1,10 +1,50 @@
 import { vestingBudgetAbi } from '@boostxyz/evm';
 import { type Address, type ContractEventName } from 'viem';
 import type { DeployableOptions, GenericDeployableParams } from '../Deployable/Deployable';
-import { DeployableTarget } from '../Deployable/DeployableTarget';
-import { type FungibleTransferPayload, type GenericLog, type ReadParams, RegistryType, type VestingBudgetPayload, type WriteParams } from '../utils';
+import { DeployableTargetWithRBAC } from '../Deployable/DeployableTargetWithRBAC';
+import { type FungibleTransferPayload } from '../transfers';
+import { type GenericLog, type ReadParams, RegistryType, type WriteParams } from '../utils';
 export { vestingBudgetAbi };
-export type { VestingBudgetPayload };
+export type { FungibleTransferPayload };
+/**
+ * The object representation of a `VestingBudget.InitPayload`
+ *
+ * @export
+ * @interface VestingBudgetPayload
+ * @typedef {VestingBudgetPayload}
+ */
+export interface VestingBudgetPayload {
+    /**
+     * The budget's owner.
+     *
+     * @type {Address}
+     */
+    owner: Address;
+    /**
+     * List of accounts authorized to use the budget. This list should include a Boost core address to interact with the protocol.
+     *
+     * @type {Address[]}
+     */
+    authorized: Address[];
+    /**
+     * The timestamp at which the vesting schedule begins
+     *
+     * @type {bigint}
+     */
+    start: bigint;
+    /**
+     * The duration of the vesting schedule (in seconds)
+     *
+     * @type {bigint}
+     */
+    duration: bigint;
+    /**
+     * The duration of the cliff period (in seconds)
+     *
+     * @type {bigint}
+     */
+    cliff: bigint;
+}
 /**
  * A generic `viem.Log` event with support for `VestingBudget` event types.
  *
@@ -26,9 +66,9 @@ export type VestingBudgetLog<event extends ContractEventName<typeof vestingBudge
  * @export
  * @class VestingBudget
  * @typedef {VestingBudget}
- * @extends {DeployableTarget<VestingBudgetPayload>}
+ * @extends {DeployableTargetWithRBAC<VestingBudgetPayload>}
  */
-export declare class VestingBudget extends DeployableTarget<VestingBudgetPayload, typeof vestingBudgetAbi> {
+export declare class VestingBudget extends DeployableTargetWithRBAC<VestingBudgetPayload, typeof vestingBudgetAbi> {
     readonly abi: readonly [{
         readonly type: "constructor";
         readonly inputs: readonly [];
@@ -126,20 +166,9 @@ export declare class VestingBudget extends DeployableTarget<VestingBudgetPayload
         readonly inputs: readonly [];
         readonly name: "Unauthorized";
     }, {
-        readonly type: "event";
-        readonly anonymous: false;
-        readonly inputs: readonly [{
-            readonly name: "account";
-            readonly internalType: "address";
-            readonly type: "address";
-            readonly indexed: true;
-        }, {
-            readonly name: "isAuthorized";
-            readonly internalType: "bool";
-            readonly type: "bool";
-            readonly indexed: false;
-        }];
-        readonly name: "Authorized";
+        readonly type: "error";
+        readonly inputs: readonly [];
+        readonly name: "Unauthorized";
     }, {
         readonly type: "event";
         readonly anonymous: false;
@@ -205,9 +234,44 @@ export declare class VestingBudget extends DeployableTarget<VestingBudgetPayload
             readonly indexed: true;
         }];
         readonly name: "OwnershipTransferred";
+    }, {
+        readonly type: "event";
+        readonly anonymous: false;
+        readonly inputs: readonly [{
+            readonly name: "user";
+            readonly internalType: "address";
+            readonly type: "address";
+            readonly indexed: true;
+        }, {
+            readonly name: "roles";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+            readonly indexed: true;
+        }];
+        readonly name: "RolesUpdated";
     }, {
         readonly type: "fallback";
         readonly stateMutability: "payable";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [];
+        readonly name: "ADMIN_ROLE";
+        readonly outputs: readonly [{
+            readonly name: "";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }];
+        readonly stateMutability: "view";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [];
+        readonly name: "MANAGER_ROLE";
+        readonly outputs: readonly [{
+            readonly name: "";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }];
+        readonly stateMutability: "view";
     }, {
         readonly type: "function";
         readonly inputs: readonly [{
@@ -252,8 +316,38 @@ export declare class VestingBudget extends DeployableTarget<VestingBudgetPayload
         readonly name: "clawback";
         readonly outputs: readonly [{
             readonly name: "";
-            readonly internalType: "bool";
-            readonly type: "bool";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }];
+        readonly stateMutability: "nonpayable";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [{
+            readonly name: "target";
+            readonly internalType: "address";
+            readonly type: "address";
+        }, {
+            readonly name: "data_";
+            readonly internalType: "bytes";
+            readonly type: "bytes";
+        }, {
+            readonly name: "boostId";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }, {
+            readonly name: "incentiveId";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }];
+        readonly name: "clawbackFromTarget";
+        readonly outputs: readonly [{
+            readonly name: "";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }, {
+            readonly name: "";
+            readonly internalType: "address";
+            readonly type: "address";
         }];
         readonly stateMutability: "nonpayable";
     }, {
@@ -348,6 +442,70 @@ export declare class VestingBudget extends DeployableTarget<VestingBudgetPayload
             readonly type: "bytes4";
         }];
         readonly stateMutability: "pure";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [{
+            readonly name: "user";
+            readonly internalType: "address";
+            readonly type: "address";
+        }, {
+            readonly name: "roles";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }];
+        readonly name: "grantRoles";
+        readonly outputs: readonly [];
+        readonly stateMutability: "payable";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [{
+            readonly name: "accounts_";
+            readonly internalType: "address[]";
+            readonly type: "address[]";
+        }, {
+            readonly name: "roles_";
+            readonly internalType: "uint256[]";
+            readonly type: "uint256[]";
+        }];
+        readonly name: "grantRoles";
+        readonly outputs: readonly [];
+        readonly stateMutability: "nonpayable";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [{
+            readonly name: "user";
+            readonly internalType: "address";
+            readonly type: "address";
+        }, {
+            readonly name: "roles";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }];
+        readonly name: "hasAllRoles";
+        readonly outputs: readonly [{
+            readonly name: "";
+            readonly internalType: "bool";
+            readonly type: "bool";
+        }];
+        readonly stateMutability: "view";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [{
+            readonly name: "user";
+            readonly internalType: "address";
+            readonly type: "address";
+        }, {
+            readonly name: "roles";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }];
+        readonly name: "hasAnyRole";
+        readonly outputs: readonly [{
+            readonly name: "";
+            readonly internalType: "bool";
+            readonly type: "bool";
+        }];
+        readonly stateMutability: "view";
     }, {
         readonly type: "function";
         readonly inputs: readonly [{
@@ -416,6 +574,16 @@ export declare class VestingBudget extends DeployableTarget<VestingBudgetPayload
         readonly name: "renounceOwnership";
         readonly outputs: readonly [];
         readonly stateMutability: "payable";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [{
+            readonly name: "roles";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }];
+        readonly name: "renounceRoles";
+        readonly outputs: readonly [];
+        readonly stateMutability: "payable";
     }, {
         readonly type: "function";
         readonly inputs: readonly [];
@@ -425,7 +593,49 @@ export declare class VestingBudget extends DeployableTarget<VestingBudgetPayload
     }, {
         readonly type: "function";
         readonly inputs: readonly [{
-            readonly name: "account_";
+            readonly name: "user";
+            readonly internalType: "address";
+            readonly type: "address";
+        }, {
+            readonly name: "roles";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }];
+        readonly name: "revokeRoles";
+        readonly outputs: readonly [];
+        readonly stateMutability: "payable";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [{
+            readonly name: "accounts_";
+            readonly internalType: "address[]";
+            readonly type: "address[]";
+        }, {
+            readonly name: "roles_";
+            readonly internalType: "uint256[]";
+            readonly type: "uint256[]";
+        }];
+        readonly name: "revokeRoles";
+        readonly outputs: readonly [];
+        readonly stateMutability: "nonpayable";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [{
+            readonly name: "user";
+            readonly internalType: "address";
+            readonly type: "address";
+        }];
+        readonly name: "rolesOf";
+        readonly outputs: readonly [{
+            readonly name: "roles";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }];
+        readonly stateMutability: "view";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [{
+            readonly name: "accounts_";
             readonly internalType: "address[]";
             readonly type: "address[]";
         }, {
@@ -493,9 +703,9 @@ export declare class VestingBudget extends DeployableTarget<VestingBudgetPayload
      *
      * @public
      * @static
-     * @type {Address}
+     * @type {Record<number, Address>}
      */
-    static base: Address;
+    static bases: Record<number, Address>;
     /**
      * @inheritdoc
      *
@@ -508,7 +718,7 @@ export declare class VestingBudget extends DeployableTarget<VestingBudgetPayload
      * Get the owner of the budget
      *
      * @public
-     * @param {?ReadParams<typeof vestingBudgetAbi, 'owner'>} [params]
+     * @param {?ReadParams} [params]
      * @returns {Promise<Address>}
      */
     owner(params?: ReadParams<typeof vestingBudgetAbi, 'owner'>): Promise<`0x${string}`>;
@@ -516,24 +726,24 @@ export declare class VestingBudget extends DeployableTarget<VestingBudgetPayload
      * The timestamp at which the vesting schedule begins
      *
      * @public
-     * @param {?ReadParams<typeof vestingBudgetAbi, 'start'>} [params]
-     * @returns {*}
+     * @param {?ReadParams} [params]
+     * @returns {Promise<bigint>}
      */
     start(params?: ReadParams<typeof vestingBudgetAbi, 'start'>): Promise<bigint>;
     /**
      * The duration of the vesting schedule (in seconds)
      *
      * @public
-     * @param {?ReadParams<typeof vestingBudgetAbi, 'duration'>} [params]
-     * @returns {*}
+     * @param {?ReadParams} [params]
+     * @returns {Promise<bigint>}
      */
     duration(params?: ReadParams<typeof vestingBudgetAbi, 'duration'>): Promise<bigint>;
     /**
      * The duration of the cliff period (in seconds)
      *
      * @public
-     * @param {?ReadParams<typeof vestingBudgetAbi, 'cliff'>} [params]
-     * @returns {*}
+     * @param {?ReadParams} [params]
+     * @returns {Promise<bigint>}
      */
     cliff(params?: ReadParams<typeof vestingBudgetAbi, 'cliff'>): Promise<bigint>;
     /**
@@ -544,7 +754,7 @@ export declare class VestingBudget extends DeployableTarget<VestingBudgetPayload
      * @public
      * @async
      * @param {(FungibleTransferPayload)} transfer
-     * @param {?WriteParams<typeof vestingBudgetAbi, 'allocate'>} [params]
+     * @param {?WriteParams} [params]
      * @returns {Promise<boolean>} - True if the allocation was successful
      */
     allocate(transfer: FungibleTransferPayload, params?: WriteParams<typeof vestingBudgetAbi, 'allocate'>): Promise<boolean>;
@@ -556,8 +766,8 @@ export declare class VestingBudget extends DeployableTarget<VestingBudgetPayload
      * @public
      * @async
      * @param {(FungibleTransferPayload)} transfer
-     * @param {?WriteParams<typeof vestingBudgetAbi, 'allocate'>} [params]
-     * @returns {Promise<boolean>} - True if the allocation was successful
+     * @param {?WriteParams} [params]
+     * @returns {Promise<{ hash: `0x${string}`; result: boolean; }>} - True if the allocation was successful
      */
     allocateRaw(transfer: FungibleTransferPayload, params?: WriteParams<typeof vestingBudgetAbi, 'allocate'>): Promise<{
         hash: `0x${string}`;
@@ -572,10 +782,10 @@ export declare class VestingBudget extends DeployableTarget<VestingBudgetPayload
      * @public
      * @async
      * @param {(FungibleTransferPayload)} transfer
-     * @param {?WriteParams<typeof vestingBudgetAbi, 'clawback'>} [params]
+     * @param {?WriteParams} [params]
      * @returns {Promise<boolean>} - True if the request was successful
      */
-    clawback(transfer: FungibleTransferPayload, params?: WriteParams<typeof vestingBudgetAbi, 'clawback'>): Promise<boolean>;
+    clawback(transfer: FungibleTransferPayload, params?: WriteParams<typeof vestingBudgetAbi, 'clawback'>): Promise<bigint>;
     /**
      * Clawbacks assets from the budget.
      * Only the owner can directly clawback assets from the budget
@@ -585,12 +795,12 @@ export declare class VestingBudget extends DeployableTarget<VestingBudgetPayload
      * @public
      * @async
      * @param {(FungibleTransferPayload)} transfer
-     * @param {?WriteParams<typeof vestingBudgetAbi, 'clawback'>} [params]
-     * @returns {Promise<boolean>} - True if the request was successful
+     * @param {?WriteParams} [params]
+     * @returns {Promise<{ hash: `0x${string}`; result: boolean; }>} - True if the request was successful
      */
     clawbackRaw(transfer: FungibleTransferPayload, params?: WriteParams<typeof vestingBudgetAbi, 'clawback'>): Promise<{
         hash: `0x${string}`;
-        result: boolean;
+        result: bigint;
     }>;
     /**
      * Disburses assets from the budget to a single recipient
@@ -599,7 +809,7 @@ export declare class VestingBudget extends DeployableTarget<VestingBudgetPayload
      * @public
      * @async
      * @param {(FungibleTransferPayload)} transfer
-     * @param {?WriteParams<typeof vestingBudgetAbi, 'disburse'>} [params]
+     * @param {?WriteParams} [params]
      * @returns {Promise<boolean>} - True if the disbursement was successful
      */
     disburse(transfer: FungibleTransferPayload, params?: WriteParams<typeof vestingBudgetAbi, 'disburse'>): Promise<boolean>;
@@ -610,8 +820,8 @@ export declare class VestingBudget extends DeployableTarget<VestingBudgetPayload
      * @public
      * @async
      * @param {(FungibleTransferPayload)} transfer
-     * @param {?WriteParams<typeof vestingBudgetAbi, 'disburse'>} [params]
-     * @returns {Promise<boolean>} - True if the disbursement was successful
+     * @param {?WriteParams} [params]
+     * @returns {Promise<{ hash: `0x${string}`; result: boolean; }>} - True if the disbursement was successful
      */
     disburseRaw(transfer: FungibleTransferPayload, params?: WriteParams<typeof vestingBudgetAbi, 'disburse'>): Promise<{
         hash: `0x${string}`;
@@ -623,7 +833,7 @@ export declare class VestingBudget extends DeployableTarget<VestingBudgetPayload
      * @public
      * @async
      * @param {Array<FungibleTransferPayload>} transfers
-     * @param {?WriteParams<typeof vestingBudgetAbi, 'disburseBatch'>} [params]
+     * @param {?WriteParams} [params]
      * @returns {Promise<boolean>} - True if all disbursements were successful
      */
     disburseBatch(transfers: FungibleTransferPayload[], params?: WriteParams<typeof vestingBudgetAbi, 'disburseBatch'>): Promise<boolean>;
@@ -633,54 +843,18 @@ export declare class VestingBudget extends DeployableTarget<VestingBudgetPayload
      * @public
      * @async
      * @param {Array<FungibleTransferPayload>} transfers
-     * @param {?WriteParams<typeof vestingBudgetAbi, 'disburseBatch'>} [params]
-     * @returns {Promise<boolean>} - True if all disbursements were successful
+     * @param {?WriteParams} [params]
+     * @returns {Promise<{ hash: `0x${string}`; result: boolean; }>} - True if all disbursements were successful
      */
     disburseBatchRaw(transfers: FungibleTransferPayload[], params?: WriteParams<typeof vestingBudgetAbi, 'disburseBatch'>): Promise<{
         hash: `0x${string}`;
         result: boolean;
     }>;
-    /**
-     * Set the authorized status of the given accounts
-     * The mechanism for managing authorization is left to the implementing contract
-     *
-     * @public
-     * @async
-     * @param {Address[]} addresses - The accounts to authorize or deauthorize
-     * @param {boolean[]} allowed - The authorization status for the given accounts
-     * @param {?WriteParams<typeof vestingBudgetAbi, 'setAuthorized'>} [params]
-     * @returns {Promise<void>}
-     */
-    setAuthorized(addresses: Address[], allowed: boolean[], params?: WriteParams<typeof vestingBudgetAbi, 'setAuthorized'>): Promise<void>;
-    /**
-     * Set the authorized status of the given accounts
-     * The mechanism for managing authorization is left to the implementing contract
-     *
-     * @public
-     * @async
-     * @param {Address[]} addresses - The accounts to authorize or deauthorize
-     * @param {boolean[]} allowed - The authorization status for the given accounts
-     * @param {?WriteParams<typeof vestingBudgetAbi, 'setAuthorized'>} [params]
-     * @returns {Promise<void>}
-     */
-    setAuthorizedRaw(addresses: Address[], allowed: boolean[], params?: WriteParams<typeof vestingBudgetAbi, 'setAuthorized'>): Promise<{
-        hash: `0x${string}`;
-        result: void;
-    }>;
-    /**
-     * Check if the given account is authorized to use the budget
-     *
-     * @public
-     * @param {Address} account
-     * @param {?ReadParams<typeof vestingBudgetAbi, 'isAuthorized'>} [params]
-     * @returns {Promise<boolean>} - True if the account is authorized
-     */
-    isAuthorized(account: Address, params?: ReadParams<typeof vestingBudgetAbi, 'isAuthorized'>): Promise<boolean>;
     /**
      * Get the end time of the vesting schedule
      *
      * @public
-     * @param {?ReadParams<typeof vestingBudgetAbi, 'end'>} [params]
+     * @param {?ReadParams} [params]
      * @returns {Promise<bigint>}
      */
     end(params?: ReadParams<typeof vestingBudgetAbi, 'end'>): Promise<bigint>;
@@ -689,30 +863,30 @@ export declare class VestingBudget extends DeployableTarget<VestingBudgetPayload
      * This is equal to the sum of the total current balance and the total distributed amount
      *
      * @public
-     * @param {Address} asset -  The address of the asset (or the zero address for native assets)
-     * @param {?ReadParams<typeof vestingBudgetAbi, 'total'>} [params]
+     * @param {Address} [asset="0x0000000000000000000000000000000000000000"] -  The address of the asset (or the zero address for native assets)
+     * @param {?ReadParams} [params]
      * @returns {Promise<bigint>}
      */
-    total(asset: Address, params?: ReadParams<typeof vestingBudgetAbi, 'total'>): Promise<bigint>;
+    total(asset?: Address, params?: ReadParams<typeof vestingBudgetAbi, 'total'>): Promise<bigint>;
     /**
      * Get the amount of assets available for distribution from the budget as of the current block timestamp
      * This is equal to the total vested amount minus any already distributed
      *
      * @public
-     * @param {Address} asset -  The address of the asset (or the zero address for native assets)
-     * @param {?ReadParams<typeof vestingBudgetAbi, 'available'>} [params]
+     * @param {Address} [asset="0x0000000000000000000000000000000000000000"] -  The address of the asset (or the zero address for native assets)
+     * @param {?ReadParams} [params]
      * @returns {Promise<bigint>} - The amount of assets currently available for distribution
      */
-    available(asset: Address, params?: ReadParams<typeof vestingBudgetAbi, 'available'>): Promise<bigint>;
+    available(asset?: Address, params?: ReadParams<typeof vestingBudgetAbi, 'available'>): Promise<bigint>;
     /**
      * Get the amount of assets that have been distributed from the budget
      *
      * @public
-     * @param {Address} asset
-     * @param {?ReadParams<typeof vestingBudgetAbi, 'distributed'>} [params]
+     * @param {Address} [asset="0x0000000000000000000000000000000000000000"]
+     * @param {?ReadParams} [params]
      * @returns {Promise<bigint>} - The amount of assets distributed
      */
-    distributed(asset: Address, params?: ReadParams<typeof vestingBudgetAbi, 'distributed'>): Promise<bigint>;
+    distributed(asset?: Address, params?: ReadParams<typeof vestingBudgetAbi, 'distributed'>): Promise<bigint>;
     /**
      * @inheritdoc
      *
@@ -723,4 +897,16 @@ export declare class VestingBudget extends DeployableTarget<VestingBudgetPayload
      */
     buildParameters(_payload?: VestingBudgetPayload, _options?: DeployableOptions): GenericDeployableParams;
 }
+/**
+ * Given a {@link VestingBudgetPayload}, properly encode a `VestingBudget.InitPayload` for use with {@link VestingBudget} initialization.
+ *
+ * @param {VestingBudgetPayload} param0
+ * @param {Address} param0.owner - The budget's owner.
+ * @param {{}} param0.authorized - List of accounts authorized to use the budget. This list should include a Boost core address to interact with the protocol.
+ * @param {bigint} param0.start - The timestamp at which the vesting schedule begins
+ * @param {bigint} param0.duration - The duration of the vesting schedule (in seconds)
+ * @param {bigint} param0.cliff - The duration of the cliff period (in seconds)
+ * @returns {Hex}
+ */
+export declare function prepareVestingBudgetPayload({ owner, authorized, start, duration, cliff, }: VestingBudgetPayload): `0x${string}`;
 //# sourceMappingURL=VestingBudget.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"VestingBudget.d.ts","sourceRoot":"","sources":["../../src/Budgets/VestingBudget.ts"],"names":[],"mappings":"AAAA,OAAO,EAeL,gBAAgB,EAMjB,MAAM,eAAe,CAAC;AAGvB,OAAO,EACL,KAAK,OAAO,EACZ,KAAK,iBAAiB,EAGvB,MAAM,MAAM,CAAC;AACd,OAAO,KAAK,EACV,iBAAiB,EACjB,uBAAuB,EACxB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,gBAAgB,EAAE,MAAM,gCAAgC,CAAC;AAElE,OAAO,EACL,KAAK,uBAAuB,EAC5B,KAAK,UAAU,EACf,KAAK,UAAU,EACf,YAAY,EACZ,KAAK,oBAAoB,EACzB,KAAK,WAAW,EAGjB,MAAM,UAAU,CAAC;AAElB,OAAO,EAAE,gBAAgB,EAAE,CAAC;AAC5B,YAAY,EAAE,oBAAoB,EAAE,CAAC;AAErC;;;;;;;;GAQG;AACH,MAAM,MAAM,gBAAgB,CAC1B,KAAK,SAAS,iBAAiB,CAAC,OAAO,gBAAgB,CAAC,GAAG,iBAAiB,CAC1E,OAAO,gBAAgB,CACxB,IACC,UAAU,CAAC,OAAO,gBAAgB,EAAE,KAAK,CAAC,CAAC;AAE/C;;;;;;;;;;;;GAYG;AACH,qBAAa,aAAc,SAAQ,gBAAgB,CACjD,oBAAoB,EACpB,OAAO,gBAAgB,CACxB;IACC,SAAyB,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAAoB;IAChD;;;;;;OAMG;IACH,OAAuB,IAAI,EAAE,OAAO,CACR;IAC5B;;;;;;OAMG;IACH,OAAuB,YAAY,EAAE,YAAY,CAAuB;IAExE;;;;;;OAMG;IACI,KAAK,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC,OAAO,gBAAgB,EAAE,OAAO,CAAC;IASlE;;;;;;OAMG;IACI,KAAK,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC,OAAO,gBAAgB,EAAE,OAAO,CAAC;IASlE;;;;;;OAMG;IACI,QAAQ,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC,OAAO,gBAAgB,EAAE,UAAU,CAAC;IASxE;;;;;;OAMG;IACI,KAAK,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC,OAAO,gBAAgB,EAAE,OAAO,CAAC;IASlE;;;;;;;;;;OAUG;IACU,QAAQ,CACnB,QAAQ,EAAE,uBAAuB,EACjC,MAAM,CAAC,EAAE,WAAW,CAAC,OAAO,gBAAgB,EAAE,UAAU,CAAC;IAK3D;;;;;;;;;;OAUG;IACU,WAAW,CACtB,QAAQ,EAAE,uBAAuB,EACjC,MAAM,CAAC,EAAE,WAAW,CAAC,OAAO,gBAAgB,EAAE,UAAU,CAAC;;;;IAgB3D;;;;;;;;;;;OAWG;IACU,QAAQ,CACnB,QAAQ,EAAE,uBAAuB,EACjC,MAAM,CAAC,EAAE,WAAW,CAAC,OAAO,gBAAgB,EAAE,UAAU,CAAC;IAK3D;;;;;;;;;;;OAWG;IACU,WAAW,CACtB,QAAQ,EAAE,uBAAuB,EACjC,MAAM,CAAC,EAAE,WAAW,CAAC,OAAO,gBAAgB,EAAE,UAAU,CAAC;;;;IAgB3D;;;;;;;;;OASG;IACU,QAAQ,CACnB,QAAQ,EAAE,uBAAuB,EACjC,MAAM,CAAC,EAAE,WAAW,CAAC,OAAO,gBAAgB,EAAE,UAAU,CAAC;IAK3D;;;;;;;;;OASG;IACU,WAAW,CACtB,QAAQ,EAAE,uBAAuB,EACjC,MAAM,CAAC,EAAE,WAAW,CAAC,OAAO,gBAAgB,EAAE,UAAU,CAAC;;;;IAgB3D;;;;;;;;OAQG;IACU,aAAa,CACxB,SAAS,EAAE,uBAAuB,EAAE,EACpC,MAAM,CAAC,EAAE,WAAW,CAAC,OAAO,gBAAgB,EAAE,eAAe,CAAC;IAKhE;;;;;;;;OAQG;IACU,gBAAgB,CAC3B,SAAS,EAAE,uBAAuB,EAAE,EACpC,MAAM,CAAC,EAAE,WAAW,CAAC,OAAO,gBAAgB,EAAE,eAAe,CAAC;;;;IAgBhE;;;;;;;;;;OAUG;IACU,aAAa,CACxB,SAAS,EAAE,OAAO,EAAE,EACpB,OAAO,EAAE,OAAO,EAAE,EAClB,MAAM,CAAC,EAAE,WAAW,CAAC,OAAO,gBAAgB,EAAE,eAAe,CAAC;IAKhE;;;;;;;;;;OAUG;IACU,gBAAgB,CAC3B,SAAS,EAAE,OAAO,EAAE,EACpB,OAAO,EAAE,OAAO,EAAE,EAClB,MAAM,CAAC,EAAE,WAAW,CAAC,OAAO,gBAAgB,EAAE,eAAe,CAAC;;;;IAgBhE;;;;;;;OAOG;IACI,YAAY,CACjB,OAAO,EAAE,OAAO,EAChB,MAAM,CAAC,EAAE,UAAU,CAAC,OAAO,gBAAgB,EAAE,cAAc,CAAC;IAU9D;;;;;;OAMG;IACI,GAAG,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC,OAAO,gBAAgB,EAAE,KAAK,CAAC;IAS9D;;;;;;;;OAQG;IACI,KAAK,CACV,KAAK,EAAE,OAAO,EACd,MAAM,CAAC,EAAE,UAAU,CAAC,OAAO,gBAAgB,EAAE,OAAO,CAAC;IAUvD;;;;;;;;OAQG;IACI,SAAS,CACd,KAAK,EAAE,OAAO,EACd,MAAM,CAAC,EAAE,UAAU,CAAC,OAAO,gBAAgB,EAAE,WAAW,CAAC;IAU3D;;;;;;;OAOG;IACI,WAAW,CAChB,KAAK,EAAE,OAAO,EACd,MAAM,CAAC,EAAE,UAAU,CAAC,OAAO,gBAAgB,EAAE,aAAa,CAAC;IAU7D;;;;;;;OAOG;IACa,eAAe,CAC7B,QAAQ,CAAC,EAAE,oBAAoB,EAC/B,QAAQ,CAAC,EAAE,iBAAiB,GAC3B,uBAAuB;CAwB3B"}
+{"version":3,"file":"VestingBudget.d.ts","sourceRoot":"","sources":["../../src/Budgets/VestingBudget.ts"],"names":[],"mappings":"AAAA,OAAO,EAeL,gBAAgB,EAMjB,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,wBAAwB,EAAE,MAAM,wCAAwC,CAAC;AAElF,OAAO,EACL,KAAK,uBAAuB,EAE7B,MAAM,cAAc,CAAC;AACtB,OAAO,EACL,KAAK,UAAU,EACf,KAAK,UAAU,EACf,YAAY,EACZ,KAAK,WAAW,EACjB,MAAM,UAAU,CAAC;AAElB,OAAO,EAAE,gBAAgB,EAAE,CAAC;AAC5B,YAAY,EAAE,uBAAuB,EAAE,CAAC;AACxC;;;;;;GAMG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;;OAIG;IACH,KAAK,EAAE,OAAO,CAAC;IACf;;;;OAIG;IACH,UAAU,EAAE,OAAO,EAAE,CAAC;IACtB;;;;OAIG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;;;OAIG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;;;;;GAQG;AACH,MAAM,MAAM,gBAAgB,CAC1B,KAAK,SAAS,iBAAiB,CAAC,OAAO,gBAAgB,CAAC,GAAG,iBAAiB,CAC1E,OAAO,gBAAgB,CACxB,IACC,UAAU,CAAC,OAAO,gBAAgB,EAAE,KAAK,CAAC,CAAC;AAE/C;;;;;;;;;;;;GAYG;AACH,qBAAa,aAAc,SAAQ,wBAAwB,CACzD,oBAAoB,EACpB,OAAO,gBAAgB,CACxB;IACC,SAAyB,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAAoB;IAChD;;;;;;OAMG;IACH,OAAuB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAM;IAC3D;;;;;;OAMG;IACH,OAAuB,YAAY,EAAE,YAAY,CAAuB;IAExE;;;;;;OAMG;IACI,KAAK,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC,OAAO,gBAAgB,EAAE,OAAO,CAAC;IASlE;;;;;;OAMG;IACI,KAAK,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC,OAAO,gBAAgB,EAAE,OAAO,CAAC;IASlE;;;;;;OAMG;IACI,QAAQ,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC,OAAO,gBAAgB,EAAE,UAAU,CAAC;IASxE;;;;;;OAMG;IACI,KAAK,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC,OAAO,gBAAgB,EAAE,OAAO,CAAC;IASlE;;;;;;;;;;OAUG;IACU,QAAQ,CACnB,QAAQ,EAAE,uBAAuB,EACjC,MAAM,CAAC,EAAE,WAAW,CAAC,OAAO,gBAAgB,EAAE,UAAU,CAAC;IAK3D;;;;;;;;;;OAUG;IACU,WAAW,CACtB,QAAQ,EAAE,uBAAuB,EACjC,MAAM,CAAC,EAAE,WAAW,CAAC,OAAO,gBAAgB,EAAE,UAAU,CAAC;;;;IAgB3D;;;;;;;;;;;OAWG;IACU,QAAQ,CACnB,QAAQ,EAAE,uBAAuB,EACjC,MAAM,CAAC,EAAE,WAAW,CAAC,OAAO,gBAAgB,EAAE,UAAU,CAAC;IAK3D;;;;;;;;;;;OAWG;IACU,WAAW,CACtB,QAAQ,EAAE,uBAAuB,EACjC,MAAM,CAAC,EAAE,WAAW,CAAC,OAAO,gBAAgB,EAAE,UAAU,CAAC;;;;IAgB3D;;;;;;;;;OASG;IACU,QAAQ,CACnB,QAAQ,EAAE,uBAAuB,EACjC,MAAM,CAAC,EAAE,WAAW,CAAC,OAAO,gBAAgB,EAAE,UAAU,CAAC;IAK3D;;;;;;;;;OASG;IACU,WAAW,CACtB,QAAQ,EAAE,uBAAuB,EACjC,MAAM,CAAC,EAAE,WAAW,CAAC,OAAO,gBAAgB,EAAE,UAAU,CAAC;;;;IAgB3D;;;;;;;;OAQG;IACU,aAAa,CACxB,SAAS,EAAE,uBAAuB,EAAE,EACpC,MAAM,CAAC,EAAE,WAAW,CAAC,OAAO,gBAAgB,EAAE,eAAe,CAAC;IAKhE;;;;;;;;OAQG;IACU,gBAAgB,CAC3B,SAAS,EAAE,uBAAuB,EAAE,EACpC,MAAM,CAAC,EAAE,WAAW,CAAC,OAAO,gBAAgB,EAAE,eAAe,CAAC;;;;IAgBhE;;;;;;OAMG;IACI,GAAG,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC,OAAO,gBAAgB,EAAE,KAAK,CAAC;IAS9D;;;;;;;;OAQG;IACI,KAAK,CACV,KAAK,GAAE,OAAqB,EAC5B,MAAM,CAAC,EAAE,UAAU,CAAC,OAAO,gBAAgB,EAAE,OAAO,CAAC;IAUvD;;;;;;;;OAQG;IACI,SAAS,CACd,KAAK,GAAE,OAAqB,EAC5B,MAAM,CAAC,EAAE,UAAU,CAAC,OAAO,gBAAgB,EAAE,WAAW,CAAC;IAU3D;;;;;;;OAOG;IACI,WAAW,CAChB,KAAK,GAAE,OAAqB,EAC5B,MAAM,CAAC,EAAE,UAAU,CAAC,OAAO,gBAAgB,EAAE,aAAa,CAAC;IAU7D;;;;;;;OAOG;IACa,eAAe,CAC7B,QAAQ,CAAC,EAAE,oBAAoB,EAC/B,QAAQ,CAAC,EAAE,iBAAiB,GAC3B,uBAAuB;CAwB3B;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,2BAA2B,CAAC,EAC1C,KAAK,EACL,UAAU,EACV,KAAK,EACL,QAAQ,EACR,KAAK,GACN,EAAE,oBAAoB,iBAQtB"}

package/dist/Deployable/Contract.cjs

@@ -1,2 +1,2 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const r=require("@wagmi/core"),i=require("viem"),o=require("viem/actions"),d=require("../errors.cjs"),c=require("../utils.cjs");class h{constructor(e,t){this._config=e,this._address=t}get address(){return this._address}at(e){return this._address=e,this}withConfig(e){return this._config=e,this}assertValidAddress(){const e=this.address;if(!e)throw new d.ContractAddressRequiredError;return e}async getLogs(e){return o.getLogs(this._config.getClient({chainId:e==null?void 0:e.chainId}),{...e,...e!=null&&e.eventName?{event:i.getAbiItem({abi:this.abi,name:e.eventName})}:{},...e!=null&&e.eventNames?{events:e.eventNames.map(t=>i.getAbiItem({abi:this.abi,name:t}))}:{},address:this.assertValidAddress()})}async subscribe(e,t){return r.watchContractEvent(this._config,{...t,eventName:t==null?void 0:t.eventName,abi:this.abi,address:this.assertValidAddress(),onLogs:s=>{for(let n of s)e(n)}})}async awaitResult(e,t){return c.awaitResult(this._config,e,t)}}exports.Contract=h;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const r=require("@wagmi/core"),i=require("viem"),o=require("viem/actions"),d=require("../errors.cjs"),c=require("../utils.cjs");class h{constructor(e,t){this._config=e,this._address=t}get address(){return this._address}at(e){return this._address=e,this}withConfig(e){return this._config=e,this}assertValidAddress(){const e=this.address;if(!e)throw new d.ContractAddressRequiredError;return e}async getLogs(e){return o.getLogs(this._config.getClient({chainId:e==null?void 0:e.chainId}),{...e,...e!=null&&e.eventName?{event:i.getAbiItem({abi:this.abi,name:e.eventName})}:{},...e!=null&&e.eventNames?{events:e.eventNames.map(t=>i.getAbiItem({abi:this.abi,name:t}))}:{},address:this.assertValidAddress()})}subscribe(e,t){return r.watchContractEvent(this._config,{...t,eventName:t==null?void 0:t.eventName,abi:this.abi,address:this.assertValidAddress(),onLogs:s=>{for(let n of s)e(n)}})}async awaitResult(e,t){return await c.awaitResult(this._config,e,t)}}exports.Contract=h;
 //# sourceMappingURL=Contract.cjs.map

package/dist/Deployable/Contract.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"Contract.cjs","sources":["../../src/Deployable/Contract.ts"],"sourcesContent":["import { type Config, watchContractEvent } from '@wagmi/core';\nimport type { ExtractAbiEvent } from 'abitype';\nimport {\n  type Abi,\n  type Address,\n  type ContractEventName,\n  type GetLogsReturnType,\n  type WaitForTransactionReceiptParameters,\n  type WatchContractEventOnLogsParameter,\n  getAbiItem,\n} from 'viem';\nimport { getLogs } from 'viem/actions';\nimport { ContractAddressRequiredError } from '../errors';\nimport {\n  type GetLogsParams,\n  type HashAndSimulatedResult,\n  type WatchParams,\n  awaitResult,\n} from '../utils';\n\n/**\n * A basic Contract class to encapsulate configuration and a potential address\n *\n * @export\n * @class Contract\n * @typedef {Contract}\n * @template {Abi} [ContractAbi=[]]\n * @template {ContractEventName<ContractAbi>} [ContractEvent=any]\n */\nexport class Contract<ContractAbi extends Abi> {\n  //@ts-expect-error this should always be set by implementing contract\n  public readonly abi: ContractAbi;\n  /**\n   * @see [Wagmi Configuration](https://wagmi.sh/core/api/createConfig)\n   * @protected\n   * @type {WagmiConfig}\n   */\n  protected _config: Config;\n  /**\n   * The internally managed address for this contract\n   *\n   * @protected\n   * @type {(Address | undefined)}\n   */\n  protected _address: Address | undefined;\n\n  /**\n   * Creates an instance of Contract.\n   *\n   * @constructor\n   * @param {Config} config\n   * @param {(Address | undefined)} address\n   */\n  constructor(config: Config, address: Address | undefined) {\n    this._config = config;\n    this._address = address;\n  }\n\n  /**\n   * A getter returning this contract's deployed address, if it exists.\n   *\n   * @public\n   * @readonly\n   * @type {*}\n   */\n  public get address() {\n    return this._address;\n  }\n\n  /**\n   * Will set this contract's address and return the instance for chaining. Does not verify that provided address is valid.\n   *\n   * @public\n   * @param {Address} address\n   * @returns {this}\n   */\n  public at(address: Address) {\n    this._address = address;\n    return this;\n  }\n\n  /**\n   * Will set this contract's internal [Wagmi Configuration](https://en.wikipedia.org/wiki/Factorial) and return the instance for chaining.\n   *\n   * @public\n   * @param {Config} config\n   * @returns {this}\n   */\n  public withConfig(config: Config) {\n    this._config = config;\n    return this;\n  }\n\n  /**\n   * Utility function to validate the existence of an address on this Contract.\n   *\n   * @public\n   * @returns {Address}\n   * @throws {@link ContractAddressRequiredError} if no address exists on this Contract instance\n   */\n  public assertValidAddress() {\n    const address = this.address;\n    if (!address) throw new ContractAddressRequiredError();\n    return address;\n  }\n\n  /**\n   * A typed wrapper for (viem.getLogs)[https://viem.sh/docs/actions/public/getLogs#getlogs].\n   * Accepts `eventName` and `eventNames` as optional parameters to narrow the returned log types.\n   * @example\n   * ```ts\n   * const logs = contract.getLogs({ eventName: 'EventName' })\n   * const logs = contract.getLogs({ eventNames: ['EventName'] })\n   *\n   * @public\n   * @async\n   * @template {ContractEvent} event\n   * @template {ExtractAbiEvent<\n   *       ContractAbi,\n   *       event\n   *     >} [abiEvent=ExtractAbiEvent<ContractAbi, event>]\n   * @param {?Omit<\n   *       GetLogsParams<ContractAbi, event, abiEvent, abiEvent[]>,\n   *       'event' | 'events'\n   *     > & {\n   *       eventName?: event;\n   *       eventNames?: event[];\n   *     }} [params]\n   * @returns {Promise<GetLogsReturnType<abiEvent, abiEvent[]>>}\n   */\n  public async getLogs<\n    event extends ContractEventName<ContractAbi>,\n    const abiEvent extends ExtractAbiEvent<\n      ContractAbi,\n      event\n    > = ExtractAbiEvent<ContractAbi, event>,\n  >(\n    params?: Omit<\n      GetLogsParams<ContractAbi, event, abiEvent, abiEvent[]>,\n      'event' | 'events'\n    > & {\n      eventName?: event;\n      eventNames?: event[];\n    },\n  ): Promise<GetLogsReturnType<abiEvent, abiEvent[]>> {\n    return getLogs(this._config.getClient({ chainId: params?.chainId }), {\n      // biome-ignore lint/suspicious/noExplicitAny: Accept any shape of valid wag\n      ...(params as any),\n      ...(params?.eventName\n        ? {\n            event: getAbiItem({\n              abi: this.abi,\n              name: params.eventName,\n              // biome-ignore lint/suspicious/noExplicitAny: awkward abi intersection issue\n            } as any),\n          }\n        : {}),\n      ...(params?.eventNames\n        ? {\n            events: params.eventNames.map((name) =>\n              getAbiItem({\n                abi: this.abi,\n                name,\n                // biome-ignore lint/suspicious/noExplicitAny: awkward abi intersection issue\n              } as any),\n            ),\n          }\n        : {}),\n      address: this.assertValidAddress(),\n    });\n  }\n\n  /**\n   * A typed wrapper for `wagmi.watchContractEvent`\n   *\n   * @public\n   * @async\n   * @template {ContractEvent} event\n   * @param {(\n   *       log: WatchContractEventOnLogsParameter<ContractAbi, event, true>[number],\n   *     ) => unknown} cb\n   * @param {?WatchParams<ContractAbi, event> & {\n   *       eventName?: event;\n   *     }} [params]\n   * @returns {unknown, params?: any) => unknown}\n   */\n  public async subscribe<event extends ContractEventName<ContractAbi>>(\n    cb: (\n      log: WatchContractEventOnLogsParameter<ContractAbi, event, true>[number],\n    ) => unknown,\n    params?: WatchParams<ContractAbi, event> & {\n      eventName?: event;\n    },\n  ) {\n    return watchContractEvent<\n      typeof this._config,\n      (typeof this._config)['chains'][number]['id'],\n      ContractAbi,\n      event\n    >(this._config, {\n      // biome-ignore lint/suspicious/noExplicitAny: Accept any shape of valid wagmi/viem parameters, wagmi does the same thing internally\n      ...(params as any),\n      eventName: params?.eventName,\n      abi: this.abi,\n      address: this.assertValidAddress(),\n      onLogs: (logs) => {\n        for (let l of logs) {\n          cb(l);\n        }\n      },\n    });\n  }\n\n  /**\n   * @see {@link awaitResult}\n   * @protected\n   * @async\n   * @template [Result=unknown]\n   * @param {Promise<HashAndSimulatedResult<Result>>} hashPromise\n   * @param {?Omit<WaitForTransactionReceiptParameters, 'hash'>} [waitParams]\n   * @returns {unknown}\n   */\n  protected async awaitResult<Result = unknown>(\n    hashPromise: Promise<HashAndSimulatedResult<Result>>,\n    waitParams?: Omit<WaitForTransactionReceiptParameters, 'hash'>,\n  ) {\n    return awaitResult(this._config, hashPromise, waitParams);\n  }\n}\n"],"names":["Contract","config","address","ContractAddressRequiredError","params","getLogs","getAbiItem","name","cb","watchContractEvent","logs","l","hashPromise","waitParams","awaitResult"],"mappings":"gNA6BO,MAAMA,CAAkC,CAwB7C,YAAYC,EAAgBC,EAA8B,CACxD,KAAK,QAAUD,EACf,KAAK,SAAWC,CAClB,CASA,IAAW,SAAU,CACnB,OAAO,KAAK,QACd,CASO,GAAGA,EAAkB,CAC1B,YAAK,SAAWA,EACT,IACT,CASO,WAAWD,EAAgB,CAChC,YAAK,QAAUA,EACR,IACT,CASO,oBAAqB,CAC1B,MAAMC,EAAU,KAAK,QACrB,GAAI,CAACA,EAAS,MAAM,IAAIC,EAA6B,6BAC9C,OAAAD,CACT,CA0BA,MAAa,QAOXE,EAOkD,CAC3C,OAAAC,EAAA,QAAQ,KAAK,QAAQ,UAAU,CAAE,QAASD,GAAA,YAAAA,EAAQ,OAAQ,CAAC,EAAG,CAEnE,GAAIA,EACJ,GAAIA,GAAA,MAAAA,EAAQ,UACR,CACE,MAAOE,EAAAA,WAAW,CAChB,IAAK,KAAK,IACV,KAAMF,EAAO,SAAA,CAEP,CAAA,EAEV,CAAC,EACL,GAAIA,GAAA,MAAAA,EAAQ,WACR,CACE,OAAQA,EAAO,WAAW,IAAKG,GAC7BD,EAAAA,WAAW,CACT,IAAK,KAAK,IACV,KAAAC,CAAA,CAEM,CACV,CAAA,EAEF,CAAC,EACL,QAAS,KAAK,mBAAmB,CAAA,CAClC,CACH,CAgBA,MAAa,UACXC,EAGAJ,EAGA,CACO,OAAAK,EAAA,mBAKL,KAAK,QAAS,CAEd,GAAIL,EACJ,UAAWA,GAAA,YAAAA,EAAQ,UACnB,IAAK,KAAK,IACV,QAAS,KAAK,mBAAmB,EACjC,OAASM,GAAS,CAChB,QAASC,KAAKD,EACZF,EAAGG,CAAC,CAER,CAAA,CACD,CACH,CAWA,MAAgB,YACdC,EACAC,EACA,CACA,OAAOC,EAAY,YAAA,KAAK,QAASF,EAAaC,CAAU,CAC1D,CACF"}
+{"version":3,"file":"Contract.cjs","sources":["../../src/Deployable/Contract.ts"],"sourcesContent":["import { type Config, watchContractEvent } from '@wagmi/core';\nimport type { ExtractAbiEvent } from 'abitype';\nimport {\n  type Abi,\n  type Address,\n  type ContractEventName,\n  type GetLogsReturnType,\n  type WaitForTransactionReceiptParameters,\n  type WatchContractEventOnLogsParameter,\n  getAbiItem,\n} from 'viem';\nimport { getLogs } from 'viem/actions';\nimport { ContractAddressRequiredError } from '../errors';\nimport {\n  type GetLogsParams,\n  type HashAndSimulatedResult,\n  type WatchParams,\n  awaitResult,\n} from '../utils';\n\n/**\n * A basic Contract class to encapsulate configuration and a potential address\n *\n * @export\n * @class Contract\n * @typedef {Contract}\n * @template {Abi} [ContractAbi=[]]\n * @template {ContractEventName<ContractAbi>} [ContractEvent=any]\n */\nexport class Contract<ContractAbi extends Abi> {\n  //@ts-expect-error this should always be set by implementing contract\n  public readonly abi: ContractAbi;\n  /**\n   * @see [Wagmi Configuration](https://wagmi.sh/core/api/createConfig)\n   * @protected\n   * @type {WagmiConfig}\n   */\n  protected _config: Config;\n  /**\n   * The internally managed address for this contract\n   *\n   * @protected\n   * @type {(Address | undefined)}\n   */\n  protected _address: Address | undefined;\n\n  /**\n   * Creates an instance of Contract.\n   *\n   * @constructor\n   * @param {Config} config\n   * @param {(Address | undefined)} address\n   */\n  constructor(config: Config, address: Address | undefined) {\n    this._config = config;\n    this._address = address;\n  }\n\n  /**\n   * A getter returning this contract's deployed address, if it exists.\n   *\n   * @public\n   * @readonly\n   * @type {Address | undefined}\n   */\n  public get address() {\n    return this._address;\n  }\n\n  /**\n   * Will set this contract's address and return the instance for chaining. Does not verify that provided address is valid.\n   *\n   * @public\n   * @param {Address} address\n   * @returns {this}\n   */\n  public at(address: Address) {\n    this._address = address;\n    return this;\n  }\n\n  /**\n   * Will set this contract's internal [Wagmi Configuration](https://en.wikipedia.org/wiki/Factorial) and return the instance for chaining.\n   *\n   * @public\n   * @param {Config} config\n   * @returns {this}\n   */\n  public withConfig(config: Config) {\n    this._config = config;\n    return this;\n  }\n\n  /**\n   * Utility function to validate the existence of an address on this Contract.\n   *\n   * @public\n   * @returns {Address}\n   * @throws {@link ContractAddressRequiredError} if no address exists on this Contract instance\n   */\n  public assertValidAddress() {\n    const address = this.address;\n    if (!address) throw new ContractAddressRequiredError();\n    return address;\n  }\n\n  /**\n   * A typed wrapper for (viem.getLogs)[https://viem.sh/docs/actions/public/getLogs#getlogs].\n   * Accepts `eventName` and `eventNames` as optional parameters to narrow the returned log types.\n   * @example\n   * ```ts\n   * const logs = contract.getLogs({ eventName: 'EventName' })\n   * const logs = contract.getLogs({ eventNames: ['EventName'] })\n   *\n   * @public\n   * @async\n   * @template {ContractEvent} event\n   * @template {ExtractAbiEvent<\n   *       ContractAbi,\n   *       event\n   *     >} [abiEvent=ExtractAbiEvent<ContractAbi, event>]\n   * @param {?Omit<\n   *       GetLogsParams<ContractAbi, event, abiEvent, abiEvent[]>,\n   *       'event' | 'events'\n   *     > & {\n   *       eventName?: event;\n   *       eventNames?: event[];\n   *     }} [params]\n   * @returns {Promise<GetLogsReturnType<abiEvent, abiEvent[]>>}\n   */\n  public async getLogs<\n    event extends ContractEventName<ContractAbi>,\n    const abiEvent extends ExtractAbiEvent<\n      ContractAbi,\n      event\n    > = ExtractAbiEvent<ContractAbi, event>,\n  >(\n    params?: Omit<\n      GetLogsParams<ContractAbi, event, abiEvent, abiEvent[]>,\n      'event' | 'events'\n    > & {\n      eventName?: event;\n      eventNames?: event[];\n    },\n  ): Promise<GetLogsReturnType<abiEvent, abiEvent[]>> {\n    return getLogs(this._config.getClient({ chainId: params?.chainId }), {\n      // biome-ignore lint/suspicious/noExplicitAny: Accept any shape of valid wag\n      ...(params as any),\n      ...(params?.eventName\n        ? {\n            event: getAbiItem({\n              abi: this.abi,\n              name: params.eventName,\n              // biome-ignore lint/suspicious/noExplicitAny: awkward abi intersection issue\n            } as any),\n          }\n        : {}),\n      ...(params?.eventNames\n        ? {\n            events: params.eventNames.map((name) =>\n              getAbiItem({\n                abi: this.abi,\n                name,\n                // biome-ignore lint/suspicious/noExplicitAny: awkward abi intersection issue\n              } as any),\n            ),\n          }\n        : {}),\n      address: this.assertValidAddress(),\n    });\n  }\n\n  /**\n   * A typed wrapper for `wagmi.watchContractEvent`\n   *\n   * @public\n   * @template {ContractEvent} event\n   * @param {(\n   *       log: WatchContractEventOnLogsParameter<ContractAbi, event, true>[number],\n   *     ) => unknown} cb\n   * @param {?WatchParams<ContractAbi, event> & {\n   *       eventName?: event;\n   *     }} [params]\n   * @returns {() => void}\n   */\n  public subscribe<event extends ContractEventName<ContractAbi>>(\n    cb: (\n      log: WatchContractEventOnLogsParameter<ContractAbi, event, true>[number],\n    ) => unknown,\n    params?: WatchParams<ContractAbi, event> & {\n      eventName?: event;\n    },\n  ) {\n    return watchContractEvent<\n      typeof this._config,\n      (typeof this._config)['chains'][number]['id'],\n      ContractAbi,\n      event\n    >(this._config, {\n      // biome-ignore lint/suspicious/noExplicitAny: Accept any shape of valid wagmi/viem parameters, wagmi does the same thing internally\n      ...(params as any),\n      eventName: params?.eventName,\n      abi: this.abi,\n      address: this.assertValidAddress(),\n      onLogs: (logs) => {\n        for (let l of logs) {\n          cb(l);\n        }\n      },\n    });\n  }\n\n  /**\n   * @see {@link awaitResult}\n   * @protected\n   * @async\n   * @template [Result=unknown]\n   * @param {Promise<HashAndSimulatedResult<Result>>} hashPromise\n   * @param {?Omit<WaitForTransactionReceiptParameters, 'hash'>} [waitParams]\n   * @returns {Promise<Result>}\n   */\n  protected async awaitResult<Result = unknown>(\n    hashPromise: Promise<HashAndSimulatedResult<Result>>,\n    waitParams?: Omit<WaitForTransactionReceiptParameters, 'hash'>,\n  ) {\n    return await awaitResult(this._config, hashPromise, waitParams);\n  }\n}\n"],"names":["Contract","config","address","ContractAddressRequiredError","params","getLogs","getAbiItem","name","cb","watchContractEvent","logs","l","hashPromise","waitParams","awaitResult"],"mappings":"gNA6BO,MAAMA,CAAkC,CAwB7C,YAAYC,EAAgBC,EAA8B,CACxD,KAAK,QAAUD,EACf,KAAK,SAAWC,CAClB,CASA,IAAW,SAAU,CACnB,OAAO,KAAK,QACd,CASO,GAAGA,EAAkB,CAC1B,YAAK,SAAWA,EACT,IACT,CASO,WAAWD,EAAgB,CAChC,YAAK,QAAUA,EACR,IACT,CASO,oBAAqB,CAC1B,MAAMC,EAAU,KAAK,QACrB,GAAI,CAACA,EAAe,MAAA,IAAIC,EAAAA,6BACjB,OAAAD,CACT,CA0BA,MAAa,QAOXE,EAOkD,CAC3C,OAAAC,EAAA,QAAQ,KAAK,QAAQ,UAAU,CAAE,QAASD,GAAA,YAAAA,EAAQ,OAAQ,CAAC,EAAG,CAEnE,GAAIA,EACJ,GAAIA,GAAA,MAAAA,EAAQ,UACR,CACE,MAAOE,EAAAA,WAAW,CAChB,IAAK,KAAK,IACV,KAAMF,EAAO,SAAA,CAEP,CAAA,EAEV,CAAC,EACL,GAAIA,GAAA,MAAAA,EAAQ,WACR,CACE,OAAQA,EAAO,WAAW,IAAKG,GAC7BD,EAAAA,WAAW,CACT,IAAK,KAAK,IACV,KAAAC,CAAA,CAEM,CACV,CAAA,EAEF,CAAC,EACL,QAAS,KAAK,mBAAmB,CAAA,CAClC,CACH,CAeO,UACLC,EAGAJ,EAGA,CACO,OAAAK,EAAA,mBAKL,KAAK,QAAS,CAEd,GAAIL,EACJ,UAAWA,GAAA,YAAAA,EAAQ,UACnB,IAAK,KAAK,IACV,QAAS,KAAK,mBAAmB,EACjC,OAASM,GAAS,CAChB,QAASC,KAAKD,EACZF,EAAGG,CAAC,CAER,CAAA,CACD,CACH,CAWA,MAAgB,YACdC,EACAC,EACA,CACA,OAAO,MAAMC,EAAA,YAAY,KAAK,QAASF,EAAaC,CAAU,CAChE,CACF"}

package/dist/Deployable/Contract.d.ts

@@ -39,7 +39,7 @@ export declare class Contract<ContractAbi extends Abi> {
      *
      * @public
      * @readonly
-     * @type {*}
+     * @type {Address | undefined}
      */
     get address(): `0x${string}` | undefined;
     /**
@@ -98,7 +98,6 @@ export declare class Contract<ContractAbi extends Abi> {
      * A typed wrapper for `wagmi.watchContractEvent`
      *
      * @public
-     * @async
      * @template {ContractEvent} event
      * @param {(
      *       log: WatchContractEventOnLogsParameter<ContractAbi, event, true>[number],
@@ -106,11 +105,11 @@ export declare class Contract<ContractAbi extends Abi> {
      * @param {?WatchParams<ContractAbi, event> & {
      *       eventName?: event;
      *     }} [params]
-     * @returns {unknown, params?: any) => unknown}
+     * @returns {() => void}
      */
     subscribe<event extends ContractEventName<ContractAbi>>(cb: (log: WatchContractEventOnLogsParameter<ContractAbi, event, true>[number]) => unknown, params?: WatchParams<ContractAbi, event> & {
         eventName?: event;
-    }): Promise<() => void>;
+    }): () => void;
     /**
      * @see {@link awaitResult}
      * @protected
@@ -118,7 +117,7 @@ export declare class Contract<ContractAbi extends Abi> {
      * @template [Result=unknown]
      * @param {Promise<HashAndSimulatedResult<Result>>} hashPromise
      * @param {?Omit<WaitForTransactionReceiptParameters, 'hash'>} [waitParams]
-     * @returns {unknown}
+     * @returns {Promise<Result>}
      */
     protected awaitResult<Result = unknown>(hashPromise: Promise<HashAndSimulatedResult<Result>>, waitParams?: Omit<WaitForTransactionReceiptParameters, 'hash'>): Promise<Result>;
 }