@silvana-one/nft 0.1.0

package/dist/node/index.d.ts

@@ -0,0 +1,8 @@
+export * from "./admin/index.js";
+export * from "./contracts/index.js";
+export * from "./metadata/index.js";
+export * from "./zkprogram-example/index.js";
+export * from "./marketplace/index.js";
+export * from "./vk.js";
+export * from "./contracts.js";
+export * from "./interfaces/index.js";

package/dist/node/index.js

@@ -0,0 +1,9 @@
+export * from "./admin/index.js";
+export * from "./contracts/index.js";
+export * from "./metadata/index.js";
+export * from "./zkprogram-example/index.js";
+export * from "./marketplace/index.js";
+export * from "./vk.js";
+export * from "./contracts.js";
+export * from "./interfaces/index.js";
+//# sourceMappingURL=index.js.map

package/dist/node/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC;AACjC,cAAc,sBAAsB,CAAC;AACrC,cAAc,qBAAqB,CAAC;AACpC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,wBAAwB,CAAC;AACvC,cAAc,SAAS,CAAC;AACxB,cAAc,gBAAgB,CAAC;AAC/B,cAAc,uBAAuB,CAAC"}

package/dist/node/interfaces/admin.d.ts

@@ -0,0 +1,102 @@
+import { Bool, PublicKey, SmartContract, VerificationKey, Field, UInt32, UInt64 } from "o1js";
+import { MintParamsOption, MintRequest, NFTState } from "./types.js";
+import { TransferEvent } from "./events.js";
+export { NFTAdminBase, NFTAdminContractConstructor };
+/**
+ * The `NFTAdminBase` interface defines the administrative functionalities required for managing an NFT collection on the Mina Protocol.
+ * It extends the `SmartContract` class and specifies methods that enforce permissions and validations for various NFT operations.
+ */
+type NFTAdminBase = SmartContract & {
+    /**
+     * Validates whether a new NFT can be minted based on the provided `MintRequest`.
+     *
+     * @param nft - The mint request containing details of the NFT to be minted.
+     * @returns A `Promise` resolving to `MintParamsOption`, containing mint parameters if minting is allowed, or an empty option if not.
+     */
+    canMint(nft: MintRequest): Promise<MintParamsOption>;
+    /**
+     * Checks if an NFT can be updated from its current state (`input`) to a new state (`output`).
+     *
+     * @param input - The current state of the NFT.
+     * @param output - The desired new state of the NFT.
+     * @returns A `Promise` resolving to a `Bool` indicating whether the update is permitted.
+     */
+    canUpdate(input: NFTState, output: NFTState): Promise<Bool>;
+    /**
+     * Determines if an NFT can be transferred from one owner (`from`) to another (`to`) for a specific NFT contract address.
+     *
+     * @param transferEvent - The transfer event containing details of the transfer.
+     * @returns A `Promise` resolving to a `Bool` indicating whether the transfer is allowed.
+     */
+    canTransfer(transferEvent: TransferEvent): Promise<Bool>;
+    /**
+     * Determines if the name can be changed for a Collection.
+     *
+     * @param name - The new name for the Collection.
+     * @returns A `Promise` resolving to a `Bool` indicating whether the name change is allowed.
+     */
+    canChangeName(name: Field): Promise<Bool>;
+    /**
+     * Determines if the creator can be changed for a Collection.
+     *
+     * @param creator - The new creator for the Collection.
+     * @returns A `Promise` resolving to a `Bool` indicating whether the creator change is allowed.
+     */
+    canChangeCreator(creator: PublicKey): Promise<Bool>;
+    /**
+     * Determines if the base URI can be changed for a Collection.
+     *
+     * @param baseUri - The new base URI for the Collection.
+     * @returns A `Promise` resolving to a `Bool` indicating whether the base URI change is allowed.
+     */
+    canChangeBaseUri(baseUri: Field): Promise<Bool>;
+    /**
+     * Determines if the royalty fee can be changed for a Collection.
+     *
+     * @param royaltyFee - The new royalty fee for the Collection.
+     * @returns A `Promise` resolving to a `Bool` indicating whether the royalty fee change is allowed.
+     */
+    canChangeRoyalty(royaltyFee: UInt32): Promise<Bool>;
+    /**
+     * Determines if the transfer fee can be changed for a Collection.
+     *
+     * @param transferFee - The new transfer fee for the Collection.
+     * @returns A `Promise` resolving to a `Bool` indicating whether the transfer fee change is allowed.
+     */
+    canChangeTransferFee(transferFee: UInt64): Promise<Bool>;
+    /**
+     * Determines if the admin contract can be changed for a Collection.
+     *
+     * @param admin - The new admin for the Collection.
+     * @returns A `Promise` resolving to a `Bool` indicating whether the admin contract change is allowed.
+     */
+    canSetAdmin(admin: PublicKey): Promise<Bool>;
+    /**
+     * Determines if the collection can be paused.
+     *
+     * @returns A `Promise` resolving to a `Bool` indicating whether the collection can be paused.
+     */
+    canPause(): Promise<Bool>;
+    /**
+     * Determines if the collection can be resumed.
+     *
+     * @returns A `Promise` resolving to a `Bool` indicating whether the collection can be resumed.
+     */
+    canResume(): Promise<Bool>;
+    /**
+     * Determines if the verification key can be changed for a specific NFT contract address and token ID.
+     *
+     * @param vk - The verification key to be changed.
+     * @param address - The public key of the NFT contract address or CollectionContract address.
+     * @param tokenId - The token ID of the NFT.
+     * @returns A `Promise` resolving to a `Bool` indicating whether the verification key change is allowed.
+     */
+    canChangeVerificationKey(vk: VerificationKey, address: PublicKey, tokenId: Field): Promise<Bool>;
+};
+/**
+ * Defines a constructor for contracts implementing `NFTAdminBase`, accepting an `address` public key and returning an instance of `NFTAdminBase`.
+ *
+ * @param address - The contract's address.
+ * @returns An instance of `NFTAdminBase`.
+ */
+type NFTAdminContractConstructor = new (address: PublicKey) => NFTAdminBase;

