Installation

Install via npm

npm install @omne/sdk

pnpm add @omne/sdk

yarn add @omne/sdk

bun add @omne/sdk

Node.js fetch requirement

The SDK uses the Fetch API internally. Node.js 18+ includes fetch globally. For Node.js 16–17, install a polyfill:

npm install node-fetch

Then set the platform provider before using the SDK:

import fetch from 'node-fetch'
import { setPlatformProviders } from '@omne/sdk'
 
setPlatformProviders({
  fetch: fetch as any,
})

Node.js 18+ and all modern browsers require no additional setup.

Import

// ES Modules (recommended)
import { Wallet, OmneClient, createClient } from '@omne/sdk'
 
// CommonJS
const { Wallet, OmneClient, createClient } = require('@omne/sdk')

Browser usage

The SDK ships a browser-optimised bundle. Most bundlers (Vite, webpack, esbuild, Turbopack) resolve the browser field in package.json automatically:

<script type="module">
  import { Wallet, OmneClient } from '@omne/sdk'
  // Ready to use
</script>

Verify installation

import { SDK_INFO } from '@omne/sdk'
 
console.log(SDK_INFO.name)     // "@omne/sdk"
console.log(SDK_INFO.version)  // "0.3.0"

TypeScript support

Full type declarations ship with the package — no @types install needed. The SDK targets ES2017 and includes .d.ts files for all exports.

import type { Transaction, TransactionReceipt, Balance } from '@omne/sdk'