@fairmint/canton-node-sdk 0.0.245 → 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
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.
|
|
@@ -44,7 +44,7 @@ class ConsoleLogger {
|
|
|
44
44
|
const methodLabel = this.colorize(method, 'cyan');
|
|
45
45
|
const urlLabel = this.colorize(url, 'blue');
|
|
46
46
|
console.log(`${prefix} ${methodLabel} ${urlLabel}`);
|
|
47
|
-
if (sanitizedRequest && Object.keys(sanitizedRequest).length > 0) {
|
|
47
|
+
if (sanitizedRequest !== null && typeof sanitizedRequest === 'object' && Object.keys(sanitizedRequest).length > 0) {
|
|
48
48
|
console.log(`${this.colorize(' Request:', 'gray')} ${this.formatJson(sanitizedRequest)}`);
|
|
49
49
|
}
|
|
50
50
|
if (sanitizedResponse !== undefined) {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ConsoleLogger.js","sourceRoot":"","sources":["../../../../src/core/logging/ConsoleLogger.ts"],"names":[],"mappings":";;;AAAA,+BAA+B;AAC/B,qCAAoF;AAEpF,2CAA2C;AAC3C,MAAM,MAAM,GAAG;IACb,KAAK,EAAE,SAAS;IAChB,GAAG,EAAE,SAAS;IACd,GAAG,EAAE,UAAU;IACf,MAAM,EAAE,UAAU;IAClB,IAAI,EAAE,UAAU;IAChB,IAAI,EAAE,UAAU;IAChB,IAAI,EAAE,UAAU;CACR,CAAC;AAEX;;;;;;;;;;;GAWG;AACH;IAIE,YAAY,MAAM,GAAwC,EAAE;QAC1D,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,IAAI,OAAO,CAAC;QAC3C,+CAA+C;QAC/C,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,MAAM,IAAI,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IACrE,CAAC;IAED,4DAA4D;IACrD,KAAK,CAAC,kBAAkB,CAAC,GAAW,EAAE,OAAgB,EAAE,QAAiB;QAC9E,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC;YAC7B,OAAO;QACT,CAAC;QAED,MAAM,SAAS,GAAG,IAAI,CAAC,eAAe,EAAE,CAAC;QACzC,MAAM,MAAM,GAAG,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;QAC3C,MAAM,gBAAgB,GAAG,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;QAC1D,MAAM,iBAAiB,GAAG,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC;QAE5D,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,SAAS,GAAG,EAAE,KAAK,CAAC,CAAC;QACtD,MAAM,WAAW,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAClD,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;QAE5C,OAAO,CAAC,GAAG,CAAC,GAAG,MAAM,IAAI,WAAW,IAAI,QAAQ,EAAE,CAAC,CAAC;QAEpD,IAAI,gBAAgB,IAAI,MAAM,CAAC,IAAI,CAAC,
|
|
1
|
+
{"version":3,"file":"ConsoleLogger.js","sourceRoot":"","sources":["../../../../src/core/logging/ConsoleLogger.ts"],"names":[],"mappings":";;;AAAA,+BAA+B;AAC/B,qCAAoF;AAEpF,2CAA2C;AAC3C,MAAM,MAAM,GAAG;IACb,KAAK,EAAE,SAAS;IAChB,GAAG,EAAE,SAAS;IACd,GAAG,EAAE,UAAU;IACf,MAAM,EAAE,UAAU;IAClB,IAAI,EAAE,UAAU;IAChB,IAAI,EAAE,UAAU;IAChB,IAAI,EAAE,UAAU;CACR,CAAC;AAEX;;;;;;;;;;;GAWG;AACH;IAIE,YAAY,MAAM,GAAwC,EAAE;QAC1D,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,IAAI,OAAO,CAAC;QAC3C,+CAA+C;QAC/C,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,MAAM,IAAI,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IACrE,CAAC;IAED,4DAA4D;IACrD,KAAK,CAAC,kBAAkB,CAAC,GAAW,EAAE,OAAgB,EAAE,QAAiB;QAC9E,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC;YAC7B,OAAO;QACT,CAAC;QAED,MAAM,SAAS,GAAG,IAAI,CAAC,eAAe,EAAE,CAAC;QACzC,MAAM,MAAM,GAAG,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;QAC3C,MAAM,gBAAgB,GAAG,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;QAC1D,MAAM,iBAAiB,GAAG,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC;QAE5D,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,SAAS,GAAG,EAAE,KAAK,CAAC,CAAC;QACtD,MAAM,WAAW,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAClD,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;QAE5C,OAAO,CAAC,GAAG,CAAC,GAAG,MAAM,IAAI,WAAW,IAAI,QAAQ,EAAE,CAAC,CAAC;QAEpD,IAAI,gBAAgB,KAAK,IAAI,IAAI,OAAO,gBAAgB,KAAK,QAAQ,IAAI,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAClH,OAAO,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC;QAC7F,CAAC;QAED,IAAI,iBAAiB,KAAK,SAAS,EAAE,CAAC;YACpC,MAAM,WAAW,GAAG,IAAI,CAAC,UAAU,CAAC,iBAAiB,CAAC,CAAC;YACvD,+BAA+B;YAC/B,MAAM,SAAS,GAAG,WAAW,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,WAAW,CAAC;YAC/F,OAAO,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC,IAAI,SAAS,EAAE,CAAC,CAAC;QACtE,CAAC;IACH,CAAC;IAEM,KAAK,CAAC,OAAe,EAAE,OAAiC;QAC7D,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IACtC,CAAC;IAEM,IAAI,CAAC,OAAe,EAAE,OAAiC;QAC5D,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IACrC,CAAC;IAEM,IAAI,CAAC,OAAe,EAAE,OAAiC;QAC5D,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IACrC,CAAC;IAEM,KAAK,CAAC,OAAe,EAAE,OAAiC;QAC7D,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IACtC,CAAC;IAEO,GAAG,CAAC,KAAe,EAAE,OAAe,EAAE,OAAiC;QAC7E,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;YAC3B,OAAO;QACT,CAAC;QAED,MAAM,SAAS,GAAG,IAAI,CAAC,eAAe,EAAE,CAAC;QACzC,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,SAAS,GAAG,EAAE,KAAK,CAAC,CAAC;QACtD,MAAM,UAAU,GAAG,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QAE3C,IAAI,IAAI,GAAG,GAAG,MAAM,IAAI,UAAU,IAAI,OAAO,EAAE,CAAC;QAEhD,IAAI,OAAO,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC/C,MAAM,SAAS,GAAG,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;YACnD,IAAI,IAAI,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC,EAAE,CAAC;QAClE,CAAC;QAED,IAAI,KAAK,KAAK,OAAO,EAAE,CAAC;YACtB,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACtB,CAAC;aAAM,IAAI,KAAK,KAAK,MAAM,EAAE,CAAC;YAC5B,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACrB,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACpB,CAAC;IACH,CAAC;IAEO,SAAS,CAAC,KAAe;QAC/B,OAAO,kBAAS,CAAC,KAAK,CAAC,IAAI,kBAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACtD,CAAC;IAEO,eAAe;QACrB,MAAM,GAAG,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,OAAO,GAAG,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,eAAe;IACzD,CAAC;IAEO,WAAW,CAAC,KAAe;QACjC,MAAM,MAAM,GAAmE;YAC7E,KAAK,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE;YACpC,IAAI,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE;YACtC,IAAI,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE;YACpC,KAAK,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE;SACtC,CAAC;QACF,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;QACtC,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,IAAI,GAAG,EAAE,KAAK,CAAC,CAAC;IAC3C,CAAC;IAEO,QAAQ,CAAC,IAAY,EAAE,KAA0B;QACvD,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC;YACvB,OAAO,IAAI,CAAC;QACd,CAAC;QACD,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,IAAI,GAAG,MAAM,CAAC,KAAK,EAAE,CAAC;IAClD,CAAC;IAEO,aAAa,CAAC,OAAgB;QACpC,IAAI,OAAO,IAAI,OAAO,OAAO,KAAK,QAAQ,IAAI,QAAQ,IAAI,OAAO,EAAE,CAAC;YAClE,OAAO,MAAM,CAAE,OAA8B,CAAC,MAAM,CAAC,CAAC;QACxD,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAEO,UAAU,CAAC,GAAY;QAC7B,IAAI,CAAC;YACH,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;QAC7B,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC;QACrB,CAAC;IACH,CAAC;IAEO,kBAAkB,CAAC,GAAY;QACrC,IAAI,GAAG,KAAK,IAAI,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;YACtC,OAAO,GAAG,CAAC;QACb,CAAC;QAED,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;YAC5B,OAAO,GAAG,CAAC;QACb,CAAC;QAED,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;YACvB,OAAO,GAAG,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC,CAAC;QAC1D,CAAC;QAED,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;YAC5B,MAAM,SAAS,GAA4B,EAAE,CAAC;YAC9C,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC/C,wBAAwB;gBACxB,IACE,CAAC,UAAU,EAAE,eAAe,EAAE,cAAc,EAAE,eAAe,EAAE,eAAe,EAAE,UAAU,CAAC,CAAC,QAAQ,CAClG,GAAG,CAAC,WAAW,EAAE,CAClB,EACD,CAAC;oBACD,SAAS,CAAC,GAAG,CAAC,GAAG,YAAY,CAAC;gBAChC,CAAC;qBAAM,CAAC;oBACN,SAAS,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;gBAClD,CAAC;YACH,CAAC;YACD,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,OAAO,GAAG,CAAC;IACb,CAAC;CACF"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@fairmint/canton-node-sdk",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.247",
|
|
4
4
|
"description": "Canton Node SDK",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"canton",
|
|
@@ -47,8 +47,8 @@
|
|
|
47
47
|
"lint:fix": "eslint . --fix",
|
|
48
48
|
"lint:npm": "npmPkgJsonLint . --fix",
|
|
49
49
|
"lint:npm:check": "npmPkgJsonLint .",
|
|
50
|
-
"localnet:quickstart": "bash ./bin/canton-localnet setup",
|
|
51
50
|
"localnet:logs": "bash ./bin/canton-localnet logs",
|
|
51
|
+
"localnet:quickstart": "bash ./bin/canton-localnet setup",
|
|
52
52
|
"localnet:setup": "bash ./bin/canton-localnet setup",
|
|
53
53
|
"localnet:smoke": "bash ./bin/canton-localnet smoke",
|
|
54
54
|
"localnet:start": "bash ./bin/canton-localnet start",
|
|
@@ -71,7 +71,7 @@
|
|
|
71
71
|
"@hardlydifficult/rest-client": "1.0.65",
|
|
72
72
|
"@hardlydifficult/websocket": "1.0.73",
|
|
73
73
|
"@stellar/stellar-base": "15.0.0",
|
|
74
|
-
"axios": "1.18.
|
|
74
|
+
"axios": "1.18.1",
|
|
75
75
|
"dotenv": "17.4.2",
|
|
76
76
|
"glob": "13.0.6",
|
|
77
77
|
"openapi-fetch": "0.17.0",
|
|
@@ -82,10 +82,10 @@
|
|
|
82
82
|
},
|
|
83
83
|
"devDependencies": {
|
|
84
84
|
"@types/jest": "30.0.0",
|
|
85
|
-
"@types/node": "
|
|
85
|
+
"@types/node": "26.1.0",
|
|
86
86
|
"@types/ws": "8.18.1",
|
|
87
|
-
"@typescript-eslint/eslint-plugin": "8.
|
|
88
|
-
"@typescript-eslint/parser": "8.
|
|
87
|
+
"@typescript-eslint/eslint-plugin": "8.62.1",
|
|
88
|
+
"@typescript-eslint/parser": "8.62.1",
|
|
89
89
|
"eslint": "9.39.2",
|
|
90
90
|
"eslint-config-prettier": "10.1.8",
|
|
91
91
|
"eslint-import-resolver-typescript": "4.4.5",
|
|
@@ -93,14 +93,14 @@
|
|
|
93
93
|
"eslint-plugin-markdown": "5.1.0",
|
|
94
94
|
"eslint-plugin-unused-imports": "4.4.1",
|
|
95
95
|
"jest": "30.4.2",
|
|
96
|
-
"markdownlint-cli": "0.
|
|
97
|
-
"npm-package-json-lint": "10.4.
|
|
96
|
+
"markdownlint-cli": "0.49.0",
|
|
97
|
+
"npm-package-json-lint": "10.4.1",
|
|
98
98
|
"prettier": "3.8.4",
|
|
99
99
|
"prettier-plugin-jsdoc": "1.8.1",
|
|
100
100
|
"prettier-plugin-organize-imports": "4.3.0",
|
|
101
101
|
"prettier-plugin-packagejson": "3.0.2",
|
|
102
102
|
"ts-jest": "29.4.11",
|
|
103
|
-
"tsx": "4.
|
|
103
|
+
"tsx": "4.23.0",
|
|
104
104
|
"typescript": "5.9.3",
|
|
105
105
|
"typescript-7": "npm:typescript@7.0.2"
|
|
106
106
|
},
|