Skip to content

fireblocks/fireblocks-staking-eth-link

Repository files navigation

Eth-Link

Reference implementation and example code for the Eth-Link protocol — a provider-agnostic API for creating compounding ETH validators (post-Pectra).

Note: This is not an official SDK. The packages and examples in this repo are provided as reference implementations to help providers and clients integrate with the Eth-Link protocol.

Packages

Package Description
@fireblocks/eth-staking-eth-link-spec OpenAPI 3.0 specification (source of truth)
@fireblocks/eth-staking-eth-link-types Zod schemas + TypeScript types
@fireblocks/eth-staking-eth-link-api-validator CLI tool for testing provider endpoints + HMAC utilities
@fireblocks/eth-staking-eth-link-server Express middleware for providers

Validate a Provider

ETH_LINK_BASE_URL=http://localhost:3000 ETH_LINK_API_KEY=your-key yarn validate

OpenAPI Spec

The source-of-truth specification lives in packages/spec/. Reference it directly in your OpenAPI tooling:

$ref: "node_modules/@fireblocks/eth-staking-eth-link-spec/eth-link-spec.yaml"

Endpoints

Method Path Description
POST /eth-link/validators/create Create a compounding validator, return signed deposit data
POST /eth-link/validators/{pubkey}/events Receive validator lifecycle events
GET /eth-link/health Health check (polled every ~60s)

Examples

  • Express Provider — Using @fireblocks/eth-staking-eth-link-server middleware
  • Standalone Provider — Using only @fireblocks/eth-staking-eth-link-api-validator with Node.js http

Development

# Install dependencies
yarn install

# Build all packages
yarn build

# Type check
yarn typecheck

# Validate a running provider
ETH_LINK_BASE_URL=http://localhost:3000 ETH_LINK_API_KEY=dev-api-key-for-testing yarn validate

License

MIT

About

No description, website, or topics provided.

Resources

License

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors