@story-protocol/core-sdk 1.2.0-rc.4 → 1.3.0-beta.2

package/dist/declarations/src/types/utils/wip.d.ts

@@ -0,0 +1,87 @@
+import { Address, Hash, PublicClient } from "viem";
+import { Multicall3Aggregate3Request, Multicall3Client, Erc20TokenClient, EncodedTxData, SimpleWalletClient, PiLicenseTemplateClient, LicensingModuleClient } from "../../abi/generated.js";
+import { TxOptions } from "../options.js";
+/**
+ * Options to override the default behavior of the auto wrapping IP
+ * and auto approve logic.
+ */
+export type WithWipOptions = {
+    /** options to configure WIP behavior */
+    wipOptions?: {
+        /**
+         * Use multicall to batch the WIP calls into one transaction when possible.
+         *
+         * @default true
+         */
+        useMulticallWhenPossible?: boolean;
+        /**
+         * By default IP is converted to WIP if the current WIP
+         * balance does not cover the fees.
+         * Set this to `false` to disable this behavior.
+         *
+         * @default true
+         */
+        enableAutoWrapIp?: boolean;
+        /**
+         * Automatically approve WIP usage when WIP is needed but current allowance
+         * is not sufficient.
+         * Set this to `false` to disable this behavior.
+         *
+         * @default true
+         */
+        enableAutoApprove?: boolean;
+    };
+};
+export type Multicall3ValueCall = Multicall3Aggregate3Request["calls"][0] & {
+    value: bigint;
+};
+export type WipSpender = {
+    address: Address;
+    /**
+     * Amount that the address will spend in WIP.
+     * If not provided, then unlimited amount is assumed.
+     */
+    amount?: bigint;
+};
+export type WipApprovalCall = {
+    spenders: WipSpender[];
+    client: Erc20TokenClient;
+    rpcClient: PublicClient;
+    /** owner is the address calling the approval */
+    owner: Address;
+    /** when true, will return an array of {@link Multicall3ValueCall} */
+    useMultiCall: boolean;
+};
+export type ContractCallWithWipFees = WithWipOptions & {
+    totalFees: bigint;
+    multicall3Client: Multicall3Client;
+    wipClient: Erc20TokenClient;
+    /** all possible spenders of the wip */
+    wipSpenders: WipSpender[];
+    contractCall: () => Promise<Hash>;
+    encodedTxs: EncodedTxData[];
+    rpcClient: PublicClient;
+    wallet: SimpleWalletClient;
+    sender: Address;
+    txOptions?: TxOptions;
+};
+export type MulticallWithWrapIp = WithWipOptions & {
+    calls: Multicall3ValueCall[];
+    ipAmountToWrap: bigint;
+    contractCall: () => Promise<Hash>;
+    wipSpenders: WipSpender[];
+    multicall3Client: Multicall3Client;
+    wipClient: Erc20TokenClient;
+    rpcClient: PublicClient;
+    wallet: SimpleWalletClient;
+};
+export type CalculateDerivativeMintFeeParams = {
+    multicall3Client: Multicall3Client;
+    licenseTemplateClient: PiLicenseTemplateClient;
+    licensingModuleClient: LicensingModuleClient;
+    parentIpId: Address;
+    licenseTermsId: bigint;
+    receiver: Address;
+    amount: bigint;
+};
+//# sourceMappingURL=wip.d.ts.map

package/dist/declarations/src/types/utils/wip.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"wip.d.ts","sourceRoot":"../../../../../src/types/utils","sources":["wip.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AAEnD,OAAO,EACL,2BAA2B,EAC3B,gBAAgB,EAChB,gBAAgB,EAChB,aAAa,EACb,kBAAkB,EAClB,uBAAuB,EACvB,qBAAqB,EACtB,+BAA4B;AAC7B,OAAO,EAAE,SAAS,EAAE,sBAAmB;AAEvC;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,wCAAwC;IACxC,UAAU,CAAC,EAAE;QACX;;;;WAIG;QACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;QAEnC;;;;;;WAMG;QACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;QAE3B;;;;;;WAMG;QACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;KAC7B,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG,2BAA2B,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC;AAE9F,MAAM,MAAM,UAAU,GAAG;IACvB,OAAO,EAAE,OAAO,CAAC;IACjB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,QAAQ,EAAE,UAAU,EAAE,CAAC;IACvB,MAAM,EAAE,gBAAgB,CAAC;IACzB,SAAS,EAAE,YAAY,CAAC;IACxB,gDAAgD;IAChD,KAAK,EAAE,OAAO,CAAC;IACf,qEAAqE;IACrE,YAAY,EAAE,OAAO,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG,cAAc,GAAG;IACrD,SAAS,EAAE,MAAM,CAAC;IAClB,gBAAgB,EAAE,gBAAgB,CAAC;IACnC,SAAS,EAAE,gBAAgB,CAAC;IAC5B,uCAAuC;IACvC,WAAW,EAAE,UAAU,EAAE,CAAC;IAC1B,YAAY,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAClC,UAAU,EAAE,aAAa,EAAE,CAAC;IAC5B,SAAS,EAAE,YAAY,CAAC;IACxB,MAAM,EAAE,kBAAkB,CAAC;IAC3B,MAAM,EAAE,OAAO,CAAC;IAChB,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG,cAAc,GAAG;IACjD,KAAK,EAAE,mBAAmB,EAAE,CAAC;IAC7B,cAAc,EAAE,MAAM,CAAC;IACvB,YAAY,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAClC,WAAW,EAAE,UAAU,EAAE,CAAC;IAC1B,gBAAgB,EAAE,gBAAgB,CAAC;IACnC,SAAS,EAAE,gBAAgB,CAAC;IAC5B,SAAS,EAAE,YAAY,CAAC;IACxB,MAAM,EAAE,kBAAkB,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,gCAAgC,GAAG;IAC7C,gBAAgB,EAAE,gBAAgB,CAAC;IACnC,qBAAqB,EAAE,uBAAuB,CAAC;IAC/C,qBAAqB,EAAE,qBAAqB,CAAC;IAC7C,UAAU,EAAE,OAAO,CAAC;IACpB,cAAc,EAAE,MAAM,CAAC;IACvB,QAAQ,EAAE,OAAO,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC"}

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

