@silvana-one/nft 0.2.2 → 0.2.4

package/README.md

@@ -2,8 +2,32 @@
 
 The MinaNFT project is an innovative Non-Fungible Token (NFT) platform that integrates the unique privacy features of the Mina blockchain. It is designed to redefine the NFT space by offering a range of functionalities that go beyond traditional NFT capabilities.
 
+## Documentation
+
+https://docs.minanft.io/
+
+## Frontend
+
+https://devnet.minanft.io/
+
+## API
+
+Docs:
+
+https://docs.minanft.io/OpenAPI/launch-nft-collection
+
+https://docs.minanft.io/api/nft
+
+Example: https://github.com/SilvanaOne/token-api-example/blob/main/tests/nft.test.ts
+
+API monitoring and keys: https://minatokens.com/api
+
 ## Contracts Code
 
+https://github.com/SilvanaOne/silvana-lib/tree/main/packages/nft
+
+Coverage: https://docs.minanft.io/coverage/
+
 ### NFT Standard Contracts
 
 Main contracts: packages/nft/src/contracts/
@@ -40,6 +64,43 @@ Tests are available at packages/nft/test
 
 See [TESTS.md](TESTS.md) for more information how to run tests
 
+### Number of Constraints
+
+The Mina blockchain imposes a maximum constraint limit of 65,536 rows for zk-SNARK proofs generated by smart contracts. It is essential to be aware of the number of constraints used by each contract to ensure they are within acceptable limits and to optimize performance.
+
+Below is a summary of the constraints used by each key contract in the MinaNFT standard:
+
+| **Contract**      | **Constraints (rows)** | **Percentage of Max Constraints** |
+| ----------------- | ---------------------- | --------------------------------- |
+| Collection        | 40,789                 | 62.24%                            |
+| NFT               | 4,807                  | 7.33%                             |
+| Offer             | 1,996                  | 3.05%                             |
+| Bid               | 8,978                  | 13.70%                            |
+| Standard Admin    | 8,607                  | 13.13%                            |
+| Advanced Admin    | 16,032                 | 24.46%                            |
+| Upgrade Authority | 3,117                  | 4.76%                             |
+| NFTProgram        | 1,833                  | 2.80%                             |
+
+### Test Coverage
+
+```sh
+npm run nft:coverage
+```
+
+The test statements coverage is summarized below:
+
+| **Contract**   | **Test Statements Coverage** |
+| -------------- | ---------------------------- |
+| NFT            | 100%                         |
+| Collection     | 99.65%                       |
+| Standard Admin | 100%                         |
+| Advanced Admin | 98.33%                       |
+| Auction        | 100%                         |
+| Offer          | 100%                         |
+| Bid            | 98.97%                       |
+
+Details are available at https://docs.minanft.io/coverage/
+
 ## Project Background
 
 Non-Fungible Tokens (NFTs) have become a pivotal aspect of digital ownership, allowing creators, individuals, and corporations to represent unique digital assets on the blockchain. However, current NFT standards, like ERC721, lack essential privacy, verifiability, and versatile content integration features. The NFT standard on Mina seeks to overcome these limitations by introducing enhanced functionality such as privacy features, verifiable proofs for both public and private data, unlocking new use cases for NFTs in the realms of digital identity, secure document sharing, and multimedia content.

package/package.json

@@ -1,17 +1,17 @@
 {
   "name": "@silvana-one/nft",
   "description": "Mina NFT library",
-  "version": "0.2.2",
+  "version": "0.2.4",
   "author": "DFST",
   "bugs": "https://github.com/SilvanaOne/silvana-lib/issues",
   "dependencies": {
     "tslib": "^2.8.1"
   },
   "devDependencies": {
-    "@silvana-one/mina-utils": "0.2.2",
-    "@silvana-one/storage": "0.2.2",
-    "@silvana-one/token": "0.2.2",
-    "@silvana-one/upgradable": "0.2.2",
+    "@silvana-one/mina-utils": "0.2.4",
+    "@silvana-one/storage": "0.2.4",
+    "@silvana-one/token": "0.2.4",
+    "@silvana-one/upgradable": "0.2.4",
     "@types/node": "^22.13.8",
     "c8": "^10.1.3",
     "dotenv": "^16.4.7",
@@ -50,9 +50,9 @@
   "license": "Apache-2.0",
   "main": "dist/web/index.js",
   "peerDependencies": {
-    "@silvana-one/storage": "0.2.2",
-    "@silvana-one/token": "0.2.2",
-    "@silvana-one/upgradable": "0.2.2",
+    "@silvana-one/storage": "0.2.4",
+    "@silvana-one/token": "0.2.4",
+    "@silvana-one/upgradable": "0.2.4",
     "o1js": "^2.2.0"
   },
   "publishConfig": {
@@ -63,10 +63,9 @@
     "build": "rm -rf dist && tsc --build tsconfig.node.json && tsc --build tsconfig.web.json && node build-cjs.js",
     "login": "npm login",
     "release": "npm publish --access public",
-    "coverage": "rm -rf coverage && c8 npm run local:all && rm -rf coverage/tmp",
+    "coverage": "rm -rf coverage && node --max-old-space-size=8192 ../../node_modules/.bin/c8 --merge-async npm run local:all",
+    "coverage:report": "node --max-old-space-size=8192 ../../node_modules/.bin/c8 report",
     "test": "NODE_NO_WARNINGS=1 node --loader=ts-node/esm --enable-source-maps -r dotenv/config --require dotenv/config --env-file=.env --test",
-    "local:agent": "CHAIN=local CLOUD=local DEPLOY=true MINT=true TRANSFER=true SELL=true BUY=true npm run test test/agent.test.ts",
-    "devnet:agent": "CHAIN=devnet DEPLOY=true MINT=true TRANSFER=true SELL=true BUY=true npm run test test/agent.test.ts",
     "local:contract": "CHAIN=local CLOUD=local ADVANCED=false npm run test test/contract.test.ts",
     "devnet:contract": "CHAIN=devnet CLOUD=local ADVANCED=false npm run test test/contract.test.ts",
     "lightnet:contract": "CHAIN=lightnet CLOUD=local ADVANCED=false npm run test test/contract.test.ts",
@@ -114,9 +113,7 @@
       ".ts"
     ],
     "include": [
-      "src/**",
-      "../packages/upgradable/src/**",
-      "../packages/storage/src/**"
+      "src/**"
     ],
     "exclude": [
       "test/**",