Skip to main content

Atlas TypeScript SDK Quickstart

This SDK was primarily built for frontend usage. Communication with the Atlas auctioneer is abstracted and compatible with browser usage.

Installation​

To use the Atlas SDK in your TypeScript project, install it using npm or yarn:

npm install @fastlane-labs/atlas-sdk

or

yarn add @fastlane-labs/atlas-sdk

Initialization​

import { AtlasSdk, FastlaneBackend } from "@fastlane-labs/atlas-sdk";
import { JsonRpcProvider } from "ethers";

// The following values must be adjusted
const chainId = 11155111;
const rpcUrl = "https://rpc.sepolia.org";
const atlasAuctioneerUrl = "https://auctioneer.atlas.fastlane.xyz";

// Create the SDK instance
const sdk = await AtlasSdk.create(
  new JsonRpcProvider(rpcUrl, chainId),
  chainId,
  new FastlaneBackend({endpoint: atlasAuctioneerUrl})
);