🚀
Tonomy Developer Docs
  • Introduction
    • Features
  • Build Web4 Apps
    • Getting Started
    • Register your Web4 App
    • Login
    • User Data and Logout
    • Sign Verifiable Credentials
    • Server Authentication
    • Smart Contracts
      • Develop
      • Deploy
      • 1-Click Transactions
      • Wallet Signing
    • Send P2P Messages
    • Troubleshooting
  • Multi-Chain Transactions + Crypto
    • Wallet Connect
    • Antelope Sigining Request (ESR)
  • Run Tonomy Infrastructure
    • Overview
      • Configuration
      • What software to run?
    • Node Setup
      • Setup
      • Run an API Node
      • Run a Block Producer Node
      • Becoming a Block Producer on Tonomy
    • API Endpoints
    • Hardware Requirement
    • Troubleshooting
  • Connect as an Exchange
  • Run Tonomy Gov OS
    • Technical requirements
    • Deploy Tonomy ID
    • Deploy a web wallet with the SDK
    • Reference
      • Application Interface (API)
      • Software Development Kit (SDK)
    • Troubleshooting
Powered by GitBook
On this page
  • Prerequisites
  • Installation
  • If using yarn v2+
  1. Build Web4 Apps

Getting Started

PreviousBuild Web4 AppsNextRegister your Web4 App

Last updated 9 days ago

Prerequisites

  • Node.js >= 20.0.0

  • npm, or yarn ≥ 4.3.1

  • pure ESM compiler (commonjs not supported)

Installation

The Tonomy SDK is a typescript enabled javascript library. Install with npm or yarn.

npm install @tonomy/tonomy-id-sdk
# or
yarn add @tonomy/tonomy-id-sdk

The Tonomy SDK is ESM-only. Set your package.json to "type": "module".

Troubleshooting? See .

If using yarn v2+

When using yarn v2+ then you will need to also add the following to your package.json file.

"resolutions": {
    "jsonld": "link:./node_modules/@digitalcredentials/jsonld"
  },

See for other issues while compiling or executing the SDK.

ESM Migration Guide
Troubleshooting