@story-protocol/core-sdk 0.1.0-rc.7 → 1.0.0-rc.10

package/dist/declarations/src/resources/license.d.ts

@@ -1,22 +1,87 @@
-import { AxiosInstance } from "axios";
-import { Signer } from "ethers";
-import { CreateLicenseRequest, CreateLicenseResponse } from "../types/resources/license.js";
-import { FranchiseRegistry } from "../abi/generated/index.js";
-import { LicenseReadOnlyClient } from "./licenseReadOnly.js";
-/**
- * A class representing License operations.
- *
- * @public
- */
-export declare class LicenseClient extends LicenseReadOnlyClient {
-    private readonly signer;
-    constructor(httpClient: AxiosInstance, signer: Signer, franchiseRegistry: FranchiseRegistry);
+import { PublicClient } from "viem";
+import { IpAssetRegistryClient, LicenseRegistryEventClient, LicenseRegistryReadOnlyClient, LicensingModuleClient, PiLicenseTemplateClient, PiLicenseTemplateGetLicenseTermsResponse, PiLicenseTemplateReadOnlyClient, RoyaltyPolicyLapClient, SimpleWalletClient } from "../abi/generated.js";
+import { RegisterNonComSocialRemixingPILRequest, RegisterPILResponse, RegisterCommercialUsePILRequest, RegisterCommercialRemixPILRequest, AttachLicenseTermsRequest, MintLicenseTokensRequest, MintLicenseTokensResponse } from "../types/resources/license.js";
+export declare class LicenseClient {
+    licenseRegistryClient: LicenseRegistryEventClient;
+    licensingModuleClient: LicensingModuleClient;
+    ipAssetRegistryClient: IpAssetRegistryClient;
+    piLicenseTemplateReadOnlyClient: PiLicenseTemplateReadOnlyClient;
+    licenseTemplateClient: PiLicenseTemplateClient;
+    royaltyPolicyLAPClient: RoyaltyPolicyLapClient;
+    licenseRegistryReadOnlyClient: LicenseRegistryReadOnlyClient;
+    private readonly rpcClient;
+    private readonly wallet;
+    constructor(rpcClient: PublicClient, wallet: SimpleWalletClient);
     /**
-     * Create a license within the Story Protocol based on the specified input data.
-     *
-     * @param request - An object containing the necessary data to create a license.
-     * @returns A response object containing the result of the create license action, including the transaction hash.
+     * Convenient function to register a PIL non commercial social remix license to the registry
+     * @param request - [Optional] The request object that contains all data needed to register a PIL non commercial social remix license.
+     *   @param request.txOptions [Optional] The transaction options.
+     * @returns A Promise that resolves to an object containing the optional transaction hash and optional license terms Id.
+     * @emits LicenseTermsRegistered (licenseTermsId, licenseTemplate, licenseTerms);
      */
-    create(request: CreateLicenseRequest): Promise<CreateLicenseResponse>;
+    registerNonComSocialRemixingPIL(request?: RegisterNonComSocialRemixingPILRequest): Promise<RegisterPILResponse>;
+    /**
+     * Convenient function to register a PIL commercial use license to the registry.
+     * @param request - The request object that contains all data needed to register a PIL commercial use license.
+     *   @param request.mintingFee The fee to be paid when minting a license.
+     *   @param request.currency The ERC20 token to be used to pay the minting fee and the token must be registered in story protocol.
+     *   @param request.txOptions [Optional] The transaction options.
+     * @returns A Promise that resolves to an object containing the optional transaction hash and optional license terms Id.
+     * @emits LicenseTermsRegistered (licenseTermsId, licenseTemplate, licenseTerms);
+     */
+    registerCommercialUsePIL(request: RegisterCommercialUsePILRequest): Promise<RegisterPILResponse>;
+    /**
+     * Convenient function to register a PIL commercial Remix license to the registry.
+     * @param request - The request object that contains all data needed to register license.
+     *   @param request.mintingFee The fee to be paid when minting a license.
+     *   @param request.commercialRevShare Percentage of revenue that must be shared with the licensor.
+     *   @param request.currency The ERC20 token to be used to pay the minting fee. the token must be registered in story protocol.
+     *   @param request.txOptions [Optional] The transaction options.
+     * @returns A Promise that resolves to an object containing the optional transaction hash and optional license terms Id.
+     * @emits LicenseTermsRegistered (licenseTermsId, licenseTemplate, licenseTerms);
+     */
+    registerCommercialRemixPIL(request: RegisterCommercialRemixPILRequest): Promise<RegisterPILResponse>;
+    /**
+     * Attaches license terms to an IP.
+     * @param request - The request object that contains all data needed to attach license terms.
+     *   @param request.ipId The address of the IP to which the license terms are attached.
+     *   @param request.licenseTemplate The address of the license template.
+     *   @param request.licenseTermsId The ID of the license terms.
+     *   @param request.txOptions [Optional] The transaction options.
+     * @returns A Promise that resolves to an object containing the transaction hash.
+     */
+    attachLicenseTerms(request: AttachLicenseTermsRequest): Promise<{
+        txHash: `0x${string}`;
+    }>;
+    /**
+     * Mints license tokens for the license terms attached to an IP.
+     * The license tokens are minted to the receiver.
+     * The license terms must be attached to the IP before calling this function.
+     * But it can mint license token of default license terms without attaching the default license terms,
+     * since it is attached to all IPs by default.
+     * IP owners can mint license tokens for their IPs for arbitrary license terms
+     * without attaching the license terms to IP.
+     * It might require the caller pay the minting fee, depending on the license terms or configured by the iP owner.
+     * The minting fee is paid in the minting fee token specified in the license terms or configured by the IP owner.
+     * IP owners can configure the minting fee of their IPs or
+     * configure the minting fee module to determine the minting fee.
+     * @param request - The request object that contains all data needed to mint license tokens.
+     *   @param request.licensorIpId The licensor IP ID.
+     *   @param request.licenseTemplate The address of the license template.
+     *   @param request.licenseTermsId The ID of the license terms within the license template.
+     *   @param request.amount The amount of license tokens to mint.
+     *   @param request.receiver The address of the receiver.
+     *   @param request.txOptions [Optional] The transaction options.
+     * @returns A Promise that resolves to an object containing the transaction hash and optional license token ID if waitForTxn is set to true.
+     * @emits LicenseTokensMinted (msg.sender, licensorIpId, licenseTemplate, licenseTermsId, amount, receiver, startLicenseTokenId);
+     */
+    mintLicenseTokens(request: MintLicenseTokensRequest): Promise<MintLicenseTokensResponse>;
+    /**
+     * Gets license terms of the given ID.
+     * @param selectedLicenseTermsId The ID of the license terms.
+     * @returns A Promise that resolves to an object containing the PILTerms associate with the given ID.
+     */
+    getLicenseTerms(selectedLicenseTermsId: string): Promise<PiLicenseTemplateGetLicenseTermsResponse>;
+    private getLicenseTermsId;
 }
 //# sourceMappingURL=license.d.ts.map

package/dist/declarations/src/resources/license.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"license.d.ts","sourceRoot":"../../../../src/resources","sources":["license.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AACtC,OAAO,EAAE,MAAM,EAAkC,MAAM,QAAQ,CAAC;AAEhE,OAAO,EAAE,oBAAoB,EAAE,qBAAqB,EAAE,sCAAmC;AACzF,OAAO,EAAE,iBAAiB,EAA4B,kCAAyB;AAE/E,OAAO,EAAE,qBAAqB,EAAE,6BAA0B;AAE1D;;;;GAIG;AACH,qBAAa,aAAc,SAAQ,qBAAqB;IACtD,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;gBAEpB,UAAU,EAAE,aAAa,EAAE,MAAM,EAAE,MAAM,EAAE,iBAAiB,EAAE,iBAAiB;IAK3F;;;;;OAKG;IACU,MAAM,CAAC,OAAO,EAAE,oBAAoB,GAAG,OAAO,CAAC,qBAAqB,CAAC;CAyDnF"}
+{"version":3,"file":"license.d.ts","sourceRoot":"../../../../src/resources","sources":["license.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAA2B,MAAM,MAAM,CAAC;AAE7D,OAAO,EACL,qBAAqB,EACrB,0BAA0B,EAC1B,6BAA6B,EAC7B,qBAAqB,EACrB,uBAAuB,EACvB,wCAAwC,EACxC,+BAA+B,EAC/B,sBAAsB,EACtB,kBAAkB,EACnB,4BAAyB;AAC1B,OAAO,EAEL,sCAAsC,EACtC,mBAAmB,EACnB,+BAA+B,EAC/B,iCAAiC,EACjC,yBAAyB,EAEzB,wBAAwB,EACxB,yBAAyB,EAE1B,sCAAmC;AAIpC,qBAAa,aAAa;IACjB,qBAAqB,EAAE,0BAA0B,CAAC;IAClD,qBAAqB,EAAE,qBAAqB,CAAC;IAC7C,qBAAqB,EAAE,qBAAqB,CAAC;IAC7C,+BAA+B,EAAE,+BAA+B,CAAC;IACjE,qBAAqB,EAAE,uBAAuB,CAAC;IAC/C,sBAAsB,EAAE,sBAAsB,CAAC;IAC/C,6BAA6B,EAAE,6BAA6B,CAAC;IACpE,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IACzC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAqB;gBAEhC,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,kBAAkB;IAW/D;;;;;;OAMG;IACU,+BAA+B,CAC1C,OAAO,CAAC,EAAE,sCAAsC,GAC/C,OAAO,CAAC,mBAAmB,CAAC;IAmB/B;;;;;;;;OAQG;IACU,wBAAwB,CACnC,OAAO,EAAE,+BAA+B,GACvC,OAAO,CAAC,mBAAmB,CAAC;IAuB/B;;;;;;;;;OASG;IACU,0BAA0B,CACrC,OAAO,EAAE,iCAAiC,GACzC,OAAO,CAAC,mBAAmB,CAAC;IAyB/B;;;;;;;;OAQG;IACU,kBAAkB,CAAC,OAAO,EAAE,yBAAyB;;;IA2ClE;;;;;;;;;;;;;;;;;;;;;OAqBG;IACU,iBAAiB,CAC5B,OAAO,EAAE,wBAAwB,GAChC,OAAO,CAAC,yBAAyB,CAAC;IAoDrC;;;;OAIG;IACU,eAAe,CAC1B,sBAAsB,EAAE,MAAM,GAC7B,OAAO,CAAC,wCAAwC,CAAC;YAUtC,iBAAiB;CAIhC"}

package/dist/declarations/src/resources/nftClient.d.ts

@@ -0,0 +1,24 @@
+import { PublicClient } from "viem";
+import { SimpleWalletClient, SpgClient } from "../abi/generated.js";
+import { CreateNFTCollectionRequest, CreateNFTCollectionResponse } from "../types/resources/nftClient.js";
+export declare class NftClient {
+    spgClient: SpgClient;
+    private readonly rpcClient;
+    private readonly wallet;
+    constructor(rpcClient: PublicClient, wallet: SimpleWalletClient);
+    /**
+     * Creates a new SPG NFT Collection.
+     * @param request - The request object containing necessary data to create a SPG NFT Collection.
+     *   @param request.name - The name of the collection.
+     * 	 @param request.symbol - The symbol of the collection.
+     * 	 @param request.maxSupply - The maximum supply of the collection.
+     * 	 @param request.mintCost - The cost to mint a token.
+     * 	 @param request.mintToken - The token to mint.
+     * 	 @param request.owner - The owner of the collection.
+     *   @param request.txOptions - Optional transaction options.
+     * @returns A Promise that resolves to a CreateNFTCollectionResponse containing the transaction hash and collection address.
+     * @emits CollectionCreated (nftContract);
+     */
+    createNFTCollection<TReq extends CreateNFTCollectionRequest, TRes = CreateNFTCollectionResponse<TReq>>(request: TReq): Promise<TRes>;
+}
+//# sourceMappingURL=nftClient.d.ts.map

package/dist/declarations/src/resources/nftClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"nftClient.d.ts","sourceRoot":"../../../../src/resources","sources":["nftClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAiD,MAAM,MAAM,CAAC;AAEnF,OAAO,EAAE,kBAAkB,EAAE,SAAS,EAAE,4BAAyB;AACjE,OAAO,EACL,0BAA0B,EAC1B,2BAA2B,EAC5B,wCAAqC;AAGtC,qBAAa,SAAS;IACb,SAAS,EAAE,SAAS,CAAC;IAC5B,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IACzC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAqB;gBAEhC,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,kBAAkB;IAM/D;;;;;;;;;;;;OAYG;IACU,mBAAmB,CAC9B,IAAI,SAAS,0BAA0B,EACvC,IAAI,GAAG,2BAA2B,CAAC,IAAI,CAAC,EACxC,OAAO,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;CA4BhC"}

package/dist/declarations/src/resources/permission.d.ts

@@ -0,0 +1,30 @@
+import { PublicClient } from "viem";
+import { SetPermissionsRequest, SetPermissionsResponse } from "../types/resources/permission.js";
+import { SimpleWalletClient } from "../abi/generated.js";
+export declare class PermissionClient {
+    private readonly wallet;
+    private readonly rpcClient;
+    private accessControllerClient;
+    constructor(rpcClient: PublicClient, wallet: SimpleWalletClient);
+    /**
+     * Sets the permission for a specific function call
+     * Each policy is represented as a mapping from an IP account address to a signer address to a recipient
+     * address to a function selector to a permission level. The permission level can be 0 (ABSTAIN), 1 (ALLOW), or
+     * 2 (DENY).
+     * By default, all policies are set to 0 (ABSTAIN), which means that the permission is not set.
+     * The owner of ipAccount by default has all permission.
+     * address(0) => wildcard
+     * bytes4(0) => wildcard
+     * Specific permission overrides wildcard permission.
+     * @param request - The request object containing necessary data to set permissions.
+     *   @param request.ipAsset The address of the IP account that grants the permission for `signer`
+     *   @param request.signer The address that can call `to` on behalf of the `ipAccount`
+     *   @param request.to The address that can be called by the `signer` (currently only modules can be `to`)
+     *   @param request.func Optional. The function selector string of `to` that can be called by the `signer` on behalf of the `ipAccount`. Be default, it allows all functions.
+     *   @param request.permission The new permission level
+     * @returns A Promise that resolves to an object containing the transaction hash
+     * @emits PermissionSet (ipAccountOwner, ipAccount, signer, to, func, permission)
+     */
+    setPermission(request: SetPermissionsRequest): Promise<SetPermissionsResponse>;
+}
+//# sourceMappingURL=permission.d.ts.map

package/dist/declarations/src/resources/permission.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"permission.d.ts","sourceRoot":"../../../../src/resources","sources":["permission.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAuC,MAAM,MAAM,CAAC;AAGzE,OAAO,EAAE,qBAAqB,EAAE,sBAAsB,EAAE,yCAAsC;AAE9F,OAAO,EAIL,kBAAkB,EACnB,4BAAyB;AAE1B,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAqB;IAC5C,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IACzC,OAAO,CAAC,sBAAsB,CAAyB;gBAE3C,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,kBAAkB;IAM/D;;;;;;;;;;;;;;;;;;OAkBG;IACU,aAAa,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,sBAAsB,CAAC;CAkC5F"}

package/dist/declarations/src/resources/royalty.d.ts

@@ -0,0 +1,73 @@
+import { Hex, PublicClient } from "viem";
+import { ClaimableRevenueRequest, ClaimableRevenueResponse, CollectRoyaltyTokensRequest, CollectRoyaltyTokensResponse, PayRoyaltyOnBehalfRequest, PayRoyaltyOnBehalfResponse, RoyaltyVaultAddress, SnapshotRequest, SnapshotResponse, ClaimRevenueRequest, ClaimRevenueResponse } from "../types/resources/royalty.js";
+import { IpAssetRegistryClient, RoyaltyModuleClient, RoyaltyPolicyLapClient, SimpleWalletClient } from "../abi/generated.js";
+import { IPAccountClient } from "./ipAccount.js";
+export declare class RoyaltyClient {
+    royaltyPolicyLapClient: RoyaltyPolicyLapClient;
+    royaltyModuleClient: RoyaltyModuleClient;
+    ipAssetRegistryClient: IpAssetRegistryClient;
+    ipAccountClient: IPAccountClient;
+    private readonly rpcClient;
+    private readonly wallet;
+    constructor(rpcClient: PublicClient, wallet: SimpleWalletClient);
+    /**
+     * Allows ancestors to claim the royalty tokens and any accrued revenue tokens
+     * @param request - The request object that contains all data needed to collect royalty tokens.
+     *   @param request.parentIpId The ip id of the ancestor to whom the royalty tokens belong to.
+     *   @param request.royaltyVaultIpId The id of the royalty vault.
+     *   @param request.txOptions [Optional] The transaction options.
+     * @returns A Promise that resolves to an object containing the transaction hash and optional the amount of royalty tokens collected if waitForTxn is set to true.
+     * @emits RoyaltyTokensCollected (ancestorIpId, royaltyTokensCollected)
+     */
+    collectRoyaltyTokens(request: CollectRoyaltyTokensRequest): Promise<CollectRoyaltyTokensResponse>;
+    /**
+     * Allows the function caller to pay royalties to the receiver IP asset on behalf of the payer IP asset.
+     * @param request - The request object that contains all data needed to pay royalty on behalf.
+     *   @param request.receiverIpId The ipId that receives the royalties.
+     *   @param request.payerIpId The ID of the IP asset that pays the royalties.
+     *   @param request.token The token to use to pay the royalties.
+     *   @param request.amount The amount to pay.
+     *   @param request.txOptions [Optional] The transaction options.
+     * @returns A Promise that resolves to an object containing the transaction hash.
+     */
+    payRoyaltyOnBehalf(request: PayRoyaltyOnBehalfRequest): Promise<PayRoyaltyOnBehalfResponse>;
+    /**
+     * Calculates the amount of revenue token claimable by a token holder at certain snapshot.
+     * @param request - The request object that contains all data needed to claim Revenue.
+     *   @param request.royaltyVaultIpId The id of the royalty vault.
+     *   @param request.account The address of the token holder.
+     *   @param request.snapshotId The snapshot id.
+     *   @param request.token The revenue token to claim.
+     *   @param request.txOptions [Optional] The transaction options.
+     * @returns A Promise that contains the amount of revenue token claimable
+     */
+    claimableRevenue(request: ClaimableRevenueRequest): Promise<ClaimableRevenueResponse>;
+    /**
+     * Allows token holders to claim by a list of snapshot ids based on the token balance at certain snapshot
+     * @param request - The request object that contains all data needed to claim revenue.
+     *   @param request.snapshotIds The list of snapshot ids.
+     *   @param request.royaltyVaultIpId The id of the royalty vault.
+     *   @param request.token The revenue token to claim.
+     *   @param request.account [Optional] The ipId to send.
+     *   @param request.txOptions [Optional] The transaction options.
+     * @returns A Promise that resolves to an object containing the transaction hash and optional claimableToken if waitForTxn is set to true.
+     * @emits RevenueTokenClaimed (claimer, token, amount).
+     */
+    claimRevenue(request: ClaimRevenueRequest): Promise<ClaimRevenueResponse>;
+    /**
+     * Snapshots the claimable revenue and royalty token amounts.
+     * @param request - The request object that contains all data needed to snapshot.
+     *   @param request.royaltyVaultIpId The id of the royalty vault.
+     *   @param request.txOptions [Optional] The transaction options.
+     * @returns A Promise that resolves to an object containing the transaction hash and optional snapshotId if waitForTxn is set to true.
+     * @emits SnapshotCompleted (snapshotId, snapshotTimestamp, unclaimedTokens).
+     */
+    snapshot(request: SnapshotRequest): Promise<SnapshotResponse>;
+    /**
+     * Get the royalty vault proxy address of given royaltyVaultIpId.
+     * @param royaltyVaultIpId the id of the royalty vault.
+     * @returns A Promise that resolves to an object containing the royalty vault address.
+     */
+    getRoyaltyVaultAddress(royaltyVaultIpId: Hex): Promise<RoyaltyVaultAddress>;
+}
+//# sourceMappingURL=royalty.d.ts.map

package/dist/declarations/src/resources/royalty.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"royalty.d.ts","sourceRoot":"../../../../src/resources","sources":["royalty.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,YAAY,EAAkC,MAAM,MAAM,CAAC;AAGzE,OAAO,EACL,uBAAuB,EACvB,wBAAwB,EACxB,2BAA2B,EAC3B,4BAA4B,EAC5B,yBAAyB,EACzB,0BAA0B,EAC1B,mBAAmB,EACnB,eAAe,EACf,gBAAgB,EAChB,mBAAmB,EACnB,oBAAoB,EACrB,sCAAmC;AACpC,OAAO,EACL,qBAAqB,EAErB,mBAAmB,EACnB,sBAAsB,EACtB,kBAAkB,EAEnB,4BAAyB;AAC1B,OAAO,EAAE,eAAe,EAAE,uBAAoB;AAE9C,qBAAa,aAAa;IACjB,sBAAsB,EAAE,sBAAsB,CAAC;IAC/C,mBAAmB,EAAE,mBAAmB,CAAC;IACzC,qBAAqB,EAAE,qBAAqB,CAAC;IAC7C,eAAe,EAAE,eAAe,CAAC;IACxC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IACzC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAqB;gBAEhC,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,kBAAkB;IAS/D;;;;;;;;OAQG;IACU,oBAAoB,CAC/B,OAAO,EAAE,2BAA2B,GACnC,OAAO,CAAC,4BAA4B,CAAC;IAgCxC;;;;;;;;;OASG;IACU,kBAAkB,CAC7B,OAAO,EAAE,yBAAyB,GACjC,OAAO,CAAC,0BAA0B,CAAC;IA+BtC;;;;;;;;;OASG;IACU,gBAAgB,CAC3B,OAAO,EAAE,uBAAuB,GAC/B,OAAO,CAAC,wBAAwB,CAAC;IAmBpC;;;;;;;;;;OAUG;IACU,YAAY,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,oBAAoB,CAAC;IA2CtF;;;;;;;OAOG;IACU,QAAQ,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAqB1E;;;;OAIG;IACU,sBAAsB,CAAC,gBAAgB,EAAE,GAAG,GAAG,OAAO,CAAC,mBAAmB,CAAC;CAezF"}

package/dist/declarations/src/types/common.d.ts

@@ -0,0 +1,5 @@
+export type TypedData = {
+    interface: string;
+    data: unknown[];
+};
+//# sourceMappingURL=common.d.ts.map

package/dist/declarations/src/types/common.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.d.ts","sourceRoot":"../../../../src/types","sources":["common.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,SAAS,GAAG;IACtB,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,OAAO,EAAE,CAAC;CACjB,CAAC"}

package/dist/declarations/src/types/config.d.ts

@@ -1,18 +1,33 @@
-import { Provider } from "@ethersproject/providers";
-import { Signer } from "ethers";
-import { Environment } from "../enums/Environment.js";
+import { Account, Transport, Address } from "viem";
+import { SimpleWalletClient } from "../abi/generated.js";
+/**
+ * Supported chains. For convenience, both name or chain ID are supported.
+ *
+ * @public
+ */
+export type SupportedChainIds = "11155111" | "sepolia";
 /**
  * Configuration for the SDK Client.
  *
  * @public
  */
-export interface StoryCommonConfig {
-    readonly environment: Environment;
-}
-export interface StoryConfig extends StoryCommonConfig {
-    readonly signer: Signer;
-}
-export interface StoryReadOnlyConfig extends StoryCommonConfig {
-    readonly provider?: Provider;
-}
+export type UseAccountStoryConfig = {
+    readonly account: Account | Address;
+    readonly chainId?: SupportedChainIds;
+    readonly transport: Transport;
+};
+export type UseWalletStoryConfig = {
+    readonly chainId?: SupportedChainIds;
+    readonly transport: Transport;
+    readonly wallet: SimpleWalletClient;
+};
+export type StoryConfig = {
+    readonly chainId?: SupportedChainIds;
+    readonly transport: Transport;
+    readonly wallet?: SimpleWalletClient;
+    readonly account?: Account | Address;
+};
+export type ContractAddress = {
+    [key in SupportedChainIds]: Record<string, string>;
+};
 //# sourceMappingURL=config.d.ts.map

package/dist/declarations/src/types/config.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"config.d.ts","sourceRoot":"../../../../src/types","sources":["config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAC;AACpD,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhC,OAAO,EAAE,WAAW,EAAE,gCAA6B;AAEnD;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;CACnC;AAED,MAAM,WAAW,WAAY,SAAQ,iBAAiB;IACpD,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,mBAAoB,SAAQ,iBAAiB;IAC5D,QAAQ,CAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC;CAC9B"}
+{"version":3,"file":"config.d.ts","sourceRoot":"../../../../src/types","sources":["config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAEnD,OAAO,EAAE,kBAAkB,EAAE,4BAAyB;AAEtD;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG,UAAU,GAAG,SAAS,CAAC;AAEvD;;;;GAIG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC,QAAQ,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC;IACpC,QAAQ,CAAC,OAAO,CAAC,EAAE,iBAAiB,CAAC;IACrC,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,QAAQ,CAAC,OAAO,CAAC,EAAE,iBAAiB,CAAC;IACrC,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;IAC9B,QAAQ,CAAC,MAAM,EAAE,kBAAkB,CAAC;CACrC,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACxB,QAAQ,CAAC,OAAO,CAAC,EAAE,iBAAiB,CAAC;IACrC,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;IAC9B,QAAQ,CAAC,MAAM,CAAC,EAAE,kBAAkB,CAAC;IACrC,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC;CACtC,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;KAAG,GAAG,IAAI,iBAAiB,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;CAAE,CAAC"}

package/dist/declarations/src/types/options.d.ts

@@ -0,0 +1,10 @@
+export type TxOptions = {
+    waitForTransaction?: boolean;
+    gasPrice?: bigint;
+    maxFeePerGas?: bigint;
+    numBlockConfirmations?: number;
+};
+export type WithTxOptions<T> = T & {
+    txOptions?: TxOptions;
+};
+//# sourceMappingURL=options.d.ts.map

package/dist/declarations/src/types/options.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"options.d.ts","sourceRoot":"../../../../src/types","sources":["options.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,SAAS,GAAG;IACtB,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC,CAAC;AAEF,MAAM,MAAM,aAAa,CAAC,CAAC,IAAI,CAAC,GAAG;IACjC,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC"}

package/dist/declarations/src/types/resources/dispute.d.ts

@@ -0,0 +1,52 @@
+import { Hex } from "viem";
+import { TxOptions } from "../options.js";
+export type Dispute = {
+    targetIpId: Hex;
+    disputeInitiator: Hex;
+    arbitrationPolicy: Hex;
+    linkToDisputeEvidence: string;
+    targetTag: string;
+    currentTag: string;
+};
+export type RaiseDisputeRequest = {
+    targetIpId: Hex;
+    arbitrationPolicy: Hex;
+    linkToDisputeEvidence: string;
+    targetTag: string;
+    calldata?: Hex;
+    txOptions?: TxOptions;
+};
+export type RaiseDisputeResponse = {
+    txHash: string;
+    disputeId?: Hex;
+    arbitrationPolicy?: Hex;
+};
+export type SetDisputeJudgementRequest = {
+    disputeId: number;
+    decision: boolean;
+    calldata?: Hex;
+    txOptions?: TxOptions;
+};
+export type SetDisputeJudgementResponse = {
+    txHash: string;
+    disputeId?: bigint;
+    decision?: boolean;
+    data?: Hex;
+};
+export type CancelDisputeRequest = {
+    disputeId: number | string | bigint;
+    calldata?: Hex;
+    txOptions?: TxOptions;
+};
+export type CancelDisputeResponse = {
+    txHash: string;
+};
+export type ResolveDisputeRequest = {
+    disputeId: number | string | bigint;
+    data: Hex;
+    txOptions?: TxOptions;
+};
+export type ResolveDisputeResponse = {
+    txHash: string;
+};
+//# sourceMappingURL=dispute.d.ts.map

package/dist/declarations/src/types/resources/dispute.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dispute.d.ts","sourceRoot":"../../../../../src/types/resources","sources":["dispute.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,MAAM,CAAC;AAE3B,OAAO,EAAE,SAAS,EAAE,sBAAmB;AAEvC,MAAM,MAAM,OAAO,GAAG;IACpB,UAAU,EAAE,GAAG,CAAC;IAChB,gBAAgB,EAAE,GAAG,CAAC;IACtB,iBAAiB,EAAE,GAAG,CAAC;IACvB,qBAAqB,EAAE,MAAM,CAAC;IAC9B,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,UAAU,EAAE,GAAG,CAAC;IAChB,iBAAiB,EAAE,GAAG,CAAC;IACvB,qBAAqB,EAAE,MAAM,CAAC;IAC9B,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,GAAG,CAAC;IACf,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,GAAG,CAAC;IAChB,iBAAiB,CAAC,EAAE,GAAG,CAAC;CACzB,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG;IACvC,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,OAAO,CAAC;IAClB,QAAQ,CAAC,EAAE,GAAG,CAAC;IACf,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,2BAA2B,GAAG;IACxC,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,IAAI,CAAC,EAAE,GAAG,CAAC;CACZ,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,SAAS,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IACpC,QAAQ,CAAC,EAAE,GAAG,CAAC;IACf,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,SAAS,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IACpC,IAAI,EAAE,GAAG,CAAC;IACV,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACnC,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC"}

package/dist/declarations/src/types/resources/ipAccount.d.ts

@@ -0,0 +1,26 @@
+import { Hex } from "viem";
+import { TxOptions } from "../options.js";
+export type IPAccountExecuteRequest = {
+    accountAddress: Hex;
+    to: Hex;
+    value: number;
+    data: Hex;
+    txOptions?: TxOptions;
+};
+export type IPAccountExecuteResponse = {
+    txHash: string;
+};
+export type IPAccountExecuteWithSigRequest = {
+    accountAddress: Hex;
+    to: Hex;
+    value: number;
+    data: Hex;
+    signer: Hex;
+    deadline: number;
+    signature: Hex;
+    txOptions?: TxOptions;
+};
+export type IPAccountExecuteWithSigResponse = {
+    txHash: string;
+};
+//# sourceMappingURL=ipAccount.d.ts.map

package/dist/declarations/src/types/resources/ipAccount.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ipAccount.d.ts","sourceRoot":"../../../../../src/types/resources","sources":["ipAccount.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,MAAM,CAAC;AAE3B,OAAO,EAAE,SAAS,EAAE,sBAAmB;AAEvC,MAAM,MAAM,uBAAuB,GAAG;IACpC,cAAc,EAAE,GAAG,CAAC;IACpB,EAAE,EAAE,GAAG,CAAC;IACR,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,GAAG,CAAC;IACV,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG;IACrC,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,8BAA8B,GAAG;IAC3C,cAAc,EAAE,GAAG,CAAC;IACpB,EAAE,EAAE,GAAG,CAAC;IACR,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,GAAG,CAAC;IACV,MAAM,EAAE,GAAG,CAAC;IACZ,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,GAAG,CAAC;IACf,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,+BAA+B,GAAG;IAC5C,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC"}

package/dist/declarations/src/types/resources/ipAsset.d.ts

@@ -1,71 +1,70 @@
-import { IPAssetType } from "../../enums/IPAssetType.js";
-/**
- * Core data model for IP Asset.
- *
- * @public
- */
-export type IPAsset = {
-    ipAssetId: string;
-    franchiseId: string;
-    ipAssetName: string;
-    ipAssetType: IPAssetType;
-    ownerAddress: string;
-    tokenUri: string;
-    txHash: string;
-};
-/**
- * Request type for ipAsset.get method.
- *
- * @public
- */
-export type GetIpAssetRequest = {
-    ipAssetId: string;
-    franchiseId: string;
+import { Address, Hex } from "viem";
+import { TxOptions } from "../options.js";
+import { PIL_TYPE } from "./license.js";
+export type RegisterIpResponse = {
+    txHash?: string;
+    ipId?: Hex;
 };
-/**
- * Response type for ipAsset.get method.
- *
- * @public
- */
-export type GetIpAssetResponse = {
-    data: IPAsset;
+export type RegisterRequest = {
+    tokenContract: Hex;
+    tokenId: string;
+    txOptions?: TxOptions;
 };
-/**
- * Request type for ipAsset.create method.
- *
- * @public
- */
-export type CreateIpAssetRequest = {
-    franchiseId: string;
-    ipAssetType: IPAssetType;
-    ipAssetName: string;
-    description: string;
-    mediaUrl: string;
-    to: string;
-    parentIpAssetId: string;
+export type RegisterDerivativeWithLicenseTokensRequest = {
+    childIpId: Hex;
+    licenseTokenIds: string[];
+    txOptions?: TxOptions;
 };
-/**
- * Response type for ipAsset.create method.
- *
- * @public
- */
-export type CreateIpAssetResponse = {
+export type RegisterDerivativeWithLicenseTokensResponse = {
     txHash: string;
 };
-/**
- * Request type for ipAsset.list method.
- *
- * @public
- */
-export type ListIpAssetRequest = {
-    franchiseId: string;
+export type RegisterDerivativeRequest = {
+    childIpId: Hex;
+    parentIpIds: Hex[];
+    licenseTermsIds: string[];
+    licenseTemplate?: Hex;
+    txOptions?: TxOptions;
+};
+export type RegisterDerivativeResponse = {
+    txHash?: string;
+    childIpId?: Hex;
+};
+export type CreateIpAssetWithPilTermsRequest = {
+    nftContract: Address;
+    pilType: PIL_TYPE;
+    metadata?: {
+        metadataURI: string;
+        metadata: string;
+        nftMetadata: string;
+    };
+    recipient?: Hex;
+    mintingFee?: string;
+    currency?: Hex;
+    commercialRevShare?: number;
+    txOptions?: TxOptions;
 };
-/**
- * Response type for ipAsset.list method.
- *
- * @public
- */
-export type ListIpAssetResponse = {
-    data: IPAsset[];
+export type RegisterIpAndMakeDerivativeRequest = {
+    nftContract: Address;
+    tokenId: string;
+    derivData: {
+        parentIpIds: Address[];
+        licenseTermsIds: string[];
+        licenseTemplate?: Address;
+    };
+    metadata?: {
+        metadataURI: string;
+        metadata: string;
+        nftMetadata: string;
+    };
+    sigMetadata?: {
+        signer: Address;
+        deadline: string;
+        signature: Hex;
+    };
+    sigRegister: {
+        signer: Address;
+        deadline: string;
+        signature: Hex;
+    };
 };
 //# sourceMappingURL=ipAsset.d.ts.map

package/dist/declarations/src/types/resources/ipAsset.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ipAsset.d.ts","sourceRoot":"../../../../../src/types/resources","sources":["ipAsset.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,mCAAgC;AAEtD;;;;GAIG;AACH,MAAM,MAAM,OAAO,GAAG;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,WAAW,CAAC;IACzB,YAAY,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,IAAI,EAAE,OAAO,CAAC;CACf,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,WAAW,CAAC;IACzB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,EAAE,EAAE,MAAM,CAAC;IACX,eAAe,EAAE,MAAM,CAAC;CACzB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,EAAE,OAAO,EAAE,CAAC;CACjB,CAAC"}
+{"version":3,"file":"ipAsset.d.ts","sourceRoot":"../../../../../src/types/resources","sources":["ipAsset.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,MAAM,CAAC;AAEpC,OAAO,EAAE,SAAS,EAAE,sBAAmB;AACvC,OAAO,EAAE,QAAQ,EAAE,qBAAkB;AAErC,MAAM,MAAM,kBAAkB,GAAG;IAC/B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,GAAG,CAAC;CACZ,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,aAAa,EAAE,GAAG,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,0CAA0C,GAAG;IACvD,SAAS,EAAE,GAAG,CAAC;IACf,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,2CAA2C,GAAG;IACxD,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACtC,SAAS,EAAE,GAAG,CAAC;IACf,WAAW,EAAE,GAAG,EAAE,CAAC;IACnB,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,eAAe,CAAC,EAAE,GAAG,CAAC;IACtB,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG;IACvC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,GAAG,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,gCAAgC,GAAG;IAC7C,WAAW,EAAE,OAAO,CAAC;IACrB,OAAO,EAAE,QAAQ,CAAC;IAClB,QAAQ,CAAC,EAAE;QACT,WAAW,EAAE,MAAM,CAAC;QACpB,QAAQ,EAAE,MAAM,CAAC;QACjB,WAAW,EAAE,MAAM,CAAC;KACrB,CAAC;IACF,SAAS,CAAC,EAAE,GAAG,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,GAAG,CAAC;IACf,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,kCAAkC,GAAG;IAC/C,WAAW,EAAE,OAAO,CAAC;IACrB,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE;QACT,WAAW,EAAE,OAAO,EAAE,CAAC;QACvB,eAAe,EAAE,MAAM,EAAE,CAAC;QAC1B,eAAe,CAAC,EAAE,OAAO,CAAC;KAC3B,CAAC;IACF,QAAQ,CAAC,EAAE;QACT,WAAW,EAAE,MAAM,CAAC;QACpB,QAAQ,EAAE,MAAM,CAAC;QACjB,WAAW,EAAE,MAAM,CAAC;KACrB,CAAC;IACF,WAAW,CAAC,EAAE;QACZ,MAAM,EAAE,OAAO,CAAC;QAChB,QAAQ,EAAE,MAAM,CAAC;QACjB,SAAS,EAAE,GAAG,CAAC;KAChB,CAAC;IACF,WAAW,EAAE;QACX,MAAM,EAAE,OAAO,CAAC;QAChB,QAAQ,EAAE,MAAM,CAAC;QACjB,SAAS,EAAE,GAAG,CAAC;KAChB,CAAC;CACH,CAAC"}