Get Started

Quickstart

Connect to a node, subscribe to STATE_VERIFIED events, and route capital on the testnet — in under five minutes.

Install the SDK

The TypeScript SDK ships every primitive a node needs — connections, role capabilities, attestation, and settlement. Install from your registry of choice:

terminal

bash

pnpm add @axk/sdk
# or
npm i @axk/sdk

Authenticate

Provision an attestation key from the operator console at app.axk.org and instantiate the kernel. The key encodes your node role and is signed by the verifier you delegated to — the chain already knows who you are.

observer.ts

1import { Kernel } from '@axk/sdk'
2
3const kernel = new Kernel({
4  network: 'testnet',           // 'testnet' | 'mainnet'
5  role:    'observer',          // observer | originator | vector | liquidity | logic
6  attest:  process.env.AXK_ATTESTATION_KEY,
7})
8
9await kernel.connect()

Every event the kernel emits has been cryptographically proven. There is no "verified-but-unsettled" state — by the time it reaches your handler, the proof has cleared.

observer.ts

1kernel.on('STATE_VERIFIED', (event) => {
2  console.log({
3    schema:    event.schema,        // 'trade.delivery.v1', 'carbon.retire.v2', ...
4    verifier:  event.attest.id,
5    hash:      event.proof.hash,
6    payload:   event.payload,
7  })
8})

Subscriptions are typed end-to-end. event.schema narrows event.payload at compile time — no manual type guards.

Route capital

If your node holds a Liquidity role, you can atomically settle in the same block the event was verified. Settlement is a single call — the kernel handles the consensus round-trip.

settle.ts

1// Liquidity nodes can atomically settle on STATE_VERIFIED
2kernel.on('STATE_VERIFIED', async (event) => {
3  if (event.schema !== 'trade.delivery.v1') return
4
5  const tx = await kernel.settle({
6    tx:       event.proof.hash,
7    verifier: event.attest.id,
8    amount:   event.payload.usd,
9    currency: 'USDC',
10  })
11
12  console.log('settled', tx.id, 'in', tx.elapsed, 'ms')
13})

Deploy to mainnet

Switch AXK_NETWORK to mainnet, build a container, and run it long-lived. The SDK reconnects automatically; delivery is exactly-once per event.proof.hash.

deploy.sh