TypeScript SDK

The Shelby Protocol TypeScript SDK provides both Node.js and browser support for interacting with the Shelby Protocol. This comprehensive reference covers all available types, functions, and classes.

Installation

npm install @shelby-protocol/sdk @aptos-labs/ts-sdk

Quick Start

Node.js Environment

import { ShelbyNodeClient } from "@shelby-protocol/sdk/node";
import { Network } from "@aptos-labs/ts-sdk";

// Create client configuration
const config = {
  network: Network.SHELBYNET,
  apiKey: "aptoslabs_***",
};

// Initialize the Shelby client
const shelbyClient = new ShelbyNodeClient(config);

Explore the complete Node.js client usage

Browser Environment

import { ShelbyClient } from '@shelby-protocol/sdk/browser'
import { Network } from '@aptos-labs/ts-sdk'

// Create client configuration
const config = {
  network: Network.SHELBYNET
  apiKey: "aptoslabs_***",
}

// Initialize the Shelby client
const shelbyClient = new ShelbyClient(config)

Explore the complete Browser client usage

Examples

Explore all of the Shelby examples provided in the examples repo, which demonstrate how to build on Shelby

Shelby Examples

API Reference

Explore the complete TypeScript API documentation:

Core Types & Functions - Shared functionality for both environments

Getting Started