@story-protocol/core-sdk 0.0.1-beta-test.1 → 0.0.1-beta-rc.3

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

@@ -0,0 +1 @@
+{"version":3,"file":"dispute.d.ts","sourceRoot":"../../../../src/resources","sources":["dispute.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,YAAY,EAAe,MAAM,MAAM,CAAC;AAI/D,OAAO,EACL,oBAAoB,EACpB,qBAAqB,EACrB,mBAAmB,EACnB,oBAAoB,EACpB,qBAAqB,EACrB,sBAAsB,EACvB,sCAAmC;AAGpC,qBAAa,aAAa;IACxB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAe;IACtC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IAClC,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MAAuB;gBAErC,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,YAAY;IAKzD;;;;;;;;;;;;;;;OAeG;IACU,YAAY,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,oBAAoB,CAAC;IA+BtF;;;;;;;;;;;OAWG;IACU,aAAa,CAAC,OAAO,EAAE,oBAAoB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAoBzF;;;;;;;;OAQG;IACU,cAAc,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,sBAAsB,CAAC;CAmB7F"}

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

@@ -1,22 +1,155 @@
-import { AxiosInstance } from "axios";
 import { PublicClient, WalletClient } from "viem";
-import { IPAssetReadOnlyClient } from "./ipAssetReadOnly.js";
 import { RegisterDerivativeIpRequest, RegisterDerivativeIpResponse, RegisterRootIpRequest, RegisterRootIpResponse } from "../types/resources/ipAsset.js";
-export declare class IPAssetClient extends IPAssetReadOnlyClient {
+export declare class IPAssetClient {
     private readonly wallet;
-    constructor(httpClient: AxiosInstance, rpcClient: PublicClient, wallet: WalletClient);
+    private readonly rpcClient;
+    ipAssetRegistryConfig: {
+        abi: readonly [{
+            readonly anonymous: false;
+            readonly inputs: readonly [{
+                readonly indexed: false;
+                readonly internalType: "address";
+                readonly name: "ipId";
+                readonly type: "address";
+            }, {
+                readonly indexed: true;
+                readonly internalType: "uint256";
+                readonly name: "chainId";
+                readonly type: "uint256";
+            }, {
+                readonly indexed: true;
+                readonly internalType: "address";
+                readonly name: "tokenContract";
+                readonly type: "address";
+            }, {
+                readonly indexed: true;
+                readonly internalType: "uint256";
+                readonly name: "tokenId";
+                readonly type: "uint256";
+            }, {
+                readonly indexed: false;
+                readonly internalType: "address";
+                readonly name: "resolver";
+                readonly type: "address";
+            }, {
+                readonly indexed: false;
+                readonly internalType: "address";
+                readonly name: "provider";
+                readonly type: "address";
+            }, {
+                readonly indexed: false;
+                readonly internalType: "bytes";
+                readonly name: "metadata";
+                readonly type: "bytes";
+            }];
+            readonly name: "IPRegistered";
+            readonly type: "event";
+        }];
+        address: `0x${string}`;
+    };
+    registrationModuleConfig: {
+        abi: readonly [{
+            readonly inputs: readonly [{
+                readonly internalType: "uint256[]";
+                readonly name: "licenseIds";
+                readonly type: "uint256[]";
+            }, {
+                readonly internalType: "address";
+                readonly name: "tokenContract";
+                readonly type: "address";
+            }, {
+                readonly internalType: "uint256";
+                readonly name: "tokenId";
+                readonly type: "uint256";
+            }, {
+                readonly internalType: "string";
+                readonly name: "ipName";
+                readonly type: "string";
+            }, {
+                readonly internalType: "bytes32";
+                readonly name: "contentHash";
+                readonly type: "bytes32";
+            }, {
+                readonly internalType: "string";
+                readonly name: "externalURL";
+                readonly type: "string";
+            }, {
+                readonly internalType: "bytes";
+                readonly name: "royaltyContext";
+                readonly type: "bytes";
+            }];
+            readonly name: "registerDerivativeIp";
+            readonly outputs: readonly [];
+            readonly stateMutability: "nonpayable";
+            readonly type: "function";
+        }, {
+            readonly inputs: readonly [{
+                readonly internalType: "uint256";
+                readonly name: "policyId";
+                readonly type: "uint256";
+            }, {
+                readonly internalType: "address";
+                readonly name: "tokenContract";
+                readonly type: "address";
+            }, {
+                readonly internalType: "uint256";
+                readonly name: "tokenId";
+                readonly type: "uint256";
+            }, {
+                readonly internalType: "string";
+                readonly name: "ipName";
+                readonly type: "string";
+            }, {
+                readonly internalType: "bytes32";
+                readonly name: "contentHash";
+                readonly type: "bytes32";
+            }, {
+                readonly internalType: "string";
+                readonly name: "externalURL";
+                readonly type: "string";
+            }];
+            readonly name: "registerRootIp";
+            readonly outputs: readonly [{
+                readonly internalType: "address";
+                readonly name: "";
+                readonly type: "address";
+            }];
+            readonly stateMutability: "nonpayable";
+            readonly type: "function";
+        }];
+        address: `0x${string}`;
+    };
+    constructor(rpcClient: PublicClient, wallet: WalletClient);
     /**
-     * Register a root IP on Story Protocol based on the specified input asset data.
-     *
-     * @param request - the request object that contains all data needed to register a root IP.
-     * @returns the response object that contains results from the IP creation.
+     *  Registers a root-level IP into the protocol. Root-level IPs can be thought of as organizational hubs
+     *  for encapsulating policies that actual IPs can use to register through. As such, a root-level IP is not an
+     *  actual IP, but a container for IP policy management for their child IP assets.
+     * @param request The request object that contains all data needed to register a root IP.
+     *   @param request.policyId The policy that identifies the licensing terms of the IP.
+     *   @param request.tokenContract The address of the NFT bound to the root-level IP.
+     *   @param request.tokenId The token id of the NFT bound to the root-level IP.
+     *   @param request.ipName [Optional] The name assigned to the new IP.
+     *   @param request.contentHash [Optional] The content hash of the IP being registered.
+     *   @param request.uri [Optional] An external URI to link to the IP.
+     *   @param request.txOptions [Optional] The transaction options.
+     * @returns A Promise that resolves to an object containing the transaction hash and optional IP ID if waitForTxn is set to true.
+     * @emits RootIPRegistered (msg.sender, ipId, policyId)
      */
     registerRootIp(request: RegisterRootIpRequest): Promise<RegisterRootIpResponse>;
     /**
-     * Register a derivative IP on Story Protocol based on the specified input asset data.
-     *
-     * @param request - the request object that contains all data needed to register a derivative IP.
-     * @returns the response object that contains results from the IP creation.
+     *  Registers derivative IPs into the protocol. Derivative IPs are IP assets that inherit policies from
+     *  parent IPs by burning acquired license NFTs.
+     * @param request The request object that contains all data needed to register a root IP.
+     *   @param request.licenseIds The policy that identifies the licensing terms of the IP.
+     *   @param request.tokenContract The address of the NFT bound to the derivative IP.
+     *   @param request.tokenId The token id of the NFT bound to the derivative IP.
+     *   @param request.ipName [Optional] The name assigned to the new IP.
+     *   @param request.contentHash [Optional] The content hash of the IP being registered.
+     *   @param request.uri [Optional] An external URI to link to the IP.
+     *   @param request.minRoyalty [Optional] The minimum royalty percentage that the IP owner will receive.
+     *   @param request.txOptions [Optional] The transaction options.
+     * @returns A Promise that resolves to an object containing the transaction hash and optional IP ID if waitForTxn is set to true.
+     * @emits RootIPRegistered (msg.sender, ipId, policyId)
      */
     registerDerivativeIp(request: RegisterDerivativeIpRequest): Promise<RegisterDerivativeIpResponse>;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"ipAsset.d.ts","sourceRoot":"../../../../src/resources","sources":["ipAsset.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AACtC,OAAO,EAAE,YAAY,EAAE,YAAY,EAAc,MAAM,MAAM,CAAC;AAE9D,OAAO,EAAE,qBAAqB,EAAE,6BAA0B;AAG1D,OAAO,EACL,2BAA2B,EAC3B,4BAA4B,EAC5B,qBAAqB,EACrB,sBAAsB,EACvB,sCAAmC;AAIpC,qBAAa,aAAc,SAAQ,qBAAqB;IACtD,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAe;gBAE1B,UAAU,EAAE,aAAa,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,YAAY;IAKpF;;;;;OAKG;IACU,cAAc,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,sBAAsB,CAAC;IA4B5F;;;;;OAKG;IACU,oBAAoB,CAC/B,OAAO,EAAE,2BAA2B,GACnC,OAAO,CAAC,4BAA4B,CAAC;CAmEzC"}
+{"version":3,"file":"ipAsset.d.ts","sourceRoot":"../../../../src/resources","sources":["ipAsset.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,YAAY,EAAc,MAAM,MAAM,CAAC;AAK9D,OAAO,EACL,2BAA2B,EAC3B,4BAA4B,EAC5B,qBAAqB,EACrB,sBAAsB,EACvB,sCAAmC;AAGpC,qBAAa,aAAa;IACxB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAe;IACtC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IAClC,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MAAyB;IAC9C,wBAAwB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MAA4B;gBAE/C,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,YAAY;IAKzD;;;;;;;;;;;;;;OAcG;IACU,cAAc,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,sBAAsB,CAAC;IA+B5F;;;;;;;;;;;;;;OAcG;IACU,oBAAoB,CAC/B,OAAO,EAAE,2BAA2B,GACnC,OAAO,CAAC,4BAA4B,CAAC;CAmCzC"}