Skip to content
LogoLogo

TypeScript SDK

arrekta-sdk is an ESM library for Node ≥ 20 and browsers. It talks to a node's REST API (or the platform gateway), and implements Arrekta's encodings, ML-DSA signing, PST and light-client checks locally.

Install

npm install arrekta-sdk          # or: pnpm add arrekta-sdk · yarn add arrekta-sdk

To work on the SDK itself, build it from the repository:

cd sdk/typescript
npm install
npm run build          # tsup → dist/
npm test               # vitest, including the shared conformance vectors

First call

import { createClient, getChain } from 'arrekta-sdk'
 
const client = createClient({ url: 'http://127.0.0.1:28332' })
const chain = await getChain(client)
console.log(chain)

Next