@fairmint/canton-fairmint-sdk 0.0.42 → 0.0.43
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 +3 -62
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,64 +1,5 @@
|
|
|
1
|
-
#
|
|
1
|
+
# canton-fairmint-sdk
|
|
2
2
|
|
|
3
|
-
Shared
|
|
3
|
+
Shared TypeScript utilities for Canton blockchain integration at Fairmint.
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
```bash
|
|
8
|
-
npm install @fairmint/canton-fairmint-sdk
|
|
9
|
-
```
|
|
10
|
-
|
|
11
|
-
## Usage
|
|
12
|
-
|
|
13
|
-
```typescript
|
|
14
|
-
import {
|
|
15
|
-
CantonDbClient,
|
|
16
|
-
PostgresDbClient,
|
|
17
|
-
} from '@fairmint/canton-fairmint-sdk';
|
|
18
|
-
|
|
19
|
-
// Create a Canton database client
|
|
20
|
-
const client = new CantonDbClient({
|
|
21
|
-
host: 'localhost',
|
|
22
|
-
port: 5432,
|
|
23
|
-
database: 'canton',
|
|
24
|
-
user: 'canton',
|
|
25
|
-
password: 'password',
|
|
26
|
-
});
|
|
27
|
-
|
|
28
|
-
// Use the client
|
|
29
|
-
const result = await client.query('SELECT * FROM events LIMIT 10');
|
|
30
|
-
```
|
|
31
|
-
|
|
32
|
-
## Features
|
|
33
|
-
|
|
34
|
-
- **PostgresDbClient**: Base PostgreSQL client with connection pooling
|
|
35
|
-
- **CantonDbClient**: Specialized client for Canton blockchain database queries
|
|
36
|
-
- **FairmintDbClient**: Client for Fairmint-specific database operations
|
|
37
|
-
- **SDK Helper**: Utilities for working with the Canton JSON API
|
|
38
|
-
|
|
39
|
-
## Development
|
|
40
|
-
|
|
41
|
-
```bash
|
|
42
|
-
# Install dependencies
|
|
43
|
-
npm install
|
|
44
|
-
|
|
45
|
-
# Build
|
|
46
|
-
npm run build
|
|
47
|
-
|
|
48
|
-
# Type check
|
|
49
|
-
npm run typecheck
|
|
50
|
-
|
|
51
|
-
# Lint
|
|
52
|
-
npm run lint
|
|
53
|
-
|
|
54
|
-
# Format
|
|
55
|
-
npm run format
|
|
56
|
-
```
|
|
57
|
-
|
|
58
|
-
## Publishing
|
|
59
|
-
|
|
60
|
-
This package is automatically published to NPM when changes are merged to `main`. The version is automatically incremented and a changelog is generated from commit messages.
|
|
61
|
-
|
|
62
|
-
## License
|
|
63
|
-
|
|
64
|
-
MIT
|
|
5
|
+
See the [wiki](https://github.com/fairmint/canton-fairmint-sdk/wiki) for full documentation.
|