TypeScript SDK

Overview

Server-side specific functionality for Node.js environments

Introduction

The Node.js version of the SDK is used to interact with the Shelby network from a Node.js environment. The SDK provides a high level interface for interacting with the different components of the Shelby network: the coordination layer, the RPC layer, and the storage layer.

Installation

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

Usage

Make sure you aquired an API Key

Access the Node.js version of the SDK by importing using the @shelby-protocol/sdk/node entry point.

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);

Next Steps