@ardriveapp/turbo-sdk 🚀

Welcome to the @ardrive/turbo-sdk! This SDK provides functionality for interacting with the Turbo Upload and Payment Services and is available for both NodeJS and Web environments.

Table of Contents

• Installation
• Quick Start
• Usage
  • Web
  • NodeJS
  • Typescript
  • Examples
• APIs
  • TurboFactory
    • unauthenticated()
    • authenticated()
  • TurboUnauthenticatedClient
    • getSupportedCurrencies()
    • getSupportedCountries()
    • getFiatToAR({ currency })
    • getFiatRates()
    • getWincForFiat({ amount })
    • getUploadCosts({ bytes })
    • uploadSignedDataItem({ dataItemStreamFactory, dataItemSizeFactory, signal })
    • createCheckoutSession({ amount, owner })
    • submitFundTransaction({ txId })
  • TurboAuthenticatedClient
    • getBalance()
    • getWincForFiat({ amount, promoCodes })
    • createCheckoutSession({ amount, owner, promoCodes })
    • uploadFile({ fileStreamFactory, fileSizeFactory, signal, dataItemOpts })
    • topUpWithTokens({ tokenAmount, feeMultiplier })
• Developers

Installation

npm install @ardrive/turbo-sdk

or

yarn add @ardrive/turbo-sdk

Quick Start

import { TurboFactory, ArweaveSigner } from '@ardrive/turbo-sdk';

// load your JWK directly to authenticate
const jwk = fs.readFileSync('./my-jwk.json');
const address = arweave.wallets.jwkToAddress(jwk);
const turbo = TurboFactory.authenticated({ privateKey: jwk });

// or provide your own signer
const signer = new ArweaveSigner(jwk);
const turbo = TurboFactory.authenticated({ signer });

// get the wallet balance
const { winc: balance } = await turbo.getBalance();

// prep file for upload
const filePath = path.join(__dirname, './my-image.png');
const fileSize = fs.statSync(filePath).size;

// get the cost of uploading the file
const [{ winc: fileSizeCost }] = await turbo.getUploadCosts({
  bytes: [fileSize],
});

// check if balance greater than upload cost
if (balance < fileSizeCost) {
  const { url } = await turbo.createCheckoutSession({
    amount: fileSizeCost,
    owner: address,
    // add a promo code if you have one
  });
  // open the URL to top-up, continue when done
  open(url);
  return;
}

// upload the file
try {
  const { id, owner, dataCaches, fastFinalityIndexes } = await turbo.uploadFile(() => {
    fileStreamFactory => () => fs.createReadStream(filePath),
    fileSizeFactory => () => fileSize,
  });
  // upload complete!
  console.log('Successfully upload data item!', { id, owner, dataCaches, fastFinalityIndexes });
} catch (error) {
  // upload failed
  console.error('Failed to upload data item!', error);
} finally {
  const { winc: newBalance } = await turbo.getBalance();
  console.log('New balance:', newBalance);
}

Usage

The SDK is provided in both CommonJS and ESM formats, and it's compatible with bundlers such as Webpack, Rollup, and ESbuild. Utilize the appropriately named exports provided by this SDK's package.json based on your project's configuration. Refer to the examples directory to see how to use the SDK in various environments.

Web

Bundlers (Webpack, Rollup, ESbuild, etc.)

CommonJS:

import { TurboFactory } from '@ardrive/turbo-sdk';

const turbo = TurboFactory.unauthenticated();
const rates = await turbo.getFiatRates();

ESM:

import { TurboFactory } from '@ardrive/turbo-sdk/<node/web>';

const turbo = TurboFactory.unauthenticated();
const rates = await turbo.getFiatRates();

Browser

<script type="module">
  import { TurboFactory } from 'https://unpkg.com/@ardrive/turbo-sdk';

  const turbo = TurboFactory.unauthenticated();
  const rates = await turbo.getFiatRates();
</script>

NodeJS

CommonJS

Example available in the examples/typescript/cjs.

ESM

Example available in the examples/typescript/esm.

Typescript

The SDK provides TypeScript types. When you import the SDK in a TypeScript project:

import { TurboFactory } from '@ardrive/turbo-sdk/<node/web>';

Types are exported from ./lib/types/[node/web]/index.d.ts and should be automatically recognized, offering benefits such as type-checking and autocompletion.

Examples

Examples are available in the examples directory. To run examples:

• yarn example:web - opens up the example web page
• yarn example:cjs - runs example CJS node script
• yarn example:esm - runs example ESM node script

APIs

TurboFactory

unauthenticated()

Creates an instance of a client that accesses Turbo's unauthenticated services.

const turbo = TurboFactory.unauthenticated();

authenticated()

Creates an instance of a client that accesses Turbo's authenticated and unauthenticated services. Requires either a signer, or private key to be provided.

Construct Turbo with an Arweave JWK

const jwk = await arweave.crypto.generateJWK();
const turbo = TurboFactory.authenticated({ privateKey: jwk });

