@silvana-one/nft 0.2.11 → 1.0.0

package/dist/web/contracts/collection.d.ts

@@ -5,8 +5,8 @@
  *
  * @module CollectionContract
  */
-import { Field, PublicKey, AccountUpdate, Bool, State, DeployArgs, AccountUpdateForest, VerificationKey, UInt32, UInt64, SmartContract } from "o1js";
-import { MintParams, MintRequest, TransferParams, CollectionData, NFTUpdateProof, NFTStateStruct, MintEvent, TransferEvent, ApproveEvent, UpgradeVerificationKeyEvent, LimitMintingEvent, PauseNFTEvent, NFTAdminBase, NFTAdminContractConstructor, PauseEvent, OwnershipChangeEvent, NFTOwnerBase, NFTOwnerContractConstructor, UpgradeVerificationKeyData, NFTApprovalContractConstructor, NFTApprovalBase, NFTUpdateContractConstructor, NFTUpdateBase, TransferExtendedParams } from "../interfaces/index.js";
+import { Field, PublicKey, AccountUpdate, Bool, State, DeployArgs, AccountUpdateForest, VerificationKey, UInt32, UInt64 } from "o1js";
+import { MintParams, MintRequest, TransferBySignatureParams, TransferByProofParams, CollectionData, NFTUpdateProof, NFTStateStruct, MintEvent, NFTUpdateEvent, TransferEvent, ApproveEvent, UpgradeVerificationKeyEvent, LimitMintingEvent, PauseNFTEvent, NFTAdminBase, NFTAdminContractConstructor, PauseEvent, SetNameEvent, SetBaseURLEvent, SetRoyaltyFeeEvent, SetTransferFeeEvent, SetAdminEvent, OwnershipChangeEvent, NFTOwnerBase, NFTOwnerContractConstructor, UpgradeVerificationKeyData, NFTApprovalContractConstructor, NFTApprovalBase, NFTUpdateContractConstructor, NFTUpdateBase, TransferExtendedParams } from "../interfaces/index.js";
 export { CollectionDeployProps, CollectionFactory, CollectionErrors };
 declare const CollectionErrors: {
     wrongMasterNFTaddress: string;
@@ -30,6 +30,7 @@ declare const CollectionErrors: {
     onlyOwnerCanUpgradeVerificationKey: string;
     invalidRoyaltyFee: string;
     invalidOracleAddress: string;
+    pendingCreatorIsEmpty: string;
 };
 interface CollectionDeployProps extends Exclude<DeployArgs, undefined> {
     collectionName: Field;
@@ -65,6 +66,8 @@ declare function CollectionFactory(params: {
          * such as flags and fee configurations.
          */
         packedData: State<import("node_modules/o1js/dist/node/lib/provable/field.js").Field>;
+        /** The public key part (x) of the pending creator. The isOdd field is written to the packedData */
+        pendingCreatorX: State<import("node_modules/o1js/dist/node/lib/provable/field.js").Field>;
         /**
          * Deploys the NFT Collection Contract with the initial settings.
          *
@@ -83,22 +86,23 @@ declare function CollectionFactory(params: {
          */
         events: {
             mint: typeof MintEvent;
-            update: typeof PublicKey;
+            update: typeof NFTUpdateEvent;
             transfer: typeof TransferEvent;
             approve: typeof ApproveEvent;
             upgradeNFTVerificationKey: typeof UpgradeVerificationKeyEvent;
-            upgradeVerificationKey: typeof import("node_modules/o1js/dist/node/lib/provable/field.js").Field & ((x: string | number | bigint | import("node_modules/o1js/dist/node/lib/provable/core/fieldvar.js").FieldConst | import("node_modules/o1js/dist/node/lib/provable/core/fieldvar.js").FieldVar | import("node_modules/o1js/dist/node/lib/provable/field.js").Field) => import("node_modules/o1js/dist/node/lib/provable/field.js").Field);
+            upgradeVerificationKey: typeof UpgradeVerificationKeyEvent;
             limitMinting: typeof LimitMintingEvent;
             pause: typeof PauseEvent;
             resume: typeof PauseEvent;
             pauseNFT: typeof PauseNFTEvent;
             resumeNFT: typeof PauseNFTEvent;
-            ownershipChange: typeof OwnershipChangeEvent;
-            setName: typeof import("node_modules/o1js/dist/node/lib/provable/field.js").Field & ((x: string | number | bigint | import("node_modules/o1js/dist/node/lib/provable/core/fieldvar.js").FieldConst | import("node_modules/o1js/dist/node/lib/provable/core/fieldvar.js").FieldVar | import("node_modules/o1js/dist/node/lib/provable/field.js").Field) => import("node_modules/o1js/dist/node/lib/provable/field.js").Field);
-            setBaseURL: typeof import("node_modules/o1js/dist/node/lib/provable/field.js").Field & ((x: string | number | bigint | import("node_modules/o1js/dist/node/lib/provable/core/fieldvar.js").FieldConst | import("node_modules/o1js/dist/node/lib/provable/core/fieldvar.js").FieldVar | import("node_modules/o1js/dist/node/lib/provable/field.js").Field) => import("node_modules/o1js/dist/node/lib/provable/field.js").Field);
-            setRoyaltyFee: typeof UInt32;
-            setTransferFee: typeof UInt64;
-            setAdmin: typeof PublicKey;
+            ownershipTransfer: typeof OwnershipChangeEvent;
+            ownershipAccepted: typeof OwnershipChangeEvent;
+            setName: typeof SetNameEvent;
+            setBaseURL: typeof SetBaseURLEvent;
+            setRoyaltyFee: typeof SetRoyaltyFeeEvent;
+            setTransferFee: typeof SetTransferFeeEvent;
+            setAdmin: typeof SetAdminEvent;
         };
         /**
          * Overrides the approveBase method to prevent transfers of tokens.
@@ -147,7 +151,7 @@ declare function CollectionFactory(params: {
          *
          * @returns The packed data of the collection.
          */
-        ensureNotPaused(): Promise<void>;
+        ensureNotPaused(): Promise<CollectionData>;
         /**
          * Mints a new NFT directly by the creator.
          *
@@ -208,8 +212,8 @@ declare function CollectionFactory(params: {
         /**
          * Transfers ownership of an NFT without admin approval.
          *
-         * @param address - The address of the NFT.
-         * @param to - The recipient's public key.
+         * @param nftAddress - The address of the NFT.
+         * @param approved - The approved public key.
          */
         approveAddressByProof(nftAddress: PublicKey, approved: PublicKey): Promise<void>;
         /**
@@ -221,7 +225,7 @@ declare function CollectionFactory(params: {
          * @param to - The recipient's public key.
          * @param price - The price of the NFT (optional).
          */
-        transferBySignature(params: TransferParams): Promise<void>;
+        transferBySignature(params: TransferBySignatureParams): Promise<void>;
         /**
          * Transfers ownership of an NFT using a proof in case the owner is a contract
          * Can be called by the owner or approved that should be a contracts
@@ -229,7 +233,7 @@ declare function CollectionFactory(params: {
          *
          * @param params - The transfer parameters.
          */
-        transferByProof(params: TransferParams): Promise<void>;
+        transferByProof(params: TransferByProofParams): Promise<void>;
         /**
          * Transfers ownership of an NFT using a proof in case the owner is a contract
          * Can be called by the owner or approved that should be a contracts
@@ -237,7 +241,7 @@ declare function CollectionFactory(params: {
          *
          * @param params - The transfer parameters.
          */
-        approvedTransferByProof(params: TransferParams): Promise<void>;
+        adminApprovedTransferByProof(params: TransferByProofParams): Promise<void>;
         /**
          * Transfers ownership of an NFT with admin approval.
          *
@@ -245,13 +249,21 @@ declare function CollectionFactory(params: {
          * @param to - The recipient's public key.
          * @param price - The price of the NFT (optional).
          */
-        approvedTransferBySignature(params: TransferParams): Promise<void>;
+        adminApprovedTransferBySignature(params: TransferBySignatureParams): Promise<void>;
         /**
          * Internal method to transfer an NFT.
          *
-         * @param address - The address of the NFT.
-         * @param to - The recipient's public key.
+         * This method handles the transfer logic and fee calculation. The fee is determined as follows:
+         * - If a price is provided, the fee is calculated as (price * royaltyFee / MAX_ROYALTY_FEE)
+         * - If no price is provided, the fixed transferFee is used to handle two cases:
+         *  when NFT is being sold and the price is not provided to the contract
+         *  when NFT is being transferred by the owner (without price)
+         * - If the sender is the creator, no fee is charged
+         * - The minimum fee is always the transferFee (unless sender is creator)
+         *
+         * @param transferEventDraft - The transfer event draft, containing the information about the transfer
          * @param transferFee - The transfer fee amount.
+         * @param royaltyFee - The royalty fee amount.
          * @returns The TransferEvent emitted.
          */
         _transfer(params: {
@@ -361,27 +373,36 @@ declare function CollectionFactory(params: {
          * @throws {Error} If caller lacks permission to change transfer fee
          */
         setTransferFee(transferFee: UInt64): Promise<void>;
+        /**
+         * Transfers ownership of the collection to a new creator.
+         * This method is called transferOwnership as the Collection is implementing OwnableContract interface
+         * For the Collection, the creator is the owner of the collection
+         *
+         * @param to - The public key of the new creator.
+         * @returns The public key of the old creator.
+         */
+        transferOwnership(to: PublicKey): Promise<PublicKey>;
         /**
          * Transfers ownership of the collection to a new owner.
          *
          * @param to - The public key of the new owner.
          * @returns The public key of the old owner.
          */
-        transferOwnership(to: PublicKey): Promise<PublicKey>;
+        acceptOwnership(): Promise<PublicKey>;
         getNFTState(address: PublicKey): Promise<NFTStateStruct>;
         deriveTokenId(): import("node_modules/o1js/dist/node/lib/provable/field.js").Field;
         readonly internal: {
             mint({ address, amount, }: {
-                address: PublicKey | AccountUpdate | SmartContract;
+                address: PublicKey | AccountUpdate | import("o1js").SmartContract;
                 amount: number | bigint | UInt64;
             }): AccountUpdate;
             burn({ address, amount, }: {
-                address: PublicKey | AccountUpdate | SmartContract;
+                address: PublicKey | AccountUpdate | import("o1js").SmartContract;
                 amount: number | bigint | UInt64;
             }): AccountUpdate;
             send({ from, to, amount, }: {
-                from: PublicKey | AccountUpdate | SmartContract;
-                to: PublicKey | AccountUpdate | SmartContract;
+                from: PublicKey | AccountUpdate | import("o1js").SmartContract;
+                to: PublicKey | AccountUpdate | import("o1js").SmartContract;
                 amount: number | bigint | UInt64;
             }): AccountUpdate;
         };
@@ -399,7 +420,7 @@ declare function CollectionFactory(params: {
         readonly self: AccountUpdate;
         newSelf(methodName?: string): AccountUpdate;
         sender: {
-            self: SmartContract;
+            self: import("o1js").SmartContract;
             getUnconstrained(): PublicKey;
             getAndRequireSignature(): PublicKey;
         };
@@ -408,15 +429,15 @@ declare function CollectionFactory(params: {
         readonly currentSlot: import("node_modules/o1js/dist/node/lib/mina/v1/precondition.js").CurrentSlot;
         approve(update: AccountUpdate | import("o1js").AccountUpdateTree | AccountUpdateForest): void;
         send(args: {
-            to: PublicKey | AccountUpdate | SmartContract;
+            to: PublicKey | AccountUpdate | import("o1js").SmartContract;
             amount: number | bigint | UInt64;
         }): AccountUpdate;
         readonly balance: {
             addInPlace(x: string | number | bigint | UInt64 | UInt32 | import("o1js").Int64): void;
             subInPlace(x: string | number | bigint | UInt64 | UInt32 | import("o1js").Int64): void;
         };
-        emitEventIf<K extends "update" | "approve" | "transfer" | "upgradeVerificationKey" | "pause" | "resume" | "mint" | "upgradeNFTVerificationKey" | "limitMinting" | "pauseNFT" | "resumeNFT" | "ownershipChange" | "setName" | "setBaseURL" | "setRoyaltyFee" | "setTransferFee" | "setAdmin">(condition: Bool, type: K, event: any): void;
-        emitEvent<K extends "update" | "approve" | "transfer" | "upgradeVerificationKey" | "pause" | "resume" | "mint" | "upgradeNFTVerificationKey" | "limitMinting" | "pauseNFT" | "resumeNFT" | "ownershipChange" | "setName" | "setBaseURL" | "setRoyaltyFee" | "setTransferFee" | "setAdmin">(type: K, event: any): void;
+        emitEventIf<K extends "update" | "approve" | "transfer" | "upgradeVerificationKey" | "pause" | "resume" | "mint" | "upgradeNFTVerificationKey" | "limitMinting" | "pauseNFT" | "resumeNFT" | "ownershipTransfer" | "ownershipAccepted" | "setName" | "setBaseURL" | "setRoyaltyFee" | "setTransferFee" | "setAdmin">(condition: Bool, type: K, event: any): void;
+        emitEvent<K extends "update" | "approve" | "transfer" | "upgradeVerificationKey" | "pause" | "resume" | "mint" | "upgradeNFTVerificationKey" | "limitMinting" | "pauseNFT" | "resumeNFT" | "ownershipTransfer" | "ownershipAccepted" | "setName" | "setBaseURL" | "setRoyaltyFee" | "setTransferFee" | "setAdmin">(type: K, event: any): void;
         fetchEvents(start?: UInt32, end?: UInt32): Promise<{
             type: string;
             event: {
@@ -489,11 +510,7 @@ declare function CollectionFactory(params: {
                 packed?: [import("node_modules/o1js/dist/node/lib/provable/field.js").Field, number][] | undefined;
             };
             toJSON: (x: {
-                accountUpdate: import("node_modules/o1js/dist/node/lib/provable/field.js" /**
-                 * Deploys the NFT Collection Contract with the initial settings.
-                 *
-                 * @param props - Deployment properties including collection name, creator, admin, baseURL, symbol, and URL.
-                 */).Field;
+                accountUpdate: import("node_modules/o1js/dist/node/lib/provable/field.js").Field;
                 calls: import("node_modules/o1js/dist/node/lib/provable/field.js").Field;
             }) => {
                 accountUpdate: string;
@@ -512,7 +529,7 @@ declare function CollectionFactory(params: {
             };
         };
         publicOutputType: import("node_modules/o1js/dist/node/lib/provable/types/struct.js").ProvablePureExtended<undefined, undefined, null>;
-        tag: () => typeof SmartContract;
+        tag: () => typeof import("o1js").SmartContract;
         fromJSON<S extends import("node_modules/o1js/dist/node/lib/util/types.js").Subclass<typeof import("o1js").Proof>>(this: S, { maxProofsVerified, proof: proofString, publicInput: publicInputJson, publicOutput: publicOutputJson, }: import("o1js").JsonProof): Promise<import("o1js").Proof<import("o1js").InferProvable<S["publicInputType"]>, import("o1js").InferProvable<S["publicOutputType"]>>>;
         dummy<Input, OutPut>(publicInput: Input, publicOutput: OutPut, maxProofsVerified: 0 | 2 | 1, domainLog2?: number): Promise<import("o1js").Proof<Input, OutPut>>;
         readonly provable: {