Skip to content

Commit d3263cc

Browse files
committed
WIP-comments-resolved
1 parent 078f9f0 commit d3263cc

File tree

4 files changed

+12
-10
lines changed

4 files changed

+12
-10
lines changed

pages/express-relay/_meta.json

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,14 +25,16 @@
2525

2626
"api-reference": {
2727
"title": "HTTP API Reference ↗",
28-
"href": "https://pyth-express-relay-mainnet.asymmetric.re/docs/"
28+
"href": "https://pyth-express-relay-mainnet.asymmetric.re/redoc/",
29+
"newWindow": true
2930
},
3031
"websocket-api-reference": "Websocket API Reference",
3132
"contract-addresses": "Contract Addresses",
3233
"errors": "Error Codes",
3334
"examples": {
3435
"title": "Example Application ↗",
35-
"href": "https://github.com/pyth-network/pyth-crosschain/tree/main/express_relay/examples/easy_lend"
36+
"href": "https://github.com/pyth-network/pyth-crosschain/tree/main/express_relay/examples/easy_lend",
37+
"newWindow": true
3638
},
3739
"-- Understand Express Relay": {
3840
"title": "Understanding Express Relay",

pages/express-relay/integrate-as-protocol.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ require(
7474
);
7575
```
7676
<Callout type="info" emoji="ℹ️">
77-
The `permissionId` represents unique identifying information of an opportunity.
77+
The `permissionId` represents a unique identifier of an opportunity.
7878
For a liquidation opportunity, the vault address or ID could be concatenated into `bytes` format.
7979
Consult [`Permissioning`](./how-express-relay-works/permissioning.mdx) for more information on generating permission IDs.
8080
</Callout>
@@ -202,7 +202,7 @@ The JSON payload should contain opportunities in the following format:
202202

203203

204204
Each protocol integrated with Express Relay must actively monitor for new opportunities.
205-
You can do this by indexing the chain, listening to protocol events, or querying protocol state through an RPC provider.
205+
Protocols can do this by indexing the chain, listening to protocol events, or querying protocol state through an RPC provider.
206206

207207
Check the [`monitor.ts`](https://github.com/pyth-network/pyth-crosschain/blob/main/express_relay/examples/easy_lend/src/monitor.ts) script,
208208
which fetches opportunities for the below-mentioned [Easy Lend](https://github.com/pyth-network/pyth-crosschain/tree/main/express_relay/examples/easy_lend) example and exposes them to Express Relay for auction.

pages/express-relay/integrate-as-searcher.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ Searchers can integrate with Express Relay in three steps:
1515

1616
<Steps>
1717

18-
### Subscribe to new opportunities
18+
### Subscribe to new Opportunities
1919

20-
Express Relay provides searchers with `Typescript` and `Python` SDKs to interact with Express Relay.
20+
Express Relay provides searchers with [`Typescript`](https://github.com/pyth-network/pyth-crosschain/tree/main/express_relay/sdk/js) and [`Python`](https://github.com/pyth-network/pyth-crosschain/tree/main/express_relay/sdk/python) SDKs to interact with Express Relay.
2121
Searchers can also directly fetch available opportunities via HTTP or subscribe to them via WebSocket.
2222

2323
<Tabs items={['Typescript', 'Python', 'HTTP', 'Websocket']}>
@@ -119,7 +119,7 @@ The server responds with opportunities in the following format:
119119
}
120120
```
121121

122-
### Evaluate the opportunity and construct the bid
122+
### Evaluate the Opportunity and Construct the Bid
123123

124124
Searchers should construct a bid based on the fetched opportunity.
125125
The SDKs provide an easy way to construct a bid using the [`OpportunityAdapter`](./integrate-as-searcher/opportunity-adapter.mdx) contract.
@@ -173,7 +173,7 @@ def opportunity_callback(opportunity: Opportunity):
173173

174174
If you prefer to use your own custom contracts instead of the `OpportunityAdapter`, please refer to the [custom contracts](./integrate-as-searcher/custom-contract.mdx) section.
175175

176-
### Submit bids on opportunities to Express Relay
176+
### Submit Bids on Opportunities to Express Relay
177177

178178
Searchers can submit the constructed bids to Express Relay via the SDKs, an HTTP POST request, or a WebSocket connection.
179179

pages/express-relay/integrate-as-searcher/opportunity-adapter.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Refer to the following command to deposit native ETH to `WETH`:
2020
```bash copy
2121
cast send \
2222
--private-key $PRIVATE_KEY \
23-
--rpc-url https://sepolia.optimism.io/ \
23+
--rpc-url https://mainnet.mode.network/ \
2424
$WETH_ADDRESS \
2525
"deposit()" --value 0.1ether # Change the value to the amount you want to deposit
2626
```
@@ -35,7 +35,7 @@ Refer to the following command to approve a token to `Permit2`:
3535
```bash copy
3636
cast send \
3737
--private-key $PRIVATE_KEY \
38-
--rpc-url https://sepolia.optimism.io/ \
38+
--rpc-url https://mainnet.mode.network/ \
3939
$TOKEN_ADDRESS \
4040
"approve(address spender, uint256 value)" \
4141
0x000000000022D473030F116dDEE9F6B43aC78BA3 100000000000000000000000000 # You can use a large amount to avoid approving multiple times

0 commit comments

Comments
 (0)