@@ -1,8 +1,8 @@
-export declare const odyssey: {
+export declare const aeneid: {
     blockExplorers: {
         readonly default: {
             readonly name: "Explorer";
-            readonly url: "https://odyssey-testnet-explorer.storyscan.xyz/";
+            readonly url: "https://aeneid.storyscan.xyz/";
         };
     };
     contracts: {
@@ -11,8 +11,8 @@ export declare const odyssey: {
             readonly blockCreated: 5882;
         };
     };
-    id: 1516;
-    name: "odyssey";
+    id: 1315;
+    name: "aeneid";
     nativeCurrency: {
         readonly name: "IP";
         readonly symbol: "IP";
@@ -20,7 +20,7 @@ export declare const odyssey: {
     };
     rpcUrls: {
         readonly default: {
-            readonly http: readonly ["https://odyssey.storyrpc.io/"];
+            readonly http: readonly ["https://aeneid.storyrpc.io/"];
         };
     };
     sourceId?: number | undefined;

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

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

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

@@ -0,0 +1,9 @@
+import { Hex } from "viem";
+export type IpMetadataForWorkflow = {
+    ipMetadataURI: string;
+    ipMetadataHash: Hex;
+    nftMetadataURI: string;
+    nftMetadataHash: Hex;
+};
+export declare const getIpMetadataForWorkflow: (metadata?: Partial<IpMetadataForWorkflow>) => IpMetadataForWorkflow;
+//# sourceMappingURL=getIpMetadataForWorkflow.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"getIpMetadataForWorkflow.d.ts","sourceRoot":"../../../../src/utils","sources":["getIpMetadataForWorkflow.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAY,MAAM,MAAM,CAAC;AAErC,MAAM,MAAM,qBAAqB,GAAG;IAClC,aAAa,EAAE,MAAM,CAAC;IACtB,cAAc,EAAE,GAAG,CAAC;IACpB,cAAc,EAAE,MAAM,CAAC;IACvB,eAAe,EAAE,GAAG,CAAC;CACtB,CAAC;AAEF,eAAO,MAAM,wBAAwB,cACxB,QAAQ,qBAAqB,CAAC,KACxC,qBAOF,CAAC"}

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

@@ -7,7 +7,6 @@ import { PermissionSignatureRequest, SignatureRequest, SignatureResponse } from
  * @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.
  */

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

@@ -1 +1 @@
-{"version":3,"file":"sign.d.ts","sourceRoot":"../../../../src/utils","sources":["sign.ts"],"names":[],"mappings":"AAWA,OAAO,EACL,0BAA0B,EAC1B,gBAAgB,EAChB,iBAAiB,EAClB,yCAAsC;AAEvC;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,sBAAsB,UAC1B,0BAA0B,KAChC,QAAQ,iBAAiB,CAoC3B,CAAC;AAEF,eAAO,MAAM,WAAW,kBAAmB,MAAM,aAAa,MAAM,GAAG,MAAM,GAAG,MAAM,KAAG,MAKxF,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,YAAY,6EAQtB,gBAAgB,KAAG,QAAQ,iBAAiB,CAkD9C,CAAC"}
+{"version":3,"file":"sign.d.ts","sourceRoot":"../../../../src/utils","sources":["sign.ts"],"names":[],"mappings":"AAWA,OAAO,EACL,0BAA0B,EAC1B,gBAAgB,EAChB,iBAAiB,EAClB,yCAAsC;AAEvC;;;;;;;;;;GAUG;AACH,eAAO,MAAM,sBAAsB,UAC1B,0BAA0B,KAChC,QAAQ,iBAAiB,CAqC3B,CAAC;AAEF,eAAO,MAAM,WAAW,kBAAmB,MAAM,aAAa,MAAM,GAAG,MAAM,GAAG,MAAM,KAAG,MAKxF,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,YAAY,6EAQtB,gBAAgB,KAAG,QAAQ,iBAAiB,CAkD9C,CAAC"}