Construct Turbo with an Arweave signer

const signer = new ArweaveSigner(jwk);
const turbo = TurboFactory.authenticated({ signer });

Construct Turbo with an Arconnect signer

const signer = new ArconnectSigner(window.arweaveWallet);
const turbo = TurboFactory.authenticated({ signer });

Construct Turbo with an ETH signer

const signer = new EthereumSigner(privateKey);
const turbo = TurboFactory.authenticated({ signer });

Construct Turbo with an ETH private key

const turbo = TurboFactory.authenticated({
  privateKey: ethHexadecimalPrivateKey,
  token: 'ethereum',
});

Construct Turbo with a SOL signer

const signer = new HexSolanaSigner(bs58.encode(secretKey));
const turbo = TurboFactory.authenticated({ signer });

Construct Turbo with a SOL secret key

const turbo = TurboFactory.authenticated({
  privateKey: bs58.encode(secretKey),
  token: 'solana',
});

TurboUnauthenticatedClient

getSupportedCurrencies()

Returns the list of currencies supported by the Turbo Payment Service for topping up a user balance of AR Credits (measured in Winston Credits, or winc).

const currencies = await turbo.getSupportedCurrencies();

getSupportedCountries()

Returns the list of countries supported by the Turbo Payment Service's top up workflow.

const countries = await turbo.getSupportedCountries();

getFiatToAR({ currency })

Returns the current raw fiat to AR conversion rate for a specific currency as reported by third-party pricing oracles.

const fiatToAR = await turbo.getFiatToAR({ currency: 'USD' });

getFiatRates()

Returns the current fiat rates for 1 GiB of data for supported currencies, including all top-up adjustments and fees.

const rates = await turbo.getFiatRates();

getWincForFiat({ amount })

Returns the current amount of Winston Credits including all adjustments for the provided fiat currency, amount. To leverage promo codes, see TurboAuthenticatedClient.

const { winc, paymentAmount, quotedPaymentAmount, adjustments } =
  await turbo.getWincForFiat({
    amount: USD(100),
    // promo codes require an authenticated client
  });

getUploadCosts({ bytes })

Returns the estimated cost in Winston Credits for the provided file sizes, including all upload adjustments and fees.

const [uploadCostForFile] = await turbo.getUploadCosts({ bytes: [1024] });
const { winc, adjustments } = uploadCostForFile;

uploadSignedDataItem({ dataItemStreamFactory, dataItemSizeFactory, signal })

Uploads a signed data item. The provided dataItemStreamFactory should produce a NEW signed data item stream each time is it invoked. The dataItemSizeFactory is a function that returns the size of the file. The signal is an optional AbortSignal that can be used to cancel the upload or timeout the request.

const filePath = path.join(__dirname, './my-signed-data-item');
const dataItemSize = fs.statSync(filePath).size;
const uploadResponse = await turbo.uploadSignedDataItem({
  dataItemStreamFactory: () => fs.createReadStream(filePath),
  dataItemSizeFactory: () => dataItemSize,
  signal: AbortSignal.timeout(10_000), // cancel the upload after 10 seconds
});

createCheckoutSession({ amount, owner })

Creates a Stripe checkout session for a Turbo Top Up with the provided amount, currency, owner. The returned URL can be opened in the browser, all payments are processed by Stripe. To leverage promo codes, see TurboAuthenticatedClient.

const { url, winc, paymentAmount, quotedPaymentAmount, adjustments } =
  await turbo.createCheckoutSession({
    amount: USD(10.0), // $10.00 USD
    owner: publicArweaveAddress,
    // promo codes require an authenticated client
  });

// Open checkout session in a browser
if (process.platform === 'darwin') {
  // macOS
  exec(`open ${url}`);
} else if (process.platform === 'win32') {
  // Windows
  exec(`start "" "${url}"`, { shell: true });
} else {
  // Linux/Unix
  open(url);
}

Top up to ETH or SOL wallets

const turbo = TurboFactory.unauthenticated({ token: 'ethereum' });

const { url, winc, paymentAmount } = await turbo.createCheckoutSession({
  amount: USD(10.0), // $10.00 USD
  owner: publicEthereumAddress,
});

const turbo = TurboFactory.unauthenticated({ token: 'solana' });

const { url, winc, paymentAmount } = await turbo.createCheckoutSession({
  amount: USD(10.0), // $10.00 USD
  owner: publicSolanaAddress,
});

submitFundTransaction({ txId })

Submits the transaction ID of a funding transaction to Turbo Payment Service for top up processing. The txId is the transaction ID of the transaction to be submitted.

• Note: Use this API if you've already executed your token transfer to the Turbo wallet. Otherwise, consider using topUpWithTokens to execute a new token transfer to the Turbo wallet and submit its resulting transaction ID for top up processing all in one go

const turbo = TurboFactory.unauthenticated(); // defaults to arweave token type
const { status, id, ...fundResult } = await turbo.submitFundTransaction({
  txId: 'my-valid-arweave-fund-transaction-id',
});

