Skip to main content

Getting Started

This guide will help you get started with the xByte SDK. You'll learn how to install the SDK, create clients, and make your first API calls.

Installation​

Install the xByte SDK using your preferred package manager:

npm install xbyte-sdk
pnpm add xbyte-sdk
yarn add xbyte-sdk

Prerequisites​

  • Node.js 18+ or Bun
  • TypeScript (recommended)
  • An xByte API endpoint URL (or use the default)

Basic Setup​

Import the SDK​

import { xByteClient, xByteEvmClient } from "xbyte-sdk";

Create an API Client​

The xByteClient is used to interact with the xByte API server:

const client = new xByteClient();

If no URL is provided, it defaults to https://api.xbyte.sh:

const client = new xByteClient();

Create an EVM Client​

The xByteEvmClient is used to interact with xByte smart contracts:

const evmClient = new xByteEvmClient("https://sepolia.base.org");

If no RPC URL is provided, it defaults to https://sepolia.base.org.

Your First API Call​

Let's start with a simple health check:

import { xByteClient } from "xbyte-sdk";

const client = new xByteClient();

const response = await client.health();

if (response.status === "Success") {
    console.log("Server is healthy:", response.data);
} else {
    console.error("Error:", response.data);
}

Working with Clients​

Creating a Client​

Before you can upload content or set prices, you need to create a client:

const clientResponse = await client.createClient({
    name: "My Content Platform",
    wallet: "0x1234567890123456789012345678901234567890",
});

if (clientResponse.status === "Success") {
    console.log("Client created:", clientResponse.data);
    const clientId = clientResponse.data.id;
}

Registering a Bucket​

After creating a client, register a bucket to store your content:

const bucketResponse = await client.registerBucket({
    bucket: "my-content-bucket",
    client: clientId,
});

if (bucketResponse.status === "Success") {
    console.log("Bucket registered:", bucketResponse.data);
}

Setting Content Prices​

Once you have a bucket, you can set prices for your content:

const priceResponse = await client.setPrice({
    bucket: "my-content-bucket",
    object: "my-video.mp4",
    price: 0.001, // Price per byte in USDC
});

if (priceResponse.status === "Success") {
    console.log("Price set successfully");
}

Retrieving Prices​

Get the price for a specific content object:

const priceResponse = await client.getPrice("my-content-bucket", "my-video.mp4");

if (priceResponse.status === "Success") {
    console.log("Price:", priceResponse.data);
}

Error Handling​

All API methods return an ApiResponse<T, E> type. Always check the status field:

const response = await client.getPrice("bucket", "object");

if (response.status === "Success") {
    const price = response.data;
} else if (response.status === "Error") {
    console.error("API Error:", response.data);
} else if (response.status === "PaymentRequired") {
    console.log("Payment required:", response.data);
}

Next Steps​