@@ -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
6160The 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
8180The 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
103100The telegram message content that needs to be sent. The content is limited to
104101512 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
125123This 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
161158Allows adding a custom public label. The Web3telegram tool writes this onchain
162159as ` 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
185183Allows 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
216206Allows specifying the maximum amount (in nRLC) you are willing to pay the
217207telegram 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
241231Allows specifying the maximum amount (in nRLC) you are willing to pay the
242232Web3telegram 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
265255Allows specifying the maximum amount you want to pay the workerpool provider for
266256using 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
293283This uniquely identifies the telegram task on the iExec side chain. You can view
294284the status of the ` sendTelegram ` method by monitoring the task on the
0 commit comments