Security News
JavaScript Leaders Demand Oracle Release the JavaScript Trademark
In an open letter, JavaScript community leaders urge Oracle to give up the JavaScript trademark, arguing that it has been effectively abandoned through nonuse.
@chainsafe/lodestar-types
Advanced tools
This package is part of ChainSafe's Lodestar project
Lodestar defines all datatypes defined in the Ethereum Consensus spec. This tooling can be used for any Typescript project looking to operate on these types. Both Typescript interfaces and Simple Serialize (SSZ) methods are exported for consumers.
npm install @chainsafe/lodestar-types
The lodestar types library organizes datatypes on several dimensions:
Lodestar types are all defined as typescript interfaces. These interfaces can be used independently, and are used throughout downstream Lodestar packages (eg: in the beacon node).
These interfaces are accessible via named exports.
import {Epoch} from "@chainsafe/lodestar-types";
const x: Epoch = 5;
Lodestar types are also defined as SSZ objects. These "Type" objects provide convenient methods to perform SSZ operations (serialization / deserialization / merkleization/etc). The library exports a singleton object containing all SSZ objects.
import {Type} from "@chainsafe/ssz";
import {ssz, Epoch} from "@chainsafe/lodestar-types";
const EpochType: Type<Epoch> = ssz.Epoch;
const e = EpochType.defaultValue();
Lodestar types support multiple different consensus forks. In order to easily differentiate types that may change across forks, types are organized in namespaces according to the fork in which they're introduced. Types introduced in phase 0 are available under the phase0
namespace. Types introduced in altair are available under the altair
namespace.
import {altair, phase0, ssz} from "@chainsafe/lodestar-types";
const phase0State: phase0.BeaconState = ssz.phase0.BeaconState.defaultValue();
const altairState: altair.BeaconState = ssz.altair.BeaconState.defaultValue();
Primitive types are directly available without a namespace.
import {Epoch, ssz} from "@chainsafe/lodestar-types";
const epoch: Epoch = ssz.Epoch.defaultValue();
In some cases, we need interfaces that accept types across all forks, eg: when the fork is not known ahead of time. Typescript interfaces for this purpose are exported under the allForks
namespace. SSZ Types typed to these interfaces are also provided under an allForks
namespace, but keyed by ForkName
.
import {ForkName} from "@chainsafe/lodestar-params";
import {allForks, ssz} from "@chainsafe/lodestar-types";
const state: allForks.BeaconState = ssz.allForks[ForkName.phase0].BeaconState.defaultValue();
Apache-2.0 ChainSafe Systems
FAQs
Typescript types required for lodestar
The npm package @chainsafe/lodestar-types receives a total of 10,870 weekly downloads. As such, @chainsafe/lodestar-types popularity was classified as popular.
We found that @chainsafe/lodestar-types demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 5 open source maintainers collaborating on the project.
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.
Security News
In an open letter, JavaScript community leaders urge Oracle to give up the JavaScript trademark, arguing that it has been effectively abandoned through nonuse.
Security News
The initial version of the Socket Python SDK is now on PyPI, enabling developers to more easily interact with the Socket REST API in Python projects.
Security News
Floating dependency ranges in npm can introduce instability and security risks into your project by allowing unverified or incompatible versions to be installed automatically, leading to unpredictable behavior and potential conflicts.