Mysten Typescript SDKs

A collection of TypeScript SDKs for interacting with the Sui blockchain ecosystem.

Documentation

For SDK documentation visit https://sdk.mystenlabs.com/typescript

Development

Any of the following commands can be run at the root of the project or from an individual package directory.

When running commands for individual you can use turbo to ensure all of a tasks dependencies are run first (eg. pnpm turbo build)

Setup

pnpm install
pnpm turbo build
Copy

Building

pnpm build
# or
pnpm turbo build
Copy

Unit tests

For unit tests

pnpm test
# or
pnpm turbo test
Copy

e2e tests

The e2e tests require docker to be installed and uses testcontainers to create an e2e test environment

pnpm test:e2e
Copy

Using turbo to run e2e tests in parallel is not recommended

Linting

This repo uses eslint and prettier for linting

pnpm lint
Copy

You can automatically fix many lint issues by running

pnpm lint:fix
Copy

To run eslint and prettier individually you can use the following commands:

pnpm prettier:check
pnpm prettier:fix
pnpm eslint:check
pnpm eslint:fix
Copy