@chainsafe/lodestar-api

A Typescript implementation of the Ethereum Consensus light client

0.39.0

latest

source

npm

Version published: 2 years ago

Weekly downloads: 4.8K; decreased by-10.45%

Maintainers: 3

Created: 3 years ago

Weekly downloads

Readme

Source

Lodestar Eth Consensus API

This package is part of ChainSafe's Lodestar project

Typescript REST client for the Ethereum Consensus API spec

Usage

import {getClient} from "@chainsafe/lodestar-api";
import {config} from "@chainsafe/lodestar-config/default";

const api = getClient({
  baseUrl: "http://localhost:9596",
}, {config});

api.beacon
  .getStateValidator(
    "head",
    "0x933ad9491b62059dd065b560d256d8957a8c402cc6e8d8ee7290ae11e8f7329267a8811c397529dac52ae1342ba58c95"
  )
  .then((res) => console.log("Your balance is:", res.data.balance));

Prerequisites

What you need

You will need to go over the specification. You will also need to have a basic understanding of sharding.

Getting started

Follow the installation guide to install Lodestar.
Quickly try out the whole stack by starting a local testnet.
View the typedoc code docs.

Contributors

Read our contributors document, submit an issue or talk to us on our discord!

License

Apache-2.0 ChainSafe Systems

Keywords

FAQs

What is @chainsafe/lodestar-api?

Is @chainsafe/lodestar-api popular?

Is @chainsafe/lodestar-api well maintained?

Last updated on 28 Jun 2022

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install