@story-protocol/core-sdk 1.3.2 → 1.4.0-rc.1

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

@@ -0,0 +1,75 @@
+import { Address } from "viem";
+import { SupportedChainIds } from "../config.js";
+import { LicenseTermsInput } from "../resources/license.js";
+import { RoyaltyPolicyInput } from "../resources/royalty.js";
+export type NonCommercialSocialRemixingRequest = {
+    /** Optional overrides for the default license terms. */
+    override?: Partial<LicenseTermsInput>;
+    /**
+     * The chain ID to use for this license flavor.
+     *
+     * @default aeneid
+     */
+    chainId?: SupportedChainIds;
+};
+export type CommercialRemixRequest = {
+    /** The fee to be paid when minting a license. */
+    defaultMintingFee: bigint | number;
+    /** Percentage of revenue that must be shared with the licensor. Must be between 0 and 100. */
+    commercialRevShare: number;
+    /** The ERC20 token to be used to pay the minting fee */
+    currency: Address;
+    /**
+     * The type of royalty policy to be used.
+     *
+     * @default LAP
+     */
+    royaltyPolicy?: RoyaltyPolicyInput;
+    /**
+     * The chain ID to use for this license flavor.
+     *
+     * @default aeneid
+     */
+    chainId?: SupportedChainIds;
+    /** Optional overrides for the default license terms. */
+    override?: Partial<LicenseTermsInput>;
+};
+export type CommercialUseRequest = {
+    /** The fee to be paid when minting a license. */
+    defaultMintingFee: bigint | number;
+    /** The ERC20 token to be used to pay the minting fee. */
+    currency: Address;
+    /**
+     * The type of royalty policy to be used.
+     *
+     * @default LAP
+     */
+    royaltyPolicy?: RoyaltyPolicyInput;
+    /**
+     * The chain ID to use for this license flavor.
+     *
+     * @default aeneid
+     */
+    chainId?: SupportedChainIds;
+    /** Optional overrides for the default license terms. */
+    override?: Partial<LicenseTermsInput>;
+};
+export type CreativeCommonsAttributionRequest = {
+    /** The ERC20 token to be used to pay the minting fee. */
+    currency: Address;
+    /**
+     * The type of royalty policy to be used.
+     *
+     * @default LAP
+     */
+    royaltyPolicy?: RoyaltyPolicyInput;
+    /**
+     * The chain ID to use for this license flavor.
+     *
+     * @default aeneid
+     */
+    chainId?: SupportedChainIds;
+    /** Optional overrides for the default license terms. */
+    override?: Partial<LicenseTermsInput>;
+};
+//# sourceMappingURL=pilFlavor.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"pilFlavor.d.ts","sourceRoot":"../../../../../src/types/utils","sources":["pilFlavor.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAE/B,OAAO,EAAE,iBAAiB,EAAE,qBAAkB;AAC9C,OAAO,EAAE,iBAAiB,EAAE,gCAA6B;AACzD,OAAO,EAAE,kBAAkB,EAAE,gCAA6B;AAE1D,MAAM,MAAM,kCAAkC,GAAG;IAC/C,wDAAwD;IACxD,QAAQ,CAAC,EAAE,OAAO,CAAC,iBAAiB,CAAC,CAAC;IACtC;;;;OAIG;IACH,OAAO,CAAC,EAAE,iBAAiB,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACnC,iDAAiD;IACjD,iBAAiB,EAAE,MAAM,GAAG,MAAM,CAAC;IACnC,8FAA8F;IAC9F,kBAAkB,EAAE,MAAM,CAAC;IAC3B,wDAAwD;IACxD,QAAQ,EAAE,OAAO,CAAC;IAClB;;;;OAIG;IACH,aAAa,CAAC,EAAE,kBAAkB,CAAC;IAEnC;;;;OAIG;IACH,OAAO,CAAC,EAAE,iBAAiB,CAAC;IAC5B,wDAAwD;IACxD,QAAQ,CAAC,EAAE,OAAO,CAAC,iBAAiB,CAAC,CAAC;CACvC,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,iDAAiD;IACjD,iBAAiB,EAAE,MAAM,GAAG,MAAM,CAAC;IACnC,yDAAyD;IACzD,QAAQ,EAAE,OAAO,CAAC;IAClB;;;;OAIG;IACH,aAAa,CAAC,EAAE,kBAAkB,CAAC;IACnC;;;;OAIG;IACH,OAAO,CAAC,EAAE,iBAAiB,CAAC;IAC5B,wDAAwD;IACxD,QAAQ,CAAC,EAAE,OAAO,CAAC,iBAAiB,CAAC,CAAC;CACvC,CAAC;AAEF,MAAM,MAAM,iCAAiC,GAAG;IAC9C,yDAAyD;IACzD,QAAQ,EAAE,OAAO,CAAC;IAClB;;;;OAIG;IACH,aAAa,CAAC,EAAE,kBAAkB,CAAC;IACnC;;;;OAIG;IACH,OAAO,CAAC,EAAE,iBAAiB,CAAC;IAC5B,wDAAwD;IACxD,QAAQ,CAAC,EAAE,OAAO,CAAC,iBAAiB,CAAC,CAAC;CACvC,CAAC"}

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

