Skip to content

Latest commit

 

History

History
51 lines (30 loc) · 2.01 KB

README.md

File metadata and controls

51 lines (30 loc) · 2.01 KB

stake.js

CircleCI

The goal of stake.js is to help developers easily integrate Proof-of-Stake staking functions into Web3 applications. We have removed the complexity involved with implementing such processes, and aim to provide users with an easy to use high-level API that "just works".

Disclaimer: this library is in active development.

Dependencies

Usage

pnpm add @restake/stake.js

Supported Protocols

  • Avalanche
  • Ethereum
  • NEAR Protocol
  • Sui

This list is not final, as we are constantly working on adding support for additional protocols.

Design and Features

Behind the scenes, the library does the heavy lifting on the following key areas:

  • Managing connection to the blockchain network
  • Transaction signing and broadcasting
    • Protocol-specific stake, deposit, unstake, withdraw and claim operations
  • Handling integrations with custodial solutions, such as Fireblocks

We also aim to keep the library as lightweight as possible by implementing common functionalities (such as various elliptic curve signers) into our core SDK. Our signers mainly rely on audited modular cryptographic libraries, such as @noble/curves and @noble/hashes. Whenever we can, we aim to use libraries that support tree-shaking to decrease package size during bundling.

Security

Restake takes security very seriously. Should you discover a vulnerability, please DO NOT submit a public PR. Instead, send your report privately to security@restake.net.

Contributing

If you find an issue or want to suggest improvements, feel free to open a pull request.

License

MIT