WIP-protocol-guide-refactor

Author: aditya520

pages/express-relay/index.mdx

@@ -8,10 +8,10 @@ import ContractIcon from "../../components/icons/ContractIcon";
 
 Express Relay is a priority auction that enables protocols to eliminate maximal extractable value (MEV).
 
-**For Protocol Developers:** Express Relay’s auction primitive allows your protocol to prioritize access to permissionless operations, eliminating the extractive role of miners in ordering transactions.
+- **For Protocol Developers:** Express Relay’s auction primitive allows your protocol to prioritize access to permissionless operations, eliminating the extractive role of miners in ordering transactions.
 A network of established searchers compete in the auctions, allowing you to avoid spending time and energy bootstrapping your own protocol-specific searcher network.
 
-**For Searchers:** Express Relay aggregates liquidation and other MEV opportunities across integrated DeFi protocols, providing easy and unified access.
+- **For Searchers:** Express Relay aggregates liquidation and other MEV opportunities across integrated DeFi protocols, providing easy and unified access.
 
 <Cards>
   <Card

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

@@ -6,12 +6,12 @@ Defi protocols can **permissionlessly** integrate with Express Relay to recaptur
 
 Integrating with Express Relay involves two main steps:
 
-- Update your defi protocol's contract to **permission** Express Relay transactions.
-- Write a script to **expose** liquidation opportunities to Searchers for auction.
+- Update your defi protocol's contract to **permit** Express Relay transactions.
+- Write a script to **expose** opportunities to searchers for auction.
 
 ## Update your defi Protocol's Contract
 
-To integrate with Express Relay, your protocol's contract must permit Express Relay to access liquidation opportunities.
+To integrate with Express Relay, your protocol's contract must permit Express Relay to access opportunities.
 
 <Steps>
 ### Install the Express Relay SDK
@@ -50,17 +50,17 @@ The following steps show how to modify your protocol's contract to permit Expres
 1. Utilize [`isPermissioned`](https://github.com/pyth-network/pyth-crosschain/blob/main/express_relay/sdk/solidity/IExpressRelay.sol#L10C14-L10C28) method from `IExpressRelay` interface to **permit** Express Relay transactions.
 1. Implement the [`IExpressRelayFeeReceiver`](https://github.com/pyth-network/pyth-crosschain/blob/main/express_relay/sdk/solidity/IExpressRelayFeeReceiver.sol#L4) interface to **receive** funds from Express Relay.
 
-#### 1. Permission Express Relay Transactions
+#### 1. Permit Express Relay Transactions
 
 The `isPermissioned` function takes two arguments:
 1. `protocolFeeReceiver`: The contract address that will receive the protocol fee from the winning searcher after a successful auction.
-1. `permissionId`: A unique identifier of a vault or position eligible for liquidation.
+1. `permissionId`: A unique identifier of a vault or position eligible to expose as an opportunity.
 
 ```solidity copy
 import "@pythnetwork/express-relay-sdk-solidity/IExpressRelay.sol";
 
 // Express Relay contract address on Optimism Sepolia
-// Check {INSERT CONTRACT ADDRESS PAGE LINK} for the address deployed on other networks
+// Check https://docs.pyth.network/express-relay/contract-addresses for the address deployed on other networks
 address expressRelay = 0xD6e417287b875A3932c1Ff5dcB26D4D2C8b90B40;
 
 require(
@@ -90,7 +90,7 @@ interface IExpressRelayFeeReceiver {
 ```
 
 
-The following code snippet shows a sample liquidation method via Express Relay.
+The following code snippet shows a sample liquidation opportunity via Express Relay.
 Note: The highlighted lines show the contract's relevant additions for Express Relay integration.
 
 ```solidity showLineNumbers {1,2,12,14,21,38-42, 57-61} copy
@@ -110,12 +110,12 @@ contract EasyLend is IExpressRelayFeeReceiver {
     address public immutable expressRelay;
 
     constructor(
-    address expressRelayAddress,
+      address expressRelayAddress,
     bool allowUndercollateralized
     ){
-    _nVaults = 0;
-    expressRelay = expressRelayAddress;
-    _allowUndercollateralized = allowUndercollateralized;
+      _nVaults = 0;
+      expressRelay = expressRelayAddress;
+      _allowUndercollateralized = allowUndercollateralized;
     }
 
     /**
@@ -161,11 +161,11 @@ contract EasyLend is IExpressRelayFeeReceiver {
 </Steps>
 
 
-## Expose Liquidation Opportunities to Searchers
+## Expose Opportunities to Searchers
 
-Your defi protocol should fetch vaults and positions eligible for liquidation and expose them to Express Relay for auction.
+Your defi protocol should fetch vaults and positions eligible as opportunites and expose them to Express Relay for auction.
 
-The Express Relay auction server provides a **POST** method, `/v1/opportunities`, which accepts a JSON payload containing the details of the liquidation opportunity.
+The Express Relay auction server provides a **POST** method, `/v1/opportunities`, which accepts a JSON payload containing the details of the opportunity.
 
 The JSON payload should contain liquidation opportunities in the following format:
 
@@ -196,7 +196,7 @@ The JSON payload should contain liquidation opportunities in the following forma
 Each protocol integrated with Express Relay must evaluate every position's health using the latest Oracle prices before exposing them to Express Relay. 
 You can do this by indexing the chain, listening to protocol events, or querying open positions through an RPC provider.
 
-Check the [`monitor.ts`]() script, which fetches liquidation 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.
+Check the [`monitor.ts`](https://github.com/pyth-network/pyth-crosschain/blob/main/express_relay/examples/easy_lend/src/monitor.ts) script, which fetches liquidation 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.
 
 
 ## Additional Resources
@@ -215,4 +215,4 @@ The [Contract Address](./contract-addresses.mdx) page lists the addresses of Exp
 
 ### API Reference
 
-The [API Reference](https://per-staging.dourolabs.app/docs/) provides detailed information on the Express Relay APIs for submitting liquidation opportunities.
+The [API Reference](https://per-staging.dourolabs.app/redoc/) provides detailed information on the Express Relay APIs for submitting opportunities.