https://github.com/windingtree/sdk
WindingTree Market protocol SDK
https://github.com/windingtree/sdk
api libp2p market sdk typescript windingtree wt
Last synced: about 2 months ago
JSON representation
WindingTree Market protocol SDK
- Host: GitHub
- URL: https://github.com/windingtree/sdk
- Owner: windingtree
- License: mit
- Created: 2023-02-21T08:20:55.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-04-29T18:21:34.000Z (about 1 year ago)
- Last Synced: 2025-04-06T11:49:14.318Z (2 months ago)
- Topics: api, libp2p, market, sdk, typescript, windingtree, wt
- Language: TypeScript
- Homepage: https://windingtree.github.io/sdk/
- Size: 3.8 MB
- Stars: 4
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/windingtree/sdk/actions/workflows/release.yml)
# @windingtree/sdk
The WindingTree market protocol SDK
> To find the documentation of the SDK please follow the [https://windingtree.github.io/sdk](https://windingtree.github.io/sdk)
## Packages
| Package | Description | Version |
|---|---|---|
| @windingtree/contracts | Smart contracts and utilities | [](https://www.npmjs.com/package/@windingtree/contracts) |
| @windingtree/sdk-server | The protocol coordination server | [](https://www.npmjs.com/package/@windingtree/sdk-server) |
| @windingtree/sdk-node | The protocol node | [](https://www.npmjs.com/package/@windingtree/sdk-node) |
| @windingtree/sdk-node-api | The protocol node management API | [](https://www.npmjs.com/package/@windingtree/sdk-node-api) |
| @windingtree/sdk-client | The protocol client | [](https://www.npmjs.com/package/@windingtree/sdk-client) |
| @windingtree/sdk-react | React components and utilities | [](https://www.npmjs.com/package/@windingtree/sdk-react) |
| @windingtree/sdk-constants | Constants | [](https://www.npmjs.com/package/@windingtree/sdk-constants) |
| @windingtree/sdk-types | The SDK shared Typescript types | [](https://www.npmjs.com/package/@windingtree/sdk-types) |
| @windingtree/sdk-utils | Shared utilities | [](https://www.npmjs.com/package/@windingtree/sdk-utils) |
| @windingtree/sdk-test-utils | Test utilities | [](https://www.npmjs.com/package/@windingtree/sdk-test-utils) |
| @windingtree/sdk-pubsub | The protocol pubsub service | [](https://www.npmjs.com/package/@windingtree/sdk-pubsub) |
| @windingtree/sdk-contracts-manager | Smart contracts connection and management | [](https://www.npmjs.com/package/@windingtree/sdk-contracts-manager) |
| @windingtree/sdk-messages | The protocol messages utilities | [](https://www.npmjs.com/package/@windingtree/sdk-messages) |
| @windingtree/sdk-queue | Jobs queue | [](https://www.npmjs.com/package/@windingtree/sdk-queue) |
| @windingtree/sdk-storage | Cross-platform storage layer | [](https://www.npmjs.com/package/@windingtree/sdk-storage) |
| @windingtree/sdk-db | Databases tools | [](https://www.npmjs.com/package/@windingtree/sdk-db) |
| @windingtree/sdk-logger | Logging utility | [](https://www.npmjs.com/package/@windingtree/sdk-logger) |
## Setup
> This repository uses [`pnpm` package manager](https://pnpm.io/installation).
```bash
pnpm install
pnpm build
```
## Testing
```bash
pnpm test
```
After finishing of tests code coverage script, you can find reports in `./coverage/index.html`
## Examples
```bash
pnpm example:server
pnpm example:node
pnpm example:client
# pnpm example:manager
```
> When started the protocol client web-app example will be available on http://localhost:5173 and the node manager app on http://localhost:5174
## Contributing
[Contribution guidelines](https://windingtree.github.io/sdk/#/contribution)