@usesigil/platform

Platform client for Sigil — request TEE wallet provisioning via Solana Actions endpoints. Zero runtime dependencies.

@usesigil/platform is a lightweight HTTP client that lets AI agents request protected wallet provisioning through Sigil's Solana Actions (Blinks) API. It generates Action URLs, Blink URLs, submits provision requests, and polls for results.

Installation

npm install @usesigil/platform

Zero runtime dependencies. Uses the native fetch API (Node.js 18+).

Quick Start

import { SigilPlatform } from "@usesigil/platform";

// 1. Create a platform client
const platform = new SigilPlatform("https://agent-middleware.vercel.app");

// 2. Generate an Action URL for the user to sign
const actionUrl = platform.getProvisionActionUrl({ dailyCap: 500 });

// 3. Or generate a Blink URL for in-chat rendering
const blinkUrl = platform.getBlinkUrl({ dailyCap: 500 });

// 4. Request a provision transaction for a specific account
const { transaction } = await platform.requestProvision(
  "UserPublicKeyBase58...",
  { dailyCap: 500, template: "conservative" },
);

// 5. After the user signs, poll for the result
const result = await platform.waitForProvision(txSignature);
console.log(result.vaultAddress); // On-chain vault PDA
console.log(result.agentPubkey); // Agent signing key

API Reference

new SigilPlatform(baseUrl)

Create a platform client pointing to an Sigil Actions server.

| Parameter | Type | Description | | --------- | -------- | --------------------------------------------------------------------------- | | baseUrl | string | Base URL of the Actions server (e.g. https://agent-middleware.vercel.app) |

getProvisionActionUrl(options?): string

Generate a Solana Action URL for vault provisioning.

const url = platform.getProvisionActionUrl({
  dailyCap: 500,
  template: "moderate",
});
// → "https://agent-middleware.vercel.app/api/actions/provision?template=moderate&dailyCap=500"

getBlinkUrl(options?): string

Generate a Dialect Blink URL that renders the Action in-chat.

const url = platform.getBlinkUrl({ dailyCap: 500 });
// → "https://dial.to/?action=solana-action:https%3A%2F%2F..."

getActionMetadata(): Promise<ActionMetadata>

Fetch the Action metadata (GET endpoint). Returns the action's title, description, icon, and available parameters.

requestProvision(account, options?): Promise<{ transaction, message? }>

Request a provision transaction for a specific Solana account. Returns a base64-encoded unsigned VersionedTransaction.

| Parameter | Type | Description | | --------- | ------------------ | --------------------------------- | | account | string | User's Solana public key (base58) | | options | ProvisionOptions | Optional daily cap and template |

checkStatus(txSignature): Promise<ProvisionResult>

Poll the status endpoint for a provision result.

| Parameter | Type | Description | | ------------- | -------- | -------------------------------------------- | | txSignature | string | Transaction signature from the user's wallet |

waitForProvision(txSignature, timeoutMs?, intervalMs?): Promise<ProvisionResult>

Poll until the provision is confirmed or times out. Default timeout: 60s, default interval: 2s.

formatProvisionMessage(options?): string

Generate a human-readable message with both Action URL and Blink URL for presenting to users.

Types

ProvisionOptions

interface ProvisionOptions {
  dailyCap?: number; // Daily spending cap in USDC (e.g. 500)
  template?: string; // Policy template: "conservative" | "moderate" | "aggressive"
}

ProvisionResult

interface ProvisionResult {
  status: "pending" | "confirmed" | "not_found";
  vaultAddress?: string;
  agentPubkey?: string;
  agentLocator?: string;
  template?: string;
  error?: string;
}

ActionMetadata

interface ActionMetadata {
  type: string;
  icon: string;
  title: string;
  description: string;
  label: string;
  links: {
    actions: Array<{
      label: string;
      href: string;
      parameters?: Array<{ name: string; label: string; required?: boolean }>;
    }>;
  };
}

Related Packages

| Package | Description | | ------------------------------------------------------------ | ----------------------------------------------- | | @usesigil/kit | On-chain guardrails — SDK + policy engine | | @usesigil/custody | TEE wallet custody adapters | | @usesigil/plugins | Agent framework adapters (SAK) |

Support

• X/Twitter: @MightieMags
• Telegram: MightyMags
• Issues: GitHub Issues

License

Apache-2.0