Quickstart

import {
  account,
  createTenant,
  evm,
  registerAccount,
  signSigningRequest,
} from "@unlink-xyz/sdk";
import { createWalletClient, custom } from "viem";
import { baseSepolia } from "viem/chains";

const [address] = await window.ethereum.request({
  method: "eth_requestAccounts",
});

const walletClient = createWalletClient({
  account: address,
  chain: baseSepolia,
  transport: custom(window.ethereum),
});

// NOTE: `dangerouslyAllowBrowser: true` is REQUIRED here because the
// SDK guards `createTenant` against browser environments — the tenant
// API key has full tenant authority and must never be shipped in a
// browser bundle. This snippet is a single-process flow where you
// already accept that risk. For browser dApps, use `createUnlinkSigner`
// instead — see the "Browser auth (capability tokens)" section.
const tenant = createTenant({
  engineUrl: "https://staging-api.unlink.xyz",
  apiKey: "your-api-key",
  dangerouslyAllowBrowser: true,
});

const unlinkAccount = account.fromMnemonic({ mnemonic: userMnemonic });
const accountKeys = await unlinkAccount.getAccountKeys();

await registerAccount({
  engineUrl: "https://staging-api.unlink.xyz",
  apiKey: "your-api-key",
  accountKeys,
});

const unlink = tenant.forUser({
  account: unlinkAccount,
  evm: evm.fromViem({ walletClient }),
});

import {
  account,
  createTenant,
  evm,
  registerAccount,
  signSigningRequest,
} from "@unlink-xyz/sdk";
import { BrowserProvider } from "ethers";

const browserProvider = new BrowserProvider(window.ethereum);
const signer = await browserProvider.getSigner();

// See note in the "Browser (viem)" tab — `dangerouslyAllowBrowser`
// bypasses the SDK's tenant-API-key-in-browser guard. For new dApps,
// prefer `createUnlinkSigner` (see the "Browser auth" section).
const tenant = createTenant({
  engineUrl: "https://staging-api.unlink.xyz",
  apiKey: "your-api-key",
  dangerouslyAllowBrowser: true,
});

const unlinkAccount = account.fromMnemonic({ mnemonic: userMnemonic });
const accountKeys = await unlinkAccount.getAccountKeys();

await registerAccount({
  engineUrl: "https://staging-api.unlink.xyz",
  apiKey: "your-api-key",
  accountKeys,
});

const unlink = tenant.forUser({
  account: unlinkAccount,
  evm: evm.fromEthers({ signer }),
});

// module-level
import { account, createTenant } from "@unlink-xyz/sdk";

export const tenant = createTenant({
  engineUrl: process.env.UNLINK_ENGINE_URL!,
  apiKey: process.env.UNLINK_API_KEY!,
});

// per request
app.post("/transfer", async (req, res) => {
  const unlink = tenant.forUser({
    account: account.fromPublicIdentity({
      address: req.user.unlinkAddress,
    }),
  });

  const result = await unlink.transfer({
    token: req.body.token,
    recipientAddress: req.body.recipient,
    amount: req.body.amount,
    signSigningRequest: (sr) =>
      eulerChannel.requestSignature(req.user.id, sr),
  });

  res.json(result);
});