@open-captable-protocol/canton 0.2.252 → 0.2.253

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 +19 -0
  2. package/package.json +2 -1
package/README.md CHANGED
@@ -96,6 +96,25 @@ This README is for SDK contributors and AI assistants. For end users/consumers,
96
96
  - Functions added to the relevant `index.ts` barrels and `OcpClient`
97
97
  - Add `buildXCommand` variant where batching is expected
98
98
 
99
+ ### LocalNet (cn-quickstart)
100
+
101
+ Local Canton Network for integration testing:
102
+
103
+ ```bash
104
+ npm run localnet:start # Start (fast path when artifacts exist)
105
+ npm run localnet:stop # Stop services
106
+ npm run localnet:status # Docker + endpoint status
107
+ npm run localnet:smoke # Endpoint smoke checks
108
+ npm run localnet:test # Run integration tests
109
+ npm run localnet:verify # Setup + start + smoke + test
110
+ ```
111
+
112
+ Environment toggles: `CANTON_LOCALNET_FAST_START` (default: true),
113
+ `CANTON_LOCALNET_FORCE_FULL_START` (default: false).
114
+
115
+ > **Note:** The orchestrator requires Linux with passwordless `sudo` and `apt-get` (designed for
116
+ > CI/cloud environments). For local development on macOS, use the cn-quickstart `Makefile` directly.
117
+
99
118
  ### OCF Schema Validation
100
119
 
101
120
  This SDK includes automated validation of all OCF data against the official
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@open-captable-protocol/canton",
3
- "version": "0.2.252",
3
+ "version": "0.2.253",
4
4
  "description": "A TypeScript SDK for interacting with the Open CapTable Protocol (OCP) Factory contract on Canton blockchain",
5
5
  "license": "MIT",
6
6
  "main": "dist/index.js",
@@ -26,6 +26,7 @@
26
26
  "localnet:start": "bash scripts/localnet/localnet-cloud.sh start",
27
27
  "localnet:status": "bash scripts/localnet/localnet-cloud.sh status",
28
28
  "localnet:stop": "bash scripts/localnet/localnet-cloud.sh stop",
29
+ "localnet:test": "bash scripts/localnet/localnet-cloud.sh test",
29
30
  "localnet:verify": "bash scripts/localnet/localnet-cloud.sh verify",
30
31
  "prepare-release": "ts-node scripts/prepare-release.ts",
31
32
  "script:authorize": "ts-node scripts/authorizeIssuer.ts",