@sperax/tool-bridges
v0.2.2
Published
Track cross-chain bridge volumes, net flows, and top bridges with real-time data from DefiLlama. — an agent tool for SperaxOS.
Downloads
503
Maintainers
Readme
@sperax/tool-bridges
Track cross-chain bridge volumes, net flows, and top bridges with real-time data from DefiLlama.
Bridge Analytics is an agent tool from SperaxOS, packaged headless so you can call
it from any agent framework. It ships two things: the manifest — a JSON-Schema function
definition a model can call — and the executor that runs the call against the real API.
There is no UI layer and no framework lock-in. It works anywhere TypeScript runs.
Install
npm install @sperax/tool-bridgesUsage
Call it directly
import { bridgesExecutor } from '@sperax/tool-bridges';
const result = await bridgesExecutor.invoke('getBridges', {"chain":"<chain>","limit":1}, {
messageId: 'msg-1',
});
console.log(result.content); // prose summary written for the model to read
console.log(result.state); // typed data payload for your own UIGive it to a model
import Anthropic from '@anthropic-ai/sdk';
import { BridgesManifest, bridgesExecutor } from '@sperax/tool-bridges';
const client = new Anthropic();
const response = await client.messages.create({
model: 'claude-opus-4-8',
max_tokens: 1024,
messages: [{ role: 'user', content: 'Ask something this tool can answer' }],
tools: BridgesManifest.api.map((api) => ({
name: api.name,
description: api.description,
input_schema: api.parameters,
})),
});
for (const block of response.content) {
if (block.type !== 'tool_use') continue;
const result = await bridgesExecutor.invoke(block.name, block.input, { messageId: response.id });
console.log(result.content);
}BridgesManifest.api is already in JSON-Schema form, so it maps onto any tool-calling API —
Anthropic, OpenAI, the Vercel AI SDK, or an MCP server — without translation.
Every executor returns a BuiltinToolResult — { success, content, state }. content is
prose written for the model to read; state is the typed data payload for your own code.
Executors never throw: a failed call comes back as { success: false, content: '<reason>' },
so a network blip degrades the answer instead of crashing the agent loop.
Configuration
None. This tool calls a public API directly and needs no key or origin configuration.
Tool identifier
sperax-bridges
API reference
getBridges
List all cross-chain bridges with 24h and 7d volume data. Filter by chain and sort by volume or name.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| chain | string | no | Filter bridges by supported chain (e.g. "Ethereum", "Arbitrum") |
| limit | number | no | Max number of bridges to return (default 25) |
| sortBy | volume | name | no | Sort order: "volume" (default) or "name" |
getBridgeVolume
Get daily bridge deposit and withdrawal volumes for a specific chain. Shows 30-day history with net flow direction (inflow vs outflow).
| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| chain | string | yes | Chain name (e.g. "Ethereum", "Arbitrum", "Optimism", "Polygon") |
getBridgeSummary
Get a summary of the cross-chain bridge ecosystem: total volume, top bridges by volume, and top chains by inflow/outflow.
Takes no parameters.
Types
Shared types come from @sperax/agent-tools-core:
BuiltinToolManifest, BuiltinToolResult, BuiltinToolContext, and the BaseExecutor
class every tool executor extends.
Related
@sperax/agent-tools-core— the tool contract- All SperaxOS agent tools — tool-bridges is one of many
- SperaxOS — the agent workspace these tools were built for
License
Apache-2.0