TurboAuthenticatedClient

getBalance()

Issues a signed request to get the credit balance of a wallet measured in AR (measured in Winston Credits, or winc).

const { winc: balance } = await turbo.getBalance();

getWincForFiat({ amount, promoCodes })

Returns the current amount of Winston Credits including all adjustments for the provided fiat currency, amount, and optional promo codes.

const { winc, paymentAmount, quotedPaymentAmount, adjustments } =
  await turbo.getWincForFiat({
    amount: USD(100),
    promoCodes: ['MY_PROMO_CODE'], // promo codes require an authenticated client
  });

createCheckoutSession({ amount, owner, promoCodes })

Creates a Stripe checkout session for a Turbo Top Up with the provided amount, currency, owner, and optional promo codes. The returned URL can be opened in the browser, all payments are processed by Stripe. Promo codes require an authenticated client.

const { url, winc, paymentAmount, quotedPaymentAmount, adjustments } =
  await turbo.createCheckoutSession({
    amount: USD(10.0), // $10.00 USD
    owner: publicArweaveAddress,
    promoCodes: ['MY_PROMO_CODE'], // promo codes require an authenticated client
  });

// Open checkout session in a browser
if (process.platform === 'darwin') {
  // macOS
  exec(`open ${url}`);
} else if (process.platform === 'win32') {
  // Windows
  exec(`start "" "${url}"`, { shell: true });
} else {
  // Linux/Unix
  open(url);
}

uploadFile({ fileStreamFactory, fileSizeFactory, signal, dataItemOpts })

Signs and uploads a raw file. The provided fileStreamFactory should produce a NEW file data stream each time is it invoked. The fileSizeFactory is a function that returns the size of the file. The signal is an optional AbortSignal that can be used to cancel the upload or timeout the request. dataItemOpts is an optional object that can be used to configure tags, target, and anchor for the data item upload.

const filePath = path.join(__dirname, './my-unsigned-file.txt');
const fileSize = fs.stateSync(filePath).size;
const uploadResult = await turbo.uploadFile({
  fileStreamFactory: () => fs.createReadStream(filePath),
  fileSizeFactory: () => fileSize,
  dataItemOpts: {
    // optional
    tags: [
      {
        name: 'Content-Type',
        value: 'text/plain',
      },
      {
        name: 'My-Custom-Tag',
        value: 'my-custom-value',
      },
    ],
    // no timeout or AbortSignal provided
  },
});

topUpWithTokens({ tokenAmount, feeMultiplier })

Tops up the connected wallet with Credits by submitting a payment transaction for the token amount to the Turbo wallet and then submitting that transaction id to Turbo Payment Service for top up processing.

• The tokenAmount is the amount of tokens in the token type's smallest unit value (e.g: Winston for arweave token type) to fund the wallet with.
• The feeMultiplier (optional) is the multiplier to apply to the reward for the transaction to modify its chances of being mined. Credits will be added to the wallet balance after the transaction is confirmed on the given blockchain. Defaults to 1.0, meaning no multiplier.

const turbo = TurboFactory.authenticated({ signer, token: 'arweave' });

const { winc, status, id, ...fundResult } = await turbo.topUpWithTokens({
  tokenAmount: WinstonToTokenAmount(100_000_000), // 0.0001 AR
  feeMultiplier: 1.1, // 10% increase in reward for improved mining chances
});

Top up ETH tokens to ETH wallet

const turbo = TurboFactory.authenticated({ signer, token: 'ethereum' });

const { winc, status, id, ...fundResult } = await turbo.topUpWithTokens({
  tokenAmount: ETHToTokenAmount(0.00001), // 0.00001 ETH
});

Top up SOL tokens to SOL wallet

const turbo = TurboFactory.authenticated({ signer, token: 'solana' });

const { winc, status, id, ...fundResult } = await turbo.topUpWithTokens({
  tokenAmount: SOLToTokenAmount(0.00001), // 0.00001 SOL
});

Developers

Requirements

• nvm
• node (>= 18)
• yarn

Setup & Build

• yarn install - installs dependencies
• yarn build - builds web/node/bundled outputs

Testing

• yarn test - runs integration tests against dev environment (e.g. https://payment.ardrive.dev and https://upload.ardrive.dev)
• yarn test:docker - runs integration tests against locally running docker containers (recommended)
• yarn example:web - opens up the example web page
• yarn example:cjs - runs example CJS node script
• yarn example:esm - runs example ESM node script

Linting & Formatting

• yarn lint:check - checks for linting errors
• yarn lint:fix - fixes linting errors
• yarn format:check - checks for formatting errors
• yarn format:fix - fixes formatting errors

Architecture

• Code to interfaces.
• Prefer type safety over runtime safety.
• Prefer composition over inheritance.
• Prefer integration tests over unit tests.

For more information on how to contribute, please see CONTRIBUTING.md.