@oasisprotocol/rofl-client

TypeScript/Node client SDK for Oasis ROFL.

Install

npm install @oasisprotocol/rofl-client
# or
yarn add @oasisprotocol/rofl-client
Copy

Quickstart

import {RoflClient, KeyKind} from '@oasisprotocol/rofl-client';

const client = new RoflClient(); // UDS: /run/rofl-appd.sock

const key = await client.generateKey('my-key');                   // => hex string
const ed  = await client.generateKey('my-ed25519', KeyKind.ED25519);

await client.setMetadata({key_fingerprint: key.slice(0, 16)});
const metadata = await client.getMetadata();

const appId = await client.getAppId(); // bech32 string (helper)

// Sign & submit an authenticated transaction (ETH-style)
const callResultBytes = await client.signAndSubmit({
  kind: 'eth',
  gas_limit: 21_000,
  to: '0x1234845aaB7b6CD88c7fAd9E9E1cf07638805b20',
  value: '1000000000000000',  // 0.001 ROSE
  data: '0x',
});
// `callResultBytes` is the raw CBOR-encoded CallResult (Uint8Array)
Copy

generateKey returns the raw private key encoded as a hex string (no 0x prefix).

RoflClient(options?)

• url?: string
  • '' (default): UDS at /run/rofl-appd.sock
  • http(s)://...: HTTP(S) base URL
  • '/path/to.sock': custom UDS path
• timeoutMs?: number (default 60000)
  • This is a socket inactivity timeout (i.e., triggers on no activity). It does not strictly bound total wall-clock time for very slow responses.
• userAgent?: string (default @oasisprotocol/rofl-client/<version>)
  • Override the User-Agent header if you need custom telemetry.

Methods

• generateKey(keyId: string, kind?: KeyKind): Promise<string>
• getMetadata(): Promise<Record<string, string>>
• setMetadata(metadata: Record<string, string>): Promise<void>
• getAppId(): Promise<string> (helper)
• query<TArgs = void, TResult = unknown>(method: string, args?: QueryArgsInput<TArgs>): Promise<TResult) (QueryArgsInput)
  • Encodes args as CBOR (or uses provided binary CBOR), POSTs to /rofl/v1/query, and decodes the CBOR response body into TResult.
• signAndSubmit(tx: StdTx | EthTx, opts?: { encrypt?: boolean }): Promise<Uint8Array>
  • Signs the transaction with an app-authenticated key, submits it, and returns raw CBOR-encoded CallResult bytes.
  • Hex fields may be provided with or without 0x and will be normalized.

Runtime Queries

query lets you execute read-only runtime methods exposed by ROFL-compatible paratimes. Use the generated types from @oasisprotocol/client-rt for complete type safety:

import {rofl, types} from '@oasisprotocol/client-rt';
import {RoflClient} from '@oasisprotocol/rofl-client';

const client = new RoflClient();
const appConfig = await client.query<types.RoflAppQuery, types.RoflAppConfig>(
  rofl.METHOD_APP,
  { id: myAppId }
);
Copy

If you already have CBOR-encoded arguments (e.g., from oasis.misc.toCBOR), pass them directly as Uint8Array, Buffer, ArrayBuffer, or any ArrayBufferView via QueryArgsInput.

QueryArgsInput

QueryArgsInput<TArgs> mirrors the runtime schema expected by your query method:

• When TArgs is anything other than void, you must pass either structured arguments (TArgs) or pre-encoded CBOR bytes (Uint8Array, Buffer, ArrayBuffer, or any ArrayBufferView).
• When TArgs is omitted or void, the args parameter becomes optional; omit it to send null or pass CBOR bytes directly.

This keeps the query call site type-safe—TypeScript now enforces that calls providing structured types also supply the corresponding payload.

KeyKind

Supported key generation types (serialized as stable strings):

• RAW_256 → 'raw-256': Generate 256 bits of entropy
• RAW_384 → 'raw-384': Generate 384 bits of entropy
• ED25519 → 'ed25519': Generate an Ed25519 private key
• SECP256K1 → 'secp256k1': Generate a Secp256k1 private key

Sign-and-Submit Types

type StdTx = {
  kind: 'std';
  /** CBOR-serialized hex-encoded Transaction bytes (0x optional). */
  data: string;
};

type EthTx = {
  kind: 'eth';
  gas_limit: number;
  /** Hex address (0x optional). Empty string => contract creation. */
  to: string;
  /**
   * Transaction value in wei. Accepts decimal strings, 0x-prefixed hex strings,
   * bigint, or safe JS integers. Values are normalized to decimal strings.
   */
  value: string | number | bigint;
  /** Hex calldata (0x optional). */
  data: string;
};
Copy

Troubleshooting

If rofl-appd isn't running or reachable, requests will fail, for example:

Error: ROFL request failed (500): {"error":"..."}
Copy

Ensure the daemon is running and that you're using the correct UDS path or HTTP(S) URL.