feat: auto-approve erc20 token (#658)

* test: enhance Erc20 Token Fee Utilities tests with new scenarios and assertions

* feat: enhance contract fee handling with separate ERC20 and WIP payment methods

* refactor: replace Erc20Spender with TokenSpender and integrate WIP token handling across multiple resources

* feat: implement spender merging logic and enhance ERC20 payment handling in contract calls

* refactor: streamline ERC20 payment handling and introduce token spender grouping logic

* feat: enhance fee handle comments

* Feat: Modify logic to auto approve in ipAsset module

* refactor: update IPAssetClient to use unified options structure for WIP and ERC20 handling

* feat: update RegisterIpAssetRequest and RegisterDerivativeIpAssetRequest to use unified ERC20 and WIP options; enhance fee handling tests for ERC20 integration

* test: add integration tests for registering IP assets with WIP token, including derivative IP handling and license terms validation

* feat: update IPAssetClient and tests to support mixed ERC20 and WIP token fees, enhancing fee calculation and registration workflows

* fix: update documentation and types to replace `wipOptions` with `options` for consistency in IP asset handling

* refactor: replace all instances of `wip` with `token` in imports and options for consistency across SDK resources

* fix: update IPAssetClient to include erc20Options in transaction handling, ensuring proper fee management for public and private minting

* refactor: streamline token handling in IPAssetClient and update documentation for clarity on erc20 and wrapped IP token usage

* refactor: unify options handling in IPAssetClient and update response structures for royalty token distribution requests

* refactor: enhance documentation and update variable names in IPAssetClient tests for clarity on ERC20 and WIP token usage

* refactor: clean up imports and improve type formatting in license and registerHelper files for consistency

* refactor: add comments for clarity on WIP token usage in dispute handling and improve type documentation for token spending

* test

* refactor: update options handling in IPAssetClient to disable multicall for WIP token registration and clean up test case for clarity

Author: bonnie57

packages/core-sdk/src/resources/dispute.ts

@@ -100,7 +100,6 @@ export class DisputeClient {
       } else {
         const contractCall = (): Promise<Hash> => this.disputeModuleClient.raiseDispute(req);
         const { txHash, receipt } = await contractCallWithFees({
-          totalFees: bonds,
           options: {
             wipOptions: {
               ...request.wipOptions,
@@ -114,6 +113,8 @@ export class DisputeClient {
             {
               address: this.arbitrationPolicyUmaClient.address,
               amount: bonds,
+              // Currently, only WIP is supported as the whitelisted dispute bond token.
+              token: WIP_TOKEN_ADDRESS,
             },
           ],
           contractCall,
@@ -319,7 +320,6 @@ export class DisputeClient {
       };
 
       const { txHash, receipt } = await contractCallWithFees({
-        totalFees: bond,
         options: {
           wipOptions: {
             ...request.wipOptions,
@@ -336,6 +336,8 @@ export class DisputeClient {
           {
             address: this.arbitrationPolicyUmaClient.address,
             amount: bond,
+            // Currently, only WIP is supported as the whitelisted dispute bond token.
+            token: WIP_TOKEN_ADDRESS,
           },
         ],
         encodedTxs: [encodedData],

packages/core-sdk/src/resources/ipAsset.ts

@@ -47,8 +47,8 @@ import {
   SetMaxLicenseTokensRequest,
 } from "../types/resources/license";
 import { SignatureMethodType } from "../types/utils/registerHelper";
-import { Erc20Spender } from "../types/utils/wip";
-import { calculateLicenseWipMintFee, predictMintingLicenseFee } from "../utils/calculateMintFee";
+import { TokenSpender } from "../types/utils/token";
+import { calculateLicenseMintFee, predictMintingLicenseFee } from "../utils/calculateMintFee";
 import { handleError } from "../utils/errors";
 import { contractCallWithFees } from "../utils/feeUtils";
 import { generateOperationSignature } from "../utils/generateOperationSignature";
@@ -232,23 +232,22 @@ export class LicenseClient {
       }
 
       // get license token minting fee
-      const licenseMintingFee = await calculateLicenseWipMintFee({
+      const licenseMintingFee = await calculateLicenseMintFee({
         predictMintingFeeRequest: req,
         rpcClient: this.rpcClient,
         chainId: this.chainId,
         walletAddress: this.walletAddress,
       });
 
-      const wipSpenders: Erc20Spender[] = [];
-      if (licenseMintingFee > 0n) {
+      const wipSpenders: TokenSpender[] = [];
+      if (licenseMintingFee.amount > 0n) {
         wipSpenders.push({
           address: royaltyModuleAddress[this.chainId],
-          amount: licenseMintingFee,
+          ...licenseMintingFee,
         });
       }
       const { txHash, receipt } = await contractCallWithFees({
-        totalFees: licenseMintingFee,
-        options: { wipOptions: request.options?.wipOptions },
+        options: request.options,
         multicall3Address: this.multicall3Client.address,
         rpcClient: this.rpcClient,
         tokenSpenders: wipSpenders,

packages/core-sdk/src/resources/license.ts

@@ -38,7 +38,7 @@ import {
   TransferClaimedTokensFromIpToWalletParams,
   TransferToVaultRequest,
 } from "../types/resources/royalty";
-import { Erc20Spender } from "../types/utils/wip";
+import { TokenSpender } from "../types/utils/token";
 import { handleError } from "../utils/errors";
 import { contractCallWithFees } from "../utils/feeUtils";
 import { royaltyPolicyInputToAddress } from "../utils/royalty";
@@ -266,14 +266,7 @@ export class RoyaltyClient {
     request: PayRoyaltyOnBehalfRequest,
   ): Promise<PayRoyaltyOnBehalfResponse> {
     try {
-      const {
-        receiverIpId,
-        payerIpId,
-        token,
-        amount,
-        options: { erc20Options, wipOptions } = {},
-        txOptions,
-      } = request;
+      const { receiverIpId, payerIpId, token, amount, options, txOptions } = request;
       const sender = this.wallet.account!.address;
       const payAmount = BigInt(amount);
       if (payAmount <= 0n) {
@@ -309,21 +302,20 @@ export class RoyaltyClient {
       const contractCall = (): Promise<Hash> => {
         return this.royaltyModuleClient.payRoyaltyOnBehalf(req);
       };
-      const tokenSpenders: Erc20Spender[] = [
+      const tokenSpenders: TokenSpender[] = [
         {
           address: this.royaltyModuleClient.address,
           amount: payAmount,
+          token,
         },
       ];
       return await contractCallWithFees({
-        totalFees: payAmount,
-        options: { erc20Options, wipOptions },
+        options,
         multicall3Address: this.multicall3Client.address,
         rpcClient: this.rpcClient,
         tokenSpenders: tokenSpenders,
         contractCall,
         sender,
-        token,
         wallet: this.wallet,
         txOptions,
         encodedTxs: [encodedTxData],

packages/core-sdk/src/resources/royalty.ts

@@ -25,9 +25,9 @@ import {
   RevShareInput,
   TokenIdInput,
 } from "../common";
-import { TxOptions, WipOptions, WithWipOptions } from "../options";
+import { ERC20Options, TxOptions, WipOptions, WithErc20AndWipOptions } from "../options";
 import { LicenseTerms, LicenseTermsDataInput } from "./license";
-import { Erc20Spender } from "../utils/wip";
+import { TokenSpender } from "../utils/token";
 
 export type MaxRtsInput = number;
 export type DerivativeDataInput = {
@@ -93,7 +93,7 @@ export type RegisterDerivativeWithLicenseTokensRequest = {
   txOptions?: TxOptions;
 };
 
-export type RegisterDerivativeRequest = WithWipOptions &
+export type RegisterDerivativeRequest = WithErc20AndWipOptions &
   DerivativeDataInput & {
     txOptions?: TxOptions;
     childIpId: Address;
@@ -118,7 +118,7 @@ export type MintAndRegisterIpAssetWithPilTermsRequest = {
   /** The address to receive the minted NFT. If not provided, the client's own wallet address will be used. */
   recipient?: Address;
 } & IpMetadataAndTxOptions &
-  WithWipOptions;
+  WithErc20AndWipOptions;
 
 export type MintAndRegisterIpAssetWithPilTermsResponse = {
   txHash?: Hash;
@@ -141,7 +141,7 @@ export type RegisterIpAndMakeDerivativeRequest = {
   /** The derivative data to be used for register derivative. */
   derivData: DerivativeDataInput;
 } & IpMetadataAndTxOptions &
-  WithWipOptions;
+  WithErc20AndWipOptions;
 
 export type RegisterIpAndMakeDerivativeResponse = {
   txHash?: Hash;
@@ -183,8 +183,7 @@ export type MintAndRegisterIpAndMakeDerivativeRequest = {
    */
   allowDuplicates?: boolean;
 } & IpMetadataAndTxOptions &
-  WithWipOptions;
-
+  WithErc20AndWipOptions;
 export type MintAndRegisterIpAndMakeDerivativeResponse = RegistrationResponse & {
   encodedTxData?: EncodedTxData;
 };
@@ -199,7 +198,7 @@ export type WithIpMetadata = {
 };
 
 export type MintAndRegisterIpRequest = IpMetadataAndTxOptions &
-  WithWipOptions & {
+  WithErc20AndWipOptions & {
     spgNftContract: Address;
     /** The address of the recipient of the minted NFT. If not provided, the client's own wallet address will be used. */
     recipient?: Address;
@@ -227,7 +226,7 @@ export type MintAndRegisterIpAndMakeDerivativeWithLicenseTokensRequest = {
    */
   allowDuplicates?: boolean;
 } & IpMetadataAndTxOptions &
-  WithWipOptions;
+  WithErc20AndWipOptions;
 
 export type RegisterIpAndMakeDerivativeWithLicenseTokensRequest = {
   nftContract: Address;
@@ -245,10 +244,10 @@ export type RegisterIpAndMakeDerivativeWithLicenseTokensRequest = {
    */
   deadline?: DeadlineInput;
 } & IpMetadataAndTxOptions &
-  WithWipOptions;
+  WithErc20AndWipOptions;
 
 export type BatchMintAndRegisterIpAssetWithPilTermsRequest = {
-  args: Omit<MintAndRegisterIpAssetWithPilTermsRequest, "txOptions">[];
+  args: Omit<MintAndRegisterIpAssetWithPilTermsRequest, "options" | "txOptions">[];
   txOptions?: Omit<TxOptions, "EncodedTxData">;
 };
 export type BatchMintAndRegisterIpAssetWithPilTermsResult = {
@@ -264,7 +263,7 @@ export type BatchMintAndRegisterIpAssetWithPilTermsResponse = {
 };
 
 export type BatchRegisterDerivativeRequest = {
-  args: RegisterDerivativeRequest[];
+  args: Omit<RegisterDerivativeRequest, "options" | "txOptions">[];
   /**
    * The deadline for the signature in seconds.
    * @default 1000
@@ -277,7 +276,7 @@ export type BatchRegisterDerivativeResponse = {
   txHash: Hash;
 };
 export type BatchMintAndRegisterIpAndMakeDerivativeRequest = {
-  args: Omit<MintAndRegisterIpAndMakeDerivativeRequest, "txOptions">[];
+  args: Omit<MintAndRegisterIpAndMakeDerivativeRequest, "txOptions" | "options">[];
   txOptions?: Omit<TxOptions, "encodedTxDataOnly">;
 };
 export type BatchMintAndRegisterIpAndMakeDerivativeResponse = {
@@ -351,7 +350,7 @@ export type RegisterDerivativeAndAttachLicenseTermsAndDistributeRoyaltyTokensReq
   /** Authors of the IP and their shares of the royalty tokens. */
   royaltyShares: RoyaltyShare[];
   txOptions?: Omit<TxOptions, "encodedTxDataOnly">;
-} & WithWipOptions &
+} & WithErc20AndWipOptions &
   WithIpMetadata;
 
 export type RegisterDerivativeAndAttachLicenseTermsAndDistributeRoyaltyTokensResponse = {
@@ -377,7 +376,7 @@ export type MintAndRegisterIpAndAttachPILTermsAndDistributeRoyaltyTokensRequest
   recipient?: Address;
   txOptions?: Omit<TxOptions, "encodedTxDataOnly">;
 } & WithIpMetadata &
-  WithWipOptions;
+  WithErc20AndWipOptions;
 
 export type MintAndRegisterIpAndAttachPILTermsAndDistributeRoyaltyTokensResponse = {
   txHash: Hash;
@@ -403,15 +402,15 @@ export type MintAndRegisterIpAndMakeDerivativeAndDistributeRoyaltyTokensRequest
   recipient?: Address;
   txOptions?: Omit<TxOptions, "encodedTxDataOnly">;
 } & WithIpMetadata &
-  WithWipOptions;
+  WithErc20AndWipOptions;
 
 export type MintAndRegisterIpAndMakeDerivativeAndDistributeRoyaltyTokensResponse = {
   txHash: Hash;
   ipId?: Address;
   tokenId?: bigint;
 };
 
-export type CommonRegistrationParams = {
+export type CommonRegistrationParams = WithErc20AndWipOptions & {
   contractCall: () => Promise<Hash>;
   encodedTxs: EncodedTxData[];
   spgNftContract?: Address;
@@ -420,7 +419,6 @@ export type CommonRegistrationParams = {
   derivData?: DerivativeData;
   sender: Address;
   txOptions?: TxOptions;
-  wipOptions?: WipOptions;
 };
 
 export type RegistrationResponse = {
@@ -456,17 +454,21 @@ export type TransformedIpRegistrationWorkflowRequest<
     | DerivativeWorkflowsClient
     | LicenseAttachmentWorkflowsClient
     | RoyaltyTokenDistributionWorkflowsClient;
-  spenders?: Erc20Spender[];
-  totalFees?: bigint;
+  spenders?: TokenSpender[];
   extraData?: ExtraData;
 };
 
+export type PrepareRoyaltyTokensDistributionRequestsResponse = {
+  requests: TransformedIpRegistrationWorkflowRequest[];
+  ipRoyaltyVaults: RoyaltyModuleIpRoyaltyVaultDeployedEvent[];
+};
+
 /**
  * Utility type that removes option-related fields (txOptions and wipOptions) from a type.
  * This preserves discriminated unions unlike using Omit directly.
  */
 type RemoveOptionsFields<Type> = {
-  [Property in keyof Type as Exclude<Property, "txOptions" | "wipOptions">]: Type[Property];
+  [Property in keyof Type as Exclude<Property, "txOptions" | "options">]: Type[Property];
 };
 
 export type MintSpgNftRegistrationRequest = RemoveOptionsFields<
@@ -516,7 +518,7 @@ export type BatchRegistrationResult = {
   }[];
 };
 
-export type BatchRegisterIpAssetsWithOptimizedWorkflowsRequest = WithWipOptions & {
+export type BatchRegisterIpAssetsWithOptimizedWorkflowsRequest = WithErc20AndWipOptions & {
   requests: IpRegistrationWorkflowRequest[];
   txOptions?: Omit<WaitForTransactionReceiptParameters, "hash">;
 };
@@ -534,8 +536,10 @@ export type ExtraData = {
 };
 
 export type BatchMintAndRegisterIpRequest = {
-  requests: Omit<MintAndRegisterIpRequest, "txOptions" | "wipOptions">[];
+  requests: Omit<MintAndRegisterIpRequest, "txOptions" | "options">[];
+  //TODO: merge wipOptions and erc20Options into options in main version upgrade
   wipOptions?: WipOptions;
+  erc20Options?: ERC20Options;
   txOptions?: Omit<TxOptions, "encodedTxDataOnly">;
 };
 
@@ -637,7 +641,7 @@ export type MintedNFT = {
  * };
  * ```
  */
-export type RegisterIpAssetRequest<T extends MintNFT | MintedNFT> = WithWipOptions &
+export type RegisterIpAssetRequest<T extends MintNFT | MintedNFT> = WithErc20AndWipOptions &
   WithIpMetadata & {
     /** The NFT to be registered as an IP asset. */
     nft: T;
@@ -764,37 +768,38 @@ export type RegisterIpAssetResponse<T extends RegisterIpAssetRequest<MintedNFT |
  * };
  * ```
  */
-export type RegisterDerivativeIpAssetRequest<T extends MintedNFT | MintNFT> = WithWipOptions &
-  WithIpMetadata & {
-    nft: T;
-    /**
-     * Authors of the IP and their shares of the royalty tokens.
-     *
-     * @remarks
-     * Royalty shares can only be specified if `derivData` is also provided.
-     * This ensures that royalty distribution is always associated with derivative IP registration.
-     * The shares define how royalty tokens will be distributed among IP authors.
-     */
-    royaltyShares?: RoyaltyShare[];
-    /**
-     * The derivative data containing parent IP information and licensing terms.
-     * Can be used independently or together with `royaltyShares` for royalty distribution.
-     */
-    derivData?: DerivativeDataInput;
-    /**
-     * The maximum number of royalty tokens that can be distributed to the external royalty policies (max: 100,000,000).
-     * @default 100_000_000
-     */
-    maxRts?: MaxRtsInput;
-    /** The IDs of the license tokens to be burned for linking the IP to parent IPs. */
-    licenseTokenIds?: LicenseTermsIdInput[];
-    /**
-     * The deadline for the signature in seconds.
-     * @default 1000
-     */
-    deadline?: DeadlineInput;
-    txOptions?: Omit<TxOptions, "encodedTxDataOnly">;
-  };
+export type RegisterDerivativeIpAssetRequest<T extends MintedNFT | MintNFT> =
+  WithErc20AndWipOptions &
+    WithIpMetadata & {
+      nft: T;
+      /**
+       * Authors of the IP and their shares of the royalty tokens.
+       *
+       * @remarks
+       * Royalty shares can only be specified if `derivData` is also provided.
+       * This ensures that royalty distribution is always associated with derivative IP registration.
+       * The shares define how royalty tokens will be distributed among IP authors.
+       */
+      royaltyShares?: RoyaltyShare[];
+      /**
+       * The derivative data containing parent IP information and licensing terms.
+       * Can be used independently or together with `royaltyShares` for royalty distribution.
+       */
+      derivData?: DerivativeDataInput;
+      /**
+       * The maximum number of royalty tokens that can be distributed to the external royalty policies (max: 100,000,000).
+       * @default 100_000_000
+       */
+      maxRts?: MaxRtsInput;
+      /** The IDs of the license tokens to be burned for linking the IP to parent IPs. */
+      licenseTokenIds?: LicenseTermsIdInput[];
+      /**
+       * The deadline for the signature in seconds.
+       * @default 1000
+       */
+      deadline?: DeadlineInput;
+      txOptions?: Omit<TxOptions, "encodedTxDataOnly">;
+    };
 
 /**
  * Response type for derivative IP asset registration with conditional return types.