Skip to content

Commit

Permalink
docs: fix build
Browse files Browse the repository at this point in the history
  • Loading branch information
Jeday committed Oct 4, 2024
1 parent da66ff4 commit 6861aa4
Show file tree
Hide file tree
Showing 7 changed files with 18 additions and 18 deletions.
20 changes: 10 additions & 10 deletions docs/examples/rewards/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ The proposed approach involves maintaining an accounting model based on stETH [s
## Implementation notes

Token shares are managed at the contract level, with dedicated methods for handling share-related operations. Detailed documentation on these methods can be found in the [shares-related methods](https://docs.lido.fi/contracts/lido/#shares-related-methods) section.
You can also use [SDK methods](/methods/shares) to work with users’ shares directly.
You can also use [SDK methods](/modules/shares) to work with users’ shares directly.

## Usage

Expand All @@ -40,13 +40,13 @@ By adopting this approach and leveraging the capabilities of the SDK, developers
The [Lido Ethereum SDK](/) has the full set of features in this regard:

- [estimating APR](/methods/lido-statistics#getlastapr) for the latest token rebase.
- [calculating average APR](/methods/lido-statistics#getsmaapr) over a selected period.
- [last rebase event](/methods/lido-events#getlastrebaseevent) (contains share rate)
- [first rebase event](/methods/lido-events#getfirstrebaseevent) starting from the reference point in the past
- [get last N](/methods/lido-events#getlastrebaseevents) rebase events
- [get all rebase events](/methods/lido-events#getrebaseevents) for the last N days
- [estimating APR](/modules/lido-statistics#getlastapr) for the latest token rebase.
- [calculating average APR](/modules/lido-statistics#getsmaapr) over a selected period.
- [last rebase event](/modules/lido-events#getlastrebaseevent) (contains share rate)
- [first rebase event](/modules/lido-events#getfirstrebaseevent) starting from the reference point in the past
- [get last N](/modules/lido-events#getlastrebaseevents) rebase events
- [get all rebase events](/modules/lido-events#getrebaseevents) for the last N days
- assessing specific rewards accrued over a chosen period by an address
- [On-chain](/methods/rewards#get-rewards-from-chain)
- [Subgraph](/methods/rewards#get-rewards-from-subgraph)
- work with [user balances](/methods/shares) based on stETH shares
- [On-chain](/modules/rewards#get-rewards-from-chain)
- [Subgraph](/modules/rewards#get-rewards-from-subgraph)
- work with [user balances](/modules/shares) based on stETH shares
2 changes: 1 addition & 1 deletion docs/examples/rewards/retrieve-rewards-onchain.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ sidebar_position: 4
[Implementation example](https://github.com/lidofinance/lido-ethereum-sdk/blob/main/examples/rewards/src/rewardsOnChain.ts)

Information about the user’s rewards can be calculating from on-chain using SDK without the need to calculate using a formula.
To do this, you need to use the `getRewardsFromChain` method ([Docs](/methods/rewards))
To do this, you need to use the `getRewardsFromChain` method ([Docs](/modules/rewards))
The method allows you to request rewards for a certain period of time (days, seconds, blocks)

Simplified code example:
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/rewards/retrieve-rewards-subgraph.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ sidebar_position: 5
[Implementation example](https://github.com/lidofinance/lido-ethereum-sdk/blob/main/examples/rewards/src/rewardsSubgraph.ts)

Information about the user’s rewards can be obtained from off-chain using SDK without the need for calculation using a formula.
To do this, you need to use the `getRewardsFromSubgraph` method [[Docs](/methods/rewards)]. You will also need a key to access `The Graph`. ([Docs](https://docs.lido.fi/integrations/subgraph/))
To do this, you need to use the `getRewardsFromSubgraph` method [[Docs](/modules/rewards)]. You will also need a key to access `The Graph`. ([Docs](https://docs.lido.fi/integrations/subgraph/))

Simplified code example:

Expand Down
2 changes: 1 addition & 1 deletion docs/examples/rewards/subscribe-on-events.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ The first thing you need to do is subscribe to the `TokenRebased` event to recei

Next, you need to calculate the user’s balance in stETH before the event (if unknown) and calculate the user’s balance in stETH after the event. The difference between these values will be the user’s rewards for the rebase.

Docs: [Shares](/methods/shares)
Docs: [Shares](/modules/shares)
Simplified code example:

```ts
Expand Down
2 changes: 1 addition & 1 deletion docs/lidoPulse/get-started/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ To form a JSON-RPC request, you need to specify:
- `params`: The parameters required by the method.
- `id`: A unique identifier for the request.

The method names and their required parameters can be found in the [Lido SDK documentation](/category/methods).
The method names and their required parameters can be found in the [Lido SDK documentation](/category/modules).

## Example JSON-RPC Request

Expand Down
2 changes: 1 addition & 1 deletion docs/sdk/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ For breaking changes between versions see [MIGRATION.md](https://github.com/lido

## Documentation

For additional information about available methods and functionality, refer to the [the documentation for the Lido Ethereum SDK](/category/methods).
For additional information about available methods and functionality, refer to the [the documentation for the Lido Ethereum SDK](/category/modules).

## Playground

Expand Down
6 changes: 3 additions & 3 deletions docs/sdk/modules/rewards.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@ y
## Common Options

- **address** - (Type: Address) address of an account you want to query rewards for
- **to** (Type: [`blockType`](/methods/lido-events#getrebaseevents)) defaults to `{block: "latest"}`, upper bound for query
- **to** (Type: [`blockType`](/modules/lido-events#getrebaseevents)) defaults to `{block: "latest"}`, upper bound for query

- **from** (Type: [`blockType`](/methods/lido-events#getrebaseevents)) lower bound for query
- **from** (Type: [`blockType`](/modules/lido-events#getrebaseevents)) lower bound for query
or
- **back** (Type: [`backType`](/methods/lido-events#getrebaseevents)) alternative way to define lower bound relative to `to`
- **back** (Type: [`backType`](/modules/lido-events#getrebaseevents)) alternative way to define lower bound relative to `to`

- **includeZeroRebases** [default: `false` ] - include rebase events when users had no rewards(because of empty balance)
- **includeOnlyRewards** [default: `false` ] - include only rebase events
Expand Down

0 comments on commit 6861aa4

Please sign in to comment.