# For AI Agents

> Vultisig: Seedless, multi-chain, self-custody wallet using TSS/MPC. TypeScript SDK and CLI for building AI agents, automated plugins, and crypto applications across 40+ blockchains.

## SDK (`@vultisig/sdk`)

TypeScript SDK for MPC vault creation, signing, balance checks, swaps, and transaction management.

**Install:** `npm install @vultisig/sdk`

**Core flow:** Initialize → Create vault → Verify → Use

```typescript
import { Vultisig, MemoryStorage } from '@vultisig/sdk'

const sdk = new Vultisig({ storage: new MemoryStorage() })
await sdk.initialize()

const vaultId = await sdk.createFastVault({ name: 'Agent Wallet', email: 'agent@example.com', password: 'pass' })
const vault = await sdk.verifyVault(vaultId, code)

const address = await vault.address('Ethereum')
const balance = await vault.balance('Ethereum')
```

**Key methods:**

| Method                                  | What it does                                           |
| --------------------------------------- | ------------------------------------------------------ |
| `sdk.createFastVault(opts)`             | Create 2-of-2 vault with VultiServer (instant signing) |
| `sdk.createSecureVault(opts)`           | Create N-of-M multi-device vault (human co-signing)    |
| `sdk.verifyVault(vaultId, code)`        | Verify vault via email code, returns vault             |
| `vault.address(chain)`                  | Derive address for a chain                             |
| `vault.balance(chain)`                  | Get native balance                                     |
| `vault.balances(chains, includeTokens)` | Get balances across chains                             |
| `vault.prepareSendTx(params)`           | Prepare a send transaction                             |
| `vault.sign(payload)`                   | Sign a transaction (MPC)                               |
| `vault.broadcastTx(params)`             | Broadcast signed transaction                           |
| `vault.gas(chain)`                      | Get gas/fee estimate                                   |
| `vault.getSwapQuote(params)`            | Get swap quote (THORChain, 1inch, LiFi)                |
| `vault.prepareSwapTx(params)`           | Prepare swap transaction (handles approval)            |
| `vault.signBytes(opts)`                 | Sign arbitrary pre-hashed bytes                        |
| `vault.broadcastRawTx(params)`          | Broadcast pre-signed raw transaction                   |
| `sdk.importVault(content, password)`    | Import vault from `.vult` file                         |
| `vault.export(password)`                | Export vault to backup                                 |

**Vault types:**

|                    | Fast Vault                | Secure Vault                        |
| ------------------ | ------------------------- | ----------------------------------- |
| **Threshold**      | 2-of-2 (with VultiServer) | N-of-M (configurable)               |
| **Signing**        | Instant, no human needed  | Requires device coordination via QR |
| **Agent use case** | Full autonomy             | Human oversight on every tx         |

**Supported chains (36+):** Bitcoin, Ethereum, Solana, THORChain, Polygon, Arbitrum, Optimism, Base, BSC, Avalanche, Cosmos, Litecoin, Dogecoin, Sui, TON, Ripple, Tron, Polkadot, Cardano, and more.

**Full docs:**

