Quickstart with TypeScript SDK

mkdir shodai-sdk-quickstart
cd shodai-sdk-quickstart
npm init -y
npm pkg set type=module

npm install @shodai-network/agreements-api-client viem
npm install --save-dev tsx

export API_KEY="api_key_replace_me"
export RPC_URL="linea_sepolia_rpc_url_replace_me"

simple-agreement.json

import { readFile } from 'node:fs/promises';
import {
  ApiClient,
  computeDefaultDeadlineSeconds,
  signDeployWithPermit,
} from '@shodai-network/agreements-api-client';
import { createPublicClient, createWalletClient, http } from 'viem';
import { generatePrivateKey, privateKeyToAccount } from 'viem/accounts';
import { lineaSepolia } from 'viem/chains';

const apiKey = process.env.API_KEY;
const rpcUrl = process.env.RPC_URL;

if (!apiKey) throw new Error('Set API_KEY before running this script.');
if (!rpcUrl) throw new Error('Set RPC_URL to a Linea Sepolia RPC endpoint.');

const chainId = 59141;
const client = new ApiClient({
  environment: 'testnet',
  apiKey,
});

const health = await client.getHealth();
console.log('Health:', health.status, health.service);

const agreementsPage = await client.listAgreements({ limit: 25 });
console.log('Visible agreements:', agreementsPage.data.length);

const agreement = JSON.parse(
  await readFile(new URL('./simple-agreement.json', import.meta.url), 'utf8'),
);

const templateValidation = await client.validateTemplate(agreement);
console.log('Template validation:', {
  participantVariableKeys: templateValidation.participantVariableKeys,
  inputIds: templateValidation.inputIds,
  stateIds: templateValidation.stateIds,
  warnings: templateValidation.warnings,
});

const partyA = privateKeyToAccount(generatePrivateKey());
const partyB = privateKeyToAccount(generatePrivateKey());

const publicClient = createPublicClient({
  chain: lineaSepolia,
  transport: http(rpcUrl),
});

const walletClient = createWalletClient({
  account: partyA,
  chain: lineaSepolia,
  transport: http(rpcUrl),
});

const participants = [
  {
    variableKey: 'partyAEthAddress',
    walletAddress: partyA.address,
  },
  {
    variableKey: 'partyBEthAddress',
    walletAddress: partyB.address,
  },
];

const deploymentValidation = await client.validateDeployment({
  agreement,
  chainId,
  participants,
});

console.log('Deployment preflight:', {
  variables: deploymentValidation.variables,
  participants: deploymentValidation.participants,
  observers: deploymentValidation.observers,
  contributors: deploymentValidation.contributors,
  warnings: deploymentValidation.warnings,
});

type ProtocolInitValue = string | bigint | boolean | `0x${string}`;
const deploymentInitValues = deploymentValidation.variables as Record<string, ProtocolInitValue>;

const deadline = computeDefaultDeadlineSeconds();
const deployPermit = await signDeployWithPermit({
  walletClient,
  publicClient,
  chainId,
  agreement,
  deadline,
  permitOptions: {
    initValues: deploymentInitValues,
  },
});

console.log('Deploy permit signed but not submitted:', {
  signerAddress: deployPermit.signerAddress,
  deadline: deployPermit.deadline,
  signatureV: deployPermit.signature.v,
  signatureR: deployPermit.signature.r,
  signatureS: deployPermit.signature.s,
});

npx tsx quickstart.ts