Skip to content

Commit

Permalink
fix: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
DiRaiks committed Aug 24, 2023
1 parent 4364b68 commit 753f57c
Showing 1 changed file with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions packages/sdk/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,25 @@

You can install the Lido Ethereum SDK using npm or yarn:

yarn:

```bash
yarn add @lidofinance/lido-ethereum-sdk
```

npm:

```bash
npm install @lidofinance/lido-ethereum-sdk
```

## Modules

The Lido Ethereum SDK consists of several modules:

- **Core** - provides access to the SDK core functionality
- **Staking** - provides access to the Lido staking functionality
...
TODO: add more modules

## Usage

Expand Down Expand Up @@ -74,6 +82,8 @@ const lidoSDK = new LidoSDK({

// Views
const balanceETH = await lidoSDK.core.balanceETH(address);

console.log(balanceETH.toString(), "ETH balance");
```

### Staking
Expand All @@ -98,7 +108,6 @@ const stakeResult = await lidoSDK.staking.stake({
referralAddress,
});

console.log(balanceETH.toString(), "ETH balance");
console.log(balanceStETH.toString(), "stETH balance");
console.log(addressStETH, "stETH contract address");
console.log(contractStETH, "stETH contract");
Expand Down

0 comments on commit 753f57c

Please sign in to comment.