Skip to content

Commit f3805e9

Browse files
JedayJeday
authored
Merge pull request #189 from lidofinance/develop
Remove goerli refs from docs
2 parents 17fba75 + 1e78249 commit f3805e9

12 files changed

+79
-82
lines changed

‎README.md

+9-8
Original file line numberDiff line numberDiff line change
@@ -58,14 +58,15 @@ Before using the SDK, you need to create an instance of the LidoSDK class:
5858
// Pass your own viem PublicClient
5959

6060
import { createPublicClient, http } from 'viem';
61-
import { goerli } from 'viem/chains';
61+
import { holesky } from 'viem/chains';
6262

6363
const rpcProvider = createPublicClient({
64-
chain: goerli,
64+
chain: holesky,
6565
transport: http(),
6666
});
67+
6768
const sdk = new LidoSDK({
68-
chainId: 5,
69+
chainId: 17000,
6970
rpcProvider,
7071
web3Provider: provider, // optional
7172
});
@@ -74,22 +75,22 @@ const sdk = new LidoSDK({
7475
```ts
7576
// Or just rpc urls so it can be created under the hood
7677
const sdk = new LidoSDK({
77-
chainId: 5,
78-
rpcUrls: ['https://eth-goerli.alchemyapi.io/v2/{ALCHEMY_API_KEY}'],
78+
chainId: 17000,
79+
rpcUrls: ['<RPC_URL>'],
7980
web3Provider: provider, // optional
8081
});
8182
```
8283

83-
Replace "https://eth-goerli.alchemyapi.io/v2/{ALCHEMY_API_KEY}" with the address of your Ethereum provider.
84+
Replace `<RPC_URL>` with the url of your Ethereum RPC provider.
8485

8586
## Examples
8687

8788
All examples and usage instructions can be found in the [Docs SDK package](https://lidofinance.github.io/lido-ethereum-sdk/).
8889

8990
```ts
9091
const lidoSDK = new LidoSDK({
91-
chainId: 5,
92-
rpcUrls: ['https://eth-goerli.alchemyapi.io/v2/{ALCHEMY_API_KEY}'],
92+
chainId: 17000,
93+
rpcUrls: ['<RPC_URL>'],
9394
web3Provider: provider,
9495
});
9596

‎docs/sdk/get-started/basic-examples.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ sidebar_position: 2
88

99
```ts
1010
const lidoSDK = new LidoSDK({
11-
chainId: 5,
12-
rpcUrls: ['https://eth-goerli.alchemyapi.io/v2/{ALCHEMY_API_KEY}'],
11+
chainId: 17000,
12+
rpcUrls: ['<RPC_URL>'],
1313
});
1414

1515
// Views
@@ -22,8 +22,8 @@ console.log(balanceETH.toString(), 'ETH balance');
2222

2323
```ts
2424
const lidoSDK = new LidoSDK({
25-
chainId: 5,
26-
rpcUrls: ['https://eth-goerli.alchemyapi.io/v2/{ALCHEMY_API_KEY}'],
25+
chainId: 17000,
26+
rpcUrls: ['<RPC_URL>'],
2727
web3provider: LidoSDKCore.createWeb3Provider(5, window.ethereum),
2828
});
2929

@@ -47,9 +47,9 @@ console.log(stakeTx, 'stake tx result');
4747

4848
```ts
4949
const lidoSDK = new LidoSDK({
50-
chainId: 5,
51-
rpcUrls: ['https://eth-goerli.alchemyapi.io/v2/{ALCHEMY_API_KEY}'],
52-
web3provider: LidoSDKCore.createWeb3Provider(5, window.ethereum),
50+
chainId: 17000,
51+
rpcUrls: ['<RPC_URL>'],
52+
web3provider: LidoSDKCore.createWeb3Provider(17000, window.ethereum),
5353
});
5454

5555
// Contracts
@@ -74,8 +74,8 @@ console.log(requestTx.result.requests, 'array of created requests');
7474

7575
```ts
7676
const lidoSDK = new LidoSDK({
77-
chainId: 5,
78-
rpcUrls: ['https://eth-goerli.alchemyapi.io/v2/{ALCHEMY_API_KEY}'],
77+
chainId: 17000,
78+
rpcUrls: ['<RPC_URL>'],
7979
web3provider: LidoSDKCore.createWeb3Provider(5, window.ethereum),
8080
});
8181

‎docs/sdk/get-started/usage.md

+13-13
Original file line numberDiff line numberDiff line change
@@ -44,14 +44,14 @@ Pass your own viem PublicClient:
4444
```ts
4545
import { LidoSDK } from '@lidofinance/lido-ethereum-sdk';
4646
import { createPublicClient, http } from 'viem';
47-
import { goerli } from 'viem/chains';
47+
import { holesky } from 'viem/chains';
4848

4949
const rpcProvider = createPublicClient({
50-
chain: goerli,
50+
chain: holesky,
5151
transport: http(),
5252
});
5353
const sdk = new LidoSDK({
54-
chainId: 5,
54+
chainId: 17000,
5555
rpcProvider,
5656
web3Provider: provider, // optional
5757
});
@@ -61,13 +61,13 @@ Or just rpc urls so it can be created under the hood:
6161

6262
```ts
6363
const sdk = new LidoSDK({
64-
chainId: 5,
65-
rpcUrls: ['https://eth-goerli.alchemyapi.io/v2/{ALCHEMY_API_KEY}'],
64+
chainId: 17000,
65+
rpcUrls: ['<RPC_URL>'],
6666
web3Provider: provider, // optional
6767
});
6868
```
6969

70-
Replace "https://eth-goerli.alchemyapi.io/v2/{ALCHEMY_API_KEY}" with the address of your Ethereum provider.
70+
Replace `<RPC_URL>` with the address of your Ethereum provider.
7171

7272
## With web3Provider
7373

@@ -79,19 +79,19 @@ Some functions don't usually require web3provider to be present like `simulate..
7979
```ts
8080
import { LidoSDK, LidoSDKCore } from '@lidofinance/lido-ethereum-sdk';
8181
import { createWalletClient, custom } from 'viem';
82-
import { goerli } from 'viem/chains';
82+
import { holesky } from 'viem/chains';
8383

8484
let web3Provider = createWalletClient({
85-
chain: goerli,
85+
chain: holesky,
8686
transport: custom(window.ethereum),
8787
});
8888

8989
// or use our helper to pass any eip-1193 provider
90-
let web3Provider = LidoSDKCore.createWeb3Provider(5, window.ethereum);
90+
let web3Provider = LidoSDKCore.createWeb3Provider(17000, window.ethereum);
9191

9292
const sdk = new LidoSDK({
93-
chainId: 5,
94-
rpcUrls: ['https://eth-goerli.alchemyapi.io/v2/{ALCHEMY_API_KEY}'],
93+
chainId: 17000,
94+
rpcUrls: ['<RPC_URL>'],
9595
web3Provider,
9696
});
9797
```
@@ -106,8 +106,8 @@ import { LidoSDKWrap } from '@lidofinance/lido-ethereum-sdk/stake';
106106
import { LidoSDKCore } from '@lidofinance/lido-ethereum-sdk/core';
107107

108108
const params = {
109-
chainId: 5,
110-
rpcUrls: ['https://eth-goerli.alchemyapi.io/v2/{ALCHEMY_API_KEY}'],
109+
chainId: 1700,
110+
rpcUrls: ['<RPC_URL>'],
111111
};
112112
// core is created under the hood
113113
const stake = new LidoSDKStake(params);

‎docs/sdk/intro.md

+9-13
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ For changes between versions see [Changelog](./changelog.mdx)
1212

1313
## Migration
1414

15-
For migration guide between major versions see [Migration](./migration.mdx)
15+
For migration guide between major versions see [Migration Guide](./migration.mdx)
1616

1717
## Installation
1818

@@ -47,14 +47,14 @@ Before using the SDK, you need to create an instance of the LidoSDK class:
4747
// Pass your own viem PublicClient
4848

4949
import { createPublicClient, http } from 'viem';
50-
import { goerli } from 'viem/chains';
50+
import { holesky } from 'viem/chains';
5151

5252
const rpcProvider = createPublicClient({
53-
chain: goerli,
53+
chain: holesky,
5454
transport: http(),
5555
});
5656
const sdk = new LidoSDK({
57-
chainId: 5,
57+
chainId: 17000,
5858
rpcProvider,
5959
web3Provider: provider, // optional
6060
});
@@ -63,22 +63,22 @@ const sdk = new LidoSDK({
6363
```ts
6464
// Or just rpc urls so it can be created under the hood
6565
const sdk = new LidoSDK({
66-
chainId: 5,
67-
rpcUrls: ['https://eth-goerli.alchemyapi.io/v2/{ALCHEMY_API_KEY}'],
66+
chainId: 17000,
67+
rpcUrls: ['<RPC_URL>'],
6868
web3Provider: provider, // optional
6969
});
7070
```
7171

72-
Replace "https://eth-goerli.alchemyapi.io/v2/{ALCHEMY_API_KEY}" with the address of your Ethereum provider.
72+
Replace `<RPC_URL>` with the URL of your Ethereum RPC provider.
7373

7474
## Example
7575

7676
Basic examples and usage instructions can be found in [here](/category/get-started).
7777

7878
```ts
7979
const lidoSDK = new LidoSDK({
80-
chainId: 5,
81-
rpcUrls: ['https://eth-goerli.alchemyapi.io/v2/{ALCHEMY_API_KEY}'],
80+
chainId: 17000,
81+
rpcUrls: ['<RPC_URL>'],
8282
web3Provider: provider,
8383
});
8484

@@ -99,10 +99,6 @@ const { stethReceived, sharesReceived } = stakeTx.result;
9999
console.log(balanceETH.toString(), 'ETH balance');
100100
```
101101

102-
## Migration
103-
104-
For breaking changes between versions see [MIGRATION.md](https://github.com/lidofinance/lido-ethereum-sdk/blob/main/packages/sdk/MIGRATION.md)
105-
106102
## Documentation
107103

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

‎docs/sdk/modules/lido-statistics.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,8 @@ sidebar_position: 11
3131
import { LidoSDK } from '@lidofinance/lido-ethereum-sdk';
3232

3333
const lidoSDK = new LidoSDK({
34-
rpcUrls: ['https://rpc-url'],
35-
chainId: 5,
34+
rpcUrls: ['<RPC_URL>'],
35+
chainId: 17000,
3636
});
3737

3838
const lastApr = await lidoSDK.statistics.apr.getLastApr();

‎docs/sdk/modules/rewards.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,8 @@ This method heavily utilizes RPC fetching chain event logs. It's better suited f
5252

5353
```ts
5454
const lidoSDK = new LidoSDK({
55-
chainId: 5,
56-
rpcUrls: ['https://eth-goerli.alchemyapi.io/v2/{ALCHEMY_API_KEY}'],
55+
chainId: 17000,
56+
rpcUrls: ['<RPC_URL>'],
5757
});
5858

5959
const rewardsQuery = await lidoSDK.rewards.getRewardsFromChain({
@@ -78,8 +78,8 @@ This method requires you to provide API URL to send subgraph requests to. It's b
7878

7979
```ts
8080
const lidoSDK = new LidoSDK({
81-
chainId: 5,
82-
rpcUrls: ['https://eth-goerli.alchemyapi.io/v2/{ALCHEMY_API_KEY}'],
81+
chainId: 1,
82+
rpcUrls: ['<RPC_URL>'],
8383
});
8484

8585
const rewardsQuery = await lidoSDK.rewards.getRewardsFromSubgraph({

‎docs/sdk/modules/shares.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ This module exposes methods of Lido(stETH) contract that allow interaction with
1212
import { LidoSDK } from '@lidofinance/lido-ethereum-sdk';
1313

1414
const lidoSDK = new LidoSDK({
15-
rpcUrls: ['https://rpc-url'],
16-
chainId: 5,
17-
web3Provider: LidoSDKCore.createWeb3Provider(5, window.ethereum),
15+
rpcUrls: ['<RPC_URL>'],
16+
chainId: 17000,
17+
web3Provider: LidoSDKCore.createWeb3Provider(17000, window.ethereum),
1818
});
1919

2020
const balanceShares = await lidoSDK.shares.balance(address);

‎docs/sdk/modules/stake.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,9 @@ import {
3131
} from '@lidofinance/lido-ethereum-sdk';
3232

3333
const lidoSDK = new LidoSDK({
34-
rpcUrls: ['https://rpc-url'],
35-
chainId: 5,
36-
web3Provider: LidoSDKCore.createWeb3Provider(5, window.ethereum),
34+
rpcUrls: ['<RPC_URL>'],
35+
chainId: 17000,
36+
web3Provider: LidoSDKCore.createWeb3Provider(1700, window.ethereum),
3737
});
3838

3939
const callback: StakeStageCallback = ({ stage, payload }) => {
@@ -86,8 +86,8 @@ try {
8686
import { LidoSDK } from '@lidofinance/lido-ethereum-sdk';
8787

8888
const lidoSDK = new LidoSDK({
89-
rpcUrls: ['https://rpc-url'],
90-
chainId: 5,
89+
rpcUrls: ['<RPC_URL>'],
90+
chainId: 17000,
9191
});
9292

9393
const populateResult = await lidoSDK.stake.stakeEthPopulateTx({
@@ -106,8 +106,8 @@ console.log(populateResult, 'to, from, value, data');
106106
import { LidoSDK } from '@lidofinance/lido-ethereum-sdk';
107107

108108
const lidoSDK = new LidoSDK({
109-
rpcUrls: ['https://rpc-url'],
110-
chainId: 5,
109+
rpcUrls: ['<RPC_URL>'],
110+
chainId: 17000,
111111
});
112112

113113
const simulateResult = await lidoSDK.staking.stakeEthSimulateTx({

‎docs/sdk/modules/unsteth-nft.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ This modules exposes NFT functionality of Lido Withdrawal Request NFT.
88

99
```ts
1010
const lidoSDK = new LidoSDK({
11-
chainId: 5,
12-
rpcUrls: ['https://eth-goerli.alchemyapi.io/v2/{ALCHEMY_API_KEY}'],
11+
chainId: 17000,
12+
rpcUrls: ['<RPC_URL>'],
1313
});
1414

1515
// Contracts

‎docs/sdk/modules/w-steth.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ stETH and wstETH tokens functionality is presented trough modules with same ERC2
88

99
```ts
1010
const lidoSDK = new LidoSDK({
11-
chainId: 5,
12-
rpcUrls: ['https://eth-goerli.alchemyapi.io/v2/{ALCHEMY_API_KEY}'],
13-
web3Provider: LidoSDKCore.createWeb3Provider(5, window.ethereum),
11+
chainId: 17000,
12+
rpcUrls: ['<RPC_URL>'],
13+
web3Provider: LidoSDKCore.createWeb3Provider(17000, window.ethereum),
1414
});
1515

1616
// Views

‎docs/sdk/modules/withdraw.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,9 @@ import {
3030
} from '@lidofinance/lido-ethereum-sdk';
3131

3232
const lidoSDK = new LidoSDK({
33-
rpcUrls: ['https://rpc-url'],
34-
chainId: 5,
35-
web3Provider: LidoSDKCore.createWeb3Provider(5, window.ethereum),
33+
rpcUrls: ['<RPC_URL>'],
34+
chainId: 17000,
35+
web3Provider: LidoSDKCore.createWeb3Provider(17000, window.ethereum),
3636
});
3737

3838
const callback: TransactionCallback = ({ stage, payload }) => {
@@ -112,9 +112,9 @@ import {
112112
} from '@lidofinance/lido-ethereum-sdk';
113113

114114
const lidoSDK = new LidoSDK({
115-
rpcUrls: ['https://rpc-url'],
116-
chainId: 5,
117-
web3Provider: LidoSDKCore.createWeb3Provider(5, window.ethereum),
115+
rpcUrls: ['<RPC_URL>'],
116+
chainId: 17000,
117+
web3Provider: LidoSDKCore.createWeb3Provider(17000, window.ethereum),
118118
});
119119

120120
const callback: TransactionCallback = ({ stage, payload }) => {
@@ -184,9 +184,9 @@ import {
184184
} from '@lidofinance/lido-ethereum-sdk';
185185

186186
const lidoSDK = new LidoSDK({
187-
rpcUrls: ['https://rpc-url'],
188-
chainId: 5,
189-
web3Provider: LidoSDKCore.createWeb3Provider(5, window.ethereum),
187+
rpcUrls: ['<RPC_URL>'],
188+
chainId: 17000,
189+
web3Provider: LidoSDKCore.createWeb3Provider(17000, window.ethereum),
190190
});
191191

192192
const callback: TransactionCallback = ({ stage, payload }) => {
@@ -253,9 +253,9 @@ import {
253253
} from '@lidofinance/lido-ethereum-sdk';
254254

255255
const lidoSDK = new LidoSDK({
256-
rpcUrls: ['https://rpc-url'],
257-
chainId: 5,
258-
web3Provider: LidoSDKCore.createWeb3Provider(5, window.ethereum),
256+
rpcUrls: ['<RPC_URL>'],
257+
chainId: 17000,
258+
web3Provider: LidoSDKCore.createWeb3Provider(17000, window.ethereum),
259259
});
260260

261261
const callback: ApproveStageCallback = ({ stage, payload }) => {

0 commit comments

Comments
 (0)