This page documents the client SDKs for interacting with the EigenLayer-AVS system and provides examples of their usage. The SDK allows developers to create applications that communicate with the Aggregator service, manage tasks, interact with smart wallets, and utilize the distributed task execution capabilities of the EigenLayer-AVS network.

For information about the Aggregator component itself, see Aggregator.

SDK Overview#

The EigenLayer-AVS system currently provides a JavaScript/Node.js client SDK for interacting with the Aggregator service. The SDK is built on top of gRPC and provides a simple interface for performing all operations supported by the Aggregator.

Sources:

• examples/example.js1-70

Installation and Setup#

To use the JavaScript SDK, you need to install the required dependencies:

Then you can import the SDK in your application:

SDK Configuration#

The SDK requires configuration to connect to the appropriate Aggregator endpoint based on your environment:

Sources:

• examples/example.js20-68

SDK Architecture#

The SDK is composed of several core components that handle different aspects of interacting with the EigenLayer-AVS system:

gRPC Client#

The SDK uses gRPC to communicate with the Aggregator service. The gRPC client is initialized with the appropriate endpoint:

Authentication#

The SDK implements an authentication mechanism using wallet signatures to authenticate with the Aggregator:

Sources:

• examples/example.js70-109
• examples/static_codegen/avs_grpc_pb.js240-254

Core SDK Functions#

The JavaScript SDK provides several core functions for interacting with the Aggregator service:

Authentication and Key Management#

• generateApiToken() - Generates an API token for authenticating subsequent requests

Smart Wallet Management#

• getWallets() - Lists all smart wallets owned by the user
• createWallet() - Creates a new smart wallet with the specified salt

Task Management#

• createTask() - Creates a new task
• listTask() - Lists all tasks created by specified smart wallets
• getTask() - Gets details of a specific task
• cancelTask() - Cancels a running task
• deleteTask() - Permanently deletes a task

Task Execution#

• triggerTask() - Manually triggers a task execution
• listExecutions() - Lists all executions of a task
• getExecution() - Gets details of a specific execution

Sources:

• examples/example.js110-208
• examples/static_codegen/avs_grpc_pb.js254-376

Task Data Model#

The SDK interacts with the Task data model, which consists of:

Sources:

• examples/static_codegen/avs_pb.js420-514

Example: Creating and Authenticating a Client#

Sources:

• examples/example.js11-109

Example: Managing Smart Wallets#

Sources:

• examples/example.js210-267
• examples/example.js269-279

Example: Creating a Task#

The following example demonstrates creating a task that monitors a price oracle and triggers a notification:

Example code:

Sources:

• examples/example.js444-565

Example: Advanced Task with Event Monitoring#

The following example shows how to create a task that monitors blockchain events and sends notifications:

Sources:

• examples/example.js570-678

Example: Monitoring External API Services#

This example demonstrates how to create a task that periodically monitors AAVE liquidity rates using GraphQL and REST APIs:

Sources:

• examples/example.js681-787

SDK Task Management Operations Table#

The following table summarizes the main task management operations available in the SDK:

Operation	Function	Description
Create Task	createTask	Creates a new task with specified nodes, edges, and trigger
List Tasks	listTask	Lists tasks created by specified smart wallets
Get Task	getTask	Gets details of a specific task by ID
Trigger Task	triggerTask	Manually triggers execution of a task
Cancel Task	cancelTask	Cancels a running task
Delete Task	deleteTask	Permanently deletes a task

Sources:

• examples/example.js282-426

Available Trigger Types#

The SDK supports various trigger types for tasks:

Trigger Type	Description	Example
Manual	Task must be manually triggered by the user	{ manual: true }
Block	Task triggered at specified block intervals	{ block: { interval: 2 } }
Cron	Task triggered according to cron schedule	{ cron: { schedule: ["0 */5 * * *"] } }
Fixed Time	Task triggered at specific timestamps	{ fixed_time: { epochs: [timestamp1, timestamp2] } }
Event	Task triggered when specified blockchain events occur	{ event: { expression: "trigger1.data.topics[0] == 0x..." } }

Sources:

• examples/example.js461-495
• examples/static_codegen/avs_pb.js189-2047

Node Types#

The SDK supports various node types for task execution:

Node Type	Description	Example Use Case
ContractWrite	Executes a write operation on a smart contract	Token transfers, contract state updates
ContractRead	Reads data from a smart contract	Reading token balances, contract state
RestAPI	Makes HTTP requests to REST APIs	Fetching external data, sending notifications
GraphQLQuery	Executes GraphQL queries	Fetching data from Graph Protocol
Branch	Conditional logic for task flow	Executing actions based on conditions
CustomCode	Executes custom JavaScript code	Data transformation, complex calculations

Sources:

• examples/static_codegen/avs_pb.js210-409

Testing and Debugging Tasks#

The SDK provides several methods to debug and monitor task executions:

1. listExecutions() - Lists all executions of a task
2. getExecution() - Gets detailed execution information, including steps and results
3. Console logging - The example code includes extensive console logging for debugging

For detailed information about task execution and monitoring, see Task Engine.

Sources:

• examples/example.js133-159

Feature this wiki to auto refresh weekly