Elektrik Staking SDK

The Elektrik Staking SDK provides a set of classes for interacting with various smart contracts related to staking and governance on the Elektrik platform.

Features

• StakerWallet: Provides methods for obtaining an ethers signer from MetaMask or a private key.
• ElektrikToken: Allows interaction with the Elektrik token contract, including methods for checking balance, allowance, and approving token transfers.
• Locking: Facilitates staking operations, such as approving staking, checking allowance, creating locks, and retrieving balances.
• Staking: Enables interaction with the Staker smart contract, including methods for approving staking, checking allowance, setting receivers, and initiating staking processes.

Classes

1. StakerWallet: Provides methods for obtaining ethers signers. examples.md
2. ElektrikToken: Allows interaction with the Elektrik token contract. examples.md
3. Locking: Facilitates staking operations. examples.md
4. Staking: Enables interaction with the Staker smart contract. examples.md

Example Usage

For example usage of each class, refer to the examples.md file.

Installation

npm install @eltk/staking-sdk

Usage

import { StakerWallet, ElektrikToken, Locking, Staking } from "elektrik-staking-sdk";

// Example usage of each class

Documentation

For detailed documentation and API reference, see the API Documentation.

License

This project is licensed under the MIT License - see the LICENSE file for details.