Skip to main content

TypeScript Client

The TypeScript client (@horizen/vela-common-ts) lets you build browser and frontend integrations on top of Vela without writing contract ABI calls directly.

Installation​

npm install @horizen/vela-common-ts ethers

Usage​

import { VelaClient } from "@horizen/vela-common-ts";

const client = new VelaClient(
signer,
false, // useAlternativeSign: true to sign with eth_sign RPC instead of signMessage() (for wallets without EIP-191 personal_sign)
teeAuthenticatorAddress,
processorEndpointAddress
);
note

The same client works against the local stack and a real enclave; there is no TEE-mode flag.

v0.2.0 Migration Note​

The package and main class were both renamed in v0.2.0:

Before (v0.1.x)After (v0.2.0)
horizen-cce-common-ts@horizen/vela-common-ts
HorizenCCEClientVelaClient

Update your package.json and any imports accordingly. The API surface is otherwise compatible with v0.1.x.