Sprinter TS - Cross-Chain Developer Toolkit

Table of Contents

• Sprinter TS - Cross-Chain Developer Toolkit
  • Introduction
  • Prerequisites
  • Getting Started
  • Building
  • Testing
  • Linting and Formatting

---

Introduction

Sprinter TS is a powerful developer toolkit designed to simplify cross-chain integrations and enhance the developer experience. It includes:

• TypeScript SDK for strongly typed APIs and simplified interactions.
• React SDK with hooks and context for seamless integration into React applications.
• Comprehensive Documentation to guide and support developers.

Whether you're building cross-chain applications or experimenting with decentralized technologies, Sprinter provides the tools you need to succeed.

---

Prerequisites

Before you begin, ensure you have the following installed:

• Node.js >= 20.0.0 (we recommend using nvm for managing Node versions)
• Yarn >= 4.3 (via corepack)

---

Getting Started

To get started with the project:

1. Clone the repository:

   git clone https://github.com/ChainSafe/sprinter-ts.git

2. Navigate to the project root:

   cd sprinter-ts

3. Set Node.js to the compatible version (skip if you use a manual approach):

   nvm use

4. Enable Corepack:

   corepack enable

5. Install the dependencies:

   yarn install

---

Building

To build all packages, run:

yarn build

---

Here's the corrected and updated Testing and Linting and Formatting documentation that reflects your unchanged package.json.

---

Testing

Run Unit Tests

yarn test:unit

This command executes unit tests in all packages where they are defined.

Run Integration Tests

yarn test:integrations

This command executes integration tests in all packages where they are defined.

---

Linting and Formatting

This project uses ESLint to enforce code style and formatting. To ensure consistent code quality, you can use the following command:

Check for Linting Issues

yarn lint

This command runs the linter across all workspaces to identify any issues.