@fairmint/canton-node-sdk 0.0.246 → 0.0.247
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 +43 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,5 +2,46 @@
|
|
|
2
2
|
|
|
3
3
|
Low-level TypeScript SDK for Canton Network nodes (Ledger JSON API, Validator API, Scan API).
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
|
|
5
|
+
## Developer documentation
|
|
6
|
+
|
|
7
|
+
The public [GitHub wiki](https://github.com/Fairmint/canton-node-sdk/wiki) is the canonical guide for
|
|
8
|
+
configuration, API boundaries, external signing, LocalNet, examples, and contribution. The public
|
|
9
|
+
[`src/index.ts`](https://github.com/Fairmint/canton-node-sdk/blob/main/src/index.ts) defines the
|
|
10
|
+
supported package surface; use the installed declarations and public
|
|
11
|
+
[`examples/`](https://github.com/Fairmint/canton-node-sdk/tree/main/examples) and
|
|
12
|
+
[`test/`](https://github.com/Fairmint/canton-node-sdk/tree/main/test) for exact methods, request
|
|
13
|
+
shapes, and error behavior.
|
|
14
|
+
|
|
15
|
+
## Install
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
npm install @fairmint/canton-node-sdk
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
```ts
|
|
22
|
+
import { Canton } from "@fairmint/canton-node-sdk";
|
|
23
|
+
|
|
24
|
+
async function main(): Promise<void> {
|
|
25
|
+
const canton = new Canton({ network: "localnet" });
|
|
26
|
+
const version = await canton.ledger.getVersion();
|
|
27
|
+
console.log(version);
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
main().catch((error: unknown) => {
|
|
31
|
+
console.error(error);
|
|
32
|
+
process.exitCode = 1;
|
|
33
|
+
});
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
## Repository setup and checks
|
|
37
|
+
|
|
38
|
+
```bash
|
|
39
|
+
git submodule update --init --depth 1 libs/splice
|
|
40
|
+
git submodule update --init --recursive libs/cn-quickstart
|
|
41
|
+
npm install
|
|
42
|
+
npm run fix
|
|
43
|
+
npm test
|
|
44
|
+
npm run build
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
Run `npm run localnet:verify` for the full LocalNet smoke and integration path.
|