Refactor: clean string type via number type (#635)

* refactor: update type definitions to use LicenseTermsIdInput and DeadlineInput for improved consistency and clarity across IP asset and licensing methods

* refactor: update LicensingConfig and related types to use RevShareInput and FeeInput for improved type consistency across SDK

* refactor: update disputeId type in settleAssertion method to use DisputeId for improved type safety

* refactor: update mintFee handling to use BigInt for consistency across NFT and licensing methods

* refactor: remove redundant NaN checks in revenue share and license validation functions for improved clarity

* refactor: update CommercialRemixRequest and CommercialUseRequest types to use FeeInput for minting fees, enhancing type consistency across SDK

Author: bonnie57

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

@@ -48,7 +48,7 @@ import {
   WrappedIpClient,
 } from "../abi/generated";
 import { MAX_ROYALTY_TOKEN } from "../constants/common";
-import { RevShareType } from "../types/common";
+import { LicenseTermsIdInput, RevShareType } from "../types/common";
 import { ChainIds } from "../types/config";
 import { TransactionResponse } from "../types/options";
 import {
@@ -2101,9 +2101,7 @@ export class IPAssetClient {
     return licenseTermsIds;
   }
 
-  private async validateLicenseTokenIds(
-    licenseTokenIds: string[] | bigint[] | number[],
-  ): Promise<bigint[]> {
+  private async validateLicenseTokenIds(licenseTokenIds: LicenseTermsIdInput[]): Promise<bigint[]> {
     if (licenseTokenIds.length === 0) {
       throw new Error("License token IDs must be provided.");
     }

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

@@ -20,15 +20,14 @@ import {
   TotalLicenseTokenLimitHookClient,
   WrappedIpClient,
 } from "../abi/generated";
-import { LicensingConfig, RevShareType } from "../types/common";
+import { LicenseTermsIdInput, LicensingConfig, RevShareType } from "../types/common";
 import { ChainIds } from "../types/config";
 import { TransactionResponse, TxOptions } from "../types/options";
 import {
   AttachLicenseTermsRequest,
   AttachLicenseTermsResponse,
   GetLicensingConfigRequest,
   LicenseTerms,
-  LicenseTermsId,
   LicenseTermsIdResponse,
   MintLicenseTokensRequest,
   MintLicenseTokensResponse,
@@ -257,7 +256,7 @@ export class LicenseClient {
    * Gets license terms of the given ID.
    */
   public async getLicenseTerms(
-    selectedLicenseTermsId: LicenseTermsId,
+    selectedLicenseTermsId: LicenseTermsIdInput,
   ): Promise<PiLicenseTemplateGetLicenseTermsResponse> {
     try {
       return await this.piLicenseTemplateReadOnlyClient.getLicenseTerms({

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

@@ -55,7 +55,7 @@ export class NftClient {
           symbol: request.symbol,
           baseURI: request.baseURI ?? "",
           maxSupply: request.maxSupply ?? Number(maxUint32),
-          mintFee: request.mintFee ?? 0n,
+          mintFee: BigInt(request.mintFee ?? 0),
           mintFeeToken: request.mintFeeToken ?? zeroAddress,
           owner: validateAddress(request.owner || this.wallet.account!.address),
           mintFeeRecipient: validateAddress(request.mintFeeRecipient),

packages/core-sdk/src/types/common.ts

@@ -23,7 +23,7 @@ export type LicensingConfigInput = {
   /** Whether the licensing configuration is active. If false, the configuration is ignored. */
   isSet: boolean;
   /** The minting fee to be paid when minting license tokens. */
-  mintingFee: bigint | string | number;
+  mintingFee: FeeInput;
   /**
    * The licensingHook is an address to a smart contract that implements the `ILicensingHook` interface.
    * This contract's `beforeMintLicenseTokens` function is executed before a user mints a License Token,
@@ -40,21 +40,21 @@ export type LicensingConfigInput = {
    * Percentage of revenue that must be shared with the licensor.
    * Must be between 0 and 100 (where 100% represents 100_000_000).
    */
-  commercialRevShare: number | string;
+  commercialRevShare: RevShareInput;
   /** Whether the licensing is disabled or not. If this is true, then no licenses can be minted and no more derivatives can be attached at all. */
   disabled: boolean;
   /**
    * The minimum percentage of the group’s reward share (from 0 to 100%, represented as 100_000_000) that can be allocated to the IP when it is added to the group.
    * Must be between 0 and 100 (where 100% represents 100_000_000).
    */
-  expectMinimumGroupRewardShare: number | string;
+  expectMinimumGroupRewardShare: RevShareInput;
   /** The address of the expected group reward pool. The IP can only be added to a group with this specified reward pool address, or zero address if the IP does not want to be added to any group. */
   expectGroupRewardPool: Address;
 };
 
 export type LicensingConfig = LicensingConfigInput & {
   mintingFee: bigint;
-  commercialRevShare: number;
+  commercialRevShare: RevShareInput;
   expectMinimumGroupRewardShare: number;
 };
 
@@ -80,3 +80,26 @@ export enum RevShareType {
   EXPECT_MINIMUM_GROUP_REWARD_SHARE = "expectMinimumGroupRewardShare",
   MAX_ALLOWED_REWARD_SHARE_PERCENTAGE = "maxAllowedRewardSharePercentage",
 }
+
+/**
+ * Input for license terms id, can be bigint or number.
+ * Will be converted to bigint for contract calls.
+ */
+export type LicenseTermsIdInput = number | bigint;
+
+/**
+ * Input for deadline, can be bigint or number.
+ * Will be converted to bigint for contract calls.
+ */
+export type DeadlineInput = number | bigint;
+
+/**
+ * Input for revenue share, can be number.
+ */
+export type RevShareInput = number;
+
+/**
+ * Input for fee, can be bigint or number.
+ * Will be converted to bigint for contract calls.
+ */
+export type FeeInput = bigint | number;

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

@@ -3,6 +3,8 @@ import { Address, Hash, Hex } from "viem";
 import { EncodedTxData } from "../../abi/generated";
 import { TxOptions, WipOptions, WithTxOptions } from "../options";
 
+export type DisputeId = number | bigint;
+
 export type RaiseDisputeRequest = WithTxOptions & {
   /** The IP ID that is the target of the dispute. */
   targetIpId: Address;
@@ -19,14 +21,14 @@ export type RaiseDisputeRequest = WithTxOptions & {
    */
   targetTag: DisputeTargetTag;
   /** The liveness is the time window (in seconds) in which a counter dispute can be presented (30days). */
-  liveness: bigint | number | string;
+  liveness: bigint | number;
   /**
    * The amount of wrapper IP that the dispute initiator pays upfront into a pool.
    * To counter that dispute the opposite party of the dispute has to place a bond of the same amount.
    * The winner of the dispute gets the original bond back + 50% of the other party bond. The remaining 50% of the loser party bond goes to the reviewer.
    * The bond amount must be between the minimum and maximum bond values defined in the Optimistic Oracle V3 (OOV3) contract. If not specified, it defaults to the minimum bond value.
    */
-  bond?: bigint | number | string;
+  bond?: bigint | number;
   /**
    * Omit {@link WipOptions.useMulticallWhenPossible} for this function due to disputeInitiator issue.
    * It will be executed sequentially with several transactions.
@@ -41,7 +43,7 @@ export type RaiseDisputeResponse = {
 };
 
 export type CancelDisputeRequest = {
-  disputeId: number | string | bigint;
+  disputeId: DisputeId;
   /**
    * Additional data used in the cancellation process.
    *
@@ -57,7 +59,7 @@ export type CancelDisputeResponse = {
 };
 
 export type ResolveDisputeRequest = {
-  disputeId: number | string | bigint;
+  disputeId: DisputeId;
   /**
    * Additional data used in the resolution process.
    *
@@ -77,7 +79,7 @@ export type TagIfRelatedIpInfringedRequest = {
     /** The ipId to tag */
     ipId: Address;
     /** The dispute id that tagged the related infringing ipId */
-    disputeId: number | string | bigint;
+    disputeId: DisputeId;
   }[];
   options?: {
     /**

packages/core-sdk/src/types/resources/group.ts

@@ -5,11 +5,19 @@ import {
   GroupingModuleClaimedRewardEvent,
   GroupingModuleCollectedRoyaltiesToGroupPoolEvent,
 } from "../../abi/generated";
-import { IpMetadataAndTxOptions, LicensingConfig, LicensingConfigInput } from "../common";
+import {
+  DeadlineInput,
+  IpMetadataAndTxOptions,
+  LicenseTermsIdInput,
+  LicensingConfig,
+  LicensingConfigInput,
+  RevShareInput,
+  TokenIdInput,
+} from "../common";
 import { TxOptions } from "../options";
 
 export type LicenseDataInput = {
-  licenseTermsId: string | bigint | number;
+  licenseTermsId: LicenseTermsIdInput;
   /**
    * The address of the license template.
    * Defaults to {@link https://docs.story.foundation/docs/programmable-ip-license | PIL} address if not provided.
@@ -36,7 +44,7 @@ export type MintAndRegisterIpAndAttachLicenseAndAddToGroupRequest = {
    * The maximum reward share percentage that can be allocated to each member IP.
    * Must be between 0 and 100 (where 100% represents 100_000_000).
    */
-  maxAllowedRewardShare: number | string;
+  maxAllowedRewardShare: RevShareInput;
   /** The data of the license and its configuration to be attached to the new group IP. */
   licenseData: LicenseDataInput[];
   /** The address of the recipient of the minted NFT. If not provided, the function will use the user's own wallet address. */
@@ -45,7 +53,7 @@ export type MintAndRegisterIpAndAttachLicenseAndAddToGroupRequest = {
    * The deadline for the signature in seconds.
    * @default 1000
    */
-  deadline?: string | number | bigint;
+  deadline?: DeadlineInput;
 } & IpMetadataAndTxOptions;
 
 export type MintAndRegisterIpAndAttachLicenseAndAddToGroupResponse = {
@@ -67,18 +75,18 @@ export type RegisterGroupResponse = {
 };
 export type RegisterIpAndAttachLicenseAndAddToGroupRequest = {
   nftContract: Address;
-  tokenId: bigint | string | number;
+  tokenId: TokenIdInput;
   /** The ID of the group IP to add the newly registered IP. */
   groupId: Address;
   /**
    * The deadline for the signature in seconds.
    * @default 1000
    */
-  deadline?: bigint;
+  deadline?: DeadlineInput;
   /** The data of the license and its configuration to be attached to the new group IP. */
   licenseData: LicenseDataInput[];
   /** The maximum reward share percentage that can be allocated to each member IP. */
-  maxAllowedRewardShare: number | string;
+  maxAllowedRewardShare: RevShareInput;
 } & IpMetadataAndTxOptions;
 
 export type RegisterIpAndAttachLicenseAndAddToGroupResponse = {
@@ -111,7 +119,7 @@ export type RegisterGroupAndAttachLicenseAndAddIpsRequest = {
    * The maximum reward share percentage that can be allocated to each member IP.
    * Must be between 0 and 100 (where 100% represents 100_000_000).
    */
-  maxAllowedRewardShare: number | string;
+  maxAllowedRewardShare: RevShareInput;
   txOptions?: TxOptions;
 };
 
@@ -157,7 +165,7 @@ export type AddIpRequest = {
    * Must be between 0 and 100 (where 100% represents 100_000_000).
    * @default 100
    */
-  maxAllowedRewardSharePercentage?: number;
+  maxAllowedRewardSharePercentage?: RevShareInput;
   txOptions?: Omit<TxOptions, "encodedTxDataOnly">;
 };
 

packages/core-sdk/src/types/resources/ipAccount.ts

@@ -1,7 +1,7 @@
 import { Address, Hash, Hex } from "viem";
 
 import { EncodedTxData } from "../../abi/generated";
-import { TokenAmountInput } from "../common";
+import { DeadlineInput, TokenAmountInput } from "../common";
 import { TxOptions } from "../options";
 
 export type IPAccountExecuteRequest = {
@@ -31,11 +31,11 @@ export type IPAccountExecuteWithSigRequest = {
   /** The signer of the transaction. */
   signer: Address;
   /** The deadline of the transaction signature in seconds. */
-  deadline: number | bigint | string;
+  deadline: DeadlineInput;
   /** The signature of the transaction, EIP-712 encoded. The helper method `getPermissionSignature` supports generating the signature. */
   signature: Address;
   /** The amount of IP to send. */
-  value?: number | bigint | string;
+  value?: number | bigint;
   txOptions?: TxOptions;
 };