@windingtree/sdk

The WindingTree market protocol SDK

To find the documentation of the SDK please follow the https://windingtree.github.io/sdk

Packages

Package	Description	Version
@windingtree/contracts	Smart contracts and utilities
@windingtree/sdk-server	The protocol coordination server
@windingtree/sdk-node	The protocol node
@windingtree/sdk-node-api	The protocol node management API
@windingtree/sdk-client	The protocol client
@windingtree/sdk-react	React components and utilities
@windingtree/sdk-constants	Constants
@windingtree/sdk-types	The SDK shared Typescript types
@windingtree/sdk-utils	Shared utilities
@windingtree/sdk-test-utils	Test utilities
@windingtree/sdk-pubsub	The protocol pubsub service
@windingtree/sdk-contracts-manager	Smart contracts connection and management
@windingtree/sdk-messages	The protocol messages utilities
@windingtree/sdk-queue	Jobs queue
@windingtree/sdk-storage	Cross-platform storage layer
@windingtree/sdk-db	Databases tools
@windingtree/sdk-logger	Logging utility

Setup

This repository uses pnpm package manager.

pnpm install
pnpm build

Testing

pnpm test

After finishing of tests code coverage script, you can find reports in ./coverage/index.html

Examples

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