![Beta Release](https://github.com/windingtree/sdk/actions/workflows/release.yml/badge.svg?branch=master&raw=true)
The WindingTree market protocol SDK
To find the documentation of the SDK please follow the https://windingtree.github.io/sdk
Package |
Description |
Version |
@windingtree/contracts |
Smart contracts and utilities |
![@windingtree/contracts](https://camo.githubusercontent.com/01f9f5c84e25d21cf4e721596ab889eb3be9a673205c29e9f714664cf271be7c/68747470733a2f2f696d672e736869656c64732e696f2f6e706d2f762f4077696e64696e67747265652f636f6e747261637473) |
@windingtree/sdk-server |
The protocol coordination server |
![@windingtree/sdk-server](https://camo.githubusercontent.com/cd7ec1d1bb15c4db53a3be637ffca1c2fe167c44e9c3d3eecd61a2d07adbb790/68747470733a2f2f696d672e736869656c64732e696f2f6e706d2f762f4077696e64696e67747265652f73646b2d736572766572) |
@windingtree/sdk-node |
The protocol node |
![@windingtree/sdk-node](https://camo.githubusercontent.com/7e4392f435e7fe781b7610b8d313e18cc366e866dda5fa997894018410a59440/68747470733a2f2f696d672e736869656c64732e696f2f6e706d2f762f4077696e64696e67747265652f73646b2d6e6f6465) |
@windingtree/sdk-node-api |
The protocol node management API |
![@windingtree/sdk-node-api](https://camo.githubusercontent.com/dd01b48eae4df17a04934925fd115532cd972c96764447c27d10e6361530cf5a/68747470733a2f2f696d672e736869656c64732e696f2f6e706d2f762f4077696e64696e67747265652f73646b2d6e6f64652d617069) |
@windingtree/sdk-client |
The protocol client |
![@windingtree/sdk-client](https://camo.githubusercontent.com/c2fd5cf51d28ab6ac86b1fc2547a6bcef7504ff3110f200b7929666da668fa34/68747470733a2f2f696d672e736869656c64732e696f2f6e706d2f762f4077696e64696e67747265652f73646b2d636c69656e74) |
@windingtree/sdk-react |
React components and utilities |
![@windingtree/sdk-react](https://camo.githubusercontent.com/c0d531e8356f1bb45da8022fba9410461e7da150271139c26274624c7390e4fe/68747470733a2f2f696d672e736869656c64732e696f2f6e706d2f762f4077696e64696e67747265652f73646b2d7265616374) |
@windingtree/sdk-constants |
Constants |
![@windingtree/sdk-constants](https://camo.githubusercontent.com/3c6aefb1ee0b9c0f1be0c741a21bd52c11258a34f67ff392c15d618cfe973bcc/68747470733a2f2f696d672e736869656c64732e696f2f6e706d2f762f4077696e64696e67747265652f73646b2d636f6e7374616e7473) |
@windingtree/sdk-types |
The SDK shared Typescript types |
![@windingtree/sdk-types](https://camo.githubusercontent.com/c64374247826479501dfa066e64de0aed45ab62330a39282eed638229a76dbda/68747470733a2f2f696d672e736869656c64732e696f2f6e706d2f762f4077696e64696e67747265652f73646b2d7479706573) |
@windingtree/sdk-utils |
Shared utilities |
![@windingtree/sdk-utils](https://camo.githubusercontent.com/e62778e239c4c447a720a251f3309006a713bf2e55ed32a649e89f7b200eadf3/68747470733a2f2f696d672e736869656c64732e696f2f6e706d2f762f4077696e64696e67747265652f73646b2d7574696c73) |
@windingtree/sdk-test-utils |
Test utilities |
![@windingtree/sdk-test-utils](https://camo.githubusercontent.com/b637f65cd0bd70c6b392632e29485e2b5dba2a208a7bce0d180878f38391fcae/68747470733a2f2f696d672e736869656c64732e696f2f6e706d2f762f4077696e64696e67747265652f73646b2d746573742d7574696c73) |
@windingtree/sdk-pubsub |
The protocol pubsub service |
![@windingtree/sdk-pubsub](https://camo.githubusercontent.com/be7d31d18450662c4daac23cc1ceb186d2c995c7d911e23166f00f790f97ea82/68747470733a2f2f696d672e736869656c64732e696f2f6e706d2f762f4077696e64696e67747265652f73646b2d707562737562) |
@windingtree/sdk-contracts-manager |
Smart contracts connection and management |
![@windingtree/sdk-contracts-manager](https://camo.githubusercontent.com/183baa40a9a15662e4abf1569dfea3c27ea82cb36bd7ad9ab3387b13c71d1a8c/68747470733a2f2f696d672e736869656c64732e696f2f6e706d2f762f4077696e64696e67747265652f73646b2d636f6e7472616374732d6d616e61676572) |
@windingtree/sdk-messages |
The protocol messages utilities |
![@windingtree/sdk-messages](https://camo.githubusercontent.com/3fe67af32fd07628a932f13ecbfb1fafbad72196d3377f5810ae1f43461b6c0c/68747470733a2f2f696d672e736869656c64732e696f2f6e706d2f762f4077696e64696e67747265652f73646b2d6d65737361676573) |
@windingtree/sdk-queue |
Jobs queue |
![@windingtree/sdk-queue](https://camo.githubusercontent.com/626f754344fb973fa5d5d5711c4c356b88413c0d3038c2fc760c84b230f07f84/68747470733a2f2f696d672e736869656c64732e696f2f6e706d2f762f4077696e64696e67747265652f73646b2d7175657565) |
@windingtree/sdk-storage |
Cross-platform storage layer |
![@windingtree/sdk-storage](https://camo.githubusercontent.com/1001a44621402d2c2244543c2beb576fd6f55ab0e67eb385b06533a22c83d05f/68747470733a2f2f696d672e736869656c64732e696f2f6e706d2f762f4077696e64696e67747265652f73646b2d73746f72616765) |
@windingtree/sdk-db |
Databases tools |
![@windingtree/sdk-db](https://camo.githubusercontent.com/ad94f01b45ee654676235e6b1a03d7c7b961cae21d8f877a9d4dd4d7b71bc65e/68747470733a2f2f696d672e736869656c64732e696f2f6e706d2f762f4077696e64696e67747265652f73646b2d6462) |
@windingtree/sdk-logger |
Logging utility |
![@windingtree/sdk-logger](https://camo.githubusercontent.com/df284bea4d69524ea822271184d125efc2a344ac6fd20c5d671ba48e83e1acd2/68747470733a2f2f696d672e736869656c64732e696f2f6e706d2f762f4077696e64696e67747265652f73646b2d6c6f67676572) |
This repository uses pnpm
package manager.
After finishing of tests code coverage script, you can find reports in ./coverage/index.html
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
Contribution guidelines