package/dist/node/interfaces/admin.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=admin.js.map

package/dist/node/interfaces/admin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"admin.js","sourceRoot":"","sources":["../../../src/interfaces/admin.ts"],"names":[],"mappings":""}

package/dist/node/interfaces/approval.d.ts

@@ -0,0 +1,57 @@
+import { AccountUpdate, Bool, PublicKey, SmartContract, State, DeployArgs } from "o1js";
+import { NFTCollectionContractConstructor } from "./collection.js";
+import { TransferExtendedParams } from "./types.js";
+export { NFTApprovalBase, NFTApprovalContractConstructor, NFTStandardApproval, NFTApprovalDeployProps, DefineApprovalFactory, };
+type DefineApprovalFactory = (params: {
+    collectionContract: () => NFTCollectionContractConstructor;
+}) => NFTApprovalContractConstructor;
+/**
+ * The `NFTApprovalBase` interface defines the administrative functionalities required for managing an NFT transfer approval on the Mina Protocol.
+ */
+type NFTApprovalBase = SmartContract & {
+    /**
+     * Determines if an NFT can be transferred from one owner (`from`) to another (`to`) for a specific NFT contract address.
+     *
+     * @param params - The transfer details.
+     * @returns A `Promise` resolving to a `Bool` indicating whether the transfer is allowed.
+     */
+    canTransfer(params: TransferExtendedParams): Promise<Bool>;
+};
+/**
+ * Defines a constructor for contracts implementing `NFTApprovalBase`, accepting an `address` public key and returning an instance of `NFTApprovalBase`.
+ *
+ * @param address - The public key of the contract's owner.
+ * @returns An instance of `NFTApprovalBase`.
+ */
+type NFTApprovalContractConstructor = new (address: PublicKey) => NFTApprovalBase;
+interface NFTApprovalDeployProps extends Exclude<DeployArgs, undefined> {
+    admin: PublicKey;
+    uri: string;
+}
+/**
+ * The **NFTStandardApproval** contract is the default implementation of the `NFTApprovalBase` interface.
+ */
+declare class NFTStandardApproval extends SmartContract implements NFTApprovalBase {
+    /**
+     * The public key of the contract's administrator.
+     * This account has the authority to perform administrative actions such as pausing the contract or upgrading the verification key.
+     */
+    admin: State<PublicKey>;
+    /**
+     * Deploys the contract with initial settings.
+     * @param props - Deployment properties including admin, upgradeAuthority, uri, canPause, and isPaused.
+     */
+    deploy(props: NFTApprovalDeployProps): Promise<void>;
+    /**
+     * Ensures that the transaction is authorized by the contract owner.
+     * @returns A signed `AccountUpdate` from the admin.
+     */
+    ensureOwnerSignature(): Promise<AccountUpdate>;
+    /**
+     * Determines if an NFT can be transferred.
+     *
+     * @param params - The transfer details.
+     * @returns A `Promise` resolving to a `Bool` indicating whether the transfer is allowed.
+     */
+    canTransfer(params: TransferExtendedParams): Promise<Bool>;
+}