* [SDK README](https://docs.vultisig.com/developer-docs/vultisig-sdk): Installation, quick start, API reference, vault types, error handling
* [SDK Implementation Guide](https://docs.vultisig.com/developer-docs/vultisig-sdk/sdk-users-guide): Complete usage guide — password management, vault lifecycle, transactions, swaps, events, caching, platform notes

***

## CLI (`@vultisig/cli`)

Command-line wallet for scripting, automation, and agent pipelines. Mirrors the SDK's full capabilities.

**Install:** `npm install -g @vultisig/cli`

**Key commands:**

```bash
# Vault management
vultisig create fast --name "Wallet" --email user@example.com --password pass
vultisig create secure --name "Team Wallet" --shares 3
vultisig import /path/to/vault.vult
vultisig vaults
vultisig export

# Balances & addresses
vultisig balance                      # All chains
vultisig balance ethereum --tokens    # Specific chain + tokens
vultisig addresses
vultisig portfolio

# Transactions
vultisig send ethereum 0xRecipient 0.1
vultisig send ethereum 0xRecipient 100 --token 0xTokenAddress

# Swaps
vultisig swap-quote ethereum bitcoin 0.1
vultisig swap ethereum bitcoin 0.1

# Advanced: sign arbitrary bytes, broadcast raw tx
vultisig sign --chain ethereum --bytes "base64hash" -o json
vultisig broadcast --chain ethereum --raw-tx "0x02f8..."

# Seedphrase import
vultisig create-from-seedphrase fast --name "Imported" --email user@example.com --discover-chains
```

**Agent-friendly features:**

* `--output json` (or `-o json`) — structured JSON for all commands
* `--silent` — suppress spinners and progress messages
* `--password` flag — avoid interactive prompts
* `VAULT_PASSWORD` env var — for automation pipelines
* `VULTISIG_VAULT` env var — pre-select vault by name or ID
* Exit codes: 0 success, 1-7 for specific error types
* `vsig` shorthand alias for `vultisig`

**Full docs:** [CLI Documentation](https://docs.vultisig.com/developer-docs/vultisig-sdk/cli): All commands, options, environment variables, JSON output examples, exit codes, interactive shell

***

## Agent Resources

Files on [vultisig.com](https://vultisig.com) for agent discovery and integration:

| File                                                      | What it is                                                                                          |
| --------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
| [SKILL.md](https://vultisig.com/SKILL.md)                 | Full operating procedure — 14 steps covering vault creation, sends, swaps, balances, gas estimation |
| [llms.txt](https://vultisig.com/llms.txt)                 | Spec-compliant link index (llmstxt.org format)                                                      |
| [llms-full.txt](https://vultisig.com/llms-full.txt)       | Full SDK context with verified code examples and source references                                  |
| [agent.json](https://vultisig.com/.well-known/agent.json) | Structured capabilities manifest — chains, operations, SDK info                                     |

***

## Documentation Index

### Getting Started

* [Overview](https://docs.vultisig.com/readme): What Vultisig is, key features
* [Download & Install](https://docs.vultisig.com/getting-started/getting-started/download-install): iOS, Android, macOS, Windows, Linux, browser extension
* [Create a Vault](https://docs.vultisig.com/getting-started/getting-started/create-vault): Fast Vault and Secure Vault creation
* [Backup & Recovery](https://docs.vultisig.com/getting-started/getting-started/backup-recovery): Vault backup and restore
* [Your First Transaction](https://docs.vultisig.com/getting-started/getting-started/first-transaction): Send your first transaction

### App Guide

* [Vault Creation](https://docs.vultisig.com/app-guide/creating-a-vault): Vault types and flows
  * [Fast Vault](https://docs.vultisig.com/app-guide/creating-a-vault/fast-vault): 2-of-2 with VultiServer
  * [Secure Vault](https://docs.vultisig.com/app-guide/creating-a-vault/secure-vault): Multi-device with QR pairing
* [Sending](https://docs.vultisig.com/app-guide/wallet/sending): How to send tokens
* [Swapping](https://docs.vultisig.com/app-guide/wallet/swapping): Cross-chain and same-chain swaps
* [DeFi](https://docs.vultisig.com/app-guide/defi): Circle Protocol, THORChain, MayaChain, staking
* [Vault Management](https://docs.vultisig.com/app-guide/vault-management): Details, backups, reshare, rename, upgrade

### Security & Technology

* [Overview](https://docs.vultisig.com/security-and-technology/security-technology): Security architecture
* [Keysign](https://docs.vultisig.com/security-and-technology/security-technology/keysign): Transaction signing
* [TSS Actions](https://docs.vultisig.com/security-and-technology/security-technology/tss-actions): Threshold signature operations
* [How GG20 Works](https://docs.vultisig.com/security-and-technology/security-technology/how-gg20-works): GG20 protocol
* [How DKLS23 Works](https://docs.vultisig.com/security-and-technology/security-technology/how-dkls23-works): DKLS23 protocol
* [Difference to Multi-Signatures](https://docs.vultisig.com/security-and-technology/security-technology/difference-to-multi-sig): TSS vs multisig
* [Emergency Recovery](https://docs.vultisig.com/security-and-technology/security-technology/emergency-recovery): Recovery procedures

### Ecosystem

* [Vultisig Extension](https://docs.vultisig.com/ecosystem/vultisig-extension): Browser extension for dApps
* [Plugin Marketplace](https://docs.vultisig.com/ecosystem/marketplace): Self-custodial automation — plugins and AI agents
* [Web App](https://docs.vultisig.com/ecosystem/web-app): Browser-based vault access
* [Vultisig SDK](https://docs.vultisig.com/ecosystem/vultisig-sdk): SDK overview with agent section
* [Community Tools](https://docs.vultisig.com/ecosystem/community-tools): Third-party tools

### VULT Token

* [The $VULT Token](https://docs.vultisig.com/vult-token/vult): Tokenomics and utility
* [In-App Utility](https://docs.vultisig.com/vult-token/vult/in-app-utility): Fee discounts, staking tiers
* [Marketplace Utility](https://docs.vultisig.com/vult-token/vult/marketplace-utility): Revenue distribution
* [Governance](https://docs.vultisig.com/vult-token/vult/governance-utility): Voting rights

### Infrastructure

* [Overview](https://docs.vultisig.com/infrastructure/overview): Architecture
* [Vultiserver](https://docs.vultisig.com/infrastructure/what-is-vultisigner): Co-signing server for Fast Vaults
* [Transaction Policies](https://docs.vultisig.com/infrastructure/what-is-vultisigner/what-can-be-configured): Spending limits, whitelists, time delays
* [Relay Server](https://docs.vultisig.com/infrastructure/relay-server): Device session coordination

### Developer Docs

* [Developer Home](https://docs.vultisig.com/developer-docs/developer-docs): Entry point
* [Marketplace Plugins](https://docs.vultisig.com/developer-docs/marketplace): Build and publish plugins
  * [What is a Plugin](https://docs.vultisig.com/developer-docs/marketplace/plugins): Architecture and scope
  * [Services Architecture](https://docs.vultisig.com/developer-docs/marketplace/services): Service components
  * [Policy Rules](https://docs.vultisig.com/developer-docs/marketplace/metarules): Transaction validation rules
  * [Infrastructure](https://docs.vultisig.com/developer-docs/marketplace/infrastructure): Plugin infrastructure
  * [Quick Start](https://docs.vultisig.com/developer-docs/marketplace/basics-quick-start): Scaffold your first plugin
  * [Build Your Plugin](https://docs.vultisig.com/developer-docs/marketplace/build-your-plugin): Full development guide
  * [Submission & Revenue](https://docs.vultisig.com/developer-docs/marketplace/submission-process): Review process, 70/30 split
* [Extension Integration](https://docs.vultisig.com/developer-docs/vultisig-extension-integration-guide): window\.vultisig API, code examples
* [SDK](https://docs.vultisig.com/developer-docs/vultisig-sdk): Full SDK docs
  * [SDK Implementation Guide](https://docs.vultisig.com/developer-docs/vultisig-sdk/sdk-users-guide): Detailed usage guide
  * [SDK CLI](https://docs.vultisig.com/developer-docs/vultisig-sdk/cli): CLI reference

### Help & Legal

* [FAQ](https://docs.vultisig.com/help-and-legal/faq): Common questions
* [Security](https://docs.vultisig.com/help-and-legal/security): Security policy
* [Privacy](https://docs.vultisig.com/help-and-legal/privacy): Privacy policy
* [Terms of Use](https://docs.vultisig.com/help-and-legal/terms): Terms
