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

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

@@ -1,78 +1,72 @@
-import { BytesLike } from "ethers";
-/**
- * Represents the core data model for a License, containing essential information.
- *
- * @public
- */
+import { Hex } from "viem";
+import { TxOptions } from "../options.js";
+export type LicenseApiResponse = {
+    data: License;
+};
 export type License = {
-    licenseId: string;
-    ipAssetId: string;
-    franchiseId: string;
-    ownerAddress: string;
-    uri: string;
-    txHash: string;
+    id: string;
+    policyId: string;
+    licensorIpId: Hex;
 };
-/**
- * Represents the request structure for retrieving license details using the `franchise.get` method.
- *
- * @public
- */
-export type GetLicenseRequest = {
-    licenseId: string;
+export type RegisterNonComSocialRemixingPILRequest = {
+    txOptions?: TxOptions;
 };
-/**
- * Represents the response structure for retrieving license details using the `license.get` method.
- *
- * @public
- */
-export type GetLicenseResponse = {
-    data: License;
+export type LicenseTerms = {
+    mintingFee: bigint;
+    expiration: bigint;
+    commercialRevCelling: bigint;
+    derivativeRevCelling: bigint;
+    commercializerCheckerData: Hex;
+    transferable: boolean;
+    royaltyPolicy: Hex;
+    commercialUse: boolean;
+    commercialAttribution: boolean;
+    commercializerChecker: Hex;
+    commercialRevShare: number;
+    derivativesAllowed: boolean;
+    derivativesAttribution: boolean;
+    derivativesApproval: boolean;
+    derivativesReciprocal: boolean;
+    currency: Hex;
+    uri: string;
+};
+export type LicenseTermsIdResponse = number;
+export type RegisterPILResponse = {
+    licenseTermsId?: string;
+    txHash?: string;
 };
-export type ListLicenseRequest = {
-    ipAssetId: string;
-    franchiseId: string;
+export type RegisterCommercialUsePILRequest = {
+    mintingFee: string;
+    currency: Hex;
+    txOptions?: TxOptions;
 };
-/**
- * Represents the request structure for listing multiple licenses using the `license.list` method.
- *
- * @public
- */
-export type ListLicenseResponse = {
-    data: License[];
+export type RegisterCommercialRemixPILRequest = {
+    mintingFee: string;
+    commercialRevShare: number;
+    currency: Hex;
+    txOptions?: TxOptions;
 };
-/**
- * Represents the optional parameters for creating a new license using the `license.create` method.
- *
- * @public
- */
-export type CreateLicenseRequestOptions = {
-    parentLicenseId?: string;
-    ownerAddress?: string;
-    revoker?: string;
-    isCommercial?: boolean;
-    isSublicensable?: boolean;
-    terms?: {
-        processor: string;
-        data: BytesLike | string;
-    };
+export type AttachLicenseTermsRequest = {
+    ipId: Hex;
+    licenseTermsId: string;
+    licenseTemplate?: Hex;
+    txOptions?: TxOptions;
 };
-/**
- * Represents the request structure for creating a new license using the `license.create` method.
- *
- * @public
- */
-export type CreateLicenseRequest = {
-    franchiseId: string;
-    ipAssetId: string;
-    licenseURI: string;
-    options?: CreateLicenseRequestOptions;
+export type MintLicenseTokensRequest = {
+    licensorIpId: Hex;
+    licenseTermsId: string;
+    licenseTemplate?: Hex;
+    amount?: number;
+    receiver?: Hex;
+    txOptions?: TxOptions;
 };
-/**
- * Represents the response structure for creating a new license using the `license.create` method.
- *
- * @public
- */
-export type CreateLicenseResponse = {
-    txHash: string;
+export type MintLicenseTokensResponse = {
+    licenseTokenId?: string;
+    txHash?: string;
 };
+export declare enum PIL_TYPE {
+    NON_COMMERCIAL_REMIX = 0,
+    COMMERCIAL_USE = 1,
+    COMMERCIAL_REMIX = 2
+}
 //# sourceMappingURL=license.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"license.d.ts","sourceRoot":"../../../../../src/types/resources","sources":["license.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAC;AAEnC;;;;GAIG;AACH,MAAM,MAAM,OAAO,GAAG;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;IACrB,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,IAAI,EAAE,OAAO,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,EAAE,OAAO,EAAE,CAAC;CACjB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,2BAA2B,GAAG;IACxC,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,KAAK,CAAC,EAAE;QACN,SAAS,EAAE,MAAM,CAAC;QAClB,IAAI,EAAE,SAAS,GAAG,MAAM,CAAC;KAC1B,CAAC;CACH,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,2BAA2B,CAAC;CACvC,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC"}
+{"version":3,"file":"license.d.ts","sourceRoot":"../../../../../src/types/resources","sources":["license.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,MAAM,CAAC;AAE3B,OAAO,EAAE,SAAS,EAAE,sBAAmB;AAEvC,MAAM,MAAM,kBAAkB,GAAG;IAC/B,IAAI,EAAE,OAAO,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,OAAO,GAAG;IACpB,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,GAAG,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,sCAAsC,GAAG;IACnD,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,oBAAoB,EAAE,MAAM,CAAC;IAC7B,oBAAoB,EAAE,MAAM,CAAC;IAC7B,yBAAyB,EAAE,GAAG,CAAC;IAC/B,YAAY,EAAE,OAAO,CAAC;IACtB,aAAa,EAAE,GAAG,CAAC;IACnB,aAAa,EAAE,OAAO,CAAC;IACvB,qBAAqB,EAAE,OAAO,CAAC;IAC/B,qBAAqB,EAAE,GAAG,CAAC;IAC3B,kBAAkB,EAAE,MAAM,CAAC;IAC3B,kBAAkB,EAAE,OAAO,CAAC;IAC5B,sBAAsB,EAAE,OAAO,CAAC;IAChC,mBAAmB,EAAE,OAAO,CAAC;IAC7B,qBAAqB,EAAE,OAAO,CAAC;IAC/B,QAAQ,EAAE,GAAG,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AACF,MAAM,MAAM,sBAAsB,GAAG,MAAM,CAAC;AAE5C,MAAM,MAAM,mBAAmB,GAAG;IAChC,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,+BAA+B,GAAG;IAC5C,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,GAAG,CAAC;IACd,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,iCAAiC,GAAG;IAC9C,UAAU,EAAE,MAAM,CAAC;IACnB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,QAAQ,EAAE,GAAG,CAAC;IACd,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACtC,IAAI,EAAE,GAAG,CAAC;IACV,cAAc,EAAE,MAAM,CAAC;IACvB,eAAe,CAAC,EAAE,GAAG,CAAC;IACtB,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG;IACrC,YAAY,EAAE,GAAG,CAAC;IAClB,cAAc,EAAE,MAAM,CAAC;IACvB,eAAe,CAAC,EAAE,GAAG,CAAC;IACtB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,GAAG,CAAC;IACf,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACtC,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,oBAAY,QAAQ;IAClB,oBAAoB,IAAA;IACpB,cAAc,IAAA;IACd,gBAAgB,IAAA;CACjB"}

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

@@ -0,0 +1,21 @@
+import { Hex } from "viem";
+import { TxOptions } from "../options.js";
+export type CreateNFTCollectionRequest = {
+    name: string;
+    symbol: string;
+    maxSupply?: number;
+    mintCost?: bigint;
+    mintToken?: Hex;
+    owner?: Hex;
+    txOptions?: TxOptions;
+};
+export type CreateNFTCollectionResponse<TReq extends CreateNFTCollectionRequest> = TReq["txOptions"] extends {
+    waitForTransaction: true;
+} ? {
+    txHash: string;
+    nftContract: Hex;
+} : {
+    txHash: string;
+    nftContract?: Hex;
+};
+//# sourceMappingURL=nftClient.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"nftClient.d.ts","sourceRoot":"../../../../../src/types/resources","sources":["nftClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,MAAM,CAAC;AAE3B,OAAO,EAAE,SAAS,EAAE,sBAAmB;AAEvC,MAAM,MAAM,0BAA0B,GAAG;IACvC,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,GAAG,CAAC;IAChB,KAAK,CAAC,EAAE,GAAG,CAAC;IACZ,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,2BAA2B,CAAC,IAAI,SAAS,0BAA0B,IAC7E,IAAI,CAAC,WAAW,CAAC,SAAS;IAAE,kBAAkB,EAAE,IAAI,CAAA;CAAE,GAClD;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,WAAW,EAAE,GAAG,CAAA;CAAE,GACpC;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,WAAW,CAAC,EAAE,GAAG,CAAA;CAAE,CAAC"}

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

@@ -0,0 +1,14 @@
+import { TxOptions } from "../options.js";
+export type SetPermissionsRequest = {
+    ipId: `0x${string}`;
+    signer: `0x${string}`;
+    to: `0x${string}`;
+    func?: string;
+    permission: number;
+    txOptions?: TxOptions;
+};
+export type SetPermissionsResponse = {
+    txHash: string;
+    success?: boolean;
+};
+//# sourceMappingURL=permission.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"permission.d.ts","sourceRoot":"../../../../../src/types/resources","sources":["permission.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,sBAAmB;AAEvC,MAAM,MAAM,qBAAqB,GAAG;IAClC,IAAI,EAAE,KAAK,MAAM,EAAE,CAAC;IACpB,MAAM,EAAE,KAAK,MAAM,EAAE,CAAC;IACtB,EAAE,EAAE,KAAK,MAAM,EAAE,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACnC,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC"}

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

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

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

@@ -0,0 +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,gBAAgB,EAAE,GAAG,CAAC;IACtB,OAAO,CAAC,EAAE,GAAG,CAAC;IACd,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"}

package/dist/story-protocol-core-sdk.cjs.d.ts

@@ -1,2 +1,2 @@
 export * from "./declarations/src/index";
-//# sourceMappingURL=story-protocol-core-sdk.cjs.d.ts.map
+//# sourceMappingURL=data:application/json;charset=utf-8;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic3RvcnktcHJvdG9jb2wtY29yZS1zZGsuY2pzLmQudHMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuL2RlY2xhcmF0aW9ucy9zcmMvaW5kZXguZC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSJ9