neozip-blockchain 0.6.0 → 0.7.0
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.
- package/README.md +36 -6
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/dist/types/index.js +2 -2
- package/package.json +8 -8
package/README.md
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
# neozip-blockchain
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Blockchain functionality for NeoZip: **Zipstamp server timestamping** (stamp, upgrade, mint, verify), NFT minting, verification, and wallet management. Part of the [neozipkit monorepo](../../README.md).
|
|
4
4
|
|
|
5
5
|
> **Pre-1.0:** This package is under active development. The API may change before 1.0; use in production with caution.
|
|
6
6
|
|
|
7
|
-
This
|
|
7
|
+
This package provides the client-side API and utilities that work with the sibling **[neozipkit](../neozipkit/)** package for full NZIP (NeoZip) workflows. The **Zipstamp server** is a **separate application**; this library contains the **Zipstamp server API client and helpers** used to communicate with that server (submit digests, poll for confirmations, fetch proofs, etc.). Run the Zipstamp server separately when using timestamping features.
|
|
8
8
|
|
|
9
9
|
## Features
|
|
10
10
|
|
|
@@ -13,7 +13,7 @@ This repository provides the client-side API and utilities that work with the **
|
|
|
13
13
|
- **Token Verification**: Verify ZIP file authenticity against blockchain
|
|
14
14
|
- **Wallet Management**: Browser and Node.js wallet integrations
|
|
15
15
|
- **Multi-Network Support**: Base Mainnet, Base Sepolia, and more
|
|
16
|
-
- **Examples**: Runnable scripts for stamp, upgrade, mint, verify, and token-create flows (see `examples
|
|
16
|
+
- **Examples**: Runnable scripts for stamp, upgrade, mint, verify, and token-create flows (see [`examples/README.md`](examples/README.md), `examples/`, and `package.json` `example:*` scripts)
|
|
17
17
|
|
|
18
18
|
## Installation
|
|
19
19
|
|
|
@@ -134,7 +134,7 @@ Use the Zipstamp server to stamp a ZIP (submit digest), upgrade once the batch i
|
|
|
134
134
|
|
|
135
135
|
## Integration with neozipkit
|
|
136
136
|
|
|
137
|
-
|
|
137
|
+
Both packages live in the same [monorepo](../../README.md) and share a locked version number. Use **[neozipkit](../neozipkit/)** for ZIP creation, merkle roots, and file handling; use this package for blockchain timestamping, NFT minting, and verification. They work together for full NZIP workflows:
|
|
138
138
|
|
|
139
139
|
```typescript
|
|
140
140
|
import { ZipkitNode } from 'neozipkit/node';
|
|
@@ -174,14 +174,44 @@ The NZIP-NFT smart contracts are included in the `contracts/` directory:
|
|
|
174
174
|
|
|
175
175
|
MIT License - see [LICENSE](LICENSE) for details.
|
|
176
176
|
|
|
177
|
+
## Publishing (npm)
|
|
178
|
+
|
|
179
|
+
The npm tarball is intentionally minimal: compiled **`dist/`**, the **package root [`README.md`](README.md)**, and **[`LICENSE`](LICENSE)** only (`package.json` `"files"`). **`examples/`**, **`contracts/`**, and other repo docs are **not** on npm; use this repository for those.
|
|
180
|
+
|
|
181
|
+
Preview what will ship: run **`yarn publish:dry-run`** (it uses **`npm publish --dry-run`**, which matches npm’s file list). Avoid **`yarn npm publish --dry-run`** for previews—Yarn can print extra paths such as nested `README.md` files that are **not** in the published package.
|
|
182
|
+
|
|
183
|
+
## Development
|
|
184
|
+
|
|
185
|
+
This package is part of the [neozipkit monorepo](../../README.md). From the **repository root**:
|
|
186
|
+
|
|
187
|
+
```bash
|
|
188
|
+
yarn install
|
|
189
|
+
yarn build # builds neozipkit first, then neozip-blockchain
|
|
190
|
+
yarn test:unit
|
|
191
|
+
```
|
|
192
|
+
|
|
193
|
+
To work on this package alone:
|
|
194
|
+
|
|
195
|
+
```bash
|
|
196
|
+
cd packages/neozip-blockchain
|
|
197
|
+
yarn build
|
|
198
|
+
yarn test
|
|
199
|
+
```
|
|
200
|
+
|
|
201
|
+
See the [monorepo README](../../README.md) for version management and release workflow.
|
|
202
|
+
|
|
203
|
+
Smart contracts (Solidity, ABI, deployments): see [`contracts/README.md`](contracts/README.md) and [`contracts/docs/`](contracts/docs/).
|
|
204
|
+
|
|
177
205
|
## Contributing
|
|
178
206
|
|
|
179
207
|
Contributions are welcome! Please read our contributing guidelines before submitting PRs.
|
|
180
208
|
|
|
181
209
|
## Links
|
|
182
210
|
|
|
183
|
-
- [neozipkit
|
|
184
|
-
- [
|
|
211
|
+
- [neozipkit](../neozipkit/) — sibling ZIP processing package in this monorepo
|
|
212
|
+
- [neozipkit on npm](https://www.npmjs.com/package/neozipkit)
|
|
213
|
+
- [neozip-blockchain on npm](https://www.npmjs.com/package/neozip-blockchain)
|
|
214
|
+
- [GitHub repository](https://github.com/NeoWareInc/neozipkit)
|
|
185
215
|
- [Documentation](https://neozip.io/docs)
|
|
186
216
|
- [NeoWare](https://neoware.com)
|
|
187
217
|
|
package/dist/index.d.ts
CHANGED
|
@@ -11,5 +11,5 @@ export type { EnhancedVerificationResult, BatchVerificationResult, VerificationJ
|
|
|
11
11
|
export { Logger, configureLoggerFromEnvironment } from './utils/Logger';
|
|
12
12
|
export type { LogLevel, LoggerConfig } from './utils/Logger';
|
|
13
13
|
export * from './zipstamp-server';
|
|
14
|
-
export declare const VERSION = "0.
|
|
14
|
+
export declare const VERSION = "0.7.0";
|
|
15
15
|
//# sourceMappingURL=index.d.ts.map
|
package/dist/index.js
CHANGED
|
@@ -36,5 +36,5 @@ Object.defineProperty(exports, "configureLoggerFromEnvironment", { enumerable: t
|
|
|
36
36
|
// Export Zipstamp server API functionality
|
|
37
37
|
__exportStar(require("./zipstamp-server"), exports);
|
|
38
38
|
// Export package version (keep in sync with package.json version)
|
|
39
|
-
exports.VERSION = '0.
|
|
39
|
+
exports.VERSION = '0.7.0';
|
|
40
40
|
//# sourceMappingURL=index.js.map
|
package/dist/types/index.js
CHANGED
package/package.json
CHANGED
|
@@ -1,7 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "neozip-blockchain",
|
|
3
|
-
"version": "0.
|
|
4
|
-
"packageManager": "yarn@4.12.0",
|
|
3
|
+
"version": "0.7.0",
|
|
5
4
|
"description": "Blockchain functionality for NeoZip and companion to neozipkit — NFT minting, verification, wallet management, OpenTimestamps",
|
|
6
5
|
"main": "dist/index.js",
|
|
7
6
|
"types": "dist/index.d.ts",
|
|
@@ -48,11 +47,11 @@
|
|
|
48
47
|
"clean": "rm -rf dist",
|
|
49
48
|
"compile": "tsc",
|
|
50
49
|
"build": "npm run clean && npm run compile",
|
|
51
|
-
"prepublishOnly": "npm run build",
|
|
52
50
|
"watch": "tsc --watch",
|
|
53
51
|
"test": "jest",
|
|
54
52
|
"test:unit": "jest tests/unit",
|
|
55
53
|
"test:watch": "jest --watch",
|
|
54
|
+
"publish:dry-run": "npm publish --access public --dry-run",
|
|
56
55
|
"verify-email": "dotenv -e .env.local -e .env -- ts-node examples/verify-email.ts",
|
|
57
56
|
"example:token-direct": "dotenv -e .env.local -e .env -- ts-node examples/token-direct.ts",
|
|
58
57
|
"example:verify-token": "ts-node examples/verify-token.ts",
|
|
@@ -82,12 +81,13 @@
|
|
|
82
81
|
"author": "NeoWare, Inc.",
|
|
83
82
|
"repository": {
|
|
84
83
|
"type": "git",
|
|
85
|
-
"url": "git+https://github.com/NeoWareInc/
|
|
84
|
+
"url": "git+https://github.com/NeoWareInc/neozipkit.git",
|
|
85
|
+
"directory": "packages/neozip-blockchain"
|
|
86
86
|
},
|
|
87
87
|
"bugs": {
|
|
88
|
-
"url": "https://github.com/NeoWareInc/
|
|
88
|
+
"url": "https://github.com/NeoWareInc/neozipkit/issues"
|
|
89
89
|
},
|
|
90
|
-
"homepage": "https://github.com/NeoWareInc/neozip-blockchain#readme",
|
|
90
|
+
"homepage": "https://github.com/NeoWareInc/neozipkit/tree/main/packages/neozip-blockchain#readme",
|
|
91
91
|
"license": "MIT",
|
|
92
92
|
"devDependencies": {
|
|
93
93
|
"@types/jest": "^29.5.12",
|
|
@@ -103,11 +103,11 @@
|
|
|
103
103
|
"dependencies": {
|
|
104
104
|
"ethers": "^6.0.0",
|
|
105
105
|
"moment-timezone": "^0.6.0",
|
|
106
|
-
"neozipkit": "
|
|
106
|
+
"neozipkit": "workspace:*",
|
|
107
107
|
"opentimestamps": "^0.4.9"
|
|
108
108
|
},
|
|
109
109
|
"peerDependencies": {
|
|
110
|
-
"neozipkit": "^0.
|
|
110
|
+
"neozipkit": "^0.7.0"
|
|
111
111
|
},
|
|
112
112
|
"peerDependenciesMeta": {
|
|
113
113
|
"neozipkit": {
|