@story-protocol/core-sdk 1.0.0-rc.17 → 1.0.0-rc.18

package/README.md

@@ -51,7 +51,7 @@ The preceding code created the `account` object for creating the SDK client.
 
 To set up the SDK client, import `StoryClient` and `StoryConfig` from `@story-protocol/core-sdk`. Write the following code, utilizing the `account` we created previously.
 
-> :information-source: Make sure to have RPC_PROVIDER_URL for your desired chain set up in your .env file. We recommend using the Sepolia network with `RPC_PROVIDER_URL=https://rpc.ankr.com/eth_sepolia`.
+> :information-source: Make sure to have RPC_PROVIDER_URL for your desired chain set up in your .env file. We recommend using the Iliad network with `RPC_PROVIDER_URL=https://rpc.partner.testnet.storyprotocol.net`.
 
 ```typescript index.ts
 import { StoryClient, StoryConfig } from "@story-protocol/core-sdk";
@@ -98,15 +98,16 @@ In your testing environment:
 
 - Run `yalc update` to pull the latest changes.
 
-## Steps to pull and compile latest smart contract ABIs (Currently pulls from the protocol-contracts `dev` branch)
+## Steps to pull and compile latest Protocol Core & Periphery v1 Smart Contract ABIs (Currently pulls from the protocol-core-v1 and protocol-periphery-v1 `release-v1.x.x` branch)
 
 - run `cd packages/wagmi-generator && npm run generate`
 
 ## Release
 
-| Package                         | Description                                    |
-| :------------------------------ | :--------------------------------------------- |
-| [core-sdk](./packages/core-sdk) | The core sdk for interacting with the protocol |
+| Package                           | Description                                     |
+| :-------------------------------- | :---------------------------------------------- |
+| [core-sdk](./packages/core-sdk)   | The core sdk for interacting with the protocol  |
+| [react-sdk](./packages/react-sdk) | The react sdk for interacting with the protocol |
 
 ## Contributing
 

package/dist/declarations/src/abi/generated.d.ts

@@ -17943,6 +17943,22 @@ export declare const spgAbi: readonly [{
     readonly type: "error";
     readonly inputs: readonly [];
     readonly name: "NotInitializing";
+}, {
+    readonly type: "error";
+    readonly inputs: readonly [{
+        readonly name: "tokenId";
+        readonly internalType: "uint256";
+        readonly type: "uint256";
+    }, {
+        readonly name: "caller";
+        readonly internalType: "address";
+        readonly type: "address";
+    }, {
+        readonly name: "actualTokenOwner";
+        readonly internalType: "address";
+        readonly type: "address";
+    }];
+    readonly name: "SPG__CallerAndNotTokenOwner";
 }, {
     readonly type: "error";
     readonly inputs: readonly [];
@@ -18256,7 +18272,7 @@ export declare const spgAbi: readonly [{
             readonly internalType: "address";
             readonly type: "address";
         }, {
-            readonly name: "mintingFee";
+            readonly name: "defaultMintingFee";
             readonly internalType: "uint256";
             readonly type: "uint256";
         }, {
@@ -18284,7 +18300,7 @@ export declare const spgAbi: readonly [{
             readonly internalType: "uint32";
             readonly type: "uint32";
         }, {
-            readonly name: "commercialRevCelling";
+            readonly name: "commercialRevCeiling";
             readonly internalType: "uint256";
             readonly type: "uint256";
         }, {
@@ -18304,7 +18320,7 @@ export declare const spgAbi: readonly [{
             readonly internalType: "bool";
             readonly type: "bool";
         }, {
-            readonly name: "derivativeRevCelling";
+            readonly name: "derivativeRevCeiling";
             readonly internalType: "uint256";
             readonly type: "uint256";
         }, {
@@ -18447,6 +18463,32 @@ export declare const spgAbi: readonly [{
         readonly type: "uint256";
     }];
     readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly inputs: readonly [{
+        readonly name: "";
+        readonly internalType: "address";
+        readonly type: "address";
+    }, {
+        readonly name: "";
+        readonly internalType: "address";
+        readonly type: "address";
+    }, {
+        readonly name: "";
+        readonly internalType: "uint256";
+        readonly type: "uint256";
+    }, {
+        readonly name: "";
+        readonly internalType: "bytes";
+        readonly type: "bytes";
+    }];
+    readonly name: "onERC721Received";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly internalType: "bytes4";
+        readonly type: "bytes4";
+    }];
+    readonly stateMutability: "nonpayable";
 }, {
     readonly type: "function";
     readonly inputs: readonly [];
@@ -18549,7 +18591,7 @@ export declare const spgAbi: readonly [{
             readonly internalType: "address";
             readonly type: "address";
         }, {
-            readonly name: "mintingFee";
+            readonly name: "defaultMintingFee";
             readonly internalType: "uint256";
             readonly type: "uint256";
         }, {
@@ -18577,7 +18619,7 @@ export declare const spgAbi: readonly [{
             readonly internalType: "uint32";
             readonly type: "uint32";
         }, {
-            readonly name: "commercialRevCelling";
+            readonly name: "commercialRevCeiling";
             readonly internalType: "uint256";
             readonly type: "uint256";
         }, {
@@ -18597,7 +18639,7 @@ export declare const spgAbi: readonly [{
             readonly internalType: "bool";
             readonly type: "bool";
         }, {
-            readonly name: "derivativeRevCelling";
+            readonly name: "derivativeRevCeiling";
             readonly internalType: "uint256";
             readonly type: "uint256";
         }, {
@@ -18841,7 +18883,7 @@ export declare const spgAbi: readonly [{
             readonly internalType: "address";
             readonly type: "address";
         }, {
-            readonly name: "mintingFee";
+            readonly name: "defaultMintingFee";
             readonly internalType: "uint256";
             readonly type: "uint256";
         }, {
@@ -18869,7 +18911,7 @@ export declare const spgAbi: readonly [{
             readonly internalType: "uint32";
             readonly type: "uint32";
         }, {
-            readonly name: "commercialRevCelling";
+            readonly name: "commercialRevCeiling";
             readonly internalType: "uint256";
             readonly type: "uint256";
         }, {
@@ -18889,7 +18931,7 @@ export declare const spgAbi: readonly [{
             readonly internalType: "bool";
             readonly type: "bool";
         }, {
-            readonly name: "derivativeRevCelling";
+            readonly name: "derivativeRevCeiling";
             readonly internalType: "uint256";
             readonly type: "uint256";
         }, {
@@ -19071,6 +19113,22 @@ export declare const spgConfig: {
         readonly type: "error";
         readonly inputs: readonly [];
         readonly name: "NotInitializing";
+    }, {
+        readonly type: "error";
+        readonly inputs: readonly [{
+            readonly name: "tokenId";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }, {
+            readonly name: "caller";
+            readonly internalType: "address";
+            readonly type: "address";
+        }, {
+            readonly name: "actualTokenOwner";
+            readonly internalType: "address";
+            readonly type: "address";
+        }];
+        readonly name: "SPG__CallerAndNotTokenOwner";
     }, {
         readonly type: "error";
         readonly inputs: readonly [];
@@ -19384,7 +19442,7 @@ export declare const spgConfig: {
                 readonly internalType: "address";
                 readonly type: "address";
             }, {
-                readonly name: "mintingFee";
+                readonly name: "defaultMintingFee";
                 readonly internalType: "uint256";
                 readonly type: "uint256";
             }, {
@@ -19412,7 +19470,7 @@ export declare const spgConfig: {
                 readonly internalType: "uint32";
                 readonly type: "uint32";
             }, {
-                readonly name: "commercialRevCelling";
+                readonly name: "commercialRevCeiling";
                 readonly internalType: "uint256";
                 readonly type: "uint256";
             }, {
@@ -19432,7 +19490,7 @@ export declare const spgConfig: {
                 readonly internalType: "bool";
                 readonly type: "bool";
             }, {
-                readonly name: "derivativeRevCelling";
+                readonly name: "derivativeRevCeiling";
                 readonly internalType: "uint256";
                 readonly type: "uint256";
             }, {
@@ -19575,6 +19633,32 @@ export declare const spgConfig: {
             readonly type: "uint256";
         }];
         readonly stateMutability: "nonpayable";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [{
+            readonly name: "";
+            readonly internalType: "address";
+            readonly type: "address";
+        }, {
+            readonly name: "";
+            readonly internalType: "address";
+            readonly type: "address";
+        }, {
+            readonly name: "";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }, {
+            readonly name: "";
+            readonly internalType: "bytes";
+            readonly type: "bytes";
+        }];
+        readonly name: "onERC721Received";
+        readonly outputs: readonly [{
+            readonly name: "";
+            readonly internalType: "bytes4";
+            readonly type: "bytes4";
+        }];
+        readonly stateMutability: "nonpayable";
     }, {
         readonly type: "function";
         readonly inputs: readonly [];
@@ -19677,7 +19761,7 @@ export declare const spgConfig: {
                 readonly internalType: "address";
                 readonly type: "address";
             }, {
-                readonly name: "mintingFee";
+                readonly name: "defaultMintingFee";
                 readonly internalType: "uint256";
                 readonly type: "uint256";
             }, {
@@ -19705,7 +19789,7 @@ export declare const spgConfig: {
                 readonly internalType: "uint32";
                 readonly type: "uint32";
             }, {
-                readonly name: "commercialRevCelling";
+                readonly name: "commercialRevCeiling";
                 readonly internalType: "uint256";
                 readonly type: "uint256";
             }, {
@@ -19725,7 +19809,7 @@ export declare const spgConfig: {
                 readonly internalType: "bool";
                 readonly type: "bool";
             }, {
-                readonly name: "derivativeRevCelling";
+                readonly name: "derivativeRevCeiling";
                 readonly internalType: "uint256";
                 readonly type: "uint256";
             }, {
@@ -19969,7 +20053,7 @@ export declare const spgConfig: {
                 readonly internalType: "address";
                 readonly type: "address";
             }, {
-                readonly name: "mintingFee";
+                readonly name: "defaultMintingFee";
                 readonly internalType: "uint256";
                 readonly type: "uint256";
             }, {
@@ -19997,7 +20081,7 @@ export declare const spgConfig: {
                 readonly internalType: "uint32";
                 readonly type: "uint32";
             }, {
-                readonly name: "commercialRevCelling";
+                readonly name: "commercialRevCeiling";
                 readonly internalType: "uint256";
                 readonly type: "uint256";
             }, {
@@ -20017,7 +20101,7 @@ export declare const spgConfig: {
                 readonly internalType: "bool";
                 readonly type: "bool";
             }, {
-                readonly name: "derivativeRevCelling";
+                readonly name: "derivativeRevCeiling";
                 readonly internalType: "uint256";
                 readonly type: "uint256";
             }, {
@@ -24659,19 +24743,19 @@ export type SpgMintAndRegisterIpAndAttachPilTermsRequest = {
     terms: {
         transferable: boolean;
         royaltyPolicy: Address;
-        mintingFee: bigint;
+        defaultMintingFee: bigint;
         expiration: bigint;
         commercialUse: boolean;
         commercialAttribution: boolean;
         commercializerChecker: Address;
         commercializerCheckerData: Hex;
         commercialRevShare: number;
-        commercialRevCelling: bigint;
+        commercialRevCeiling: bigint;
         derivativesAllowed: boolean;
         derivativesAttribution: boolean;
         derivativesApproval: boolean;
         derivativesReciprocal: boolean;
-        derivativeRevCelling: bigint;
+        derivativeRevCeiling: bigint;
         currency: Address;
         uri: string;
     };
@@ -24766,19 +24850,19 @@ export type SpgRegisterIpAndAttachPilTermsRequest = {
     terms: {
         transferable: boolean;
         royaltyPolicy: Address;
-        mintingFee: bigint;
+        defaultMintingFee: bigint;
         expiration: bigint;
         commercialUse: boolean;
         commercialAttribution: boolean;
         commercializerChecker: Address;
         commercializerCheckerData: Hex;
         commercialRevShare: number;
-        commercialRevCelling: bigint;
+        commercialRevCeiling: bigint;
         derivativesAllowed: boolean;
         derivativesAttribution: boolean;
         derivativesApproval: boolean;
         derivativesReciprocal: boolean;
-        derivativeRevCelling: bigint;
+        derivativeRevCeiling: bigint;
         currency: Address;
         uri: string;
     };
@@ -24871,19 +24955,19 @@ export type SpgRegisterPilTermsAndAttachRequest = {
     terms: {
         transferable: boolean;
         royaltyPolicy: Address;
-        mintingFee: bigint;
+        defaultMintingFee: bigint;
         expiration: bigint;
         commercialUse: boolean;
         commercialAttribution: boolean;
         commercializerChecker: Address;
         commercializerCheckerData: Hex;
         commercialRevShare: number;
-        commercialRevCelling: bigint;
+        commercialRevCeiling: bigint;
         derivativesAllowed: boolean;
         derivativesAttribution: boolean;
         derivativesApproval: boolean;
         derivativesReciprocal: boolean;
-        derivativeRevCelling: bigint;
+        derivativeRevCeiling: bigint;
         currency: Address;
         uri: string;
     };
@@ -25051,6 +25135,135 @@ export declare class SpgClient extends SpgEventClient {
      */
     registerPilTermsAndAttachEncode(request: SpgRegisterPilTermsAndAttachRequest): EncodedTxData;
 }
+/**
+ * SpgnftBeaconOwnershipTransferredEvent
+ *
+ * @param previousOwner address
+ * @param newOwner address
+ */
+export type SpgnftBeaconOwnershipTransferredEvent = {
+    previousOwner: Address;
+    newOwner: Address;
+};
+/**
+ * SpgnftBeaconUpgradedEvent
+ *
+ * @param implementation address
+ */
+export type SpgnftBeaconUpgradedEvent = {
+    implementation: Address;
+};
+export type SpgnftBeaconImplementationResponse = Address;
+export type SpgnftBeaconOwnerResponse = Address;
+/**
+ * SpgnftBeaconTransferOwnershipRequest
+ *
+ * @param newOwner address
+ */
+export type SpgnftBeaconTransferOwnershipRequest = {
+    newOwner: Address;
+};
+/**
+ * SpgnftBeaconUpgradeToRequest
+ *
+ * @param newImplementation address
+ */
+export type SpgnftBeaconUpgradeToRequest = {
+    newImplementation: Address;
+};
+/**
+ * contract SPGNFTBeacon event
+ */
+export declare class SpgnftBeaconEventClient {
+    protected readonly rpcClient: PublicClient;
+    readonly address: Address;
+    constructor(rpcClient: PublicClient, address?: Address);
+    /**
+     * event OwnershipTransferred for contract SPGNFTBeacon
+     */
+    watchOwnershipTransferredEvent(onLogs: (txHash: Hex, ev: Partial<SpgnftBeaconOwnershipTransferredEvent>) => void): WatchContractEventReturnType;
+    /**
+     * parse tx receipt event OwnershipTransferred for contract SPGNFTBeacon
+     */
+    parseTxOwnershipTransferredEvent(txReceipt: TransactionReceipt): Array<SpgnftBeaconOwnershipTransferredEvent>;
+    /**
+     * event Upgraded for contract SPGNFTBeacon
+     */
+    watchUpgradedEvent(onLogs: (txHash: Hex, ev: Partial<SpgnftBeaconUpgradedEvent>) => void): WatchContractEventReturnType;
+    /**
+     * parse tx receipt event Upgraded for contract SPGNFTBeacon
+     */
+    parseTxUpgradedEvent(txReceipt: TransactionReceipt): Array<SpgnftBeaconUpgradedEvent>;
+}
+/**
+ * contract SPGNFTBeacon readonly method
+ */
+export declare class SpgnftBeaconReadOnlyClient extends SpgnftBeaconEventClient {
+    constructor(rpcClient: PublicClient, address?: Address);
+    /**
+     * method implementation for contract SPGNFTBeacon
+     *
+     * @param request SpgnftBeaconImplementationRequest
+     * @return Promise<SpgnftBeaconImplementationResponse>
+     */
+    implementation(): Promise<SpgnftBeaconImplementationResponse>;
+    /**
+     * method owner for contract SPGNFTBeacon
+     *
+     * @param request SpgnftBeaconOwnerRequest
+     * @return Promise<SpgnftBeaconOwnerResponse>
+     */
+    owner(): Promise<SpgnftBeaconOwnerResponse>;
+}
+/**
+ * contract SPGNFTBeacon write method
+ */
+export declare class SpgnftBeaconClient extends SpgnftBeaconReadOnlyClient {
+    protected readonly wallet: SimpleWalletClient;
+    constructor(rpcClient: PublicClient, wallet: SimpleWalletClient, address?: Address);
+    /**
+     * method renounceOwnership for contract SPGNFTBeacon
+     *
+     * @param request SpgnftBeaconRenounceOwnershipRequest
+     * @return Promise<WriteContractReturnType>
+     */
+    renounceOwnership(): Promise<WriteContractReturnType>;
+    /**
+     * method renounceOwnership for contract SPGNFTBeacon with only encode
+     *
+     * @param request SpgnftBeaconRenounceOwnershipRequest
+     * @return EncodedTxData
+     */
+    renounceOwnershipEncode(): EncodedTxData;
+    /**
+     * method transferOwnership for contract SPGNFTBeacon
+     *
+     * @param request SpgnftBeaconTransferOwnershipRequest
+     * @return Promise<WriteContractReturnType>
+     */
+    transferOwnership(request: SpgnftBeaconTransferOwnershipRequest): Promise<WriteContractReturnType>;
+    /**
+     * method transferOwnership for contract SPGNFTBeacon with only encode
+     *
+     * @param request SpgnftBeaconTransferOwnershipRequest
+     * @return EncodedTxData
+     */
+    transferOwnershipEncode(request: SpgnftBeaconTransferOwnershipRequest): EncodedTxData;
+    /**
+     * method upgradeTo for contract SPGNFTBeacon
+     *
+     * @param request SpgnftBeaconUpgradeToRequest
+     * @return Promise<WriteContractReturnType>
+     */
+    upgradeTo(request: SpgnftBeaconUpgradeToRequest): Promise<WriteContractReturnType>;
+    /**
+     * method upgradeTo for contract SPGNFTBeacon with only encode
+     *
+     * @param request SpgnftBeaconUpgradeToRequest
+     * @return EncodedTxData
+     */
+    upgradeToEncode(request: SpgnftBeaconUpgradeToRequest): EncodedTxData;
+}
 /**
  * SpgnftImplApprovalEvent
  *