Skip to content

Commit a285e17

Browse files
committed
docs: use # [!code focus] on booleans and numbers in code examples
1 parent 0881892 commit a285e17

File tree

7 files changed

+35
-73
lines changed

7 files changed

+35
-73
lines changed

documentation/rrelayer/docs/pages/config/networks/automatic-top-up.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ networks: // [!code focus]
7070
from: // [!code focus]
7171
relayer: // [!code focus]
7272
address: "0x33993A4F4AA617DA4558A0CFD0C39A7989B67720"
73-
internal_only: false // [!code focus]
73+
internal_only: false # [!code focus]
7474
```
7575
7676
#### safe
@@ -246,7 +246,7 @@ networks: // [!code focus]
246246
native: // [!code focus]
247247
min_balance: "0.1"
248248
top_up_amount: "0.5"
249-
decimals: "6" // [!code focus]
249+
decimals: 6 # [!code focus]
250250
```
251251

252252
### erc20 tokens - optional (you should have this OR native)
@@ -288,5 +288,5 @@ networks: // [!code focus]
288288
- address: "0x99bba657f2bbc93c02d617f8ba121cb8fc104acf" // [!code focus]
289289
min_balance: "100" // [!code focus]
290290
top_up_amount: "500" // [!code focus]
291-
decimals: "18" // [!code focus]
291+
decimals: 18 # [!code focus]
292292
```

documentation/rrelayer/docs/pages/config/networks/config.mdx

Lines changed: 4 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ signing_provider:
3939
region: "eu-west-1"
4040
networks: // [!code focus]
4141
- name: "sepolia_ethereum"
42-
chain_id: 11155111 // [!code focus]
42+
chain_id: 11155111 # [!code focus]
4343
```
4444
4545
### provider_urls
@@ -111,34 +111,7 @@ networks: // [!code focus]
111111
provider_urls:
112112
- "https://sepolia.gateway.tenderly.co"
113113
block_explorer_url: "https://sepolia.etherscan.io"
114-
max_gas_price_multiplier: 4 // [!code focus]
115-
```
116-
117-
### max_gas_price_multiplier - default 4
118-
119-
rrelayer will bump up prices after n numbers of blocks depending on what transaction speed you sent it as,
120-
with that it could end up on huge spikes trying to bump it a very high amount. The idea with this is rrelayer
121-
will never send a transaction more then 4x greater then the fastest gas price we have from our gas providers.
122-
You can change this to say 1000 if you wish to never care about max gas cost. Note each relayer can have its own
123-
config for max gas price which you can read more about [here](/integration/sdk/relayers/node#update-max-gas-price)
124-
125-
```yaml [rrelayer.yaml]
126-
name: first-rrelayer
127-
description: "my first rrelayer"
128-
api_config:
129-
port: 3000
130-
authentication_username: ${RRELAYER_AUTH_USERNAME}
131-
authentication_password: ${RRELAYER_AUTH_PASSWORD}
132-
signing_provider:
133-
aws_kms:
134-
region: "eu-west-1"
135-
networks: // [!code focus]
136-
- name: "sepolia_ethereum"
137-
chain_id: 11155111
138-
provider_urls:
139-
- "https://sepolia.gateway.tenderly.co"
140-
block_explorer_url: "https://sepolia.etherscan.io"
141-
max_gas_price_multiplier: 4 // [!code focus]
114+
max_gas_price_multiplier: 4 # [!code focus]
142115
```
143116
144117
### confirmations - optional default 12
@@ -163,12 +136,7 @@ networks: // [!code focus]
163136
- "https://sepolia.gateway.tenderly.co"
164137
block_explorer_url: "https://sepolia.etherscan.io"
165138
max_gas_price_multiplier: 4
166-
gas_bump_blocks_every:
167-
slow: 10
168-
medium: 5
169-
fast: 4
170-
super_fast: 2
171-
confirmations: 2 // [!code focus]
139+
confirmations: 2 # [!code focus]
172140
```
173141
174142
### enable_sending_blobs - optional
@@ -192,11 +160,5 @@ networks: // [!code focus]
192160
- "https://sepolia.gateway.tenderly.co"
193161
block_explorer_url: "https://sepolia.etherscan.io"
194162
max_gas_price_multiplier: 4
195-
gas_bump_blocks_every:
196-
slow: 10
197-
medium: 5
198-
fast: 4
199-
super_fast: 2
200-
confirmations: 12
201-
enable_sending_blobs: false // [!code focus]
163+
enable_sending_blobs: false # [!code focus]
202164
```

documentation/rrelayer/docs/pages/config/networks/permissions.mdx

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ networks: // [!code focus]
4646
- address: "0x99bba657f2bbc93c02d617f8ba121cb8fc104acf"
4747
min_balance: "100"
4848
top_up_amount: "500"
49-
decimals: "18"
49+
decimals: 18 # [!code focus]
5050
permissions: // [!code focus]
5151
- relayers: // [!code focus]
5252
- "0x1c09df15fb12656420033eb58067ec9406ef0e26" // [!code focus]
@@ -89,7 +89,7 @@ networks: // [!code focus]
8989
- address: "0x99bba657f2bbc93c02d617f8ba121cb8fc104acf"
9090
min_balance: "100"
9191
top_up_amount: "500"
92-
decimals: "18"
92+
decimals: 18 # [!code focus]
9393
permissions: // [!code focus]
9494
- relayers: "0x1c09df15fb12656420033eb58067ec9406ef0e26" // [!code focus]
9595
```
@@ -130,7 +130,7 @@ networks: // [!code focus]
130130
- address: "0x99bba657f2bbc93c02d617f8ba121cb8fc104acf"
131131
min_balance: "100"
132132
top_up_amount: "500"
133-
decimals: "18"
133+
decimals: 18 # [!code focus]
134134
permissions: // [!code focus]
135135
- relayers: "*" // [!code focus]
136136
```
@@ -174,7 +174,7 @@ networks: // [!code focus]
174174
- address: "0x99bba657f2bbc93c02d617f8ba121cb8fc104acf"
175175
min_balance: "100"
176176
top_up_amount: "500"
177-
decimals: "18"
177+
decimals: 18 # [!code focus]
178178
permissions: // [!code focus]
179179
- relayers:
180180
- "0x1c09df15fb12656420033eb58067ec9406ef0e26"
@@ -222,15 +222,15 @@ networks: // [!code focus]
222222
- address: "0x99bba657f2bbc93c02d617f8ba121cb8fc104acf"
223223
min_balance: "100"
224224
top_up_amount: "500"
225-
decimals: "18"
225+
decimals: 18 # [!code focus]
226226
permissions: // [!code focus]
227227
- relayers:
228228
- "0x1c09df15fb12656420033eb58067ec9406ef0e26"
229229
- "0x6f3e343161c4b905342015ad20a5c492adfb730e"
230230
allowlist:
231231
- "0x70997970C51812dc3A010C7d01b50e0d17dc79C8"
232232
- "0xcfe267de230a234c5937f18f239617b7038ec271"
233-
disable_native_transfer: true // [!code focus]
233+
disable_native_transfer: true # [!code focus]
234234
```
235235
236236
### disable_personal_sign - optional default false
@@ -271,7 +271,7 @@ networks: // [!code focus]
271271
- address: "0x99bba657f2bbc93c02d617f8ba121cb8fc104acf"
272272
min_balance: "100"
273273
top_up_amount: "500"
274-
decimals: "18"
274+
decimals: 18 # [!code focus]
275275
permissions: // [!code focus]
276276
- relayers:
277277
- "0x1c09df15fb12656420033eb58067ec9406ef0e26"
@@ -280,7 +280,7 @@ networks: // [!code focus]
280280
- "0x70997970C51812dc3A010C7d01b50e0d17dc79C8"
281281
- "0xcfe267de230a234c5937f18f239617b7038ec271"
282282
disable_native_transfer: true
283-
disable_personal_sign: true // [!code focus]
283+
disable_personal_sign: true # [!code focus]
284284
```
285285
286286
### disable_typed_data_sign - optional default false
@@ -321,7 +321,7 @@ networks: // [!code focus]
321321
- address: "0x99bba657f2bbc93c02d617f8ba121cb8fc104acf"
322322
min_balance: "100"
323323
top_up_amount: "500"
324-
decimals: "18"
324+
decimals: 18 # [!code focus]
325325
permissions: // [!code focus]
326326
- relayers:
327327
- "0x1c09df15fb12656420033eb58067ec9406ef0e26"
@@ -331,7 +331,7 @@ networks: // [!code focus]
331331
- "0xcfe267de230a234c5937f18f239617b7038ec271"
332332
disable_native_transfer: true
333333
disable_personal_sign: true
334-
disable_typed_data_sign: true // [!code focus]
334+
disable_typed_data_sign: true # [!code focus]
335335
```
336336
337337
### disable_transactions - optional default false
@@ -372,7 +372,7 @@ networks: // [!code focus]
372372
- address: "0x99bba657f2bbc93c02d617f8ba121cb8fc104acf"
373373
min_balance: "100"
374374
top_up_amount: "500"
375-
decimals: "18"
375+
decimals: 18 # [!code focus]
376376
permissions: // [!code focus]
377377
- relayers:
378378
- "0x1c09df15fb12656420033eb58067ec9406ef0e26"
@@ -383,5 +383,5 @@ networks: // [!code focus]
383383
disable_native_transfer: true
384384
disable_personal_sign: true
385385
disable_typed_data_sign: true
386-
disable_transactions: true // [!code focus]
386+
disable_transactions: true # [!code focus]
387387
```

documentation/rrelayer/docs/pages/config/networks/transaction-speed.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,10 @@ networks:
2424
block_explorer_url: https://sepolia.etherscan.io
2525
enable_sending_blobs: true
2626
gas_bump_blocks_every: // [!code focus]
27-
slow: 10 // [!code focus]
28-
medium: 6 // [!code focus]
29-
fast: 4 // [!code focus]
30-
super_fast: 2 // [!code focus]
27+
slow: 10 # [!code focus]
28+
medium: 6 # [!code focus]
29+
fast: 4 # [!code focus]
30+
super_fast: 2 # [!code focus]
3131
api_config:
3232
port: 8000
3333
authentication_username: ${RRELAYER_AUTH_USERNAME}

documentation/rrelayer/docs/pages/config/rate-limits.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,8 @@ rate_limits: // [!code focus]
4646
user_limits: // [!code focus]
4747
per_relayer: // [!code focus]
4848
interval: "minute" // [!code focus]
49-
transactions: 10 // [!code focus]
50-
signing_operations: 20 // [!code focus]
49+
transactions: 10 # [!code focus]
50+
signing_operations: 20 # [!code focus]
5151
```
5252
5353
### Complete Rate Limiting Configuration
@@ -61,9 +61,9 @@ rate_limits: // [!code focus]
6161
signing_operations: 20 // [!code focus]
6262
global: // [!code focus]
6363
interval: "minute" // [!code focus]
64-
transactions: 100 // [!code focus]
65-
signing_operations: 200 // [!code focus]
66-
fallback_to_relayer: true // [!code focus]
64+
transactions: 100 # [!code focus]
65+
signing_operations: # [!code focus]
66+
fallback_to_relayer: true # [!code focus]
6767
```
6868
6969
### Advanced Configuration

documentation/rrelayer/docs/pages/config/signing-providers/privy.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@ api_config:
2727
authentication_password: "${RRELAYER_AUTH_PASSWORD}"
2828
signing_provider: // [!code focus]
2929
privy: // [!code focus]
30-
app_id: ${PRIVY_APP_ID} // [!code focus]
31-
app_secret: ${PRIVY_APP_SECRET} // [!code focus]
30+
app_id: "${PRIVY_APP_ID}" // [!code focus]
31+
app_secret: "${PRIVY_APP_SECRET}" // [!code focus]
3232
```
3333
3434
You then need to add the privy credentials to the `.env`