package/dist/node/interfaces/approval.js

@@ -0,0 +1,62 @@
+import { __decorate, __metadata } from "tslib";
+import { AccountUpdate, Bool, method, PublicKey, SmartContract, state, State, Permissions, } from "o1js";
+import { TransferExtendedParams } from "./types.js";
+export { NFTStandardApproval, };
+/**
+ * The **NFTStandardApproval** contract is the default implementation of the `NFTApprovalBase` interface.
+ */
+class NFTStandardApproval extends SmartContract {
+    constructor() {
+        super(...arguments);
+        /**
+         * The public key of the contract's administrator.
+         * This account has the authority to perform administrative actions such as pausing the contract or upgrading the verification key.
+         */
+        this.admin = State();
+    }
+    /**
+     * Deploys the contract with initial settings.
+     * @param props - Deployment properties including admin, upgradeAuthority, uri, canPause, and isPaused.
+     */
+    async deploy(props) {
+        await super.deploy(props);
+        this.admin.set(props.admin);
+        this.account.zkappUri.set(props.uri);
+        this.account.permissions.set({
+            ...Permissions.default(),
+            setVerificationKey: Permissions.VerificationKey.signature(),
+            setPermissions: Permissions.impossible(),
+        });
+    }
+    /**
+     * Ensures that the transaction is authorized by the contract owner.
+     * @returns A signed `AccountUpdate` from the admin.
+     */
+    async ensureOwnerSignature() {
+        const admin = this.admin.getAndRequireEquals();
+        const adminUpdate = AccountUpdate.createSigned(admin);
+        adminUpdate.body.useFullCommitment = Bool(true); // Prevent memo and fee change
+        return adminUpdate;
+    }
+    /**
+     * Determines if an NFT can be transferred.
+     *
+     * @param params - The transfer details.
+     * @returns A `Promise` resolving to a `Bool` indicating whether the transfer is allowed.
+     */
+    async canTransfer(params) {
+        await this.ensureOwnerSignature();
+        return Bool(true);
+    }
+}
+__decorate([
+    state(PublicKey),
+    __metadata("design:type", Object)
+], NFTStandardApproval.prototype, "admin", void 0);
+__decorate([
+    method.returns(Bool),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [TransferExtendedParams]),
+    __metadata("design:returntype", Promise)
+], NFTStandardApproval.prototype, "canTransfer", null);
+//# sourceMappingURL=approval.js.map

