Skip to content

Commit 6b8161c

Browse files
committed
refactor: update blockchain node URLs and remove deprecated workerpool references in documentation
1 parent a6855de commit 6b8161c

File tree

9 files changed

+39
-83
lines changed

9 files changed

+39
-83
lines changed

src/guides/use-iapp/how-to-pay-executions.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ this, you should use the [iExec SDK](/references/sdk.md).
3737
import { IExec, utils } from 'iexec';
3838

3939
const ethProvider = utils.getSignerFromPrivateKey(
40-
'bellecour', // blockchain node URL
40+
'chain', // blockchain node URL
4141
'PRIVATE_KEY'
4242
);
4343
const iexec = new IExec({
@@ -136,7 +136,6 @@ const sendTelegram = await web3telegram.sendTelegram({
136136
telegramContent: 'My telegram message content',
137137
senderName: 'Awesome project team',
138138
label: 'some-custom-id',
139-
workerpoolAddressOrEns: 'prod-v8-bellecour.main.pools.iexec.eth',
140139
dataMaxPrice: 42,
141140
appMaxPrice: 42,
142141
workerpoolMaxPrice: 42,

src/guides/use-iapp/run-iapp-without-ProtectedData.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ blockchain.
4747
import { IExec, utils } from 'iexec';
4848

4949
const ethProvider = utils.getSignerFromPrivateKey(
50-
'bellecour', // blockchain node URL
50+
'chain', // blockchain node URL
5151
'PRIVATE_KEY'
5252
);
5353
const iexec = new IExec({
@@ -98,7 +98,7 @@ execution.
9898
import { IExec, utils } from 'iexec';
9999

100100
const ethProvider = utils.getSignerFromPrivateKey(
101-
'bellecour', // blockchain node URL
101+
'chain', // blockchain node URL
102102
'PRIVATE_KEY'
103103
);
104104
const iexec = new IExec({
@@ -155,7 +155,7 @@ securely and made available to the iApp as environment variables.
155155
import { IExec, utils } from 'iexec';
156156

157157
const ethProvider = utils.getSignerFromPrivateKey(
158-
'bellecour', // blockchain node URL
158+
'chain', // blockchain node URL
159159
'PRIVATE_KEY'
160160
);
161161
const iexec = new IExec({

src/references/dataProtector/advanced/advanced-configuration.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -74,8 +74,7 @@ import { IExecDataProtector, getWeb3Provider } from '@iexec/dataprotector';
7474
const web3Provider = getWeb3Provider('PRIVATE_KEY');
7575
// ---cut---
7676
const dataProtector = new IExecDataProtector(web3Provider, {
77-
subgraphUrl:
78-
'https://thegraph-product.iex.ec/subgraphs/name/bellecour/dataprotector', // [!code focus]
77+
subgraphUrl: 'subgraph-url', // [!code focus]
7978
});
8079
```
8180

@@ -94,7 +93,7 @@ import { IExecDataProtector, getWeb3Provider } from '@iexec/dataprotector';
9493
const web3Provider = getWeb3Provider('PRIVATE_KEY');
9594
// ---cut---
9695
const dataProtector = new IExecDataProtector(web3Provider, {
97-
ipfsNode: 'https://ipfs-upload.v8-bellecour.iex.ec', // [!code focus]
96+
ipfsNode: 'ipfs-node-url', // [!code focus]
9897
});
9998
```
10099

@@ -114,7 +113,7 @@ import { IExecDataProtector, getWeb3Provider } from '@iexec/dataprotector';
114113
const web3Provider = getWeb3Provider('PRIVATE_KEY');
115114
// ---cut---
116115
const dataProtector = new IExecDataProtector(web3Provider, {
117-
ipfsGateway: 'https://ipfs-gateway.v8-bellecour.iex.ec', // [!code focus]
116+
ipfsGateway: 'ipfs-gateway-url', // [!code focus]
118117
});
119118
```
120119

@@ -130,7 +129,7 @@ import { IExecDataProtector, getWeb3Provider } from '@iexec/dataprotector';
130129
const web3Provider = getWeb3Provider('PRIVATE_KEY');
131130
// ---cut---
132131
const dataProtector = new IExecDataProtector(web3Provider, {
133-
iexecOptions: { smsURL: 'https://sms.scone-prod.v8-bellecour.iex.ec' }, // [!code focus]
132+
iexecOptions: { smsURL: 'sms-url' }, // [!code focus]
134133
});
135134
```
136135

src/references/dataProtector/dataProtectorSharing/consume/consumeProtectedData.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -177,14 +177,6 @@ const consumeProtectedDataResult =
177177
});
178178
```
179179

180-
::: tip
181-
182-
iExec currently offers a production workerpool located at the Ethereum Name
183-
Service (ENS) address `prod-v8-bellecour.main.pools.iexec.eth`. This is the
184-
default workerpool for running confidential computations on the iExec platform.
185-
186-
:::
187-
188180
### maxPrice <OptionalBadge />
189181

190182
**Type:** `number`

src/references/web3mail/advanced-configuration.md

Lines changed: 5 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -23,19 +23,13 @@ import { type Web3MailConfigOptions } from '@iexec/web3mail';
2323
The Ethereum contract address or ENS (Ethereum Name Service) for the web3mail
2424
iApp.
2525

26-
If not provided, the default ENS `web3mail.apps.iexec.eth` pointing to the
27-
latest version of the web3mail iApp provided by iExec will be used.
28-
29-
You can find the corresponding iApp address with Bellecour explorer:
30-
[https://explorer.iex.ec/bellecour/search/web3mail.apps.iexec.eth](https://explorer.iex.ec/bellecour/search/web3mail.apps.iexec.eth).
31-
3226
```ts twoslash
3327
import { IExecWeb3mail, getWeb3Provider } from '@iexec/web3mail';
3428

3529
const web3Provider = getWeb3Provider('PRIVATE_KEY');
3630
// ---cut---
3731
const web3mail = new IExecWeb3mail(web3Provider, {
38-
dappAddressOrENS: 'web3mail.apps.iexec.eth', // [!code focus]
32+
dappAddressOrENS: '0x456def...', // [!code focus]
3933
});
4034
```
4135

@@ -54,13 +48,10 @@ import { IExecWeb3mail, getWeb3Provider } from '@iexec/web3mail';
5448
const web3Provider = getWeb3Provider('PRIVATE_KEY');
5549
// ---cut---
5650
const web3mail = new IExecWeb3mail(web3Provider, {
57-
dappWhitelistAddress: '0x781482C39CcE25546583EaC4957Fb7Bf04C277D2', // [!code focus]
51+
dappWhitelistAddress: '0x456def...', // [!code focus]
5852
});
5953
```
6054

61-
See it in
62-
[https://blockscout-bellecour.iex.ec/](https://blockscout-bellecour.iex.ec/address/0x781482C39CcE25546583EaC4957Fb7Bf04C277D2)
63-
6455
### dataProtectorSubgraph
6556

6657
The subgraph URL for querying data.
@@ -74,8 +65,7 @@ import { IExecWeb3mail, getWeb3Provider } from '@iexec/web3mail';
7465
const web3Provider = getWeb3Provider('PRIVATE_KEY');
7566
// ---cut---
7667
const web3mail = new IExecWeb3mail(web3Provider, {
77-
dataProtectorSubgraph:
78-
'https://thegraph-product.iex.ec/subgraphs/name/bellecour/dataprotector', // [!code focus]
68+
dataProtectorSubgraph: 'subgraph-url', // [!code focus]
7969
});
8070
```
8171

@@ -92,7 +82,7 @@ import { IExecWeb3mail, getWeb3Provider } from '@iexec/web3mail';
9282
const web3Provider = getWeb3Provider('PRIVATE_KEY');
9383
// ---cut---
9484
const web3mail = new IExecWeb3mail(web3Provider, {
95-
ipfsNode: 'https://ipfs-upload.v8-bellecour.iex.ec', // [!code focus]
85+
ipfsNode: 'ipfs-node-url', // [!code focus]
9686
});
9787
```
9888

@@ -110,7 +100,7 @@ import { IExecWeb3mail, getWeb3Provider } from '@iexec/web3mail';
110100
const web3Provider = getWeb3Provider('PRIVATE_KEY');
111101
// ---cut---
112102
const web3mail = new IExecWeb3mail(web3Provider, {
113-
ipfsGateway: 'https://ipfs-gateway.v8-bellecour.iex.ec', // [!code focus]
103+
ipfsGateway: 'ipfs-gateway-url', // [!code focus]
114104
});
115105
```
116106

src/references/web3mail/methods/sendEmail.md

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -216,7 +216,8 @@ const sendEmail = await web3mail.sendEmail({
216216
### workerpoolAddressOrEns <OptionalBadge />
217217

218218
**Type:** `workerpoolAddressOrEns`
219-
**Default:** iExec's production workerpool
219+
**Default:** `prod-v8-bellecour.main.pools.iexec.eth` (iExec's production
220+
workerpool)
220221

221222
Allows specifying the workerpool that will run the Web3Mail application.
222223

@@ -234,14 +235,6 @@ const sendEmail = await web3mail.sendEmail({
234235
});
235236
```
236237

237-
::: tip
238-
239-
iExec currently offers a production workerpool located at the Ethereum Name
240-
Service (ENS) address `prod-v8-bellecour.main.pools.iexec.eth`. This is the
241-
default workerpool for running confidential computations on the iExec platform.
242-
243-
:::
244-
245238
### dataMaxPrice <OptionalBadge />
246239

247240
**Type:** `number`

src/references/web3telegram/advanced-configuration.md

Lines changed: 7 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -23,19 +23,16 @@ import { type Web3TelegramConfigOptions } from '@iexec/web3telegram';
2323
The Ethereum contract address or ENS (Ethereum Name Service) for the
2424
web3telegram iApp.
2525

26-
If not provided, the default ENS `web3telegram.apps.iexec.eth` pointing to the
27-
latest version of the web3telegram iApp provided by iExec will be used.
28-
29-
You can find the corresponding iApp address with Bellecour explorer:
30-
[https://explorer.iex.ec/bellecour/search/web3telegram.apps.iexec.eth](https://explorer.iex.ec/bellecour/search/web3telegram.apps.iexec.eth).
26+
If not provided, the default ENS web3telegram iApp provided by iExec will be
27+
used.
3128

3229
```ts twoslash
3330
import { IExecWeb3telegram, getWeb3Provider } from '@iexec/web3telegram';
3431

3532
const web3Provider = getWeb3Provider('PRIVATE_KEY');
3633
// ---cut---
3734
const web3telegram = new IExecWeb3telegram(web3Provider, {
38-
dappAddressOrENS: 'web3telegram.apps.iexec.eth', // [!code focus]
35+
dappAddressOrENS: '0x456def...', // [!code focus]
3936
});
4037
```
4138

@@ -54,13 +51,10 @@ import { IExecWeb3telegram, getWeb3Provider } from '@iexec/web3telegram';
5451
const web3Provider = getWeb3Provider('PRIVATE_KEY');
5552
// ---cut---
5653
const web3telegram = new IExecWeb3telegram(web3Provider, {
57-
dappWhitelistAddress: '0x192C6f5AccE52c81Fcc2670f10611a3665AAA98F', // [!code focus]
54+
dappWhitelistAddress: '0x456def...', // [!code focus]
5855
});
5956
```
6057

61-
See it in
62-
[https://blockscout-bellecour.iex.ec/](https://blockscout-bellecour.iex.ec/address/0x192C6f5AccE52c81Fcc2670f10611a3665AAA98F)
63-
6458
### dataProtectorSubgraph
6559

6660
The subgraph URL for querying data.
@@ -74,8 +68,7 @@ import { IExecWeb3telegram, getWeb3Provider } from '@iexec/web3telegram';
7468
const web3Provider = getWeb3Provider('PRIVATE_KEY');
7569
// ---cut---
7670
const web3telegram = new IExecWeb3telegram(web3Provider, {
77-
dataProtectorSubgraph:
78-
'https://thegraph-product.iex.ec/subgraphs/name/bellecour/dataprotector', // [!code focus]
71+
dataProtectorSubgraph: 'subgraph-url', // [!code focus]
7972
});
8073
```
8174

@@ -92,7 +85,7 @@ import { IExecWeb3telegram, getWeb3Provider } from '@iexec/web3telegram';
9285
const web3Provider = getWeb3Provider('PRIVATE_KEY');
9386
// ---cut---
9487
const web3telegram = new IExecWeb3telegram(web3Provider, {
95-
ipfsNode: 'https://ipfs-upload.v8-bellecour.iex.ec', // [!code focus]
88+
ipfsNode: 'ipfs-node-url', // [!code focus]
9689
});
9790
```
9891

@@ -110,7 +103,7 @@ import { IExecWeb3telegram, getWeb3Provider } from '@iexec/web3telegram';
110103
const web3Provider = getWeb3Provider('PRIVATE_KEY');
111104
// ---cut---
112105
const web3telegram = new IExecWeb3telegram(web3Provider, {
113-
ipfsGateway: 'https://ipfs-gateway.v8-bellecour.iex.ec', // [!code focus]
106+
ipfsGateway: 'ipfs-gateway-url', // [!code focus]
114107
});
115108
```
116109

src/references/web3telegram/methods/fetchUserContacts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ import { type FetchUserContactsParams } from '@iexec/web3telegram';
3333

3434
### userAddress
3535

36-
`Address`
36+
**Type:** `Address`
3737

3838
The entity for which you wish to obtain the list of contacts.
3939

src/references/web3telegram/methods/sendTelegram.md

Lines changed: 16 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,6 @@ const sendTelegram = await web3telegram.sendTelegram({
4141
telegramContent: 'My telegram message content',
4242
senderName: 'Awesome project team',
4343
label: 'some-custom-id',
44-
workerpoolAddressOrEns: 'prod-v8-bellecour.main.pools.iexec.eth',
4544
dataMaxPrice: 42,
4645
appMaxPrice: 42,
4746
workerpoolMaxPrice: 42,
@@ -56,7 +55,7 @@ import { type SendTelegramParams } from '@iexec/web3telegram';
5655

5756
### protectedData
5857

59-
`Address`
58+
**Type:** `Address`
6059

6160
The address of the `protectedData` holding the contact's telegram chat ID.
6261

@@ -76,7 +75,7 @@ const sendTelegram = await web3telegram.sendTelegram({
7675

7776
### senderName
7877

79-
`string`
78+
**Type:** `string`
8079

8180
The name of the telegram message sender.
8281

@@ -96,9 +95,7 @@ const sendTelegram = await web3telegram.sendTelegram({
9695

9796
### telegramContent
9897

99-
`string`
100-
101-
_maximum size_: 512 kb
98+
**Type:**`string` **Maximum siz:** `512 kb`
10299

103100
The telegram message content that needs to be sent. The content is limited to
104101
512 kb in size. Telegram content is encrypted and stored in IPFS.
@@ -119,7 +116,8 @@ const sendTelegram = await web3telegram.sendTelegram({
119116

120117
### useVoucher <ChainNotSupportedBadge /> <OptionalBadge />
121118

122-
**Type:** `boolean`
119+
**Type:** `boolean`
120+
123121
**Default:** `false`
124122

125123
This optional param allows you to pay for the deal using your voucher. Make sure
@@ -137,7 +135,6 @@ const sendTelegram = await web3telegram.sendTelegram({
137135
telegramContent: 'My telegram message content',
138136
senderName: 'Awesome project team',
139137
label: 'some-custom-id',
140-
workerpoolAddressOrEns: 'prod-v8-bellecour.main.pools.iexec.eth',
141138
dataMaxPrice: 42,
142139
appMaxPrice: 42,
143140
workerpoolMaxPrice: 42,
@@ -156,7 +153,7 @@ sufficient funds for this transfer to proceed.
156153

157154
### label
158155

159-
`string | undefined`
156+
**Type:** `string | undefined`
160157

161158
Allows adding a custom public label. The Web3telegram tool writes this onchain
162159
as `iexec_args` in the deal params.
@@ -178,9 +175,10 @@ const sendTelegram = await web3telegram.sendTelegram({
178175

179176
### workerpoolAddressOrEns
180177

181-
`workerpoolAddressOrEns | undefined`
178+
**Type:** `workerpoolAddressOrEns | undefined`
182179

183-
_default_: iExec's production workerpool
180+
**Default:** `prod-v8-bellecour.main.pools.iexec.eth` (iExec's production
181+
workerpool)
184182

185183
Allows specifying the workerpool that will run the Web3Telegram application.
186184

@@ -199,19 +197,11 @@ const sendTelegram = await web3telegram.sendTelegram({
199197
});
200198
```
201199

202-
::: tip
203-
204-
iExec currently offers a production workerpool located at the Ethereum Name
205-
Service (ENS) address `prod-v8-bellecour.main.pools.iexec.eth`. This is the
206-
default workerpool for running confidential computations on the iExec platform.
207-
208-
:::
209-
210200
### dataMaxPrice
211201

212-
`number | undefined`
202+
**Type:** `number | undefined`
213203

214-
_default_: `0`
204+
**Default:** `0`
215205

216206
Allows specifying the maximum amount (in nRLC) you are willing to pay the
217207
telegram chat ID owner for using their data. The owner of the protected chat ID
@@ -234,9 +224,9 @@ const sendTelegram = await web3telegram.sendTelegram({
234224

235225
### appMaxPrice
236226

237-
`number | undefined`
227+
**Type:** `number | undefined`
238228

239-
_default_: `0`
229+
**Default:** `0`
240230

241231
Allows specifying the maximum amount (in nRLC) you are willing to pay the
242232
Web3telegram app provider (iExec) for using the Web3telegram application.
@@ -258,9 +248,9 @@ const sendTelegram = await web3telegram.sendTelegram({
258248

259249
### workerpoolMaxPrice
260250

261-
`number | undefined`
251+
**Type:** `number | undefined`
262252

263-
_default_: `0`
253+
**Default:** `0`
264254

265255
Allows specifying the maximum amount you want to pay the workerpool provider for
266256
using their infrastructure to run the web3telegram app in nRLC.
@@ -288,7 +278,7 @@ import { type SendTelegramResponse } from '@iexec/web3telegram';
288278

289279
### taskId
290280

291-
`Addess`
281+
**Type:** `Address`
292282

293283
This uniquely identifies the telegram task on the iExec side chain. You can view
294284
the status of the `sendTelegram` method by monitoring the task on the

0 commit comments

Comments
 (0)