@starton/sdk NPM

@starton/sdk

🏗 Under construction! 🏗

This is an alpha release of the Starton SDK. We are still working on the documentation and examples and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

If you have any questions, please reach out to us on Discord.

SDK Installation

NPM

npm add @starton/sdk

Yarn

yarn add @starton/sdk

SDK Example Usage

import { Starton } from "@starton/sdk"

const sdk = new Starton({
    startonApiKey: "",
})

sdk.data.getBalance({
    address: "0xc479C6ceAd4fE25AF85965aB2364C1C5f5351200",
    network: "ethereum-mainnet",
}).then(response => console.log(response))

Available Resources and Operations

data

getBalance - Retrieve the native token balance of a specific blockchain address
getErc20Balance - Retrieve the ERC20 token balance for a specific address
getGasPrice - Retrieve the current gas prices

wallet

create - Create a new wallet
delete - Delete a wallet
getAll - Retrieve the list of Wallets
getOne - Fetch Wallet Details
import - Import Wallet from Provider Key
requestFaucet - Request tokens from faucet
resyncNonce - Synchronize Nonces for a wallet
sign - Sign a message
update - Update Wallet Information

ipfs

delete - Deletes pinned file referenced by {id}
getAll - Retrieve all files
getOne - Retrieve a Specific File
getStorageUsed - Retrieve Current Storage Usage
pinExistingFile - Pin Existing IPFS File
update - Update File Details
uploadFile - Upload a file
uploadFolder - Upload a folder
uploadJson - Upload a JSON file

kms

create - Create a new KMS entry
delete - Remove a specific KMS entry
getAll - Retrieve all Key Management Systems (KMS)
getOne - Retrieve details of a specific KMS
update - Update the details of a KMS

transactionManager

create - Create a new transaction
getAll - Retrieve a List of Transactions
getAvailableNonces - Retrieve Available Nonces for a wallet
getOne - Get a Specific Transaction
resyncNonce - Synchronize Nonces for a wallet

transactionManager.setting

get - Get Relayer settings
update - Update Relayer Settings

network

create - Create a new network (Enterprise)
delete - Delete a network (Enterprise)
getAll - Retrieve the list of supported networks
getOne - Fetch a specific network
update - Update specific network details (Enterprise)

network.rpc

create - Add a rpc (enterprise)
delete - Delete a rpc (enterprise)
getAll - Get all rpc (enterprise)
getOne - Get a rpc (enterprise)
update - Update a rpc (enterprise)

project.member

delete - Remove a user from a project.
getAll - Retrieve a list of all members of a specific project.

project.member.invitation

create - Send an invitation to the project
delete - Revoke a previously sent invitation.
getAll - Retrieve a list of all member invitations for a specific project

smartContractManagement

call - Execute Smart Contract Function
delete - Delete a smart contract
deployFromBytecode - Deploy from bytecode (your own contract)
deployFromTemplate - Deploy Smart Contract from Template
getAll - Get all smart contracts
getFunctions - Retrieves Smart Contract Functions and Events
getOne - Get a single smart contract
importExisting - Import Existing Smart Contract
read - Query Smart Contract Function
update - Update a smart contract

smartContract.template

getAll - Fetch the list of Smart Contract Templates
getOne - Retrieve a Specific Smart Contract Template

monitor

create - Create a New Watcher
delete - Delete a watcher
getAll - Retrieve List of Watchers
getAllEvents - Fetches the list of events for a watcher
getOne - Get a specific watcher
getOneEvent - Get a watcher event
update - Update a watcher

webhook

cancel - Cancel a webhook
getAll - Retrieve the list of Webhooks
getOne - Retrieve a Specific Webhook
getSigningSecret - Retrieve Webhook Signing Secret
regenerateSigningSecret - Regenerate Webhook signing secret
resend - Resend a Webhook

Custom HTTP Client

The TypeScript SDK makes API calls using an HTTPClient that wraps the native Fetch API. This client is a thin wrapper around fetch and provides the ability to attach hooks around the request lifecycle that can be used to modify the request or handle errors and response.

The HTTPClient constructor takes an optional fetcher argument that can be used to integrate a third-party HTTP client or when writing tests to mock out the HTTP client and feed in fixtures.

The following example shows how to use the "beforeRequest" hook to to add a custom header and a timeout to requests and how to use the "requestError" hook to log errors:

import { Starton } from "@starton/sdk";
import { HTTPClient } from "@starton/sdk/lib/http";

const httpClient = new HTTPClient({
  // fetcher takes a function that has the same signature as native `fetch`.
  fetcher: (request) => {
    return fetch(request);
  }
});

httpClient.addHook("beforeRequest", (request) => {
  const nextRequest = new Request(request, {
    signal: request.signal || AbortSignal.timeout(5000)
  });

  nextRequest.headers.set("x-custom-header", "custom value");

  return nextRequest;
});

httpClient.addHook("requestError", (error, request) => {
  console.group("Request Error");
  console.log("Reason:", `${error}`);
  console.log("Endpoint:", `${request.method} ${request.url}`);
  console.groupEnd();
});

const sdk = new Starton({ httpClient });

Pagination

Some of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but the returned response object will also be an async iterable that can be consumed using the for await...of syntax.

Here's an example of one such pagination call:

import { Starton } from "@starton/sdk";

const starton = new Starton({
    startonApiKey: "<YOUR_API_KEY_HERE>",
});

async function run() {
    const result = await starton.wallet.getAll({
        limit: 20,
        page: 0,
    });

    for await (const page of result) {
        // handle page
    }
}

run();

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name	Type	Scheme
`startonApiKey`	apiKey	API key

To authenticate with the API the startonApiKey parameter must be set when initializing the SDK client instance. For example:

import { Starton } from "@starton/sdk";

const starton = new Starton({
    startonApiKey: "<YOUR_API_KEY_HERE>",
});

async function run() {
    const result = await starton.data.getBalance({
        address: "0xc2132d05d31c914a87c6611c10748aeb04b58e8f",
        network: "polygon-mainnet",
    });

    // Handle the result
    console.log(result);
}

run();

File uploads

Certain SDK methods accept files as part of a multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request.

!TIP
Depending on your JavaScript runtime, there are convenient utilities that return a handle to a file without reading the entire contents into memory:
Node.js v20+: Since v20, Node.js comes with a native openAsBlob function in node:fs.
Bun: The native Bun.file function produces a file handle that can be used for streaming file uploads.
Browsers: All supported browsers return an instance to a File when reading the value from an <input type="file"> element.
Node.js v18: A file stream can be created using the fileFrom helper from fetch-blob/from.js.

import { Starton } from "@starton/sdk";

const starton = new Starton({
    startonApiKey: "<YOUR_API_KEY_HERE>",
});

async function run() {
    const result = await starton.ipfs.uploadFile({});

    // Handle the result
    console.log(result);
}

run();

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

Development

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!