@nevermined-io/core-kit 0.0.58-rc0 → 0.0.58

package/dist/contracts/AssetRegistry.d.ts

@@ -1,21 +1,31 @@
-import { CreditsConfig, CreditsType, DIDAsset, Plan, PriceConfig } from '@nvm-monorepo/commons';
-import { Account, Address, Hex, TransactionReceipt } from 'viem';
+import { CreditsConfig, DIDAgent, Plan, PriceConfig } from '@nvm-monorepo/commons';
+import { Account, Address, TransactionReceipt } from 'viem';
 import { SmartAccount, UserOperationReceipt } from 'viem/account-abstraction';
 import { InstantiableConfig } from '../Instantiable.abstract.js';
 import { TxParameters } from '../models/Transactions.js';
 import { ContractBase } from './ContractBase.js';
 export declare class AssetRegistry extends ContractBase {
     static getInstance(config: InstantiableConfig): Promise<AssetRegistry>;
-    hashDID(didSeed: string, owner: Address): Promise<string>;
-    getAsset(did: string): Promise<DIDAsset>;
-    assetExists(did: Hex): Promise<boolean>;
-    register({ didSeed, url, plans, owner, txParams, }: {
-        didSeed: string;
+    hashAgentId(seed: string, owner: Address): Promise<bigint>;
+    getAgent(agentId: string | bigint): Promise<DIDAgent>;
+    register({ seed, url, plans, owner, txParams, }: {
+        seed: string;
         url: string;
         plans: bigint[];
         owner: Account | SmartAccount;
         txParams?: TxParameters;
     }): Promise<TransactionReceipt | UserOperationReceipt>;
+    createPayAsYouGoPlan({ priceConfig, creditsConfig, owner, nonce, addFees, isTrialPlan, organizationCryptoFee, organizationCryptoWallet, txParams, }: {
+        priceConfig: PriceConfig;
+        creditsConfig: CreditsConfig;
+        owner: Account | SmartAccount;
+        nonce?: bigint;
+        addFees?: boolean;
+        isTrialPlan?: boolean;
+        organizationCryptoFee?: bigint;
+        organizationCryptoWallet?: string;
+        txParams?: TxParameters;
+    }): Promise<TransactionReceipt | UserOperationReceipt>;
     createPlan({ priceConfig, creditsConfig, owner, nonce, addFees, isTrialPlan, organizationCryptoFee, organizationCryptoWallet, txParams, }: {
         priceConfig: PriceConfig;
         creditsConfig: CreditsConfig;
@@ -27,8 +37,8 @@ export declare class AssetRegistry extends ContractBase {
         organizationCryptoWallet?: string;
         txParams?: TxParameters;
     }): Promise<TransactionReceipt | UserOperationReceipt>;
-    registerAssetAndPlan({ didSeed, url, priceConfig, creditsConfig, owner, addFees, organizationCryptoFee, organizationCryptoWallet, txParams, }: {
-        didSeed: string;
+    registerAgentAndPlan({ seed, url, priceConfig, creditsConfig, owner, addFees, organizationCryptoFee, organizationCryptoWallet, txParams, }: {
+        seed: string;
         url: string;
         priceConfig: PriceConfig;
         creditsConfig: CreditsConfig;
@@ -44,19 +54,20 @@ export declare class AssetRegistry extends ContractBase {
         plan?: Plan;
     }): Promise<bigint>;
     planExists(id: bigint): Promise<boolean>;
-    addPlanToAsset(planId: bigint, did: string, owner: Account | SmartAccount, txParams?: TxParameters): Promise<TransactionReceipt | UserOperationReceipt>;
-    removePlanFromAsset(planId: bigint, did: string, owner: Account | SmartAccount, txParams?: TxParameters): Promise<TransactionReceipt | UserOperationReceipt>;
-    planConfigPreFilter(priceConfig: PriceConfig, creditsConfig: CreditsConfig, addFees?: boolean, organizationCryptoFee?: bigint, organizationCryptoWallet?: string): Promise<{
+    addPlanToAgent(planId: bigint, agentId: string | bigint, owner: Account | SmartAccount, txParams?: TxParameters): Promise<TransactionReceipt | UserOperationReceipt>;
+    removePlanFromAgent(planId: bigint, agentId: string | bigint, owner: Account | SmartAccount, txParams?: TxParameters): Promise<TransactionReceipt | UserOperationReceipt>;
+    planConfigPreFilter(priceConfig: PriceConfig, creditsConfig: CreditsConfig, includeFees?: boolean, organizationCryptoFee?: bigint, organizationCryptoWallet?: string): Promise<{
         priceConfig: {
-            priceType: import("@nvm-monorepo/commons").PriceType;
+            isCrypto: boolean;
             tokenAddress?: Address;
             amounts: bigint[];
             receivers: string[];
-            contractAddress?: Address;
+            externalPriceAddress?: Address;
             feeController?: Address;
+            templateAddress?: Address;
         };
         creditsConfig: {
-            creditsType: CreditsType;
+            isRedemptionAmountFixed: boolean;
             redemptionType: import("@nvm-monorepo/commons").RedemptionType;
             proofRequired: boolean;
             durationSecs: bigint;
@@ -67,7 +78,28 @@ export declare class AssetRegistry extends ContractBase {
         };
     }>;
     hashPlanId(_priceConfig: PriceConfig, _creditsConfig: CreditsConfig, owner: Address, addFees?: boolean, nonce?: bigint, organizationCryptoFee?: bigint, organizationCryptoWallet?: string): Promise<bigint>;
+    /**
+     * @notice Checks if Nevermined fees are included in the payment distribution
+     * @param _planId The ID of the plan to check
+     * @return bool True if Nevermined fees are properly included
+     */
     areNeverminedFeesIncluded(priceConfig: PriceConfig): Promise<boolean>;
+    /**
+     * @notice Getting a payment distribution, it includes the Nevermined fees if not already included
+     * This method subsctracts the fees from the original amounts and adds a new entry for the fee recipient
+     * @param priceConfig The price configuration of the plan
+     * @param creditsConfig The credits configuration of the plan
+     * @return amounts Updated array of payment amounts including fees
+     * @return receivers Updated array of payment receivers including fee recipient
+     */
+    includeFeesInPaymentsDistribution(priceConfig: PriceConfig, creditsConfig: CreditsConfig): Promise<[bigint[], string[]]>;
+    /**
+     * @notice Adds Nevermined fees to the payment distribution if not already included
+     * @param priceConfig The price configuration of the plan
+     * @param creditsConfig The credits configuration of the plan
+     * @return amounts Updated array of payment amounts including fees
+     * @return receivers Updated array of payment receivers including fee recipient
+     */
     addFeesToPaymentsDistribution(priceConfig: PriceConfig, creditsConfig: CreditsConfig): Promise<[bigint[], string[]]>;
 }
 //# sourceMappingURL=AssetRegistry.d.ts.map

package/dist/contracts/AssetRegistry.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AssetRegistry.d.ts","sourceRoot":"","sources":["../../src/contracts/AssetRegistry.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,QAAQ,EAAE,IAAI,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AAC/F,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,EAAa,kBAAkB,EAAE,MAAM,MAAM,CAAA;AAC3E,OAAO,EAAE,YAAY,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAA;AAS7E,OAAO,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAA;AAChE,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAA;AAExD,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAEhD,qBAAa,aAAc,SAAQ,YAAY;WAChB,WAAW,CAAC,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,aAAa,CAAC;IAS/E,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC;IAIzD,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAMxC,WAAW,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC;IAIvC,QAAQ,CAAC,EACpB,OAAO,EACP,GAAG,EACH,KAAK,EACL,KAAK,EACL,QAAQ,GACT,EAAE;QACD,OAAO,EAAE,MAAM,CAAA;QACf,GAAG,EAAE,MAAM,CAAA;QACX,KAAK,EAAE,MAAM,EAAE,CAAA;QACf,KAAK,EAAE,OAAO,GAAG,YAAY,CAAA;QAC7B,QAAQ,CAAC,EAAE,YAAY,CAAA;KACxB,GAAG,OAAO,CAAC,kBAAkB,GAAG,oBAAoB,CAAC;IAIzC,UAAU,CAAC,EACtB,WAAW,EACX,aAAa,EACb,KAAK,EACL,KAAU,EACV,OAAc,EACd,WAAmB,EACnB,qBAAqB,EACrB,wBAAwB,EACxB,QAAQ,GACT,EAAE;QACD,WAAW,EAAE,WAAW,CAAA;QACxB,aAAa,EAAE,aAAa,CAAA;QAC5B,KAAK,EAAE,OAAO,GAAG,YAAY,CAAA;QAC7B,KAAK,CAAC,EAAE,MAAM,CAAA;QACd,OAAO,CAAC,EAAE,OAAO,CAAA;QACjB,WAAW,CAAC,EAAE,OAAO,CAAA;QACrB,qBAAqB,CAAC,EAAE,MAAM,CAAA;QAC9B,wBAAwB,CAAC,EAAE,MAAM,CAAA;QACjC,QAAQ,CAAC,EAAE,YAAY,CAAA;KACxB,GAAG,OAAO,CAAC,kBAAkB,GAAG,oBAAoB,CAAC;IA2BzC,oBAAoB,CAAC,EAChC,OAAO,EACP,GAAG,EACH,WAAW,EACX,aAAa,EACb,KAAK,EACL,OAAc,EACd,qBAAqB,EACrB,wBAAwB,EACxB,QAAQ,GACT,EAAE;QACD,OAAO,EAAE,MAAM,CAAA;QACf,GAAG,EAAE,MAAM,CAAA;QACX,WAAW,EAAE,WAAW,CAAA;QACxB,aAAa,EAAE,aAAa,CAAA;QAC5B,KAAK,EAAE,OAAO,GAAG,YAAY,CAAA;QAC7B,OAAO,CAAC,EAAE,OAAO,CAAA;QACjB,qBAAqB,CAAC,EAAE,MAAM,CAAA;QAC9B,wBAAwB,CAAC,EAAE,MAAM,CAAA;QACjC,QAAQ,CAAC,EAAE,YAAY,CAAA;KACxB,GAAG,OAAO,CAAC,kBAAkB,GAAG,oBAAoB,CAAC;IAiBzC,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAMtC,iBAAiB,CAAC,EAC7B,MAAM,EACN,IAAI,GACL,EAAE;QACD,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,IAAI,CAAC,EAAE,IAAI,CAAA;KACZ,GAAG,OAAO,CAAC,MAAM,CAAC;IAYN,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAIxC,cAAc,CACzB,MAAM,EAAE,MAAM,EACd,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,OAAO,GAAG,YAAY,EAC7B,QAAQ,CAAC,EAAE,YAAY,GACtB,OAAO,CAAC,kBAAkB,GAAG,oBAAoB,CAAC;IAIxC,mBAAmB,CAC9B,MAAM,EAAE,MAAM,EACd,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,OAAO,GAAG,YAAY,EAC7B,QAAQ,CAAC,EAAE,YAAY,GACtB,OAAO,CAAC,kBAAkB,GAAG,oBAAoB,CAAC;IAIxC,mBAAmB,CAC9B,WAAW,EAAE,WAAW,EACxB,aAAa,EAAE,aAAa,EAC5B,OAAO,UAAO,EACd,qBAAqB,CAAC,EAAE,MAAM,EAC9B,wBAAwB,CAAC,EAAE,MAAM;;;;;;;;;;;;;;;;;;;;IA8BtB,UAAU,CACrB,YAAY,EAAE,WAAW,EACzB,cAAc,EAAE,aAAa,EAC7B,KAAK,EAAE,OAAO,EACd,OAAO,UAAO,EACd,KAAK,SAAK,EACV,qBAAqB,CAAC,EAAE,MAAM,EAC9B,wBAAwB,CAAC,EAAE,MAAM,GAChC,OAAO,CAAC,MAAM,CAAC;IAgBL,yBAAyB,CAAC,WAAW,EAAE,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC;IAOrE,6BAA6B,CACxC,WAAW,EAAE,WAAW,EACxB,aAAa,EAAE,aAAa,GAC3B,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;CAOjC"}
+{"version":3,"file":"AssetRegistry.d.ts","sourceRoot":"","sources":["../../src/contracts/AssetRegistry.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,QAAQ,EAAE,IAAI,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AAClF,OAAO,EAAE,OAAO,EAAE,OAAO,EAAa,kBAAkB,EAAe,MAAM,MAAM,CAAA;AACnF,OAAO,EAAE,YAAY,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAA;AAU7E,OAAO,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAA;AAChE,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAA;AAExD,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAEhD,qBAAa,aAAc,SAAQ,YAAY;WAChB,WAAW,CAAC,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,aAAa,CAAC;IAS/E,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC;IAI1D,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAMrD,QAAQ,CAAC,EACpB,IAAI,EACJ,GAAG,EACH,KAAK,EACL,KAAK,EACL,QAAQ,GACT,EAAE;QACD,IAAI,EAAE,MAAM,CAAA;QACZ,GAAG,EAAE,MAAM,CAAA;QACX,KAAK,EAAE,MAAM,EAAE,CAAA;QACf,KAAK,EAAE,OAAO,GAAG,YAAY,CAAA;QAC7B,QAAQ,CAAC,EAAE,YAAY,CAAA;KACxB,GAAG,OAAO,CAAC,kBAAkB,GAAG,oBAAoB,CAAC;IAIzC,oBAAoB,CAAC,EAChC,WAAW,EACX,aAAa,EACb,KAAK,EACL,KAAU,EACV,OAAc,EACd,WAAmB,EACnB,qBAAqB,EACrB,wBAAwB,EACxB,QAAQ,GACT,EAAE;QACD,WAAW,EAAE,WAAW,CAAA;QACxB,aAAa,EAAE,aAAa,CAAA;QAC5B,KAAK,EAAE,OAAO,GAAG,YAAY,CAAA;QAC7B,KAAK,CAAC,EAAE,MAAM,CAAA;QACd,OAAO,CAAC,EAAE,OAAO,CAAA;QACjB,WAAW,CAAC,EAAE,OAAO,CAAA;QACrB,qBAAqB,CAAC,EAAE,MAAM,CAAA;QAC9B,wBAAwB,CAAC,EAAE,MAAM,CAAA;QACjC,QAAQ,CAAC,EAAE,YAAY,CAAA;KACxB,GAAG,OAAO,CAAC,kBAAkB,GAAG,oBAAoB,CAAC;IAezC,UAAU,CAAC,EACtB,WAAW,EACX,aAAa,EACb,KAAK,EACL,KAAU,EACV,OAAc,EACd,WAAmB,EACnB,qBAAqB,EACrB,wBAAwB,EACxB,QAAQ,GACT,EAAE;QACD,WAAW,EAAE,WAAW,CAAA;QACxB,aAAa,EAAE,aAAa,CAAA;QAC5B,KAAK,EAAE,OAAO,GAAG,YAAY,CAAA;QAC7B,KAAK,CAAC,EAAE,MAAM,CAAA;QACd,OAAO,CAAC,EAAE,OAAO,CAAA;QACjB,WAAW,CAAC,EAAE,OAAO,CAAA;QACrB,qBAAqB,CAAC,EAAE,MAAM,CAAA;QAC9B,wBAAwB,CAAC,EAAE,MAAM,CAAA;QACjC,QAAQ,CAAC,EAAE,YAAY,CAAA;KACxB,GAAG,OAAO,CAAC,kBAAkB,GAAG,oBAAoB,CAAC;IA2BzC,oBAAoB,CAAC,EAChC,IAAI,EACJ,GAAG,EACH,WAAW,EACX,aAAa,EACb,KAAK,EACL,OAAc,EACd,qBAAqB,EACrB,wBAAwB,EACxB,QAAQ,GACT,EAAE;QACD,IAAI,EAAE,MAAM,CAAA;QACZ,GAAG,EAAE,MAAM,CAAA;QACX,WAAW,EAAE,WAAW,CAAA;QACxB,aAAa,EAAE,aAAa,CAAA;QAC5B,KAAK,EAAE,OAAO,GAAG,YAAY,CAAA;QAC7B,OAAO,CAAC,EAAE,OAAO,CAAA;QACjB,qBAAqB,CAAC,EAAE,MAAM,CAAA;QAC9B,wBAAwB,CAAC,EAAE,MAAM,CAAA;QACjC,QAAQ,CAAC,EAAE,YAAY,CAAA;KACxB,GAAG,OAAO,CAAC,kBAAkB,GAAG,oBAAoB,CAAC;IAiBzC,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAMtC,iBAAiB,CAAC,EAC7B,MAAM,EACN,IAAI,GACL,EAAE;QACD,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,IAAI,CAAC,EAAE,IAAI,CAAA;KACZ,GAAG,OAAO,CAAC,MAAM,CAAC;IAYN,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAIxC,cAAc,CACzB,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,MAAM,GAAG,MAAM,EACxB,KAAK,EAAE,OAAO,GAAG,YAAY,EAC7B,QAAQ,CAAC,EAAE,YAAY,GACtB,OAAO,CAAC,kBAAkB,GAAG,oBAAoB,CAAC;IAIxC,mBAAmB,CAC9B,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,MAAM,GAAG,MAAM,EACxB,KAAK,EAAE,OAAO,GAAG,YAAY,EAC7B,QAAQ,CAAC,EAAE,YAAY,GACtB,OAAO,CAAC,kBAAkB,GAAG,oBAAoB,CAAC;IAIxC,mBAAmB,CAC9B,WAAW,EAAE,WAAW,EACxB,aAAa,EAAE,aAAa,EAC5B,WAAW,UAAO,EAClB,qBAAqB,CAAC,EAAE,MAAM,EAC9B,wBAAwB,CAAC,EAAE,MAAM;;;;;;;;;;;;;;;;;;;;;IAiCtB,UAAU,CACrB,YAAY,EAAE,WAAW,EACzB,cAAc,EAAE,aAAa,EAC7B,KAAK,EAAE,OAAO,EACd,OAAO,UAAO,EACd,KAAK,SAAK,EACV,qBAAqB,CAAC,EAAE,MAAM,EAC9B,wBAAwB,CAAC,EAAE,MAAM,GAChC,OAAO,CAAC,MAAM,CAAC;IAgBlB;;;;OAIG;IACU,yBAAyB,CAAC,WAAW,EAAE,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC;IAOlF;;;;;;;OAOG;IACU,iCAAiC,CAC5C,WAAW,EAAE,WAAW,EACxB,aAAa,EAAE,aAAa,GAC3B,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IAQhC;;;;;;OAMG;IACU,6BAA6B,CACxC,WAAW,EAAE,WAAW,EACxB,aAAa,EAAE,aAAa,GAC3B,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;CAOjC"}

package/dist/contracts/AssetRegistry.js

@@ -1,8 +1,7 @@
-import { CreditsType } from '@nvm-monorepo/commons';
-import { isAddress } from 'viem';
-import { assetsRegistryConfig, nft1155CreditsAddress, nft1155ExpirableCreditsAddress, oneTimeCreatorHookAddress, protocolStandardFeesAddress, } from '../artifacts/generated.js';
-import { AssetNotFound, PlanNotFound } from '../errors/NeverminedErrors.js';
-import { didZeroX } from '../utils/ConversionTypeHelpers.js';
+import { isAddress, zeroAddress } from 'viem';
+import { assetsRegistryConfig, nft1155CreditsAddress, nft1155ExpirableCreditsAddress, oneTimeCreatorHookAddress, payAsYouGoTemplateAddress, protocolStandardFeesAddress, } from '../artifacts/generated.js';
+import { AgentNotFound, PlanNotFound } from '../errors/NeverminedErrors.js';
+import { zeroX, toAgentId } from '../utils/ConversionTypeHelpers.js';
 import { ContractBase } from './ContractBase.js';
 export class AssetRegistry extends ContractBase {
     static async getInstance(config) {
@@ -10,21 +9,32 @@ export class AssetRegistry extends ContractBase {
         await assetRegistry.init(config, assetsRegistryConfig);
         return assetRegistry;
     }
-    async hashDID(didSeed, owner) {
-        return this.contract.read.hashDID([didSeed, owner]);
+    async hashAgentId(seed, owner) {
+        return this.contract.read.hashAgentId([seed, owner]);
     }
-    async getAsset(did) {
-        const didAsset = await this.contract.read.getAsset([did]);
-        if (didAsset.lastUpdated != 0)
-            return didAsset;
+    async getAgent(agentId) {
+        const didAgent = await this.contract.read.getAgent([toAgentId(agentId)]);
+        if (didAgent.lastUpdated != 0)
+            return didAgent;
         else
-            throw new AssetNotFound(`Asset with DID ${did} not found`);
+            throw new AgentNotFound(`Agent with id ${agentId} not found`);
     }
-    async assetExists(did) {
-        return this.contract.read.assetExists([did]);
+    async register({ seed, url, plans, owner, txParams, }) {
+        return this.send('register', owner, [zeroX(seed), url, plans], txParams);
     }
-    async register({ didSeed, url, plans, owner, txParams, }) {
-        return this.send('register', owner, [didZeroX(didSeed), url, plans], txParams);
+    async createPayAsYouGoPlan({ priceConfig, creditsConfig, owner, nonce = 0n, addFees = true, isTrialPlan = false, organizationCryptoFee, organizationCryptoWallet, txParams, }) {
+        priceConfig.templateAddress = payAsYouGoTemplateAddress;
+        return this.createPlan({
+            priceConfig,
+            creditsConfig,
+            owner,
+            nonce,
+            addFees,
+            isTrialPlan,
+            organizationCryptoFee,
+            organizationCryptoWallet,
+            txParams,
+        });
     }
     async createPlan({ priceConfig, creditsConfig, owner, nonce = 0n, addFees = true, isTrialPlan = false, organizationCryptoFee, organizationCryptoWallet, txParams, }) {
         const _config = await this.planConfigPreFilter(priceConfig, creditsConfig, addFees, organizationCryptoFee, organizationCryptoWallet);
@@ -36,9 +46,9 @@ export class AssetRegistry extends ContractBase {
             return this.send('createPlan', owner, [_config.priceConfig, _config.creditsConfig, nonce], txParams);
         }
     }
-    async registerAssetAndPlan({ didSeed, url, priceConfig, creditsConfig, owner, addFees = true, organizationCryptoFee, organizationCryptoWallet, txParams, }) {
+    async registerAgentAndPlan({ seed, url, priceConfig, creditsConfig, owner, addFees = true, organizationCryptoFee, organizationCryptoWallet, txParams, }) {
         const _config = await this.planConfigPreFilter(priceConfig, creditsConfig, addFees, organizationCryptoFee, organizationCryptoWallet);
-        return this.send('registerAssetAndPlan', owner, [didZeroX(didSeed), url, _config.priceConfig, _config.creditsConfig], txParams);
+        return this.send('registerAgentAndPlan', owner, [zeroX(seed), url, _config.priceConfig, _config.creditsConfig], txParams);
     }
     async getPlan(planId) {
         const plan = this.contract.read.getPlan([planId]);
@@ -61,27 +71,29 @@ export class AssetRegistry extends ContractBase {
     async planExists(id) {
         return this.contract.read.planExists([id]);
     }
-    async addPlanToAsset(planId, did, owner, txParams) {
-        return this.send('addPlanToAsset', owner, [didZeroX(did), planId], txParams);
+    async addPlanToAgent(planId, agentId, owner, txParams) {
+        return this.send('addPlanToAgent', owner, [toAgentId(agentId), planId], txParams);
     }
-    async removePlanFromAsset(planId, did, owner, txParams) {
-        return this.send('removePlanFromAsset', owner, [didZeroX(did), planId], txParams);
+    async removePlanFromAgent(planId, agentId, owner, txParams) {
+        return this.send('removePlanFromAgent', owner, [toAgentId(agentId), planId], txParams);
     }
-    async planConfigPreFilter(priceConfig, creditsConfig, addFees = true, organizationCryptoFee, organizationCryptoWallet) {
+    async planConfigPreFilter(priceConfig, creditsConfig, includeFees = true, organizationCryptoFee, organizationCryptoWallet) {
         const _priceConfig = { ...priceConfig };
         const _creditsConfig = { ...creditsConfig };
         if (!priceConfig.feeController || !isAddress(priceConfig.feeController))
             _priceConfig.feeController = protocolStandardFeesAddress;
+        if (!priceConfig.templateAddress || !isAddress(priceConfig.templateAddress))
+            _priceConfig.templateAddress = zeroAddress;
         if (!creditsConfig.nftAddress || !isAddress(creditsConfig.nftAddress)) {
-            if (creditsConfig.creditsType === CreditsType.EXPIRABLE) {
+            if (creditsConfig.durationSecs > 0n) {
                 _creditsConfig.nftAddress = nft1155ExpirableCreditsAddress;
             }
             else {
                 _creditsConfig.nftAddress = nft1155CreditsAddress;
             }
         }
-        if (addFees) {
-            const fees = await this.addFeesToPaymentsDistribution(_priceConfig, _creditsConfig);
+        if (includeFees) {
+            const fees = await this.includeFeesInPaymentsDistribution(_priceConfig, _creditsConfig);
             _priceConfig.amounts = fees[0];
             _priceConfig.receivers = fees[1];
         }
@@ -100,12 +112,39 @@ export class AssetRegistry extends ContractBase {
             nonce,
         ]);
     }
+    /**
+     * @notice Checks if Nevermined fees are included in the payment distribution
+     * @param _planId The ID of the plan to check
+     * @return bool True if Nevermined fees are properly included
+     */
     async areNeverminedFeesIncluded(priceConfig) {
         return await this.contract.read.areNeverminedFeesIncluded([
             priceConfig.amounts,
             priceConfig.receivers,
         ]);
     }
+    /**
+     * @notice Getting a payment distribution, it includes the Nevermined fees if not already included
+     * This method subsctracts the fees from the original amounts and adds a new entry for the fee recipient
+     * @param priceConfig The price configuration of the plan
+     * @param creditsConfig The credits configuration of the plan
+     * @return amounts Updated array of payment amounts including fees
+     * @return receivers Updated array of payment receivers including fee recipient
+     */
+    async includeFeesInPaymentsDistribution(priceConfig, creditsConfig) {
+        const result = await this.contract.read.includeFeesInPaymentsDistribution([
+            priceConfig,
+            creditsConfig,
+        ]);
+        return result;
+    }
+    /**
+     * @notice Adds Nevermined fees to the payment distribution if not already included
+     * @param priceConfig The price configuration of the plan
+     * @param creditsConfig The credits configuration of the plan
+     * @return amounts Updated array of payment amounts including fees
+     * @return receivers Updated array of payment receivers including fee recipient
+     */
     async addFeesToPaymentsDistribution(priceConfig, creditsConfig) {
         const result = await this.contract.read.addFeesToPaymentsDistribution([
             priceConfig,

package/dist/contracts/ContractBase.d.ts

@@ -21,9 +21,12 @@ export declare abstract class ContractBase extends Instantiable {
     getTransactionReceipt(txHash: UserOperationReceipt | TransactionReceipt): Promise<TransactionReceipt>;
     getTransactionLogs(txReceipt: TransactionReceipt | UserOperationReceipt, eventName?: string): any[];
     multicall(calls: MulticallEntry[], from: Account | SmartAccount, params?: TxParameters): Promise<TransactionReceipt | undefined>;
+    simulate(functionName: string, from: Account | SmartAccount, args: any[], params?: TxParameters): Promise<boolean>;
     send(functionName: string, from: Account | SmartAccount, args: any[], params?: TxParameters): Promise<TransactionReceipt | UserOperationReceipt>;
     private internalMulticallSmartAccount;
     private internalSendSmartAccount;
+    private internalSimulateSmartAccount;
+    private localAccountSimulate;
     private localAccountSend;
     private localAccountMulticall;
 }

package/dist/contracts/ContractBase.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ContractBase.d.ts","sourceRoot":"","sources":["../../src/contracts/ContractBase.ts"],"names":[],"mappings":"AACA,OAAO,EACL,GAAG,EACH,OAAO,EACP,OAAO,EAQP,kBAAkB,EACnB,MAAM,MAAM,CAAA;AACb,OAAO,EAAE,YAAY,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAA;AAE7E,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAA;AAC9E,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAA;AAIxD,MAAM,WAAW,cAAc;IAC7B,eAAe,EAAE,OAAO,CAAA;IACxB,GAAG,EAAE,GAAG,CAAA;IACR,YAAY,EAAE,MAAM,CAAA;IACpB,IAAI,EAAE,GAAG,EAAE,CAAA;CACZ;AAED,8BAAsB,YAAa,SAAQ,YAAY;IACrD,SAAgB,YAAY,EAAE,MAAM,CAAA;IAC7B,QAAQ,EAAE,GAAG,CAAA;IACb,OAAO,EAAE,OAAO,CAAA;gBAEX,YAAY,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO;cAMlC,IAAI,CAClB,MAAM,EAAE,kBAAkB,EAC1B,cAAc,EAAE;QAAE,OAAO,EAAE,KAAK,MAAM,EAAE,CAAC;QAAC,GAAG,EAAE,GAAG,CAAA;KAAE;IAYzC,IAAI,CAAC,CAAC,EAAE,YAAY,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC;IAiBrE,qBAAqB,CAChC,MAAM,EAAE,oBAAoB,GAAG,kBAAkB,GAChD,OAAO,CAAC,kBAAkB,CAAC;IAiBvB,kBAAkB,CACvB,SAAS,EAAE,kBAAkB,GAAG,oBAAoB,EACpD,SAAS,CAAC,EAAE,MAAM,GAOZ,GAAG,EAAE;IAGA,SAAS,CACpB,KAAK,EAAE,cAAc,EAAE,EACvB,IAAI,EAAE,OAAO,GAAG,YAAY,EAC5B,MAAM,GAAE,YAAiB;IAgBd,IAAI,CACf,YAAY,EAAE,MAAM,EACpB,IAAI,EAAE,OAAO,GAAG,YAAY,EAC5B,IAAI,EAAE,GAAG,EAAE,EACX,MAAM,GAAE,YAAiB,GACxB,OAAO,CAAC,kBAAkB,GAAG,oBAAoB,CAAC;YAiBvC,6BAA6B;YA+E7B,wBAAwB;YA8HxB,gBAAgB;YAkGhB,qBAAqB;CAepC"}
+{"version":3,"file":"ContractBase.d.ts","sourceRoot":"","sources":["../../src/contracts/ContractBase.ts"],"names":[],"mappings":"AACA,OAAO,EACL,GAAG,EACH,OAAO,EACP,OAAO,EAQP,kBAAkB,EACnB,MAAM,MAAM,CAAA;AACb,OAAO,EAAE,YAAY,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAA;AAE7E,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAA;AAC9E,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAA;AAIxD,MAAM,WAAW,cAAc;IAC7B,eAAe,EAAE,OAAO,CAAA;IACxB,GAAG,EAAE,GAAG,CAAA;IACR,YAAY,EAAE,MAAM,CAAA;IACpB,IAAI,EAAE,GAAG,EAAE,CAAA;CACZ;AAED,8BAAsB,YAAa,SAAQ,YAAY;IACrD,SAAgB,YAAY,EAAE,MAAM,CAAA;IAC7B,QAAQ,EAAE,GAAG,CAAA;IACb,OAAO,EAAE,OAAO,CAAA;gBAEX,YAAY,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO;cAMlC,IAAI,CAClB,MAAM,EAAE,kBAAkB,EAC1B,cAAc,EAAE;QAAE,OAAO,EAAE,KAAK,MAAM,EAAE,CAAC;QAAC,GAAG,EAAE,GAAG,CAAA;KAAE;IAYzC,IAAI,CAAC,CAAC,EAAE,YAAY,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC;IAiBrE,qBAAqB,CAChC,MAAM,EAAE,oBAAoB,GAAG,kBAAkB,GAChD,OAAO,CAAC,kBAAkB,CAAC;IAiBvB,kBAAkB,CACvB,SAAS,EAAE,kBAAkB,GAAG,oBAAoB,EACpD,SAAS,CAAC,EAAE,MAAM,GAOZ,GAAG,EAAE;IAGA,SAAS,CACpB,KAAK,EAAE,cAAc,EAAE,EACvB,IAAI,EAAE,OAAO,GAAG,YAAY,EAC5B,MAAM,GAAE,YAAiB;IAgBd,QAAQ,CACnB,YAAY,EAAE,MAAM,EACpB,IAAI,EAAE,OAAO,GAAG,YAAY,EAC5B,IAAI,EAAE,GAAG,EAAE,EACX,MAAM,GAAE,YAAiB;IAgBd,IAAI,CACf,YAAY,EAAE,MAAM,EACpB,IAAI,EAAE,OAAO,GAAG,YAAY,EAC5B,IAAI,EAAE,GAAG,EAAE,EACX,MAAM,GAAE,YAAiB,GACxB,OAAO,CAAC,kBAAkB,GAAG,oBAAoB,CAAC;YAiBvC,6BAA6B;YA+E7B,wBAAwB;YA8HxB,4BAA4B;YAoD5B,oBAAoB;YAuBpB,gBAAgB;YAkGhB,qBAAqB;CAepC"}

package/dist/contracts/ContractBase.js

@@ -1,6 +1,6 @@
 import { createKernelAccountClient, createZeroDevPaymasterClient } from '@zerodev/sdk';
 import { BaseError, ContractFunctionRevertedError, encodeFunctionData, getContract, http, parseAbi, parseEventLogs, } from 'viem';
-import { ContractsError } from '../errors/index.js';
+import { ContractsError, ContractSimulationError } from '../errors/index.js';
 import { Instantiable } from '../Instantiable.abstract.js';
 import { getInputsOfFunctionFormatted, getTransactionReceipt } from '../nevermined/index.js';
 import { getChain } from '../utils/Network.js';
@@ -80,6 +80,23 @@ export class ContractBase extends Instantiable {
             throw new ContractsError(`Account not supported`);
         }
     }
+    async simulate(functionName, from, args, params = {}) {
+        if (from.type === 'local') {
+            this.logger.debug(`Simulating call to: ${functionName} and following args: ${args}`);
+            return await this.localAccountSimulate(functionName, from, args, params);
+        }
+        else if (from.type === 'json-rpc') {
+            this.logger.debug(`Simulating call to: ${functionName} and following args: ${args}`);
+            return await this.localAccountSimulate(functionName, from, args, params);
+        }
+        else if (from.type === 'smart') {
+            this.logger.debug(`Simulating call to: ${functionName} and following args: ${args}`);
+            return await this.internalSimulateSmartAccount(functionName, from, args, params);
+        }
+        else {
+            throw new ContractsError(`Account not supported`);
+        }
+    }
     async send(functionName, from, args, params = {}) {
         if (from.type === 'local') {
             this.logger.debug(`Blockchain Send using Local account with functionName: ${functionName} and following args: ${args}`);
@@ -151,7 +168,7 @@ export class ContractBase extends Instantiable {
                 });
             }
             // Wait for the transaction to be mined
-            this.logger.debug(`Waiting for transaction to be mined...`, userOpHash);
+            this.logger.debug(`Waiting for transaction to be mined... ${userOpHash}`);
             const txReceipt = await kernelClient.waitForUserOperationReceipt({ hash: userOpHash });
             this.logger.debug(`Transaction mined: ${userOpHash}`);
             return txReceipt.receipt;
@@ -159,7 +176,7 @@ export class ContractBase extends Instantiable {
         catch (err) {
             if (err instanceof BaseError) {
                 const revertError = err.walk((err) => err instanceof ContractFunctionRevertedError);
-                this.logger.error('revertError', revertError);
+                this.logger.error(`revertError: ${String(revertError)}`);
             }
             throw new ContractsError(`Multicall failed: ${err}`);
         }
@@ -193,7 +210,7 @@ export class ContractBase extends Instantiable {
         catch (err) {
             if (err instanceof BaseError) {
                 const revertError = err.walk((err) => err instanceof ContractFunctionRevertedError);
-                this.logger.error('revertError', revertError);
+                this.logger.error(`revertError: ${String(revertError)}`);
             }
             throw new ContractsError(`Calling method "${name}" on contract "${this.contractName}" failed. Args: ${args} - ${err}`);
         }
@@ -234,7 +251,7 @@ export class ContractBase extends Instantiable {
         catch (err) {
             if (err instanceof BaseError) {
                 const revertError = err.walk((err) => err instanceof ContractFunctionRevertedError);
-                this.logger.error('revertError', revertError);
+                this.logger.error(`revertError: ${String(revertError)}`);
             }
             throw new ContractsError(`Calling method "${name}" on contract "${this.contractName}" failed. Args: ${args} - ${err}`);
         }
@@ -267,10 +284,66 @@ export class ContractBase extends Instantiable {
         }
         return txReceipt;
     }
+    async internalSimulateSmartAccount(name, from, args, txparams) {
+        const ZERODEV_RPC = `https://rpc.zerodev.app/api/v3/${this.config.zeroDevProjectId}/chain/${this.config.chainId}`;
+        try {
+            const zerodevPaymaster = createZeroDevPaymasterClient({
+                chain: getChain(this.config.chainId),
+                transport: http(ZERODEV_RPC),
+            });
+            const kernelClient = createKernelAccountClient({
+                account: from,
+                // Replace with your chain
+                chain: getChain(this.config.chainId),
+                // Find the RPC in your ZeroDev dashboard
+                bundlerTransport: http(ZERODEV_RPC),
+                // Required - the public client
+                client: this.contract.publicClient,
+                // Optional -- only if you want to use a paymaster
+                paymaster: {
+                    getPaymasterData: (userOperation) => {
+                        return zerodevPaymaster.sponsorUserOperation({
+                            userOperation,
+                        });
+                    },
+                },
+            });
+            const data = encodeFunctionData({ abi: this.contract.abi, functionName: name, args });
+            kernelClient.estimateUserOperationGas({
+                callData: await kernelClient.account.encodeCalls([
+                    {
+                        to: this.address,
+                        value: txparams.value || 0n,
+                        data,
+                    },
+                ]),
+            });
+            return true;
+        }
+        catch (err) {
+            throw new ContractSimulationError(`Error Simulating contract call "${name}" on contract "${this.contractName}" failed. Args: ${args} - ${err}`);
+        }
+    }
+    async localAccountSimulate(name, from, args, txparams) {
+        try {
+            await this.client.public.simulateContract({
+                address: this.address,
+                abi: this.contract.abi,
+                functionName: name,
+                args,
+                account: from,
+                ...(txparams.value && { value: txparams.value }),
+            });
+        }
+        catch (err) {
+            throw new ContractSimulationError(`Error Simulating contract call "${name}" on contract "${this.contractName}" failed. Args: ${args} - ${err}`);
+        }
+        return true;
+    }
     async localAccountSend(name, from, args, txparams, progress) {
         const functionInputs = getInputsOfFunctionFormatted(this.contract.abi, name, args);
         // Uncomment to debug contract calls
-        // if (name === 'createAgreement') {
+        // if (name === 'order') {
         //   const functionSignature = getSignatureOfFunction(this.contract.abi, name, args)
         //   this.logger.info(`Making contract call ....: ${name} - ${from}`)
         //   this.logger.info(`With args: `, JSON.stringify(args, jsonReplacer))
@@ -318,7 +391,7 @@ export class ContractBase extends Instantiable {
         catch (err) {
             if (err instanceof BaseError) {
                 const revertError = err.walk((err) => err instanceof ContractFunctionRevertedError);
-                this.logger.error('revertError', revertError);
+                this.logger.error(`revertError: ${String(revertError)}`);
             }
             throw new ContractsError(`Calling method "${name}" on contract "${this.contractName}" failed. Args: ${args} - ${err}`);
         }

package/dist/contracts/ContractsApi.d.ts

@@ -3,6 +3,7 @@ import { AccessManager } from './AccessManager.js';
 import { AssetRegistry } from './AssetRegistry.js';
 import { FiatPaymentTemplate } from './FiatPaymentTemplate.js';
 import { FixedPaymentTemplate } from './FixedPaymentTemplate.js';
+import { PayAsYouGoTemplate } from './PayAsYouGoTemplate.js';
 import { NFT1155Credits } from './NFT1155Credits.js';
 import { NFT1155ExpirableCredits } from './NFT1155ExpirableCredits.js';
 import { NeverminedConfig } from './NVMConfig.js';
@@ -46,6 +47,12 @@ export declare class ContractsApi extends Instantiable {
      * Used for creating and managing payment agreements with predefined terms.
      */
     fixedPaymentTemplate: FixedPaymentTemplate;
+    /**
+     * PayAsYouGoTemplate smart contract instance.
+     * Handles pay-as-you-go payment agreements between parties.
+     * Used for creating and managing payment agreements with predefined terms.
+     */
+    payAsYouGoTemplate: PayAsYouGoTemplate;
     /**
      * FiatPaymentTemplate smart contract instance.
      * Handles fiat payment agreements between parties (i.e Stripe).

package/dist/contracts/ContractsApi.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ContractsApi.d.ts","sourceRoot":"","sources":["../../src/contracts/ContractsApi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAA;AAC9E,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAA;AAClD,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAA;AAClD,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAA;AAC9D,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAA;AAChE,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAA;AACpD,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAA;AACtE,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAA;AACjD,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAA;AAEhE,qBAAa,YAAa,SAAQ,YAAY;IAC5C;;;;OAIG;WAC0B,WAAW,CAAC,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,YAAY,CAAC;IAM9E,IAAI;IA0BjB;;OAEG;IACI,aAAa,EAAG,aAAa,CAAA;IACpC;;OAEG;IACI,SAAS,EAAG,gBAAgB,CAAA;IAEnC;;OAEG;IACI,aAAa,EAAG,aAAa,CAAA;IAEpC;;;;OAIG;IACI,cAAc,EAAG,cAAc,CAAA;IAEtC;;;;;OAKG;IACI,uBAAuB,EAAG,uBAAuB,CAAA;IAExD;;;;OAIG;IACI,oBAAoB,EAAG,oBAAoB,CAAA;IAElD;;;;OAIG;IACI,mBAAmB,EAAG,mBAAmB,CAAA;IAEhD;;;;OAIG;IACI,oBAAoB,EAAG,oBAAoB,CAAA;CACnD"}
+{"version":3,"file":"ContractsApi.d.ts","sourceRoot":"","sources":["../../src/contracts/ContractsApi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAA;AAC9E,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAA;AAClD,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAA;AAClD,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAA;AAC9D,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAA;AAChE,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAA;AAC5D,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAA;AACpD,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAA;AACtE,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAA;AACjD,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAA;AAEhE,qBAAa,YAAa,SAAQ,YAAY;IAC5C;;;;OAIG;WAC0B,WAAW,CAAC,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,YAAY,CAAC;IAM9E,IAAI;IAqCjB;;OAEG;IACI,aAAa,EAAG,aAAa,CAAA;IACpC;;OAEG;IACI,SAAS,EAAG,gBAAgB,CAAA;IAEnC;;OAEG;IACI,aAAa,EAAG,aAAa,CAAA;IAEpC;;;;OAIG;IACI,cAAc,EAAG,cAAc,CAAA;IAEtC;;;;;OAKG;IACI,uBAAuB,EAAG,uBAAuB,CAAA;IAExD;;;;OAIG;IACI,oBAAoB,EAAG,oBAAoB,CAAA;IAElD;;;;OAIG;IACI,kBAAkB,EAAG,kBAAkB,CAAA;IAE9C;;;;OAIG;IACI,mBAAmB,EAAG,mBAAmB,CAAA;IAEhD;;;;OAIG;IACI,oBAAoB,EAAG,oBAAoB,CAAA;CACnD"}

package/dist/contracts/ContractsApi.js

@@ -18,6 +18,7 @@ export class ContractsApi extends Instantiable {
         this.nft1155ExpirableCredits = await (await import('./NFT1155ExpirableCredits.js')).NFT1155ExpirableCredits.getInstance(this.instanceConfig);
         this.fixedPaymentTemplate = await (await import('./FixedPaymentTemplate.js')).FixedPaymentTemplate.getInstance(this.instanceConfig);
         this.fiatPaymentTemplate = await (await import('./FiatPaymentTemplate.js')).FiatPaymentTemplate.getInstance(this.instanceConfig);
+        this.payAsYouGoTemplate = await (await import('./PayAsYouGoTemplate.js')).PayAsYouGoTemplate.getInstance(this.instanceConfig);
         this.protocolStandardFees = await (await import('./ProtocolStandardFees.js')).ProtocolStandardFees.getInstance(this.instanceConfig);
     }
     /**
@@ -51,6 +52,12 @@ export class ContractsApi extends Instantiable {
      * Used for creating and managing payment agreements with predefined terms.
      */
     fixedPaymentTemplate;
+    /**
+     * PayAsYouGoTemplate smart contract instance.
+     * Handles pay-as-you-go payment agreements between parties.
+     * Used for creating and managing payment agreements with predefined terms.
+     */
+    payAsYouGoTemplate;
     /**
      * FiatPaymentTemplate smart contract instance.
      * Handles fiat payment agreements between parties (i.e Stripe).

package/dist/contracts/FiatPaymentTemplate.d.ts

@@ -5,6 +5,6 @@ import { TxParameters } from '../models/Transactions.js';
 import { ContractBase } from './ContractBase.js';
 export declare class FiatPaymentTemplate extends ContractBase {
     static getInstance(config: InstantiableConfig): Promise<FiatPaymentTemplate>;
-    createAgreement(planId: bigint, creditsReceiver: Address, owner: Account | SmartAccount, txParams?: TxParameters): Promise<import("viem").TransactionReceipt | import("viem/account-abstraction").UserOperationReceipt>;
+    order(planId: bigint, creditsReceiver: Address, owner: Account | SmartAccount, numberOfPurchases?: bigint, txParams?: TxParameters): Promise<import("viem").TransactionReceipt | import("viem/account-abstraction").UserOperationReceipt>;
 }
 //# sourceMappingURL=FiatPaymentTemplate.d.ts.map

package/dist/contracts/FiatPaymentTemplate.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"FiatPaymentTemplate.d.ts","sourceRoot":"","sources":["../../src/contracts/FiatPaymentTemplate.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,MAAM,CAAA;AACvC,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAA;AAEvD,OAAO,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAA;AAChE,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAA;AAExD,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAEhD,qBAAa,mBAAoB,SAAQ,YAAY;WACtB,WAAW,CACtC,MAAM,EAAE,kBAAkB,GACzB,OAAO,CAAC,mBAAmB,CAAC;IASlB,eAAe,CAC1B,MAAM,EAAE,MAAM,EACd,eAAe,EAAE,OAAO,EACxB,KAAK,EAAE,OAAO,GAAG,YAAY,EAC7B,QAAQ,CAAC,EAAE,YAAY;CAU1B"}
+{"version":3,"file":"FiatPaymentTemplate.d.ts","sourceRoot":"","sources":["../../src/contracts/FiatPaymentTemplate.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,MAAM,CAAA;AACvC,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAA;AAEvD,OAAO,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAA;AAChE,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAA;AAExD,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAEhD,qBAAa,mBAAoB,SAAQ,YAAY;WACtB,WAAW,CACtC,MAAM,EAAE,kBAAkB,GACzB,OAAO,CAAC,mBAAmB,CAAC;IASlB,KAAK,CAChB,MAAM,EAAE,MAAM,EACd,eAAe,EAAE,OAAO,EACxB,KAAK,EAAE,OAAO,GAAG,YAAY,EAC7B,iBAAiB,SAAK,EACtB,QAAQ,CAAC,EAAE,YAAY;CAU1B"}

package/dist/contracts/FiatPaymentTemplate.js

@@ -7,8 +7,8 @@ export class FiatPaymentTemplate extends ContractBase {
         await fiatPaymentTemplate.init(config, fiatPaymentTemplateConfig);
         return fiatPaymentTemplate;
     }
-    async createAgreement(planId, creditsReceiver, owner, txParams) {
+    async order(planId, creditsReceiver, owner, numberOfPurchases = 1n, txParams) {
         const agreementIdSeed = generateZeroXId();
-        return this.send('createAgreement', owner, [agreementIdSeed, planId, creditsReceiver, []], txParams);
+        return this.send('order', owner, [agreementIdSeed, planId, creditsReceiver, numberOfPurchases, []], txParams);
     }
 }

package/dist/contracts/FiatSettlementCondition.d.ts

@@ -6,6 +6,6 @@ import { TxParameters } from '../models/Transactions.js';
 export declare class FiatSettlementCondition extends ContractBase {
     static getInstance(config: InstantiableConfig): Promise<FiatSettlementCondition>;
     getFiatSettlementRole(): Promise<bigint>;
-    createAgreement(planId: bigint, planReceiver: Address, owner: Account | SmartAccount, txParams?: TxParameters): Promise<import("viem").TransactionReceipt | import("viem/account-abstraction").UserOperationReceipt>;
+    order(planId: bigint, planReceiver: Address, owner: Account | SmartAccount, txParams?: TxParameters): Promise<import("viem").TransactionReceipt | import("viem/account-abstraction").UserOperationReceipt>;
 }
 //# sourceMappingURL=FiatSettlementCondition.d.ts.map

package/dist/contracts/FiatSettlementCondition.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"FiatSettlementCondition.d.ts","sourceRoot":"","sources":["../../src/contracts/FiatSettlementCondition.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,MAAM,CAAA;AACvC,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAA;AAEvD,OAAO,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAA;AAChE,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAChD,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAA;AAIxD,qBAAa,uBAAwB,SAAQ,YAAY;WAC1B,WAAW,CACtC,MAAM,EAAE,kBAAkB,GACzB,OAAO,CAAC,uBAAuB,CAAC;IAStB,qBAAqB,IAAI,OAAO,CAAC,MAAM,CAAC;IAIxC,eAAe,CAC1B,MAAM,EAAE,MAAM,EACd,YAAY,EAAE,OAAO,EACrB,KAAK,EAAE,OAAO,GAAG,YAAY,EAC7B,QAAQ,CAAC,EAAE,YAAY;CAU1B"}
+{"version":3,"file":"FiatSettlementCondition.d.ts","sourceRoot":"","sources":["../../src/contracts/FiatSettlementCondition.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,MAAM,CAAA;AACvC,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAA;AAEvD,OAAO,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAA;AAChE,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAChD,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAA;AAIxD,qBAAa,uBAAwB,SAAQ,YAAY;WAC1B,WAAW,CACtC,MAAM,EAAE,kBAAkB,GACzB,OAAO,CAAC,uBAAuB,CAAC;IAStB,qBAAqB,IAAI,OAAO,CAAC,MAAM,CAAC;IAIxC,KAAK,CAChB,MAAM,EAAE,MAAM,EACd,YAAY,EAAE,OAAO,EACrB,KAAK,EAAE,OAAO,GAAG,YAAY,EAC7B,QAAQ,CAAC,EAAE,YAAY;CAK1B"}

package/dist/contracts/FiatSettlementCondition.js

@@ -11,8 +11,8 @@ export class FiatSettlementCondition extends ContractBase {
     async getFiatSettlementRole() {
         return FIAT_SETTLEMENT_ROLE;
     }
-    async createAgreement(planId, planReceiver, owner, txParams) {
+    async order(planId, planReceiver, owner, txParams) {
         const agreementIdSeed = generateZeroXId();
-        return this.send('createAgreement', owner, [agreementIdSeed, planId, planReceiver, []], txParams);
+        return this.send('order', owner, [agreementIdSeed, planId, planReceiver, []], txParams);
     }
 }

package/dist/contracts/FixedPaymentTemplate.d.ts

@@ -6,8 +6,8 @@ import { ContractBase } from './ContractBase.js';
 export declare class FixedPaymentTemplate extends ContractBase {
     private TOKEN_APPROVE_ABI;
     static getInstance(config: InstantiableConfig): Promise<FixedPaymentTemplate>;
-    createAgreement(planId: bigint, owner: Account | SmartAccount, creditsReceiver?: Address, txParams?: TxParameters): Promise<import("viem").TransactionReceipt | import("viem/account-abstraction").UserOperationReceipt>;
+    order(planId: bigint, owner: Account | SmartAccount, creditsReceiver?: Address, numberOfPurchases?: bigint, txParams?: TxParameters): Promise<import("viem").TransactionReceipt | import("viem/account-abstraction").UserOperationReceipt>;
     approveERC20(totalAmount: bigint, tokenAddress: Address, owner: Account | SmartAccount, txParams?: TxParameters): Promise<import("viem").TransactionReceipt | undefined>;
-    createAgreementWithApprovals(planId: bigint, totalAmount: bigint, tokenAddress: Address, owner: Account | SmartAccount, creditsReceiver?: Address, txParams?: TxParameters): Promise<import("viem").TransactionReceipt | undefined>;
+    orderWithApprovals(planId: bigint, totalAmount: bigint, tokenAddress: Address, owner: Account | SmartAccount, creditsReceiver?: Address, numberOfPurchases?: bigint, txParams?: TxParameters): Promise<import("viem").TransactionReceipt | undefined>;
 }
 //# sourceMappingURL=FixedPaymentTemplate.d.ts.map

package/dist/contracts/FixedPaymentTemplate.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"FixedPaymentTemplate.d.ts","sourceRoot":"","sources":["../../src/contracts/FixedPaymentTemplate.ts"],"names":[],"mappings":"AAAA,OAAO,EAAO,OAAO,EAAE,OAAO,EAAY,MAAM,MAAM,CAAA;AACtD,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAA;AAMvD,OAAO,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAA;AAChE,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAA;AAExD,OAAO,EAAE,YAAY,EAAkB,MAAM,mBAAmB,CAAA;AAEhE,qBAAa,oBAAqB,SAAQ,YAAY;IACpD,OAAO,CAAC,iBAAiB,CAEhB;WAEoB,WAAW,CACtC,MAAM,EAAE,kBAAkB,GACzB,OAAO,CAAC,oBAAoB,CAAC;IASnB,eAAe,CAC1B,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,OAAO,GAAG,YAAY,EAC7B,eAAe,CAAC,EAAE,OAAO,EACzB,QAAQ,CAAC,EAAE,YAAY;IAWZ,YAAY,CACvB,WAAW,EAAE,MAAM,EACnB,YAAY,EAAE,OAAO,EACrB,KAAK,EAAE,OAAO,GAAG,YAAY,EAC7B,QAAQ,CAAC,EAAE,YAAY;IAmBZ,4BAA4B,CACvC,MAAM,EAAE,MAAM,EACd,WAAW,EAAE,MAAM,EACnB,YAAY,EAAE,OAAO,EACrB,KAAK,EAAE,OAAO,GAAG,YAAY,EAC7B,eAAe,CAAC,EAAE,OAAO,EACzB,QAAQ,CAAC,EAAE,YAAY;CA0B1B"}
+{"version":3,"file":"FixedPaymentTemplate.d.ts","sourceRoot":"","sources":["../../src/contracts/FixedPaymentTemplate.ts"],"names":[],"mappings":"AAAA,OAAO,EAAO,OAAO,EAAE,OAAO,EAAY,MAAM,MAAM,CAAA;AACtD,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAA;AAMvD,OAAO,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAA;AAChE,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAA;AAExD,OAAO,EAAE,YAAY,EAAkB,MAAM,mBAAmB,CAAA;AAEhE,qBAAa,oBAAqB,SAAQ,YAAY;IACpD,OAAO,CAAC,iBAAiB,CAEhB;WAEoB,WAAW,CACtC,MAAM,EAAE,kBAAkB,GACzB,OAAO,CAAC,oBAAoB,CAAC;IASnB,KAAK,CAChB,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,OAAO,GAAG,YAAY,EAC7B,eAAe,CAAC,EAAE,OAAO,EACzB,iBAAiB,SAAK,EACtB,QAAQ,CAAC,EAAE,YAAY;IAWZ,YAAY,CACvB,WAAW,EAAE,MAAM,EACnB,YAAY,EAAE,OAAO,EACrB,KAAK,EAAE,OAAO,GAAG,YAAY,EAC7B,QAAQ,CAAC,EAAE,YAAY;IAmBZ,kBAAkB,CAC7B,MAAM,EAAE,MAAM,EACd,WAAW,EAAE,MAAM,EACnB,YAAY,EAAE,OAAO,EACrB,KAAK,EAAE,OAAO,GAAG,YAAY,EAC7B,eAAe,CAAC,EAAE,OAAO,EACzB,iBAAiB,SAAK,EACtB,QAAQ,CAAC,EAAE,YAAY;CA0B1B"}

package/dist/contracts/FixedPaymentTemplate.js

@@ -11,9 +11,9 @@ export class FixedPaymentTemplate extends ContractBase {
         await fixedPaymentTemplate.init(config, fixedPaymentTemplateConfig);
         return fixedPaymentTemplate;
     }
-    async createAgreement(planId, owner, creditsReceiver, txParams) {
+    async order(planId, owner, creditsReceiver, numberOfPurchases = 1n, txParams) {
         const agreementIdSeed = generateZeroXId();
-        return this.send('createAgreement', owner, [agreementIdSeed, planId, creditsReceiver || owner.address, []], txParams);
+        return this.send('order', owner, [agreementIdSeed, planId, creditsReceiver || owner.address, numberOfPurchases, []], txParams);
     }
     async approveERC20(totalAmount, tokenAddress, owner, txParams) {
         const calls = [
@@ -32,7 +32,7 @@ export class FixedPaymentTemplate extends ContractBase {
         ];
         return await this.multicall(calls, owner, txParams);
     }
-    async createAgreementWithApprovals(planId, totalAmount, tokenAddress, owner, creditsReceiver, txParams) {
+    async orderWithApprovals(planId, totalAmount, tokenAddress, owner, creditsReceiver, numberOfPurchases = 1n, txParams) {
         const agreementIdSeed = generateZeroXId();
         const calls = [
             {
@@ -50,8 +50,8 @@ export class FixedPaymentTemplate extends ContractBase {
             {
                 contractAddress: this.address,
                 abi: this.contract.abi,
-                functionName: 'createAgreement',
-                args: [agreementIdSeed, planId, creditsReceiver || owner.address, []],
+                functionName: 'order',
+                args: [agreementIdSeed, planId, creditsReceiver || owner.address, numberOfPurchases, []],
             },
         ];
         return await this.multicall(calls, owner, txParams);

package/dist/contracts/NFT1155Base.d.ts

@@ -21,6 +21,15 @@ export declare abstract class NFT1155Base extends ContractBase {
         data?: string;
         txParams?: TxParameters;
     }): Promise<import("viem").TransactionReceipt | import("viem/account-abstraction").UserOperationReceipt>;
+    simulateCreditsRedemption({ from, planId, amount, keyspace, signature, owner, txParams, }: {
+        from: Address;
+        planId: bigint;
+        amount: bigint;
+        keyspace?: bigint;
+        signature?: string;
+        owner: Account | SmartAccount;
+        txParams?: TxParameters;
+    }): Promise<boolean>;
     burn({ from, planId, amount, keyspace, signature, owner, txParams, }: {
         from: Address;
         planId: bigint;