@@ -5,6 +5,7 @@ export declare const aeneid: {
             readonly url: "https://aeneid.storyscan.xyz/";
         };
     };
+    blockTime?: number | undefined | undefined;
     contracts: {
         readonly multicall3: {
             readonly address: "0xca11bde05977b3631167028862be2a173976ca11";
@@ -19,6 +20,7 @@ export declare const aeneid: {
         readonly symbol: "IP";
         readonly decimals: 18;
     };
+    experimental_preconfirmationTime?: number | undefined | undefined;
     rpcUrls: {
         readonly default: {
             readonly http: readonly ["https://aeneid.storyrpc.io/"];
@@ -38,6 +40,7 @@ export declare const mainnet: {
             readonly url: "https://dev-mainnet.storyscan.xyz/";
         };
     };
+    blockTime?: number | undefined | undefined;
     contracts: {
         readonly multicall3: {
             readonly address: "0xca11bde05977b3631167028862be2a173976ca11";
@@ -52,6 +55,7 @@ export declare const mainnet: {
         readonly symbol: "IP";
         readonly decimals: 18;
     };
+    experimental_preconfirmationTime?: number | undefined | undefined;
     rpcUrls: {
         readonly default: {
             readonly http: readonly ["https://mainnet.storyrpc.io/"];

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,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAsBjB,CAAC;AAEH,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;AAEH,eAAO,MAAM,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAsBlB,CAAC"}

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

@@ -0,0 +1,54 @@
+import { SupportedChainIds } from "../types/config.js";
+import { LicenseTerms, LicenseTermsInput } from "../types/resources/license.js";
+import { CommercialRemixRequest, CommercialUseRequest, CreativeCommonsAttributionRequest, NonCommercialSocialRemixingRequest } from "../types/utils/pilFlavor.js";
+/**
+ * Pre-configured Programmable IP License (PIL) flavors for ease of use.
+ *
+ * The PIL is highly configurable, but these pre-configured license terms (flavors)
+ * are the most popular options that cover common use cases.
+ *
+ * @see {@link https://docs.story.foundation/concepts/programmable-ip-license/pil-flavors | PIL Flavors Documentation}
+ *
+ * @example
+ * ```typescript
+ * // Create a commercial use license
+ * const commercialLicense = PILFlavor.commercialUse({
+ *   defaultMintingFee: 1000000000000000000n, // 1 IP minting fee
+ *   currencyToken: "0x1234...", // currency token
+ *   royaltyPolicy: "LAP"  // royalty policy
+ * });
+ *
+ * // Create a non-commercial social remixing license
+ * const remixLicense = PILFlavor.nonCommercialSocialRemixing();
+ * ```
+ */
+export declare class PILFlavor {
+    private static readonly _nonComSocialRemixingPIL;
+    private static readonly _commercialUse;
+    private static readonly _commercialRemix;
+    private static readonly _creativeCommonsAttribution;
+    /**
+     * Gets the values to create a Non-Commercial Social Remixing license terms flavor.
+     * @see {@link https://docs.story.foundation/concepts/programmable-ip-license/pil-flavors#non-commercial-social-remixing | Non Commercial Social Remixing}
+     */
+    static nonCommercialSocialRemixing: (request?: NonCommercialSocialRemixingRequest) => LicenseTerms;
+    /**
+     * Gets the values to create a Commercial Use license terms flavor.
+     * @see {@link https://docs.story.foundation/concepts/programmable-ip-license/pil-flavors#commercial-use | Commercial Use}
+     */
+    static commercialUse: ({ defaultMintingFee, currency, royaltyPolicy, chainId, override, }: CommercialUseRequest) => LicenseTerms;
+    /**
+     * Gets the values to create a Commercial Remixing license terms flavor.
+     * @see {@link https://docs.story.foundation/concepts/programmable-ip-license/pil-flavors#commercial-remix | Commercial Remix}
+     */
+    static commercialRemix: ({ defaultMintingFee, royaltyPolicy, currency, commercialRevShare, chainId, override, }: CommercialRemixRequest) => LicenseTerms;
+    /**
+     * Gets the values to create a Creative Commons Attribution (CC-BY) license terms flavor.
+     * @see {@link https://docs.story.foundation/concepts/programmable-ip-license/pil-flavors#creative-commons-attribution | Creative Commons Attribution}
+     */
+    static creativeCommonsAttribution: ({ royaltyPolicy, currency, chainId, override, }: CreativeCommonsAttributionRequest) => LicenseTerms;
+    static validateLicenseTerms: (params: LicenseTermsInput, chainId?: SupportedChainIds) => LicenseTerms;
+    private static verifyCommercialUse;
+    private static verifyDerivatives;
+}
+//# sourceMappingURL=pilFlavor.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"pilFlavor.d.ts","sourceRoot":"../../../../src/utils","sources":["pilFlavor.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,iBAAiB,EAAE,2BAAwB;AACpD,OAAO,EAAE,YAAY,EAAE,iBAAiB,EAAE,sCAAmC;AAC7E,OAAO,EACL,sBAAsB,EACtB,oBAAoB,EACpB,iCAAiC,EACjC,kCAAkC,EACnC,oCAAiC;AAyBlC;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,qBAAa,SAAS;IACpB,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,wBAAwB,CAS9C;IAEF,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,cAAc,CASpC;IAEF,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,gBAAgB,CAStC;IAEF,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,2BAA2B,CASjD;IAEF;;;OAGG;IACH,OAAc,2BAA2B,GACvC,UAAU,kCAAkC,KAC3C,YAAY,CAQb;IAEF;;;OAGG;IACH,OAAc,aAAa,GAAI,oEAM5B,oBAAoB,KAAG,YAAY,CAWpC;IAEF;;;OAGG;IACH,OAAc,eAAe,GAAI,wFAO9B,sBAAsB,KAAG,YAAY,CAYtC;IAEF;;;OAGG;IACH,OAAc,0BAA0B,GAAI,iDAKzC,iCAAiC,KAAG,YAAY,CAUjD;IAEF,OAAc,oBAAoB,GAChC,QAAQ,iBAAiB,EACzB,UAAU,iBAAiB,KAC1B,YAAY,CAmCb;IAEF,OAAO,CAAC,MAAM,CAAC,mBAAmB,CAqBhC;IAEF,OAAO,CAAC,MAAM,CAAC,iBAAiB,CAe9B;CACH"}