package/dist/node/interfaces/approval.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"approval.js","sourceRoot":"","sources":["../../../src/interfaces/approval.ts"],"names":[],"mappings":";AAAA,OAAO,EACL,aAAa,EACb,IAAI,EACJ,MAAM,EACN,SAAS,EACT,aAAa,EACb,KAAK,EACL,KAAK,EACL,WAAW,GAEZ,MAAM,MAAM,CAAC;AAEd,OAAO,EAAE,sBAAsB,EAAE,MAAM,YAAY,CAAC;AACpD,OAAO,EAGL,mBAAmB,GAGpB,CAAC;AAiCF;;GAEG;AACH,MAAM,mBAAoB,SAAQ,aAAa;IAA/C;;QACE;;;WAGG;QACe,UAAK,GAAG,KAAK,EAAa,CAAC;IAsC/C,CAAC;IApCC;;;OAGG;IACH,KAAK,CAAC,MAAM,CAAC,KAA6B;QACxC,MAAM,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAC1B,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAC5B,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACrC,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,GAAG,CAAC;YAC3B,GAAG,WAAW,CAAC,OAAO,EAAE;YACxB,kBAAkB,EAAE,WAAW,CAAC,eAAe,CAAC,SAAS,EAAE;YAC3D,cAAc,EAAE,WAAW,CAAC,UAAU,EAAE;SACzC,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,oBAAoB;QACxB,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,mBAAmB,EAAE,CAAC;QAC/C,MAAM,WAAW,GAAG,aAAa,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;QACtD,WAAW,CAAC,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,8BAA8B;QAC/E,OAAO,WAAW,CAAC;IACrB,CAAC;IACD;;;;;OAKG;IAEG,AAAN,KAAK,CAAC,WAAW,CAAC,MAA8B;QAC9C,MAAM,IAAI,CAAC,oBAAoB,EAAE,CAAC;QAClC,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC;IACpB,CAAC;CACF;AAtCmB;IAAjB,KAAK,CAAC,SAAS,CAAC;;kDAA4B;AAkCvC;IADL,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC;;qCACK,sBAAsB;;sDAG/C"}

package/dist/node/interfaces/collection.d.ts

@@ -0,0 +1,57 @@
+import { PublicKey, TokenContract } from "o1js";
+import { TransferParams, NFTStateStruct } from "./types.js";
+import { NFTOwnerContractConstructor } from "./owner.js";
+import { NFTApprovalContractConstructor } from "./approval.js";
+import { NFTUpdateContractConstructor } from "./update.js";
+import { NFTAdminContractConstructor } from "./admin.js";
+export { NFTCollectionBase, NFTCollectionContractConstructor, DefineCollectionFactory, };
+/**
+ * The `NFTCollectionBase` interface defines the functionalities required for managing an NFT collection on the Mina Protocol.
+ * It extends the `SmartContract` class and specifies methods that enforce permissions and validations for various NFT operations.
+ */
+type NFTCollectionBase = TokenContract & {
+    /**
+     * Transfers ownership of an NFT from contract without admin approval using a proof.
+     *
+     * @param params - The transfer details.
+     */
+    transferByProof(params: TransferParams): Promise<void>;
+    /**
+     * Transfers ownership of an NFT from contract without admin approval.
+     *
+     * @param params - The transfer details.
+     */
+    transferBySignature(params: TransferParams): Promise<void>;
+    /**
+     * Transfers ownership of an NFT from contract without admin approval using a proof.
+     *
+     * @param params - The transfer details.
+     */
+    approvedTransferByProof(params: TransferParams): Promise<void>;
+    /**
+     * Transfers ownership of an NFT from contract without admin approval.
+     *
+     * @param params - The transfer details.
+     */
+    approvedTransferBySignature(params: TransferParams): Promise<void>;
+    /**
+     * Returns the state of an NFT.
+     *
+     * @param address - The address of the NFT.
+     * @returns The state of the NFT.
+     */
+    getNFTState(address: PublicKey): Promise<NFTStateStruct>;
+};
+/**
+ * Defines a constructor for contracts implementing `NFTCollectionBase`, accepting an `address` public key and returning an instance of `NFTCollectionBase`.
+ *
+ * @param address - The contract's address.
+ * @returns An instance of `NFTCollectionBase`.
+ */
+type NFTCollectionContractConstructor = new (address: PublicKey) => NFTCollectionBase;
+type DefineCollectionFactory = (params: {
+    adminContract: () => NFTAdminContractConstructor;
+    ownerContract: () => NFTOwnerContractConstructor;
+    approvalContract: () => NFTApprovalContractConstructor;
+    updateContract: () => NFTUpdateContractConstructor;
+}) => NFTCollectionContractConstructor;

