@story-protocol/core-sdk 1.0.0-rc.6 → 1.1.0-stable

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

@@ -1,10 +1,11 @@
-import { Hex } from "viem";
+import { Address } from "viem";
 import { TxOptions } from "../options.js";
+import { EncodedTxData } from "../../abi/generated.js";
 export type RoyaltyPolicyApiResponse = {
     data: RoyaltyPolicy;
 };
 export type RoyaltyPolicy = {
-    id: `0x${string}`;
+    id: Address;
     targetAncestors: string[];
     targetRoyaltyAmount: string[];
 };
@@ -17,56 +18,59 @@ export type RoyaltyContext = {
     parentAncestorsRoyalties2: number[];
 };
 export type CollectRoyaltyTokensRequest = {
-    parentIpId: Hex;
-    royaltyVaultIpId: Hex;
+    parentIpId: Address;
+    royaltyVaultIpId: Address;
     txOptions?: TxOptions;
 };
 export type CollectRoyaltyTokensResponse = {
-    txHash: string;
-    royaltyTokensCollected?: string;
+    txHash?: string;
+    encodedTxData?: EncodedTxData;
+    royaltyTokensCollected?: bigint;
 };
 export type RoyaltyData = [
     isUnlinkableToParents: boolean,
-    ipRoyaltyVault: Hex,
+    ipRoyaltyVault: Address,
     royaltyStack: bigint,
-    ancestorsAddresses: Hex,
+    ancestorsAddresses: Address,
     ancestorsRoyalties: bigint[]
 ];
 export type ClaimableRevenueRequest = {
-    royaltyVaultIpId: Hex;
-    account: Hex;
-    snapshotId: string;
-    token: Hex;
+    royaltyVaultIpId: Address;
+    account: Address;
+    snapshotId: string | number | bigint;
+    token: Address;
 };
-export type ClaimableRevenueResponse = string;
+export type ClaimableRevenueResponse = bigint;
 export type PayRoyaltyOnBehalfRequest = {
-    receiverIpId: Hex;
-    payerIpId: Hex;
-    token: Hex;
-    amount: string;
+    receiverIpId: Address;
+    payerIpId: Address;
+    token: Address;
+    amount: string | number | bigint;
     txOptions?: TxOptions;
 };
 export type PayRoyaltyOnBehalfResponse = {
-    txHash: string;
+    txHash?: string;
+    encodedTxData?: EncodedTxData;
 };
 export type SnapshotRequest = {
-    royaltyVaultIpId: Hex;
+    royaltyVaultIpId: Address;
     txOptions?: TxOptions;
 };