documentation/rrelayer/docs/pages/config/webhooks.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -56,8 +56,8 @@ webhooks: // [!code focus]
5656
- endpoint: "https://api.yourapp.com/webhooks/rrelayer" // [!code focus]
5757
shared_secret: "${WEBHOOK_SECRET}" // [!code focus]
5858
networks: "*" // [!code focus]
59-
max_retries: 3 // [!code focus]
60-
alert_on_low_balances: true // [!code focus]
59+
max_retries: 3 # [!code focus]
60+
alert_on_low_balances: true # [!code focus]
6161
```
6262
6363
### Multiple Webhooks
@@ -69,12 +69,12 @@ webhooks: // [!code focus]
6969
- endpoint: "https://api.yourapp.com/webhooks/transactions" // [!code focus]
7070
shared_secret: "${TRANSACTION_WEBHOOK_SECRET}" // [!code focus]
7171
networks: ["sepolia_ethereum", "polygon_mainnet"] // [!code focus]
72-
max_retries: 5 // [!code focus]
72+
max_retries: 5 # [!code focus]
7373
- endpoint: "https://monitoring.yourapp.com/webhooks/alerts" // [!code focus]
7474
shared_secret: "${ALERT_WEBHOOK_SECRET}" // [!code focus]
7575
networks: "*" // [!code focus]
76-
max_retries: 3 // [!code focus]
77-
alert_on_low_balances: true // [!code focus]
76+
max_retries: 3 # [!code focus]
77+
alert_on_low_balances: true # [!code focus]
7878
```
7979
8080
### Network Filtering

0 commit comments

Comments
 (0)