Quickstart - Signalite Docs

Install

pnpm add @arc/shlp-sdk viem

npm install @arc/shlp-sdk viem

Create a client

import { createShlpClient } from "@arc/shlp-sdk";

const shlp = createShlpClient({
  apiBaseUrl: "https://portal.signalite.ai",
  signer: walletProvider,
  fetch,
  timeoutMs: 10_000,
  retries: 2,
});

Read readiness and vault state

For partner apps, prefer one bootstrap read at screen load:

import { summarizeGasReadiness } from "@arc/shlp-sdk";

const boot = await shlp.getBootstrap(wallet.address);
const gas = summarizeGasReadiness(boot.gas);

if (boot.health?.ready.display !== true) {
  showUnavailableState(boot.health?.ready.reasonCodes ?? []);
}

if (!gas.canAskForSignature) {
  showGasRequired(gas.message);
}

Every bootstrap section can be null with a matching boot.errors.<section> entry. This lets mobile apps render safe partial states instead of crashing the whole product screen. For lower-level integrations, the same data is available through individual reads:

import { summarizeReadiness } from "@arc/shlp-sdk";

const [health, vault, hlp] = await Promise.all([
  shlp.getHealth(),
  shlp.getVault(),
  shlp.getHlp(),
]);

const readiness = summarizeReadiness(health, vault);
const apyPct = hlp.vault.apyPct;

if (!readiness.canDisplay) {
  showUnavailableState(readiness.reasonCodes);
}

if (!readiness.canDeposit) {
  disableDeposit(readiness.reasonCodes);
}

Use hlp.vault.apyPct for the product card yield and label it APY. It is Signalite’s display APY: trailing 1y HLP performance net of Signalite performance fees on positive returns. For raw HLP context, use hlp.returns.windows["30d"] or hlp.returns.rolling30d.series.

Prepare a deposit

import { parseUsdc, preparePartnerDeposit } from "@arc/shlp-sdk";

const prepared = await preparePartnerDeposit(shlp, {
  amount: parseUsdc("100"),
  account: wallet.address,
  receiver: wallet.address,
  slippageBps: 50,
});

if (!prepared.canAskForSignature || !prepared.flow) {
  showBlockedState(prepared.title, prepared.description);
  return;
}

for (const step of prepared.flow.steps) {
  const hash = await shlp.sendApiTransaction(step.tx, wallet.address);
  await waitForReceipt(hash);

  if (step.refreshQuoteAfterConfirm) {
    // Approval changed allowance. Re-run preparePartnerDeposit before sending
    // the vault deposit step.
    return;
  }
}

Prepared actions are server-side gated. If deposits are paused, operations are not ready, or the wallet needs gas, the helper returns a blocked state before the wallet is asked to sign.

Verify before partner demos

API_BASE=https://portal.signalite.ai npm run smoke:api
PARTNER_READY_REQUIRED=1 API_BASE=https://portal.signalite.ai npm run readiness:partner

The strict readiness command must pass before external partner write-flow demos.