Aptos JS-Pro

A library of opinionated utilities built on top of the @aptos-labs/ts-sdk

Overview

Aptos JS-Pro is a library of utilities built on top of the @aptos-labs/ts-sdk. This library is focused on an opinionated tools based off of internal usecases derived from Aptos Labs products such as Petra and Aptos Connect.

Documentation

Please visit js-pro.aptos.dev for the latest documentation.

Installation

Note

These packages are still in development and may change rapidly as they are developed.

TypeScript

npm install @aptos-labs/ts-sdk @aptos-labs/js-pro

React

npm install @aptos-labs/ts-sdk @aptos-labs/js-pro @tanstack/react-query @aptos-labs/react

Getting Started

Prerequisites

Check out .tool-versions for runtime requirements.

Installation

1. Clone the repository:

git clone https://github.com/aptos-labs/aptos-js-pro.git
cd aptos-js-pro

2. Install runtimes (mise)

mise install

If mise is not installed, check out their Getting Started page.

3. Install dependencies:

pnpm install

4. Build packages:

pnpm build

5. Run tests:

pnpm test

6. Run checks:

pnpm check

Deployment

The documentation is automatically deployed to js-pro.aptos.dev when a pull request is merged into the main branch. This deployment is handled through a private Vercel instance.

Contributing

Contributions are welcome! Please refer to the CONTRIBUTING.md file for more information.