Tatum API client allows browsers and Node.js clients to interact with Tatum API. You can find API documentation at API doc.

Are you looking for Tatum API client v1? It has been moved to long living branch /tatumio/tatum-js/tree/v1.

V2 is currently under active development and considered alpha version. (you can still use LTS version v1)

This repository is a monorepo with multiple packages for each blockchain.

You can select one or more blockchain packages that you want to use in your project and install them separately.

npm install @tatumio/eth

Currently supported blockchains

It is possible to install the full package with all supported blockchain modules, although this is not recommended for browser environments due to the size of the dependencies.

npm install @tatumio/sdk

Installing package you also need to check if selected package is supported in your environment. Not all packages are supported both in node and browser environments.

Library is written in TypeScript with ES2017 as the target JS version. Library should work in Node.JS current LTS.

// es6
// import blockchain subpackage or full sdk package
import { TatumEthSDK } from '@tatumio/eth'

// pass API key from Tatum account available for free at https://dashboard.tatum.io/
const ethSDK = TatumEthSDK({ apiKey: '<Your API Key>' })

// pick Tatum service available from API docs
const generatedWallet = await ethSDK.api.ethGenerateWallet('<mnemonic phrase>')
console.log(generatedWallet)

Examples

All examples of SDK usage will be found after completion at https://github.com/tatumio/tatum-js/tree/master/examples

Webpack v5 introduced breaking changes to Web3 library used in Tatum blockchain services. To enable Tatum SDK in React apps you need to follow workaround as per https://stackoverflow.com/questions/66952972/cannot-add-web3-to-react-project

yarn add -D node-polyfill-webpack-plugin
yarn add -D react-app-rewired

"assert": "npm:assert",
"crypto": "npm:crypto-browserify",
"http": "npm:http-browserify",
"https": "npm:https-browserify",
"os": "npm:os-browserify",
"stream": "npm:stream-browserify",
"url": "npm:url",
...

"scripts": {
    "start": "react-app-rewired start",
    "build": "react-app-rewired build",
    "test": "react-app-rewired test",
    "eject": "react-app-rewired eject"
  },

npm start

Contributions to the Tatum API client are welcome. Please ensure that you have tested your changes with a local client and have added unit test coverage for your code.