package/dist/node/interfaces/collection.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=collection.js.map

package/dist/node/interfaces/collection.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"collection.js","sourceRoot":"","sources":["../../../src/interfaces/collection.ts"],"names":[],"mappings":""}

package/dist/node/interfaces/encoding.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Utilities for encoding and decoding `Field` elements to and from strings.
+ * These functions are used throughout the NFT standard for handling off-chain storage references and metadata.
+ */
+import { Field } from "o1js";
+export { fieldToString, fieldFromString };
+/**
+ * Converts a `Field` element to a string representation.
+ * This is used for serializing `Field` values into strings suitable for storage or transmission.
+ *
+ * @param {Field} field - The `Field` element to convert.
+ * @returns {string} The string representation of the `Field`.
+ */
+declare function fieldToString(field: Field): string;
+/**
+ * Reconstructs a `Field` element from its string representation.
+ * This function is essential for deserializing strings back into `Field` elements,
+ * which can then be used within the smart contract logic.
+ *
+ * @param {string} storage - The string representation of the `Field`.
+ * @returns {Field} The reconstructed `Field` element.
+ * @throws Will throw an error if the input string does not correspond to exactly one `Field`.
+ */
+declare function fieldFromString(storage: string): Field;

package/dist/node/interfaces/encoding.js

@@ -0,0 +1,32 @@
+/**
+ * Utilities for encoding and decoding `Field` elements to and from strings.
+ * These functions are used throughout the NFT standard for handling off-chain storage references and metadata.
+ */
+import { Encoding } from "o1js";
+export { fieldToString, fieldFromString };
+/**
+ * Converts a `Field` element to a string representation.
+ * This is used for serializing `Field` values into strings suitable for storage or transmission.
+ *
+ * @param {Field} field - The `Field` element to convert.
+ * @returns {string} The string representation of the `Field`.
+ */
+function fieldToString(field) {
+    return Encoding.stringFromFields([field]);
+}
+/**
+ * Reconstructs a `Field` element from its string representation.
+ * This function is essential for deserializing strings back into `Field` elements,
+ * which can then be used within the smart contract logic.
+ *
+ * @param {string} storage - The string representation of the `Field`.
+ * @returns {Field} The reconstructed `Field` element.
+ * @throws Will throw an error if the input string does not correspond to exactly one `Field`.
+ */
+function fieldFromString(storage) {
+    const fields = Encoding.stringToFields(storage);
+    if (fields.length !== 1)
+        throw new Error("String is too long");
+    return fields[0];
+}
+//# sourceMappingURL=encoding.js.map

package/dist/node/interfaces/encoding.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"encoding.js","sourceRoot":"","sources":["../../../src/interfaces/encoding.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAE,QAAQ,EAAS,MAAM,MAAM,CAAC;AACvC,OAAO,EAAE,aAAa,EAAE,eAAe,EAAE,CAAC;AAE1C;;;;;;GAMG;AACH,SAAS,aAAa,CAAC,KAAY;IACjC,OAAO,QAAQ,CAAC,gBAAgB,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;AAC5C,CAAC;AAED;;;;;;;;GAQG;AACH,SAAS,eAAe,CAAC,OAAe;IACtC,MAAM,MAAM,GAAG,QAAQ,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;IAChD,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC;QAAE,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;IAC/D,OAAO,MAAM,CAAC,CAAC,CAAC,CAAC;AACnB,CAAC"}