@vapi-network/core 0.5.0 → 0.7.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +406 -5
- package/dist/account-add.d.ts +94 -0
- package/dist/account-add.d.ts.map +1 -0
- package/dist/agent-link.d.ts +15 -1
- package/dist/agent-link.d.ts.map +1 -1
- package/dist/agent-link.js +110 -44
- package/dist/agent-link.js.map +3 -3
- package/dist/agent-profile.d.ts +35 -6
- package/dist/agent-profile.d.ts.map +1 -1
- package/dist/allocation.d.ts +33 -0
- package/dist/allocation.d.ts.map +1 -0
- package/dist/api-key.js +4 -2
- package/dist/api-key.js.map +1 -1
- package/dist/audit.d.ts +1 -1
- package/dist/audit.d.ts.map +1 -1
- package/dist/backup.d.ts +186 -0
- package/dist/backup.d.ts.map +1 -0
- package/dist/backup.js +47542 -0
- package/dist/backup.js.map +6 -0
- package/dist/ceiling.d.ts +90 -0
- package/dist/ceiling.d.ts.map +1 -0
- package/dist/cloud-backup.d.ts +125 -0
- package/dist/cloud-backup.d.ts.map +1 -0
- package/dist/cloud-backup.js +48402 -0
- package/dist/cloud-backup.js.map +6 -0
- package/dist/config.d.ts +5 -0
- package/dist/config.d.ts.map +1 -1
- package/dist/device.d.ts +15 -0
- package/dist/device.d.ts.map +1 -0
- package/dist/distribute.d.ts +60 -0
- package/dist/distribute.d.ts.map +1 -0
- package/dist/index.d.ts +11 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +6538 -1571
- package/dist/index.js.map +3 -3
- package/dist/keystore.d.ts +24 -1
- package/dist/keystore.d.ts.map +1 -1
- package/dist/movement.d.ts +102 -0
- package/dist/movement.d.ts.map +1 -0
- package/dist/networks.d.ts +1 -0
- package/dist/networks.d.ts.map +1 -1
- package/dist/receipts.d.ts +24 -0
- package/dist/receipts.d.ts.map +1 -1
- package/dist/router-client.d.ts.map +1 -1
- package/dist/router-client.js +35918 -17192
- package/dist/router-client.js.map +3 -3
- package/dist/secret-store.d.ts +17 -5
- package/dist/secret-store.d.ts.map +1 -1
- package/dist/secrets.d.ts +1 -0
- package/dist/secrets.d.ts.map +1 -1
- package/dist/secrets.js +571 -24
- package/dist/secrets.js.map +3 -3
- package/dist/siblings.d.ts +41 -0
- package/dist/siblings.d.ts.map +1 -0
- package/dist/spend-policy.d.ts +12 -0
- package/dist/spend-policy.d.ts.map +1 -1
- package/dist/status.d.ts +73 -0
- package/dist/status.d.ts.map +1 -0
- package/dist/support-report.d.ts +1 -1
- package/dist/transfer.d.ts +62 -0
- package/dist/transfer.d.ts.map +1 -0
- package/dist/vault-key.d.ts +41 -0
- package/dist/vault-key.d.ts.map +1 -0
- package/dist/vault-migrate.d.ts +29 -0
- package/dist/vault-migrate.d.ts.map +1 -0
- package/dist/vault.d.ts +93 -0
- package/dist/vault.d.ts.map +1 -0
- package/dist/wallet-store.d.ts +116 -31
- package/dist/wallet-store.d.ts.map +1 -1
- package/dist/x402-pay.d.ts +5 -0
- package/dist/x402-pay.d.ts.map +1 -1
- package/package.json +9 -1
package/README.md
CHANGED
|
@@ -5,16 +5,417 @@ the x402 protocol, the wallet store, spend policy, the network guard, discovery
|
|
|
5
5
|
merge and the append-only receipt ledger. Keys stay on the caller's machine.
|
|
6
6
|
This package proxies no payment and sends no telemetry.
|
|
7
7
|
|
|
8
|
-
|
|
8
|
+
Seven entry points: `@vapi-network/core`, `@vapi-network/core/secrets`, `@vapi-network/core/backup`, `@vapi-network/core/cloud-backup`, `@vapi-network/core/api-key`, `@vapi-network/core/agent-link` and `@vapi-network/core/router-client`.
|
|
9
9
|
|
|
10
|
-
- `@vapi-network/core
|
|
10
|
+
- `@vapi-network/core`, everything an agent-driven surface may use: accounts,
|
|
11
11
|
balances, `WalletStore`, `SpendPolicy`, `resolvePassphrase`, receipts, stats
|
|
12
12
|
and the x402 primitives.
|
|
13
|
-
- `@vapi-network/core/secrets
|
|
13
|
+
- `@vapi-network/core/secrets`, human-only. `exportRecoveryPhrase`,
|
|
14
14
|
`exportKeystoreKeys`, `createKeystoreWithPhrase` and `decryptPrivateKey`
|
|
15
15
|
return a recovery phrase or a private key, so they are deliberately not
|
|
16
16
|
re-exported from the main index and the MCP package is forbidden to import
|
|
17
17
|
them.
|
|
18
|
+
- `@vapi-network/core/backup` creates, opens, exports and restores encrypted vault backups, derives owner keys, and seals relay payloads. The MCP package is forbidden to import it.
|
|
19
|
+
- `@vapi-network/core/cloud-backup` runs owner relays, stores per-device backup keys, uploads envelopes and restores owner-approved backups. The MCP package is forbidden to import it.
|
|
20
|
+
- The `@vapi-network/core/api-key` entry point stores and resolves the registry API key without placing it in parsed MCP configuration.
|
|
21
|
+
- The `@vapi-network/core/agent-link` entry point handles device linking and agent tokens for a wallet.
|
|
22
|
+
- The `@vapi-network/core/router-client` entry point lists router models, reads usage and buys router balance.
|
|
18
23
|
|
|
19
|
-
|
|
20
|
-
|
|
24
|
+
## Exports
|
|
25
|
+
|
|
26
|
+
### Runtime exports
|
|
27
|
+
|
|
28
|
+
| Name | What it is | Since |
|
|
29
|
+
| ------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------- |
|
|
30
|
+
| `activeAgentMarker` | function (env: NodeJS.ProcessEnv): AgentMarker \| undefined | 0.5.0 or earlier |
|
|
31
|
+
| `AGENT_MARKER_VARIABLES` | constant AGENT_MARKER_VARIABLES: readonly ["VAPI_NO_SECRETS", "CLAUDECODE", "CLAUDE_CODE", "CURSOR_AGENT", "CODEX_SANDBOX", "OPENAI_CODEX", "AGENT", "CI"] | 0.5.0 or earlier |
|
|
32
|
+
| `agentProfileSchema` | constant agentProfileSchema: ZodObject<{ version: ZodLiteral<1>; name: ZodString; wallet: ZodString; model: ZodString; instructions: ZodString; verifiedOnly: ZodDefault<ZodBoolean>; ... 4 more ...; createdAt: ZodString; }, $strip> | 0.5.0 or earlier |
|
|
33
|
+
| `aggregateStats` | function (args: { receipts: readonly Receipt[]; searches: readonly SearchEvent[]; range?: StatsRange; now?: Date; }): StatsReport | 0.5.0 or earlier |
|
|
34
|
+
| `apiMarketplaceHitSchema` | constant apiMarketplaceHitSchema: ZodDiscriminatedUnion<[ZodObject<{ kind: ZodLiteral<"api">; provenance: ZodEnum<{ partner: "partner"; self_listed: "self_listed"; }>; execution: ZodObject<{ mode: ZodEnum<{ direct: "direct"; gateway: "gateway"; }>; }, $loos... | 0.5.0 or earlier |
|
|
35
|
+
| `appendAudit` | function (home: string, record: AuditRecord, options: AuditOptions = {}): Promise<AuditEntry> | 0.5.0 or earlier |
|
|
36
|
+
| `appendReceipt` | function (receipt: Receipt, path = getVapiPaths().receipts, options: { wallet?: string } = {}): Promise<Receipt> | 0.5.0 or earlier |
|
|
37
|
+
| `appendSearchEvent` | function (event: SearchEvent, path = getVapiPaths().searches): Promise<SearchEvent> | 0.5.0 or earlier |
|
|
38
|
+
| `ARC_MAINNET_CAIP2` | constant ARC_MAINNET_CAIP2: "eip155:5042" | 0.5.0 |
|
|
39
|
+
| `ARC_TESTNET_CAIP2` | constant ARC_TESTNET_CAIP2: "eip155:5042002" | 0.5.0 or earlier |
|
|
40
|
+
| `areSamePaymentNetwork` | function (left: string, right: string): boolean | 0.5.0 or earlier |
|
|
41
|
+
| `assertMaxPrice` | function (amountAtomic: bigint, maxPriceUsd: number \| string \| undefined): unknown | 0.5.0 or earlier |
|
|
42
|
+
| `assertPublicUrl` | function (url: URL, options: { allowPrivateNetwork: boolean; lookup?: LookupFn; timeoutMs?: number }): Promise<void> | 0.5.0 or earlier |
|
|
43
|
+
| `assertSIWxChallengeBoundToOrigin` | function (info: Pick<SIWxExtensionInfo, "domain" \| "uri">, responseUrl: string \| URL): void | 0.5.0 or earlier |
|
|
44
|
+
| `assertWalletName` | function (value: string): WalletName | 0.5.0 or earlier |
|
|
45
|
+
| `AUDIT_EVENTS` | constant AUDIT_EVENTS: readonly ["secret.export.phrase", "secret.export.key", "wallet.create", "wallet.import", "wallet.remove", "wallet.restore", "wallet.rename", "wallet.default", "wallet.caps", ... 17 more ..., "listing.claim"] | 0.5.0 or earlier |
|
|
46
|
+
| `AUDIT_FILE` | constant AUDIT_FILE: "audit.log" | 0.5.0 or earlier |
|
|
47
|
+
| `auditLogPath` | function (home: string): string | 0.5.0 or earlier |
|
|
48
|
+
| `BASE_MAINNET_CAIP2` | constant BASE_MAINNET_CAIP2: "eip155:8453" | 0.5.0 or earlier |
|
|
49
|
+
| `BROWSER_ENABLED_X402_NETWORK_CONFIG` | constant BROWSER_ENABLED_X402_NETWORK_CONFIG: X402NetworkConfig | 0.5.0 or earlier |
|
|
50
|
+
| `buildCompatibleX402Payment` | function (args: { account: X402Signer; quote: X402Quote; nowSeconds?: number; nonce?: Hex; fetchImpl?: typeof fetch; paymentId?: string; }): Promise<{ payload: X402PaymentPayload; headers: X402CompatiblePaymentHeaders; paymentId?: string; }> | 0.5.0 or earlier |
|
|
51
|
+
| `buildEip3009TypedData` | function (args: { from: Address; quote: X402Quote; nonce: Hex; nowSeconds: number; }): { authorization: Eip3009Authorization; typedData: X402TypedData } | 0.5.0 or earlier |
|
|
52
|
+
| `buildPaymentExtensions` | function (serverExtensions: Readonly<Record<string, unknown>> \| undefined, options: Readonly<{ paymentId?: string }> = {}): Record<string, unknown> | 0.5.0 or earlier |
|
|
53
|
+
| `buildSIWxProof` | function (args: { signer: SIWxSigner; challenge: SIWxChallenge; responseUrl: string \| URL; }): Promise<{ payload: SIWxPayload; headers: Readonly<{ "SIGN-IN-WITH-X": string }>; }> | 0.5.0 or earlier |
|
|
54
|
+
| `buildSupportIssueUrl` | function (message: string, version = VAPI_CLIENT_VERSION): string | 0.5.0 or earlier |
|
|
55
|
+
| `buildX402Payment` | function (args: { signer: X402Signer; quote: X402Quote; nowSeconds?: number; nonce?: Hex; fetchImpl?: typeof fetch; paymentId?: string; }): Promise<{ payload: X402PaymentPayload; headers: X402PaymentHeaders; paymentId?: string; }> | 0.5.0 or earlier |
|
|
56
|
+
| `buyRouterBalance` | function (deps: RouterClientDeps & { account: VapiPaymentAccount; config: VapiConfig; caps: SpendCaps; paths?: { ledgerPath?: string; receiptsPath?: string }; now?: Date; }, tierUsd: RouterTopupTier): Promise<{ receipt: Receipt; balance: AgentRouterUsage["b... | 0.5.0 or earlier |
|
|
57
|
+
| `calculateSweepAmount` | function (balanceAtomic: bigint, gasHeadroomAtomic: bigint): bigint | 0.5.0 or earlier |
|
|
58
|
+
| `CALLABLE_CATEGORIES` | constant CALLABLE_CATEGORIES: readonly ["ai", "data", "crypto", "compute", "search"] | 0.5.0 or earlier |
|
|
59
|
+
| `CALLABLE_CATEGORY_LABELS` | constant CALLABLE_CATEGORY_LABELS: { readonly ai: { readonly catalog: "AI / LLM"; readonly publish: "AI and models"; }; readonly data: { readonly catalog: "Data"; readonly publish: "Data"; }; readonly crypto: { readonly catalog: "Crypto"; readonly publish: ... | 0.5.0 or earlier |
|
|
60
|
+
| `CALLABLE_KIND` | constant CALLABLE_KIND: "agent" | 0.5.0 or earlier |
|
|
61
|
+
| `callableCategorySchema` | constant callableCategorySchema: ZodEnum<{ ai: "ai"; data: "data"; crypto: "crypto"; compute: "compute"; search: "search"; }> | 0.5.0 or earlier |
|
|
62
|
+
| `CANONICAL_X402_USDC_NETWORKS` | constant CANONICAL_X402_USDC_NETWORKS: Readonly<{ "eip155:8453": Readonly<{ usdc: `0x${string}`; eip712Domain: Readonly<{ name: string; version: string; }>; }>; "eip155:5042": Readonly<{ usdc: `0x${string}`; eip712Domain: Readonly<{ name: string; version: s... | 0.5.0 or earlier |
|
|
63
|
+
| `changeKeystorePassphrase` | function (oldPassphrase: string, newPassphrase: string, path = getVapiPaths().keystore): Promise<VapiPaymentAccount> | 0.5.0 or earlier |
|
|
64
|
+
| `checkReceiptSettlement` | function (receipt: Receipt, config: Pick<VapiConfig, "networks" \| "allowPrivateNetwork">, options: { fetchImpl?: typeof fetch; lookup?: LookupFn } = {}): Promise<ReceiptSettlementCheck> | 0.5.0 or earlier |
|
|
65
|
+
| `classifySettlement` | function (value: unknown): X402SettlementOutcome | 0.5.0 or earlier |
|
|
66
|
+
| `completeX402Payment` | function (args: CompleteX402PaymentArgs<T>): Promise<CompleteX402PaymentResult<T>> | 0.5.0 or earlier |
|
|
67
|
+
| `configSchema` | constant configSchema: ZodObject<{ discoveryUrl: ZodURL; marketplaceDiscoveryUrl: ZodDefault<ZodURL>; registryFallbacks: ZodOptional<ZodArray<ZodObject<{ discoveryUrl: ZodURL; marketplaceDiscoveryUrl: ZodURL; }, $strip>>>; allowPrivateNetwork: ZodOptional<.... | 0.5.0 or earlier |
|
|
68
|
+
| `configuredNetworkFor` | function (networks: Readonly<Record<string, ConfiguredNetwork>>, network: string): ConfiguredNetwork \| undefined | 0.5.0 or earlier |
|
|
69
|
+
| `createChain` | function (network: string, rpcUrl: string): Chain | 0.5.0 or earlier |
|
|
70
|
+
| `createKeystore` | function (passphrase: string, path = getVapiPaths().keystore, options: CreateKeystoreOptions = {}): Promise<VapiPaymentAccount> | 0.5.0 or earlier |
|
|
71
|
+
| `createKeystoreFromPrivateKey` | function (passphrase: string, path = getVapiPaths().keystore, options: { privateKey: string }): Promise<VapiPaymentAccount> | 0.5.0 or earlier |
|
|
72
|
+
| `createNetworkHttpTransport` | function (rpcUrl: string, options: NetworkTransportOptions = {}): HttpTransport | 0.5.0 or earlier |
|
|
73
|
+
| `createNetworkPublicClient` | function (network: string, configured: ConfiguredNetwork, options: NetworkTransportOptions = {}): PublicClient | 0.5.0 or earlier |
|
|
74
|
+
| `createPaymentId` | function (randomBytes: (bytes: Uint8Array<ArrayBuffer>) => void = fillRandomBytes): string | 0.5.0 or earlier |
|
|
75
|
+
| `createPublicFetch` | function (options: { allowPrivateNetwork: boolean; lookup?: LookupFn; }): typeof fetch | 0.5.0 or earlier |
|
|
76
|
+
| `createSIWxMessage` | function (challenge: SIWxChallenge, address: Address): string | 0.5.0 or earlier |
|
|
77
|
+
| `createSupportReport` | function (options: CreateSupportReportOptions): Promise<CreateSupportReportResult> | 0.5.0 or earlier |
|
|
78
|
+
| `decodePaymentRequiredHeader` | function (value: string): unknown | 0.5.0 or earlier |
|
|
79
|
+
| `DEFAULT_ARC_GAS_HEADROOM_ATOMIC` | constant DEFAULT_ARC_GAS_HEADROOM_ATOMIC: 50000n | 0.5.0 or earlier |
|
|
80
|
+
| `DEFAULT_DISCOVERY_URL` | constant DEFAULT_DISCOVERY_URL: "https: | 0.5.0 or earlier |
|
|
81
|
+
| `DEFAULT_MARKETPLACE_DISCOVERY_URL` | constant DEFAULT_MARKETPLACE_DISCOVERY_URL: "https: | 0.5.0 or earlier |
|
|
82
|
+
| `DEFAULT_REGISTRY_FALLBACKS` | constant DEFAULT_REGISTRY_FALLBACKS: readonly [{ readonly discoveryUrl: "https: | 0.5.0 or earlier |
|
|
83
|
+
| `DEFAULT_REGISTRY_URL` | constant DEFAULT_REGISTRY_URL: "https: | 0.5.0 or earlier |
|
|
84
|
+
| `DEFAULT_SPEND_CAPS` | constant DEFAULT_SPEND_CAPS: { readonly perCallAtomic: "100000"; readonly perDayAtomic: "1000000"; } | 0.5.0 or earlier |
|
|
85
|
+
| `DEFAULT_WALLET_NAME` | constant DEFAULT_WALLET_NAME: "main" | 0.5.0 or earlier |
|
|
86
|
+
| `deriveEvmPrivateKey` | function (seed: Uint8Array, path = EVM_DERIVATION_PATH): Hex | 0.5.0 or earlier |
|
|
87
|
+
| `deriveSolanaPrivateKey` | function (seed: Uint8Array, path = SOLANA_DERIVATION_PATH): Uint8Array | 0.5.0 or earlier |
|
|
88
|
+
| `discardBody` | function (response: Response \| null \| undefined): void | 0.5.0 or earlier |
|
|
89
|
+
| `discover` | function (sources: readonly Source[], query?: string, options: { searchesPath?: string; now?: Date; nowMs?: () => number; } & SourceSearchOptions = {}): Promise<{ listings: Listing[]; errors: ReadonlyArray<{ source: string; error: unknown }> }> | 0.5.0 or earlier |
|
|
90
|
+
| `DISCOVERY_CATEGORIES` | constant DISCOVERY_CATEGORIES: readonly ["ai", "data", "crypto", "compute", "search", "other"] | 0.5.0 or earlier |
|
|
91
|
+
| `DiscoveryCatalogError` | class DiscoveryCatalogError | 0.5.0 or earlier |
|
|
92
|
+
| `discoveryCategorySchema` | constant discoveryCategorySchema: ZodEnum<{ ai: "ai"; data: "data"; crypto: "crypto"; compute: "compute"; search: "search"; other: "other"; }> | 0.5.0 or earlier |
|
|
93
|
+
| `discoveryEndpointSchema` | constant discoveryEndpointSchema: ZodObject<{ name: ZodString; method: ZodString; url: ZodURL; price: ZodString; description: ZodString; operationId: ZodOptional<ZodString>; ... 5 more ...; payment: ZodOptional<...>; }, $loose> | 0.5.0 or earlier |
|
|
94
|
+
| `discoveryResponseSchema` | constant discoveryResponseSchema: ZodObject<{ services: ZodArray<ZodObject<{ verified: ZodBoolean; wrapped: ZodBoolean; price: ZodString; networks: ZodArray<ZodString>; endpoints: ZodArray<...>; ... 10 more ...; tier: ZodEnum<...>; }, $loose>>; }, $loose> | 0.5.0 or earlier |
|
|
95
|
+
| `discoveryServiceSchema` | constant discoveryServiceSchema: ZodObject<{ verified: ZodBoolean; wrapped: ZodBoolean; price: ZodString; networks: ZodArray<ZodString>; endpoints: ZodArray<ZodObject<{ name: ZodString; ... 10 more ...; payment: ZodOptional<...>; }, $loose>>; ... 10 more ..... | 0.5.0 or earlier |
|
|
96
|
+
| `EIP3009_AUTHORIZATION_STATE_ABI` | constant EIP3009_AUTHORIZATION_STATE_ABI: readonly [{ readonly type: "function"; readonly name: "authorizationState"; readonly stateMutability: "view"; readonly inputs: readonly [{ readonly name: "authorizer"; readonly type: "address"; }, { readonly name: "... | 0.5.0 or earlier |
|
|
97
|
+
| `EIP3009_AUTHORIZATION_TYPES` | constant EIP3009_AUTHORIZATION_TYPES: { readonly TransferWithAuthorization: readonly [{ readonly name: "from"; readonly type: "address"; }, { readonly name: "to"; readonly type: "address"; }, { readonly name: "value"; readonly type: "uint256"; }, { ...; }, ... | 0.5.0 or earlier |
|
|
98
|
+
| `enableDefaultNetwork` | function (network: "solana" \| "arc", path = getVapiPaths().config, source: NodeJS.ProcessEnv = process.env): Promise<VapiConfig> | 0.5.0 or earlier |
|
|
99
|
+
| `enableSolanaKey` | function (passphrase: string, path = getVapiPaths().keystore): Promise<VapiPaymentAccount> | 0.5.0 or earlier |
|
|
100
|
+
| `encryptPrivateKey` | function (privateKey: Hex, passphrase: string): Promise<VapiKeystore> | 0.5.0 or earlier |
|
|
101
|
+
| `entropyToPhrase` | function (entropy: Uint8Array): string | 0.5.0 or earlier |
|
|
102
|
+
| `ERC20_ABI` | constant ERC20_ABI: readonly [{ readonly type: "function"; readonly name: "balanceOf"; readonly stateMutability: "view"; readonly inputs: readonly [{ readonly name: "account"; readonly type: "address"; }]; readonly outputs: readonly [{ readonly name: "balan... | 0.5.0 or earlier |
|
|
103
|
+
| `EVM_DERIVATION_PATH` | constant EVM_DERIVATION_PATH: "m/44'/60'/0'/0/0" | 0.5.0 or earlier |
|
|
104
|
+
| `EXECUTION_MODES` | constant EXECUTION_MODES: readonly ["direct", "gateway"] | 0.5.0 or earlier |
|
|
105
|
+
| `executionModeSchema` | constant executionModeSchema: ZodEnum<{ direct: "direct"; gateway: "gateway"; }> | 0.5.0 or earlier |
|
|
106
|
+
| `explorerAddressUrl` | function (network: string, address: string): string \| undefined | 0.5.0 or earlier |
|
|
107
|
+
| `explorerTransactionUrl` | function (network: string, hash: string): string \| undefined | 0.5.0 or earlier |
|
|
108
|
+
| `filterReceiptsByRange` | function (receipts: readonly Receipt[], range: StatsRange, now = new Date(), wallet?: string): Receipt[] | 0.5.0 or earlier |
|
|
109
|
+
| `filterReceiptsByWallet` | function (receipts: readonly Receipt[], name: WalletName): Receipt[] | 0.5.0 or earlier |
|
|
110
|
+
| `FIRST_PARTY_PROVENANCES` | constant FIRST_PARTY_PROVENANCES: readonly ["self_listed", "partner"] | 0.5.0 or earlier |
|
|
111
|
+
| `firstPartyProvenanceSchema` | constant firstPartyProvenanceSchema: ZodEnum<{ partner: "partner"; self_listed: "self_listed"; }> | 0.5.0 or earlier |
|
|
112
|
+
| `formatLegacyRegistryRewrites` | function (changes: readonly LegacyRegistryRewrite[]): string | 0.5.0 or earlier |
|
|
113
|
+
| `formatUsdc` | function (amountAtomic: bigint): string | 0.5.0 or earlier |
|
|
114
|
+
| `fundingPageUrl` | function (registryUrl: string, address: string, options: FundingPageOptions = {}): string | 0.2.5 |
|
|
115
|
+
| `generateRecoveryPhrase` | function (): string | 0.5.0 or earlier |
|
|
116
|
+
| `getAgentCashPaths` | constant getAgentCashPaths: (directory?: string) => VapiPaths | 0.5.0 or earlier |
|
|
117
|
+
| `getArcGasHeadroomAtomic` | function (): bigint | 0.5.0 or earlier |
|
|
118
|
+
| `getCanonicalX402Usdc` | function (network: string): CanonicalX402UsdcIdentity \| undefined | 0.5.0 or earlier |
|
|
119
|
+
| `getDefaultConfig` | function (source: NodeJS.ProcessEnv = process.env, options: DefaultConfigOptions = {}): VapiConfig | 0.5.0 |
|
|
120
|
+
| `getKeystorePassphrase` | function (options?: { confirm?: boolean }): Promise<string> | 0.5.0 or earlier |
|
|
121
|
+
| `getNetworkDefinition` | function (network: string): NetworkDefinition | 0.5.0 or earlier |
|
|
122
|
+
| `getVapiPaths` | function (directory = process.env.VAPI_HOME?.trim() \|\| join(homedir(), ".vapi")): VapiPaths | 0.5.0 or earlier |
|
|
123
|
+
| `isCallableListing` | function (kind: string, category: string): boolean | 0.5.0 or earlier |
|
|
124
|
+
| `isEvmPaymentRequirements` | function (requirements: X402PaymentRequirements): requirements is EvmX402PaymentRequirements | 0.5.0 or earlier |
|
|
125
|
+
| `isMirroredHit` | function (hit: MarketplaceHit): boolean | 0.5.0 or earlier |
|
|
126
|
+
| `isMissingFile` | function (error: unknown): error is NodeJS.ErrnoException | 0.5.0 or earlier |
|
|
127
|
+
| `isNetworkConfigured` | function (networks: VapiConfig["networks"], network: string): boolean | 0.5.0 or earlier |
|
|
128
|
+
| `isSolanaAddress` | function (value: string): boolean | 0.5.0 or earlier |
|
|
129
|
+
| `isSolanaNetwork` | function (network: string): boolean | 0.5.0 or earlier |
|
|
130
|
+
| `isSupportedPaymentNetwork` | function (network: string): boolean | 0.5.0 or earlier |
|
|
131
|
+
| `isSvmPaymentRequirements` | function (requirements: X402PaymentRequirements): requirements is SvmX402PaymentRequirements | 0.5.0 or earlier |
|
|
132
|
+
| `isValidPaymentId` | function (value: unknown): value is string | 0.5.0 or earlier |
|
|
133
|
+
| `isWalletName` | function (value: string): boolean | 0.5.0 or earlier |
|
|
134
|
+
| `KeystoreError` | class KeystoreError | 0.5.0 or earlier |
|
|
135
|
+
| `listAccounts` | function (args: ListAccountsArgs): Promise<AccountInfo[]> | 0.5.0 or earlier |
|
|
136
|
+
| `listAgentProfiles` | function (home: string, options: { warn?: (message: string) => void } = {}): Promise<AgentProfile[]> | 0.5.0 or earlier |
|
|
137
|
+
| `LISTING_GROUPS` | constant LISTING_GROUPS: readonly ["vapi", "added", "partner", "external"] | 0.5.0 or earlier |
|
|
138
|
+
| `LISTING_VERIFICATIONS` | constant LISTING_VERIFICATIONS: readonly ["none", "requested", "verified"] | 0.5.0 or earlier |
|
|
139
|
+
| `listingConformanceSchema` | constant listingConformanceSchema: ZodObject<{ declaredVersion: ZodNullable<ZodUnion<readonly [ZodLiteral<1>, ZodLiteral<2>]>>; versionConformant: ZodBoolean; offerTransport: ZodEnum<...>; issues: ZodArray<...>; }, $loose> | 0.5.0 or earlier |
|
|
140
|
+
| `listingDisclosureShape` | constant listingDisclosureShape: { readonly group: ZodOptional<ZodEnum<{ partner: "partner"; vapi: "vapi"; added: "added"; external: "external"; }>>; readonly fee: ZodOptional<ZodObject<{ bps: ZodNumber; label: ZodString; }, $loose>>; readonly verification:... | 0.5.0 or earlier |
|
|
141
|
+
| `listingFeeSchema` | constant listingFeeSchema: ZodObject<{ bps: ZodNumber; label: ZodString; }, $loose> | 0.5.0 or earlier |
|
|
142
|
+
| `listingGroupSchema` | constant listingGroupSchema: ZodEnum<{ partner: "partner"; vapi: "vapi"; added: "added"; external: "external"; }> | 0.5.0 or earlier |
|
|
143
|
+
| `listingIdentitySchema` | constant listingIdentitySchema: ZodObject<{ erc8004Id: ZodString; reputation: ZodCatch<ZodOptional<ZodObject<{ score: ZodNumber; count: ZodNumber; }, $loose>>>; }, $loose> | 0.5.0 or earlier |
|
|
144
|
+
| `listingLivenessSchema` | constant listingLivenessSchema: ZodObject<{ uptime7d: ZodNumber; latencyP50Ms: ZodNullable<ZodNumber>; latencyP95Ms: ZodNullable<ZodNumber>; checks7d: ZodNumber; }, $loose> | 0.5.0 or earlier |
|
|
145
|
+
| `listingVerificationFieldSchema` | constant listingVerificationFieldSchema: ZodCatch<ZodDefault<ZodEnum<{ verified: "verified"; none: "none"; requested: "requested"; }>>> | 0.5.0 or earlier |
|
|
146
|
+
| `listingVerificationSchema` | constant listingVerificationSchema: ZodEnum<{ verified: "verified"; none: "none"; requested: "requested"; }> | 0.5.0 or earlier |
|
|
147
|
+
| `listServicesResponseSchema` | constant listServicesResponseSchema: ZodObject<{ services: ZodArray<ZodObject<{ verified: ZodBoolean; wrapped: ZodBoolean; price: ZodString; networks: ZodArray<ZodString>; endpoints: ZodArray<...>; ... 10 more ...; tier: ZodEnum<...>; }, $loose>>; }, $loose> | 0.5.0 or earlier |
|
|
148
|
+
| `loadConfig` | function (path = getVapiPaths().config, source: NodeJS.ProcessEnv = process.env, options: LoadConfigOptions = {}): Promise<VapiConfig> | 0.5.0 or earlier |
|
|
149
|
+
| `LocalWallet` | class LocalWallet | 0.5.0 or earlier |
|
|
150
|
+
| `MARKETPLACE_DISCOVERY_PROTOCOL` | constant MARKETPLACE_DISCOVERY_PROTOCOL: "vapi.marketplace.discovery/1" | 0.5.0 or earlier |
|
|
151
|
+
| `MARKETPLACE_EXECUTION_METHODS` | constant MARKETPLACE_EXECUTION_METHODS: readonly ["GET", "HEAD", "POST", "PUT", "PATCH", "DELETE"] | 0.5.0 or earlier |
|
|
152
|
+
| `MARKETPLACE_KINDS` | constant MARKETPLACE_KINDS: readonly ["api", "service_offer", "open_request"] | 0.5.0 or earlier |
|
|
153
|
+
| `MARKETPLACE_RANKING_VERSION` | constant MARKETPLACE_RANKING_VERSION: "marketplace-ranking-v1" | 0.5.0 or earlier |
|
|
154
|
+
| `marketplaceBadgeCodeSchema` | constant marketplaceBadgeCodeSchema: ZodEnum<{ partner: "partner"; live_x402: "live_x402"; payout_wallet_confirmed: "payout_wallet_confirmed"; vapi_verified: "vapi_verified"; external_catalog: "external_catalog"; approved_vendor: "approved_vendor"; }> | 0.5.0 or earlier |
|
|
155
|
+
| `marketplaceBadgeSchema` | constant marketplaceBadgeSchema: ZodObject<{ code: ZodEnum<{ partner: "partner"; live_x402: "live_x402"; payout_wallet_confirmed: "payout_wallet_confirmed"; vapi_verified: "vapi_verified"; external_catalog: "external_catalog"; approved_vendor: "approved_ven... | 0.5.0 or earlier |
|
|
156
|
+
| `marketplaceDiscoveryInputSchema` | constant marketplaceDiscoveryInputSchema: ZodObject<{ q: ZodOptional<ZodString>; kinds: ZodOptional<ZodArray<ZodEnum<{ api: "api"; service_offer: "service_offer"; open_request: "open_request"; }>>>; network: ZodOptional<...>; cursor: ZodOptional<...>; limit... | 0.5.0 or earlier |
|
|
157
|
+
| `marketplaceDiscoveryPageSchema` | constant marketplaceDiscoveryPageSchema: ZodObject<{ protocol: ZodLiteral<"vapi.marketplace.discovery/1">; items: ZodArray<ZodUnion<readonly [ZodDiscriminatedUnion<[ZodObject<{ kind: ZodLiteral<"api">; provenance: ZodEnum<{ partner: "partner"; self_listed: ... | 0.5.0 or earlier |
|
|
158
|
+
| `marketplaceExecutionMethodSchema` | constant marketplaceExecutionMethodSchema: ZodEnum<{ GET: "GET"; HEAD: "HEAD"; POST: "POST"; PUT: "PUT"; PATCH: "PATCH"; DELETE: "DELETE"; }> | 0.5.0 or earlier |
|
|
159
|
+
| `marketplaceHitSchema` | constant marketplaceHitSchema: ZodUnion<readonly [ZodDiscriminatedUnion<[ZodObject<{ kind: ZodLiteral<"api">; provenance: ZodEnum<{ partner: "partner"; self_listed: "self_listed"; }>; execution: ZodObject<{ mode: ZodEnum<{ direct: "direct"; gateway: "gatewa... | 0.5.0 or earlier |
|
|
160
|
+
| `marketplaceKindSchema` | constant marketplaceKindSchema: ZodEnum<{ api: "api"; service_offer: "service_offer"; open_request: "open_request"; }> | 0.5.0 or earlier |
|
|
161
|
+
| `marketplacePublicFactSchema` | constant marketplacePublicFactSchema: ZodObject<{ label: ZodString; value: ZodString; }, $loose> | 0.5.0 or earlier |
|
|
162
|
+
| `mergeListings` | function (groups: Iterable<readonly Listing[]>): Listing[] | 0.5.0 or earlier |
|
|
163
|
+
| `migrateLegacyRegistryConfig` | function (path = getVapiPaths().config): Promise<LegacyRegistryRewrite[]> | 0.5.0 or earlier |
|
|
164
|
+
| `migrateLegacyVapiHome` | function (options: MigrationOptions = {}): Promise<string[]> | 0.5.0 or earlier |
|
|
165
|
+
| `NETWORKS` | constant NETWORKS: { readonly "eip155:8453": { readonly family: "evm"; readonly chainId: 8453; readonly name: "Base mainnet"; readonly usdc: `0x${string}`; readonly gasToken: "ETH"; readonly rpcEnv: "BASE_RPC_URL"; readonly publicRpcUrl: "https: | 0.5.0 or earlier |
|
|
166
|
+
| `noPassphraseHint` | function (walletName: string): string | 0.5.0 or earlier |
|
|
167
|
+
| `normalizeResourceUrl` | function (value: string): string | 0.5.0 or earlier |
|
|
168
|
+
| `ONRAMP_FALLBACK_INSTRUCTIONS` | constant ONRAMP_FALLBACK_INSTRUCTIONS: "Send USDC on Base (eip155:8453) to this address; add a little ETH for gas if you plan to sweep." | 0.5.0 or earlier |
|
|
169
|
+
| `ONRAMP_NETWORK` | constant ONRAMP_NETWORK: "base" | 0.5.0 or earlier |
|
|
170
|
+
| `openRequestMarketplaceHitSchema` | constant openRequestMarketplaceHitSchema: ZodObject<{ kind: ZodLiteral<"open_request">; action: ZodObject<{ type: ZodLiteral<"propose_to_request">; href: ZodUnion<readonly [ZodString, ZodURL]>; }, $loose>; ... 7 more ...; card: ZodObject<...>; }, $loose> | 0.5.0 or earlier |
|
|
171
|
+
| `parse402Challenge` | function (challenge: unknown, configuredNetworks: X402NetworkConfig, fallbackResourceUrl = "", requiredNetwork?: string, expectedPayTo?: string): X402Quote | 0.5.0 or earlier |
|
|
172
|
+
| `parse402Response` | function (response: Response, configuredNetworks: X402NetworkConfig, requiredNetwork?: string, expectedPayTo?: string): Promise<X402Quote> | 0.5.0 or earlier |
|
|
173
|
+
| `parseDiscovery` | function (raw: unknown): DiscoveryCatalog | 0.5.0 or earlier |
|
|
174
|
+
| `parseEip155ChainId` | function (network: string): number | 0.5.0 or earlier |
|
|
175
|
+
| `parseReceipt` | function (value: unknown): Receipt | 0.5.0 or earlier |
|
|
176
|
+
| `parseSearchEvent` | function (value: unknown): SearchEvent | 0.5.0 or earlier |
|
|
177
|
+
| `parseSettlementResponse` | function (headers: Headers): unknown \| null | 0.5.0 or earlier |
|
|
178
|
+
| `parseSIWxChallenge` | function (paymentRequired: unknown, configuredNetworks: X402NetworkConfig, responseUrl: string \| URL, requiredNetwork?: string): SIWxChallenge \| null | 0.5.0 or earlier |
|
|
179
|
+
| `parseSIWxResponse` | function (response: Response, configuredNetworks: X402NetworkConfig, responseUrl: string \| URL = response.url, requiredNetwork?: string): Promise<SIWxChallenge \| null> | 0.5.0 or earlier |
|
|
180
|
+
| `PASSPHRASE_ENVIRONMENT_VARIABLE` | constant PASSPHRASE_ENVIRONMENT_VARIABLE: "VAPI_KEYSTORE_PASSWORD" | 0.5.0 or earlier |
|
|
181
|
+
| `payRequest` | function (args: PayRequestArgs): Promise<PayRequestResult> | 0.5.0 or earlier |
|
|
182
|
+
| `phraseToEntropy` | function (phrase: string): Uint8Array | 0.5.0 or earlier |
|
|
183
|
+
| `phraseToSeed` | function (phrase: string): Uint8Array | 0.5.0 or earlier |
|
|
184
|
+
| `pinnedLookup` | function (lookup: LookupFn): LookupFunction | 0.5.0 or earlier |
|
|
185
|
+
| `promptForSecret` | function (prompt: string, noTerminalHint?: string): Promise<string> | 0.5.0 or earlier |
|
|
186
|
+
| `PROVENANCES` | constant PROVENANCES: readonly ["indexed", "self_listed", "partner"] | 0.5.0 or earlier |
|
|
187
|
+
| `provenanceSchema` | constant provenanceSchema: ZodEnum<{ partner: "partner"; indexed: "indexed"; self_listed: "self_listed"; }> | 0.5.0 or earlier |
|
|
188
|
+
| `readAgentProfile` | function (home: string, name: string): Promise<AgentProfile> | 0.5.0 or earlier |
|
|
189
|
+
| `readAuditLog` | function (home: string): Promise<AuditEntry[]> | 0.5.0 or earlier |
|
|
190
|
+
| `readKeystoreAddress` | function (path = getVapiPaths().keystore): Promise<string \| undefined> | 0.5.0 or earlier |
|
|
191
|
+
| `readKeystoreVersion` | function (path = getVapiPaths().keystore): Promise<number \| undefined> | 0.5.0 or earlier |
|
|
192
|
+
| `readReceipts` | function (path = getVapiPaths().receipts, options: { limit?: number; wallet?: string } = {}): Promise<Receipt[]> | 0.3.0 |
|
|
193
|
+
| `readSearchEvents` | function (path = getVapiPaths().searches): Promise<SearchEvent[]> | 0.5.0 or earlier |
|
|
194
|
+
| `readSolanaGasBalance` | function (args: { network: string; configured: ConfiguredNetwork; address: string; } & SolanaRpcOptions): Promise<bigint> | 0.5.0 or earlier |
|
|
195
|
+
| `readSolanaUsdcBalance` | function (args: { network: string; configured: ConfiguredNetwork; address: string; } & SolanaRpcOptions): Promise<bigint> | 0.5.0 or earlier |
|
|
196
|
+
| `readSpendLedger` | function (path = getAgentCashPaths().ledger, now = new Date(), wallet: WalletName = DEFAULT_WALLET_NAME): Promise<SpendLedger> | 0.5.0 or earlier |
|
|
197
|
+
| `readSpendLedgerRows` | function (path = getAgentCashPaths().ledger, now = new Date()): Promise<SpendLedgerRow[]> | 0.5.0 or earlier |
|
|
198
|
+
| `readUsdcBalance` | function (args: { network: string; configured: AgentCashConfig["networks"][string]; address: string; allowPrivateNetwork?: boolean; fetchImpl?: typeof fetch; lookup?: LookupFn; }): Promise<bigint> | 0.5.0 or earlier |
|
|
199
|
+
| `receiptsToCsv` | function (receipts: readonly Receipt[]): string | 0.5.0 or earlier |
|
|
200
|
+
| `receiptWallet` | function (receipt: Receipt): WalletName | 0.5.0 or earlier |
|
|
201
|
+
| `removeAgentProfile` | function (home: string, name: string): Promise<void> | 0.5.0 or earlier |
|
|
202
|
+
| `renameReceiptWallet` | function (from: WalletName, to: WalletName, path = getVapiPaths().receipts): Promise<number> | 0.5.0 or earlier |
|
|
203
|
+
| `requireRpcUrl` | function (network: string, configured: ConfiguredNetwork): string | 0.5.0 or earlier |
|
|
204
|
+
| `reserveSpend` | function (amountAtomic: bigint, caps: SpendCaps, options?: { ledgerPath?: string; now?: Date; wallet?: WalletName }): Promise<SpendLedger> | 0.5.0 or earlier |
|
|
205
|
+
| `resolvePassphrase` | function (walletName: string, options: ResolvePassphraseOptions = {}): Promise<ResolvedPassphrase> | 0.3.0 |
|
|
206
|
+
| `resolveRegistryUrl` | function (env: NodeJS.ProcessEnv = process.env): string | 0.5.0 or earlier |
|
|
207
|
+
| `rewriteLegacyRegistryUrl` | function (value: string): string | 0.5.0 or earlier |
|
|
208
|
+
| `rewriteLegacyRegistryUrls` | function (config: VapiConfig): { config: VapiConfig; changes: LegacyRegistryRewrite[]; } | 0.5.0 or earlier |
|
|
209
|
+
| `ROUTER_TOPUP_TIERS` | constant ROUTER_TOPUP_TIERS: readonly [1, 5, 20, 50] | 0.5.0 or earlier |
|
|
210
|
+
| `searchServicesResponseSchema` | constant searchServicesResponseSchema: ZodObject<{ services: ZodArray<ZodObject<{ verified: ZodBoolean; wrapped: ZodBoolean; price: ZodString; networks: ZodArray<ZodString>; endpoints: ZodArray<...>; ... 10 more ...; tier: ZodEnum<...>; }, $loose>>; }, $loose> | 0.5.0 or earlier |
|
|
211
|
+
| `SECRET_STORE_SERVICE` | constant SECRET_STORE_SERVICE: "vapi-network" | 0.5.0 or earlier |
|
|
212
|
+
| `secretsAllowed` | function (env: NodeJS.ProcessEnv, streams: SecretsStreams): SecretsDecision | 0.5.0 or earlier |
|
|
213
|
+
| `secretStore` | function (options: SecretStoreOptions = {}): SecretStore | 0.5.0 or earlier |
|
|
214
|
+
| `serviceOfferMarketplaceHitSchema` | constant serviceOfferMarketplaceHitSchema: ZodObject<{ kind: ZodLiteral<"service_offer">; action: ZodObject<{ type: ZodLiteral<"start_engagement">; href: ZodUnion<readonly [ZodString, ZodURL]>; }, $loose>; ... 7 more ...; card: ZodObject<...>; }, $loose> | 0.5.0 or earlier |
|
|
215
|
+
| `serviceSummarySchema` | constant serviceSummarySchema: ZodObject<{ verified: ZodBoolean; wrapped: ZodBoolean; price: ZodString; networks: ZodArray<ZodString>; endpoints: ZodArray<ZodObject<{ name: ZodString; ... 10 more ...; payment: ZodOptional<...>; }, $loose>>; ... 10 more ...;... | 0.5.0 or earlier |
|
|
216
|
+
| `serviceTierSchema` | constant serviceTierSchema: ZodEnum<{ listed: "listed"; verified: "verified"; partner: "partner"; }> | 0.5.0 or earlier |
|
|
217
|
+
| `SIGN_IN_WITH_X` | constant SIGN_IN_WITH_X: "sign-in-with-x" | 0.5.0 or earlier |
|
|
218
|
+
| `SIWxError` | class SIWxError | 0.5.0 or earlier |
|
|
219
|
+
| `SOLANA_DERIVATION_PATH` | constant SOLANA_DERIVATION_PATH: "m/44'/501'/0'/0'" | 0.5.0 or earlier |
|
|
220
|
+
| `SOLANA_MAINNET_CAIP2` | constant SOLANA_MAINNET_CAIP2: "solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdpKuc147dw2N9d" | 0.5.0 or earlier |
|
|
221
|
+
| `SOLANA_MAINNET_USDC` | constant SOLANA_MAINNET_USDC: "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v" | 0.5.0 or earlier |
|
|
222
|
+
| `SpendCapError` | class SpendCapError | 0.5.0 or earlier |
|
|
223
|
+
| `spendCapsForWallet` | function (store: WalletStore, name: WalletName = DEFAULT_WALLET_NAME): Promise<SpendCaps> | 0.5.0 or earlier |
|
|
224
|
+
| `spendCapsSchema` | constant spendCapsSchema: ZodObject<{ perCallAtomic: ZodString; perDayAtomic: ZodString; }, $strip> | 0.5.0 or earlier |
|
|
225
|
+
| `SpendPolicy` | class SpendPolicy | 0.5.0 or earlier |
|
|
226
|
+
| `staleStoredPassphraseMessage` | function (walletName: string, store: SecretStore): string | 0.5.0 or earlier |
|
|
227
|
+
| `STATS_RANGES` | constant STATS_RANGES: readonly ["24h", "7d", "30d"] | 0.5.0 or earlier |
|
|
228
|
+
| `sweepBack` | function (args: { account: VapiPaymentAccount; config: AgentCashConfig; network: string; destination: string; arcGasHeadroomAtomic?: bigint; fetchImpl?: typeof fetch; lookup?: LookupFn; }): Promise<SweepResult> | 0.5.0 or earlier |
|
|
229
|
+
| `SweepGasError` | class SweepGasError | 0.5.0 or earlier |
|
|
230
|
+
| `sweepSolanaUsdc` | function (args: { network: string; configured: ConfiguredNetwork; signer: KeyPairSigner; destination: string; } & SolanaRpcOptions): Promise<{ amountAtomic: bigint; transaction: string }> | 0.5.0 or earlier |
|
|
231
|
+
| `unlockKeystore` | function (passphrase: string, path = getVapiPaths().keystore): Promise<VapiPaymentAccount> | 0.5.0 or earlier |
|
|
232
|
+
| `USDC_DECIMALS` | constant USDC_DECIMALS: 6 | 0.5.0 or earlier |
|
|
233
|
+
| `usdToAtomic` | function (value: number \| string): bigint | 0.5.0 or earlier |
|
|
234
|
+
| `usesUsdcGas` | function (network: string): boolean | 0.5.0 or earlier |
|
|
235
|
+
| `utcDateKey` | function (now = new Date()): string | 0.5.0 or earlier |
|
|
236
|
+
| `validatePrivateKey` | function (value: string): Hex | 0.5.0 or earlier |
|
|
237
|
+
| `validateRecoveryPhrase` | function (phrase: string): string | 0.5.0 or earlier |
|
|
238
|
+
| `VAPI_BUILDER_CODE` | constant VAPI_BUILDER_CODE: "vapi" | 0.5.0 or earlier |
|
|
239
|
+
| `VAPI_CLIENT_VERSION` | constant VAPI_CLIENT_VERSION: "0.5.0" | 0.4.0 |
|
|
240
|
+
| `WALLET_NAME_PATTERN` | constant WALLET_NAME_PATTERN: RegExp | 0.5.0 or earlier |
|
|
241
|
+
| `walletEntrySchema` | constant walletEntrySchema: ZodObject<{ createdAt: ZodISODateTime; label: ZodOptional<ZodString>; spendCaps: ZodObject<{ perCallAtomic: ZodString; perDayAtomic: ZodString; }, $strip>; routerRefill: ZodOptional<...>; link: ZodOptional<...>; }, $strip> | 0.5.0 or earlier |
|
|
242
|
+
| `walletNameSchema` | constant walletNameSchema: ZodString | 0.5.0 or earlier |
|
|
243
|
+
| `walletRegistrySchema` | constant walletRegistrySchema: ZodObject<{ version: ZodLiteral<1>; default: ZodOptional<ZodString>; wallets: ZodRecord<ZodString, ZodObject<{ createdAt: ZodISODateTime; label: ZodOptional<...>; spendCaps: ZodObject<...>; routerRefill: ZodOptional<...>; link... | 0.5.0 or earlier |
|
|
244
|
+
| `WalletStore` | class WalletStore | 0.3.0 |
|
|
245
|
+
| `writeAgentProfile` | function (home: string, profile: AgentProfileInput): Promise<void> | 0.5.0 or earlier |
|
|
246
|
+
| `writeDefaultConfig` | function (path = getVapiPaths().config, source: NodeJS.ProcessEnv = process.env, options: DefaultConfigOptions = {}): Promise<VapiConfig> | 0.5.0 or earlier |
|
|
247
|
+
| `X402_SOLANA_MAINNET_CAIP2` | constant X402_SOLANA_MAINNET_CAIP2: "solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp" | 0.5.0 or earlier |
|
|
248
|
+
| `X402Error` | class X402Error | 0.5.0 or earlier |
|
|
249
|
+
| `X402PaymentError` | class X402PaymentError | 0.5.0 or earlier |
|
|
250
|
+
|
|
251
|
+
### Types
|
|
252
|
+
|
|
253
|
+
| Name | What it is | Since |
|
|
254
|
+
| ------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------- |
|
|
255
|
+
| `AccountBalance` | type AccountBalance = { atomic: string; formatted: string; } | 0.5.0 or earlier |
|
|
256
|
+
| `AccountInfo` | type AccountInfo = { caip2: string; name: string; address: string; usdcBalance: AccountBalance \| null; gasTokenBalance?: GasTokenBalance \| null; depositUrl?: string; depositInstructions?: string; error?: string; } | 0.5.0 or earlier |
|
|
257
|
+
| `AccountNetworkAdapter` | type AccountNetworkAdapter = ( context: AccountNetworkAdapterContext, ) => Promise<Omit<AccountInfo, "caip2">> | 0.5.0 or earlier |
|
|
258
|
+
| `AccountNetworkAdapterContext` | type AccountNetworkAdapterContext = { caip2: string; configured: VapiConfig["networks"][string]; defaultAddress: string; allowPrivateNetwork?: boolean; fetchImpl?: typeof fetch; lookup?: LookupFn; } | 0.5.0 or earlier |
|
|
259
|
+
| `Address` | type Address = ResolvedRegister['addressType'] | 0.5.0 or earlier |
|
|
260
|
+
| `AgentCashConfig` | type AgentCashConfig = VapiConfig | 0.5.0 or earlier |
|
|
261
|
+
| `AgentCashKeystore` | type AgentCashKeystore = VapiKeystore | 0.5.0 or earlier |
|
|
262
|
+
| `AgentCashPaths` | type AgentCashPaths = VapiPaths | 0.5.0 or earlier |
|
|
263
|
+
| `AgentLink` | type AgentLink = { apiBase: string; clientId: string; owner: `0x${string}`; label: string; scopes: string[]; linkedAt: string; routerBaseUrl?: string; } | 0.5.0 or earlier |
|
|
264
|
+
| `AgentMarker` | type AgentMarker = (typeof AGENT_MARKER_VARIABLES)[number] | 0.5.0 or earlier |
|
|
265
|
+
| `AgentProfile` | type AgentProfile = z.infer<typeof agentProfileSchema> | 0.5.0 or earlier |
|
|
266
|
+
| `AgentProfileInput` | type AgentProfileInput = z.input<typeof agentProfileSchema> | 0.5.0 or earlier |
|
|
267
|
+
| `AgentRouterUsage` | type AgentRouterUsage = { compute: { allowanceUsd: number; spentTodayUsd: number; remainingTodayUsd: number; resetsAt: string; ownerLimitUsd: number; ownerSpentUsd: number; }; balance: { purchasedUsd: number; spentUsd: number; remainingUsd: number } \| null; } | 0.5.0 or earlier |
|
|
268
|
+
| `AgentTokens` | type AgentTokens = { accessToken: string; refreshToken: string; expiresAt: number; scopes: string[]; } | 0.5.0 or earlier |
|
|
269
|
+
| `ApiMarketplaceHit` | type ApiMarketplaceHit = z.infer<typeof apiMarketplaceHitSchema> | 0.5.0 or earlier |
|
|
270
|
+
| `AuditEntry` | type AuditEntry = AuditRecord & { time: string } | 0.5.0 or earlier |
|
|
271
|
+
| `AuditEvent` | type AuditEvent = (typeof AUDIT_EVENTS)[number] | 0.5.0 or earlier |
|
|
272
|
+
| `AuditOptions` | type AuditOptions = { now?: () => Date; } | 0.5.0 or earlier |
|
|
273
|
+
| `AuditRecord` | type AuditRecord = { event: AuditEvent; wallet?: string; owner?: string; tty: boolean; agentMarker?: string; detail?: string; } | 0.5.0 or earlier |
|
|
274
|
+
| `AuthorizationState` | type AuthorizationState = "settled" \| "expired" \| "pending" | 0.5.0 or earlier |
|
|
275
|
+
| `CallableCategory` | type CallableCategory = z.infer<typeof callableCategorySchema> | 0.5.0 or earlier |
|
|
276
|
+
| `CallTarget` | type CallTarget = DiscoveryEndpoint | 0.5.0 or earlier |
|
|
277
|
+
| `CanonicalX402UsdcIdentity` | type CanonicalX402UsdcIdentity = Readonly<{ usdc: Address; eip712Domain: X402TokenDomain; }> | 0.5.0 or earlier |
|
|
278
|
+
| `CanonicalX402UsdcNetwork` | type CanonicalX402UsdcNetwork = typeof BASE_MAINNET_CAIP2 \| typeof ARC_MAINNET_CAIP2 \| typeof ARC_TESTNET_CAIP2 | 0.5.0 or earlier |
|
|
279
|
+
| `ChatMessage` | type ChatMessage = { role: "system" \| "user" \| "assistant" \| "tool"; content: string; name?: string; tool_call_id?: string; tool_calls?: Array<{ id: string; type: "function"; function: { name: string; arguments: string }; }>; } | 0.5.0 or earlier |
|
|
280
|
+
| `ChatRequest` | type ChatRequest = { model: string; messages: ChatMessage[]; max_tokens?: number; temperature?: number; tools?: unknown[]; tool_choice?: unknown; } | 0.5.0 or earlier |
|
|
281
|
+
| `ChatResult` | type ChatResult = { content: string \| null; toolCalls: Array<{ id: string; name: string; arguments: string }>; usage?: { prompt_tokens: number; completion_tokens: number; total_tokens: number }; model: string; keyUsed: "stake" \| "balance"; } | 0.5.0 or earlier |
|
|
282
|
+
| `CompleteX402PaymentArgs` | type CompleteX402PaymentArgs = { challenge: X402PaymentAttempt; account: VapiPaymentAccount; caps: SpendCaps; config: VapiConfig; send(request: Request): Promise<X402PaymentAttempt>; consumeResponse?: (response: Response) => Promise<T>; fetchImpl?: typeof f... | 0.5.0 or earlier |
|
|
283
|
+
| `CompleteX402PaymentResult` | type CompleteX402PaymentResult = { response: Response; request: Request; body: T \| undefined; quote: X402Quote; payer: string; paymentId?: string; settlement: unknown \| null; settlementOutcome: X402SettlementOutcome; } | 0.5.0 or earlier |
|
|
284
|
+
| `ConfiguredNetwork` | type ConfiguredNetwork = { rpcUrl: string; usdc: string; } | 0.5.0 or earlier |
|
|
285
|
+
| `CreatedWallet` | type CreatedWallet = ResolvedWallet & { account: VapiPaymentAccount; recoveryPhrase: string; } | 0.5.0 or earlier |
|
|
286
|
+
| `CreateKeystoreOptions` | type CreateKeystoreOptions = { enableSolana?: boolean; phrase?: string; } | 0.5.0 or earlier |
|
|
287
|
+
| `CreateSupportReportOptions` | type CreateSupportReportOptions = { message: string; includeAddresses?: boolean; send?: boolean; reportsDirectory?: string; receiptsPath?: string; clientVersion?: string; now?: Date; systemInfo?: SupportSystemInfo; registryUrl?: string; env?: NodeJS.Process... | 0.5.0 or earlier |
|
|
288
|
+
| `CreateSupportReportResult` | type CreateSupportReportResult = { path: string; issueUrl: string; report: SupportReport; responseCode?: number; } | 0.5.0 or earlier |
|
|
289
|
+
| `DefaultConfigOptions` | type DefaultConfigOptions = { networks?: readonly string[]; } | 0.5.0 or earlier |
|
|
290
|
+
| `DeviceLinkStart` | type DeviceLinkStart = { clientId: string; deviceCode: string; userCode: string; verificationUri: string; verificationUriComplete: string; expiresIn: number; interval: number; } | 0.5.0 or earlier |
|
|
291
|
+
| `DiscoverServicesResult` | type DiscoverServicesResult = SearchServicesResponse | 0.5.0 or earlier |
|
|
292
|
+
| `DiscoveryCatalog` | type DiscoveryCatalog = { services: DiscoveryService[]; resolve(serviceId: string, endpointName?: string): CallTarget; resolveListing(serviceId: string, endpointName?: string): ResolvedListing; } | 0.5.0 or earlier |
|
|
293
|
+
| `DiscoveryCatalogErrorCode` | type DiscoveryCatalogErrorCode = \| "no_endpoint" \| "ambiguous_default" \| "malformed_url" \| "blank_method" \| "invalid_endpoint_name" \| "duplicate_endpoint_name" \| "service_not_found" \| "endpoint_not_found" \| "invalid_discovery" | 0.5.0 or earlier |
|
|
294
|
+
| `DiscoveryCategory` | type DiscoveryCategory = z.infer<typeof discoveryCategorySchema> | 0.5.0 or earlier |
|
|
295
|
+
| `DiscoveryEndpoint` | type DiscoveryEndpoint = z.infer<typeof discoveryEndpointSchema> | 0.5.0 or earlier |
|
|
296
|
+
| `DiscoveryService` | type DiscoveryService = ServiceSummary | 0.5.0 or earlier |
|
|
297
|
+
| `Eip3009Authorization` | type Eip3009Authorization = { from: Address; to: Address; value: string; validAfter: "0"; validBefore: string; nonce: Hex; } | 0.5.0 or earlier |
|
|
298
|
+
| `EvmX402PaymentRequirements` | type EvmX402PaymentRequirements = { scheme: "exact"; network: `eip155:${number}`; asset: Address; amount: string; payTo: Address; maxTimeoutSeconds: number; extra: Record<string, unknown> & { name: string; version: string }; } | 0.5.0 or earlier |
|
|
299
|
+
| `ExecutionMode` | type ExecutionMode = z.infer<typeof executionModeSchema> | 0.5.0 or earlier |
|
|
300
|
+
| `FirstPartyProvenance` | type FirstPartyProvenance = z.infer<typeof firstPartyProvenanceSchema> | 0.5.0 or earlier |
|
|
301
|
+
| `FundingPageOptions` | type FundingPageOptions = { amount?: number; } | 0.5.0 or earlier |
|
|
302
|
+
| `GasTokenBalance` | type GasTokenBalance = AccountBalance & { symbol: string; } | 0.5.0 or earlier |
|
|
303
|
+
| `Hex` | type Hex = `0x${string}` | 0.5.0 or earlier |
|
|
304
|
+
| `ImportedWallet` | type ImportedWallet = ResolvedWallet & { account: VapiPaymentAccount; } | 0.5.0 or earlier |
|
|
305
|
+
| `LatencyPercentiles` | type LatencyPercentiles = Readonly<{ p50Ms: number \| null; p95Ms: number \| null }> | 0.5.0 or earlier |
|
|
306
|
+
| `LayoutMigration` | type LayoutMigration = { moved: boolean; from?: string; to?: string; } | 0.5.0 or earlier |
|
|
307
|
+
| `LegacyRegistryRewrite` | type LegacyRegistryRewrite = { field: string; from: string; to: string; } | 0.5.0 or earlier |
|
|
308
|
+
| `LegacyVapiKeystore` | type LegacyVapiKeystore = z.infer<typeof legacyKeystoreSchema> | 0.5.0 or earlier |
|
|
309
|
+
| `LinkResult` | type LinkResult = { tokens: AgentTokens; owner: `0x${string}`; routerKey?: string; routerBaseUrl?: string; routerKeyError?: string; } | 0.5.0 or earlier |
|
|
310
|
+
| `ListAccountsArgs` | type ListAccountsArgs = { address: string; solanaAddress?: string; config: VapiConfig; fetchImpl?: typeof fetch; lookup?: LookupFn; adapters?: Readonly<Record<string, AccountNetworkAdapter>>; } | 0.5.0 or earlier |
|
|
311
|
+
| `Listing` | interface Listing | 0.4.0 |
|
|
312
|
+
| `ListingConformance` | type ListingConformance = z.infer<typeof listingConformanceSchema> | 0.5.0 or earlier |
|
|
313
|
+
| `ListingFee` | type ListingFee = z.infer<typeof listingFeeSchema> | 0.5.0 or earlier |
|
|
314
|
+
| `ListingGroup` | type ListingGroup = z.infer<typeof listingGroupSchema> | 0.5.0 or earlier |
|
|
315
|
+
| `ListingIdentity` | type ListingIdentity = z.infer<typeof listingIdentitySchema> | 0.5.0 or earlier |
|
|
316
|
+
| `ListingLiveness` | type ListingLiveness = z.infer<typeof listingLivenessSchema> | 0.5.0 or earlier |
|
|
317
|
+
| `ListingProvenance` | type ListingProvenance = Readonly<{ source: string; sourceUrl?: string; ref?: string; }> | 0.5.0 or earlier |
|
|
318
|
+
| `ListingVerification` | type ListingVerification = z.infer<typeof listingVerificationSchema> | 0.5.0 or earlier |
|
|
319
|
+
| `ListServicesResponse` | type ListServicesResponse = z.infer<typeof listServicesResponseSchema> | 0.5.0 or earlier |
|
|
320
|
+
| `LoadConfigOptions` | type LoadConfigOptions = { notice?: (message: string) => void; } | 0.5.0 or earlier |
|
|
321
|
+
| `LookupFn` | type LookupFn = (hostname: string) => Promise<string[]> | 0.5.0 or earlier |
|
|
322
|
+
| `MarketplaceBadge` | type MarketplaceBadge = z.infer<typeof marketplaceBadgeSchema> | 0.5.0 or earlier |
|
|
323
|
+
| `MarketplaceBadgeCode` | type MarketplaceBadgeCode = z.infer<typeof marketplaceBadgeCodeSchema> | 0.5.0 or earlier |
|
|
324
|
+
| `MarketplaceDiscoveryInput` | type MarketplaceDiscoveryInput = z.infer<typeof marketplaceDiscoveryInputSchema> | 0.5.0 or earlier |
|
|
325
|
+
| `MarketplaceDiscoveryPage` | type MarketplaceDiscoveryPage = z.infer<typeof marketplaceDiscoveryPageSchema> | 0.5.0 or earlier |
|
|
326
|
+
| `MarketplaceExecutionMethod` | type MarketplaceExecutionMethod = z.infer<typeof marketplaceExecutionMethodSchema> | 0.5.0 or earlier |
|
|
327
|
+
| `MarketplaceHit` | type MarketplaceHit = z.infer<typeof marketplaceHitSchema> | 0.5.0 or earlier |
|
|
328
|
+
| `MarketplaceKind` | type MarketplaceKind = z.infer<typeof marketplaceKindSchema> | 0.5.0 or earlier |
|
|
329
|
+
| `MarketplacePublicFact` | type MarketplacePublicFact = z.infer<typeof marketplacePublicFactSchema> | 0.5.0 or earlier |
|
|
330
|
+
| `MigrationOptions` | type MigrationOptions = { targetDirectory?: string; legacyDirectory?: string; notice?: (message: string) => void; } | 0.5.0 or earlier |
|
|
331
|
+
| `NetworkDefinition` | type NetworkDefinition = { family: "evm" \| "svm"; chainId?: number; name: string; usdc: string; gasToken: "ETH" \| "USDC" \| "SOL"; rpcEnv: string; publicRpcUrl?: string; explorerUrl?: string; } | 0.5.0 or earlier |
|
|
332
|
+
| `NetworkTransportOptions` | type NetworkTransportOptions = { allowPrivateNetwork?: boolean; fetch?: typeof fetch; lookup?: LookupFn; } | 0.5.0 or earlier |
|
|
333
|
+
| `OpenRequestMarketplaceHit` | type OpenRequestMarketplaceHit = z.infer<typeof openRequestMarketplaceHitSchema> | 0.5.0 or earlier |
|
|
334
|
+
| `PassphraseSource` | type PassphraseSource = "environment" \| "secret-store" \| "prompt" | 0.5.0 or earlier |
|
|
335
|
+
| `PaymentIntent` | type PaymentIntent = Readonly<{ amountAtomic: bigint; network: string; payTo: Address; resourceUrl?: string; }> | 0.5.0 or earlier |
|
|
336
|
+
| `PayRequestArgs` | type PayRequestArgs = { url: string; init: RequestInit; account: VapiPaymentAccount; wallet: WalletName; caps: SpendCaps; config: VapiConfig; fetchImpl: typeof fetch; paths?: { ledgerPath?: string; receiptsPath?: string }; maxAtomic?: bigint; preferNetworks... | 0.5.0 or earlier |
|
|
337
|
+
| `PayRequestResult` | type PayRequestResult = { response: Response; receipt: Receipt } | 0.5.0 or earlier |
|
|
338
|
+
| `Policy` | interface Policy | 0.5.0 or earlier |
|
|
339
|
+
| `Provenance` | type Provenance = z.infer<typeof provenanceSchema> | 0.5.0 or earlier |
|
|
340
|
+
| `Receipt` | interface Receipt | 0.5.0 or earlier |
|
|
341
|
+
| `ReceiptOutcome` | type ReceiptOutcome = NonNullable<Receipt["outcome"]> | 0.5.0 or earlier |
|
|
342
|
+
| `ReceiptSettlementCheck` | type ReceiptSettlementCheck = { network: string; token: string; authorizer: string; nonce: string; validBefore: string; chainTime: string; state: AuthorizationState; } | 0.5.0 or earlier |
|
|
343
|
+
| `ResolvedListing` | type ResolvedListing = { service: DiscoveryService; endpoint: CallTarget; } | 0.5.0 or earlier |
|
|
344
|
+
| `ResolvedPassphrase` | type ResolvedPassphrase = { passphrase: string; source: PassphraseSource; } | 0.5.0 or earlier |
|
|
345
|
+
| `ResolvedWallet` | type ResolvedWallet = { name: WalletName; path: string; entry: WalletEntry; } | 0.5.0 or earlier |
|
|
346
|
+
| `ResolvePassphraseOptions` | type ResolvePassphraseOptions = { env?: NodeJS.ProcessEnv \| undefined; store?: SecretStore \| undefined; prompt?: ((prompt: string, noTerminalHint?: string) => Promise<string>) \| undefined; interactive?: boolean \| undefined; confirm?: boolean \| undefined; } | 0.5.0 or earlier |
|
|
347
|
+
| `RouterModel` | type RouterModel = { id: string; [k: string]: unknown } | 0.5.0 or earlier |
|
|
348
|
+
| `RouterRefill` | type RouterRefill = { belowUsd: number; tierUsd: RouterTopupTier } | 0.5.0 or earlier |
|
|
349
|
+
| `RouterTopupTier` | type RouterTopupTier = (typeof ROUTER_TOPUP_TIERS)[number] | 0.5.0 or earlier |
|
|
350
|
+
| `SearchEvent` | interface SearchEvent | 0.5.0 or earlier |
|
|
351
|
+
| `SearchServicesResponse` | type SearchServicesResponse = z.infer<typeof searchServicesResponseSchema> | 0.5.0 or earlier |
|
|
352
|
+
| `SecretsDecision` | type SecretsDecision = { allowed: boolean; reason?: string; marker?: AgentMarker; } | 0.5.0 or earlier |
|
|
353
|
+
| `SecretsStreams` | type SecretsStreams = { stdinIsTTY: boolean; stdoutIsTTY: boolean; } | 0.5.0 or earlier |
|
|
354
|
+
| `SecretStore` | type SecretStore = { available: boolean; platform: NodeJS.Platform; description: string; get(name: string): Promise<string \| undefined>; has(name: string): Promise<boolean>; set(name: string, passphrase: string): Promise<void>; remove(name: string): Promise... | 0.5.0 or earlier |
|
|
355
|
+
| `SecretStoreOptions` | type SecretStoreOptions = { platform?: NodeJS.Platform \| undefined; run?: SecretStoreRunner \| undefined; } | 0.5.0 or earlier |
|
|
356
|
+
| `SecretStoreOutcome` | type SecretStoreOutcome = { code: number \| null; stdout: string; stderr: string; notFound?: boolean; } | 0.5.0 or earlier |
|
|
357
|
+
| `SecretStoreRunner` | type SecretStoreRunner = ( file: string, args: readonly string[], input?: string, ) => Promise<SecretStoreOutcome> | 0.5.0 or earlier |
|
|
358
|
+
| `ServiceOfferMarketplaceHit` | type ServiceOfferMarketplaceHit = z.infer<typeof serviceOfferMarketplaceHitSchema> | 0.5.0 or earlier |
|
|
359
|
+
| `ServiceStats` | interface ServiceStats | 0.5.0 or earlier |
|
|
360
|
+
| `ServiceSummary` | type ServiceSummary = z.infer<typeof serviceSummarySchema> | 0.5.0 or earlier |
|
|
361
|
+
| `ServiceTier` | type ServiceTier = z.infer<typeof serviceTierSchema> | 0.5.0 or earlier |
|
|
362
|
+
| `Signer` | interface Signer | 0.5.0 or earlier |
|
|
363
|
+
| `SIWxChallenge` | type SIWxChallenge = Readonly<{ info: SIWxExtensionInfo; chain: SIWxSupportedChain; }> | 0.5.0 or earlier |
|
|
364
|
+
| `SIWxExtensionInfo` | type SIWxExtensionInfo = Readonly<{ domain: string; uri: string; statement?: string; version: "1"; nonce: string; issuedAt: string; expirationTime?: string; notBefore?: string; requestId?: string; resources?: readonly string[]; }> | 0.5.0 or earlier |
|
|
365
|
+
| `SIWxPayload` | type SIWxPayload = SIWxExtensionInfo & Readonly<{ address: Address; chainId: `eip155:${number}`; type: SIWxSignatureType; signatureScheme?: SIWxSupportedChain["signatureScheme"]; signature: Hex; }> | 0.5.0 or earlier |
|
|
366
|
+
| `SIWxSignatureType` | type SIWxSignatureType = "eip191" | 0.5.0 or earlier |
|
|
367
|
+
| `SIWxSigner` | type SIWxSigner = Readonly<{ address: Address; signMessage(args: { message: string }): Promise<Hex>; }> | 0.5.0 or earlier |
|
|
368
|
+
| `SIWxSupportedChain` | type SIWxSupportedChain = Readonly<{ chainId: `eip155:${number}`; type: SIWxSignatureType; signatureScheme?: "eip191" \| "eip1271" \| "eip6492"; }> | 0.5.0 or earlier |
|
|
369
|
+
| `Source` | interface Source | 0.5.0 or earlier |
|
|
370
|
+
| `SourceSearchOptions` | type SourceSearchOptions = Readonly<{ includeUnverified?: boolean; }> | 0.5.0 or earlier |
|
|
371
|
+
| `SpendCaps` | type SpendCaps = z.infer<typeof spendCapsSchema> | 0.5.0 or earlier |
|
|
372
|
+
| `SpendLedger` | type SpendLedger = z.infer<typeof ledgerSchema> | 0.5.0 or earlier |
|
|
373
|
+
| `SpendLedgerRow` | type SpendLedgerRow = SpendLedger & { wallet: WalletName } | 0.5.0 or earlier |
|
|
374
|
+
| `StatsRange` | type StatsRange = (typeof STATS_RANGES)[number] | 0.5.0 or earlier |
|
|
375
|
+
| `StatsReport` | interface StatsReport | 0.5.0 or earlier |
|
|
376
|
+
| `SupportReport` | type SupportReport = { message: string; clientVersion: string; os: { platform: string; release: string; arch: string; }; node: string; receiptIds: string[]; receiptAddresses?: Array<{ receiptId: string; payer?: string; payTo?: string; }>; } | 0.5.0 or earlier |
|
|
377
|
+
| `SupportSystemInfo` | type SupportSystemInfo = { platform: string; release: string; arch: string; node: string; } | 0.5.0 or earlier |
|
|
378
|
+
| `SvmX402PaymentRequirements` | type SvmX402PaymentRequirements = { scheme: "exact"; network: `solana:${string}`; asset: string; amount: string; payTo: string; maxTimeoutSeconds: number; extra: Record<string, unknown> & { feePayer: string }; } | 0.5.0 or earlier |
|
|
379
|
+
| `SweepResult` | type SweepResult = { network: string; amountAtomic: string; transaction: string; } | 0.5.0 or earlier |
|
|
380
|
+
| `TrashedWallet` | type TrashedWallet = { name: WalletName; removedAt: string; path: string; entry?: WalletEntry; } | 0.5.0 or earlier |
|
|
381
|
+
| `VapiConfig` | type VapiConfig = z.infer<typeof configSchema> | 0.5.0 or earlier |
|
|
382
|
+
| `VapiKeystore` | type VapiKeystore = z.infer<typeof keystoreSchema> | 0.5.0 or earlier |
|
|
383
|
+
| `VapiKeystoreV3` | type VapiKeystoreV3 = z.infer<typeof keystoreV3Schema> | 0.5.0 or earlier |
|
|
384
|
+
| `VapiPaths` | type VapiPaths = { directory: string; agentsDir: string; config: string; keystore: string; receipts: string; searches: string; ledger: string; } | 0.5.0 or earlier |
|
|
385
|
+
| `VapiPaymentAccount` | type VapiPaymentAccount = ReturnType<typeof privateKeyToAccount> & { readonly solana?: KeyPairSigner; } | 0.5.0 or earlier |
|
|
386
|
+
| `Wallet` | interface Wallet | 0.5.0 or earlier |
|
|
387
|
+
| `WalletBalanceReader` | type WalletBalanceReader = (address: string) => Promise<bigint> | 0.5.0 or earlier |
|
|
388
|
+
| `WalletEntry` | type WalletEntry = z.infer<typeof walletEntrySchema> | 0.5.0 or earlier |
|
|
389
|
+
| `WalletInfo` | type WalletInfo = ResolvedWallet & { address?: string; solanaAddress?: string; keystoreVersion?: number; isDefault: boolean; spendCaps: SpendCaps; label?: string; createdAt: string; } | 0.5.0 or earlier |
|
|
390
|
+
| `WalletName` | type WalletName = string | 0.5.0 or earlier |
|
|
391
|
+
| `WalletRegistry` | type WalletRegistry = z.infer<typeof walletRegistrySchema> | 0.5.0 or earlier |
|
|
392
|
+
| `WalletSelection` | type WalletSelection = { name?: string \| undefined; env?: NodeJS.ProcessEnv \| undefined; } | 0.5.0 or earlier |
|
|
393
|
+
| `WalletStoreOptions` | type WalletStoreOptions = { now?: () => Date; } | 0.5.0 or earlier |
|
|
394
|
+
| `X402CompatiblePaymentHeaders` | type X402CompatiblePaymentHeaders = X402PaymentHeaders & { "X-PAYMENT": string; } | 0.5.0 or earlier |
|
|
395
|
+
| `X402NetworkConfig` | type X402NetworkConfig = Readonly< Record< string, Readonly<{ usdc: string; rpcUrl?: string; enabled?: boolean; eip712Domain?: X402TokenDomain; }> > > | 0.5.0 or earlier |
|
|
396
|
+
| `X402PaymentAttempt` | type X402PaymentAttempt = { response: Response; request: Request; finish(): void; waitFor<T>(operation: Promise<T>, response: Response): Promise<T>; } | 0.5.0 or earlier |
|
|
397
|
+
| `X402PaymentHeaders` | type X402PaymentHeaders = { "PAYMENT-SIGNATURE": string; } | 0.5.0 or earlier |
|
|
398
|
+
| `X402PaymentPayload` | type X402PaymentPayload = { x402Version: 2; resource: X402Resource; accepted: X402PaymentRequirements; payload: { signature: Hex; authorization: Eip3009Authorization } \| { transaction: string }; extensions?: Record<string, unknown>; } | 0.5.0 or earlier |
|
|
399
|
+
| `X402PaymentRequirements` | type X402PaymentRequirements = EvmX402PaymentRequirements \| SvmX402PaymentRequirements | 0.5.0 or earlier |
|
|
400
|
+
| `X402PaymentTrace` | type X402PaymentTrace = { phases: { quoteMs?: number; signMs?: number; requestMs?: number; settleMs?: number; }; quote?: NonNullable<Receipt["quote"]>; payer?: string; paymentId?: string; authorization?: NonNullable<Receipt["authorization"]>; settlement?: N... | 0.5.0 or earlier |
|
|
401
|
+
| `X402PossibleSettlement` | type X402PossibleSettlement = { network: string; asset: string; amountAtomic: string; payTo: string; payer: string; paymentId?: string; authorizationNonce?: string; authorizationExpiresAt?: string; authorizationTransaction?: string; receipt: unknown \| null; } | 0.5.0 or earlier |
|
|
402
|
+
| `X402Quote` | type X402Quote = { x402Version: 2; amountAtomic: bigint; resource: X402Resource; accepted: X402PaymentRequirements; extensions?: Record<string, unknown>; rpcUrl?: string; } | 0.5.0 or earlier |
|
|
403
|
+
| `X402Resource` | type X402Resource = { url: string; description?: string; mimeType?: string; serviceName?: string; tags?: string[]; iconUrl?: string; } | 0.5.0 or earlier |
|
|
404
|
+
| `X402SettlementOutcome` | type X402SettlementOutcome = "succeeded" \| "rejected" \| "unknown" | 0.5.0 or earlier |
|
|
405
|
+
| `X402Signer` | type X402Signer = { address: Address; signTypedData(typedData: X402TypedData): Promise<Hex>; solana?: ConstructorParameters<typeof ExactSvmScheme>[0]; } | 0.5.0 or earlier |
|
|
406
|
+
| `X402TokenDomain` | type X402TokenDomain = Readonly<{ name: string; version: string; }> | 0.5.0 or earlier |
|
|
407
|
+
| `X402TypedData` | type X402TypedData = { domain: { name: string; version: string; chainId: number; verifyingContract: Address; }; types: typeof EIP3009_AUTHORIZATION_TYPES; primaryType: "TransferWithAuthorization"; message: { from: Address; to: Address; value: bigint; validA... | 0.5.0 or earlier |
|
|
408
|
+
|
|
409
|
+
### `@vapi-network/core/secrets`
|
|
410
|
+
|
|
411
|
+
The MCP package never imports this entry point; lint forbids it.
|
|
412
|
+
|
|
413
|
+
| Name | What it is | Since |
|
|
414
|
+
| -------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------- |
|
|
415
|
+
| `createKeystoreWithPhrase` | function (passphrase: string, path = getVapiPaths().keystore, options: CreateKeystoreOptions = {}): Promise<{ account: VapiPaymentAccount; recoveryPhrase: string }> | 0.3.0 |
|
|
416
|
+
| `decryptPrivateKey` | function (keystore: VapiKeystore \| VapiKeystoreV3, passphrase: string): Promise<Hex> | 0.3.0 |
|
|
417
|
+
| `ExportedVapiKeys` | type ExportedVapiKeys = { evm: { address: string; privateKey: Hex }; solana?: { address: string; secretKey: string }; } | 0.5.0 or earlier |
|
|
418
|
+
| `exportKeystoreKeys` | function (passphrase: string, path = getVapiPaths().keystore): Promise<ExportedVapiKeys> | 0.3.0 |
|
|
419
|
+
| `exportRecoveryPhrase` | function (passphrase: string, path = getVapiPaths().keystore): Promise<string> | 0.3.0 |
|
|
420
|
+
|
|
421
|
+
See the [root README](https://github.com/vAPI-Network/vapi-network/blob/main/docs/sdk.md) for the SDK examples, the [configuration layout](https://github.com/vAPI-Network/vapi-network/blob/main/docs/configuration.md) and the [custody model](https://github.com/vAPI-Network/vapi-network/blob/main/docs/wallets.md).
|