@silvana-one/nft 0.2.3 → 0.2.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +46 -1
  2. package/package.json +9 -11
package/README.md CHANGED
@@ -12,14 +12,22 @@ https://devnet.minanft.io/
12
12
 
13
13
  ## API
14
14
 
15
- Docs: https://docs.minanft.io/
15
+ Docs:
16
+
17
+ https://docs.minanft.io/OpenAPI/launch-nft-collection
18
+
19
+ https://docs.minanft.io/api/nft
20
+
16
21
  Example: https://github.com/SilvanaOne/token-api-example/blob/main/tests/nft.test.ts
22
+
17
23
  API monitoring and keys: https://minatokens.com/api
18
24
 
19
25
  ## Contracts Code
20
26
 
21
27
  https://github.com/SilvanaOne/silvana-lib/tree/main/packages/nft
22
28
 
29
+ Coverage: https://docs.minanft.io/coverage/
30
+
23
31
  ### NFT Standard Contracts
24
32
 
25
33
  Main contracts: packages/nft/src/contracts/
@@ -56,6 +64,43 @@ Tests are available at packages/nft/test
56
64
 
57
65
  See [TESTS.md](TESTS.md) for more information how to run tests
58
66
 
67
+ ### Number of Constraints
68
+
69
+ 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.
70
+
71
+ Below is a summary of the constraints used by each key contract in the MinaNFT standard:
72
+
73
+ | **Contract** | **Constraints (rows)** | **Percentage of Max Constraints** |
74
+ | ----------------- | ---------------------- | --------------------------------- |
75
+ | Collection | 40,789 | 62.24% |
76
+ | NFT | 4,807 | 7.33% |
77
+ | Offer | 1,996 | 3.05% |
78
+ | Bid | 8,978 | 13.70% |
79
+ | Standard Admin | 8,607 | 13.13% |
80
+ | Advanced Admin | 16,032 | 24.46% |
81
+ | Upgrade Authority | 3,117 | 4.76% |
82
+ | NFTProgram | 1,833 | 2.80% |
83
+
84
+ ### Test Coverage
85
+
86
+ ```sh
87
+ npm run nft:coverage
88
+ ```
89
+
90
+ The test statements coverage is summarized below:
91
+
92
+ | **Contract** | **Test Statements Coverage** |
93
+ | -------------- | ---------------------------- |
94
+ | NFT | 100% |
95
+ | Collection | 99.65% |
96
+ | Standard Admin | 100% |
97
+ | Advanced Admin | 98.33% |
98
+ | Auction | 100% |
99
+ | Offer | 100% |
100
+ | Bid | 98.97% |
101
+
102
+ Details are available at https://docs.minanft.io/coverage/
103
+
59
104
  ## Project Background
60
105
 
61
106
  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 CHANGED
@@ -1,17 +1,17 @@
1
1
  {
2
2
  "name": "@silvana-one/nft",
3
3
  "description": "Mina NFT library",
4
- "version": "0.2.3",
4
+ "version": "0.2.4",
5
5
  "author": "DFST",
6
6
  "bugs": "https://github.com/SilvanaOne/silvana-lib/issues",
7
7
  "dependencies": {
8
8
  "tslib": "^2.8.1"
9
9
  },
10
10
  "devDependencies": {
11
- "@silvana-one/mina-utils": "0.2.3",
12
- "@silvana-one/storage": "0.2.3",
13
- "@silvana-one/token": "0.2.3",
14
- "@silvana-one/upgradable": "0.2.3",
11
+ "@silvana-one/mina-utils": "0.2.4",
12
+ "@silvana-one/storage": "0.2.4",
13
+ "@silvana-one/token": "0.2.4",
14
+ "@silvana-one/upgradable": "0.2.4",
15
15
  "@types/node": "^22.13.8",
16
16
  "c8": "^10.1.3",
17
17
  "dotenv": "^16.4.7",
@@ -50,9 +50,9 @@
50
50
  "license": "Apache-2.0",
51
51
  "main": "dist/web/index.js",
52
52
  "peerDependencies": {
53
- "@silvana-one/storage": "0.2.3",
54
- "@silvana-one/token": "0.2.3",
55
- "@silvana-one/upgradable": "0.2.3",
53
+ "@silvana-one/storage": "0.2.4",
54
+ "@silvana-one/token": "0.2.4",
55
+ "@silvana-one/upgradable": "0.2.4",
56
56
  "o1js": "^2.2.0"
57
57
  },
58
58
  "publishConfig": {
@@ -66,9 +66,7 @@
66
66
  "coverage": "rm -rf coverage && node --max-old-space-size=8192 ../../node_modules/.bin/c8 --merge-async npm run local:all",
67
67
  "coverage:report": "node --max-old-space-size=8192 ../../node_modules/.bin/c8 report",
68
68
  "test": "NODE_NO_WARNINGS=1 node --loader=ts-node/esm --enable-source-maps -r dotenv/config --require dotenv/config --env-file=.env --test",
69
- "local:agent": "CHAIN=local CLOUD=local DEPLOY=true MINT=true TRANSFER=true SELL=true BUY=true npm run test test/agent.test.ts",
70
- "devnet:agent": "CHAIN=devnet DEPLOY=true MINT=true TRANSFER=true SELL=true BUY=true npm run test test/agent.test.ts",
71
- "local:contract": "CHAIN=local CLOUD=local ADVANCED=true npm run test test/contract.test.ts",
69
+ "local:contract": "CHAIN=local CLOUD=local ADVANCED=false npm run test test/contract.test.ts",
72
70
  "devnet:contract": "CHAIN=devnet CLOUD=local ADVANCED=false npm run test test/contract.test.ts",
73
71
  "lightnet:contract": "CHAIN=lightnet CLOUD=local ADVANCED=false npm run test test/contract.test.ts",
74
72
  "zeko:contract": "CHAIN=zeko CLOUD=local ADVANCED=false npm run test test/contract.test.ts",