-export type claimRevenueRequest = {
-    snapshotIds: string[];
-    token: Hex;
-    account: Hex;
-    royaltyVaultIpId: Hex;
+export type ClaimRevenueRequest = {
+    snapshotIds: string[] | number[] | bigint[];
+    token: Address;
+    royaltyVaultIpId: Address;
+    account?: Address;
     txOptions?: TxOptions;
 };
-export type claimRevenueResponse = {
-    txHash: string;
-    claimableToken?: string;
+export type ClaimRevenueResponse = {
+    txHash?: string;
+    encodedTxData?: EncodedTxData;
+    claimableToken?: bigint;
 };
 export type SnapshotResponse = {
-    txHash: string;
-    snapshotId?: string;
+    txHash?: string;
+    encodedTxData?: EncodedTxData;
+    snapshotId?: bigint;
 };
-export type RoyaltyVaultAddress = Hex;
 //# sourceMappingURL=royalty.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"royalty.d.ts","sourceRoot":"../../../../../src/types/resources","sources":["royalty.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,MAAM,CAAC;AAE3B,OAAO,EAAE,SAAS,EAAE,sBAAmB;AAEvC,MAAM,MAAM,wBAAwB,GAAG;IACrC,IAAI,EAAE,aAAa,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,EAAE,EAAE,KAAK,MAAM,EAAE,CAAC;IAClB,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,mBAAmB,EAAE,MAAM,EAAE,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,mBAAmB,EAAE,MAAM,EAAE,CAAC;IAC9B,gBAAgB,EAAE,MAAM,EAAE,CAAC;IAC3B,gBAAgB,EAAE,MAAM,EAAE,CAAC;IAC3B,yBAAyB,EAAE,MAAM,EAAE,CAAC;IACpC,yBAAyB,EAAE,MAAM,EAAE,CAAC;CACrC,CAAC;AAEF,MAAM,MAAM,2BAA2B,GAAG;IACxC,UAAU,EAAE,GAAG,CAAC;IAChB,gBAAgB,EAAE,GAAG,CAAC;IACtB,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,4BAA4B,GAAG;IACzC,MAAM,EAAE,MAAM,CAAC;IACf,sBAAsB,CAAC,EAAE,MAAM,CAAC;CACjC,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACxB,qBAAqB,EAAE,OAAO;IAC9B,cAAc,EAAE,GAAG;IACnB,YAAY,EAAE,MAAM;IACpB,kBAAkB,EAAE,GAAG;IACvB,kBAAkB,EAAE,MAAM,EAAE;CAC7B,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACpC,gBAAgB,EAAE,GAAG,CAAC;IACtB,OAAO,EAAE,GAAG,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,GAAG,CAAC;CACZ,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG,MAAM,CAAC;AAE9C,MAAM,MAAM,yBAAyB,GAAG;IACtC,YAAY,EAAE,GAAG,CAAC;IAClB,SAAS,EAAE,GAAG,CAAC;IACf,KAAK,EAAE,GAAG,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG;IACvC,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,gBAAgB,EAAE,GAAG,CAAC;IACtB,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,KAAK,EAAE,GAAG,CAAC;IACX,OAAO,EAAE,GAAG,CAAC;IACb,gBAAgB,EAAE,GAAG,CAAC;IACtB,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,MAAM,EAAE,MAAM,CAAC;IACf,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG,GAAG,CAAC"}
+{"version":3,"file":"royalty.d.ts","sourceRoot":"../../../../../src/types/resources","sources":["royalty.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAE/B,OAAO,EAAE,SAAS,EAAE,sBAAmB;AACvC,OAAO,EAAE,aAAa,EAAE,+BAA4B;AAEpD,MAAM,MAAM,wBAAwB,GAAG;IACrC,IAAI,EAAE,aAAa,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,EAAE,EAAE,OAAO,CAAC;IACZ,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,mBAAmB,EAAE,MAAM,EAAE,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,mBAAmB,EAAE,MAAM,EAAE,CAAC;IAC9B,gBAAgB,EAAE,MAAM,EAAE,CAAC;IAC3B,gBAAgB,EAAE,MAAM,EAAE,CAAC;IAC3B,yBAAyB,EAAE,MAAM,EAAE,CAAC;IACpC,yBAAyB,EAAE,MAAM,EAAE,CAAC;CACrC,CAAC;AAEF,MAAM,MAAM,2BAA2B,GAAG;IACxC,UAAU,EAAE,OAAO,CAAC;IACpB,gBAAgB,EAAE,OAAO,CAAC;IAC1B,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,4BAA4B,GAAG;IACzC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,sBAAsB,CAAC,EAAE,MAAM,CAAC;CACjC,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACxB,qBAAqB,EAAE,OAAO;IAC9B,cAAc,EAAE,OAAO;IACvB,YAAY,EAAE,MAAM;IACpB,kBAAkB,EAAE,OAAO;IAC3B,kBAAkB,EAAE,MAAM,EAAE;CAC7B,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACpC,gBAAgB,EAAE,OAAO,CAAC;IAC1B,OAAO,EAAE,OAAO,CAAC;IACjB,UAAU,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IACrC,KAAK,EAAE,OAAO,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG,MAAM,CAAC;AAE9C,MAAM,MAAM,yBAAyB,GAAG;IACtC,YAAY,EAAE,OAAO,CAAC;IACtB,SAAS,EAAE,OAAO,CAAC;IACnB,KAAK,EAAE,OAAO,CAAC;IACf,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IACjC,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG;IACvC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,gBAAgB,EAAE,OAAO,CAAC;IAC1B,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,WAAW,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC;IAC5C,KAAK,EAAE,OAAO,CAAC;IACf,gBAAgB,EAAE,OAAO,CAAC;IAC1B,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC"}

package/dist/declarations/src/utils/chain.d.ts

@@ -0,0 +1,34 @@
+export declare const iliad: {
+    blockExplorers: {
+        readonly default: {
+            readonly name: "Explorer";
+            readonly url: "https://testnet.storyscan.xyz";
+        };
+    };
+    contracts: {
+        readonly multicall3: {
+            readonly address: "0xcA11bde05977b3631167028862bE2a173976CA11";
+            readonly blockCreated: 5882;
+        };
+    };
+    id: 1513;
+    name: "iliad";
+    nativeCurrency: {
+        readonly name: "IP";
+        readonly symbol: "IP";
+        readonly decimals: 18;
+    };
+    rpcUrls: {
+        readonly default: {
+            readonly http: readonly ["https://testnet.storyrpc.io"];
+            readonly webSocket: readonly ["wss://story-network.rpc.caldera.xyz/ws"];
+        };
+    };
+    sourceId?: number | undefined;
+    testnet: true;
+    custom?: Record<string, unknown> | undefined;
+    formatters?: undefined;
+    serializers?: import("viem").ChainSerializers<undefined> | undefined;
+    fees?: import("viem").ChainFees<undefined> | undefined;
+};
+//# sourceMappingURL=chain.d.ts.map

package/dist/declarations/src/utils/chain.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"chain.d.ts","sourceRoot":"../../../../src/utils","sources":["chain.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,KAAK;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAuBhB,CAAC"}

package/dist/declarations/src/utils/sign.d.ts

@@ -0,0 +1,16 @@
+import { PermissionSignatureRequest, PermissionSignatureResponse } from "../types/common.js";
+/**
+ * Get the signature for setting permissions.
+ * @param param - The parameter object containing necessary data to get the signature.
+ * @param param.ipId - The IP ID.
+ * @param param.deadline - The deadline.
+ * @param param.nonce - The nonce.
+ * @param param.wallet - The wallet client.
+ * @param param.chainId - The chain ID.
+ * @param param.permissions - The permissions.
+ * @param param.permissionFunc - The permission function,default function is setPermission.
+ * @returns A Promise that resolves to the signature.
+ */
+export declare const getPermissionSignature: (param: PermissionSignatureRequest) => Promise<PermissionSignatureResponse>;
+export declare const getDeadline: (deadline?: bigint | number | string) => bigint;
+//# sourceMappingURL=sign.d.ts.map

package/dist/declarations/src/utils/sign.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sign.d.ts","sourceRoot":"../../../../src/utils","sources":["sign.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,0BAA0B,EAAE,2BAA2B,EAAE,2BAAwB;AAE1F;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,sBAAsB,UAC1B,0BAA0B,KAChC,QAAQ,2BAA2B,CA8ErC,CAAC;AAEF,eAAO,MAAM,WAAW,cAAe,MAAM,GAAG,MAAM,GAAG,MAAM,KAAG,MAMjE,CAAC"}