Express Relay docs v1

Author: aditya520

components/icons/CodeIcon.tsx

@@ -1,7 +1,7 @@
 const CodeIcon = ({ className }: { className: string }) => {
   return (
     <svg
-    xmlns="http://www.w3.org/2000/svg"
+      xmlns="http://www.w3.org/2000/svg"
       viewBox="0 0 1024 1024"
       fill="currentColor"
       height="1em"
@@ -10,8 +10,6 @@ const CodeIcon = ({ className }: { className: string }) => {
       <path d="M516 673c0 4.4 3.4 8 7.5 8h185c4.1 0 7.5-3.6 7.5-8v-48c0-4.4-3.4-8-7.5-8h-185c-4.1 0-7.5 3.6-7.5 8v48zm-194.9 6.1l192-161c3.8-3.2 3.8-9.1 0-12.3l-192-160.9A7.95 7.95 0 00308 351v62.7c0 2.4 1 4.6 2.9 6.1L420.7 512l-109.8 92.2a8.1 8.1 0 00-2.9 6.1V673c0 6.8 7.9 10.5 13.1 6.1zM880 112H144c-17.7 0-32 14.3-32 32v736c0 17.7 14.3 32 32 32h736c17.7 0 32-14.3 32-32V144c0-17.7-14.3-32-32-32zm-40 728H184V184h656v656z" />
     </svg>
   );
-}
+};
 
 export default CodeIcon;
-
-  

images/express_relay/express_relay_schematic.svg

@@ -1,4 +1,4 @@
-import {Tabs} from "nextra/components"
+import { Tabs } from "nextra/components";
 import AddressTable from "../../components/AddressTable";
 
 Express Relay is currently deployed on the following networks:
@@ -48,7 +48,6 @@ Auction Server endpoint: https://pyth-express-relay-mainnet.asymmetric.re/
 
 This list contains the addresses of the commonly used assets present in opportunities on the Mode network:
 
-
 <AddressTable
   explorer={"https://explorer.mode.network/address/$ADDRESS"}
   entries={[
@@ -109,7 +108,6 @@ Auction Server endpoint: https://per-staging.dourolabs.app/
 
 This list contains the addresses of the commonly used assets present in opportunities on the Optimism Sepolia network:
 
-
 <AddressTable
   explorer={"https://optimism-sepolia.blockscout.com/address/$ADDRESS"}
   entries={[
@@ -137,4 +135,4 @@ This list contains the addresses of the commonly used assets present in opportun
 />
 
 </Tabs.Tab>
-</Tabs>
+</Tabs>

pages/express-relay/api-reference.mdx

@@ -10,13 +10,12 @@ Express Relay solves the problem of MEV by providing protocol developers with an
 Developers specify a set of operations in their protocol that must be accessed through Express Relay.
 Searchers then participate in an off-chain auction to access these operations.
 Their bids in the auction are used to determine the order in which their transactions will be executed.
-The winners' transactions are forwarded to the Express Relay smart contract. As part of the transaction, searchers must pay their specified bid. 
+The winners' transactions are forwarded to the Express Relay smart contract. As part of the transaction, searchers must pay their specified bid.
 The auction profits are then split between the integrated protocol and other participants in Express Relay.
 
 ![](images/express_relay/before_express.jpg)
 ![](images/express_relay/after_express.jpg)
 
-
 The diagram above shows how Express Relay changes the MEV landscape for a liquidation.
 In the status quo (above), Searchers tip miners to guarantee that their liquidation transaction lands on-chain and that their transaction directly interacts with the protocol, exposing the liquidation opportunity.
 With Express Relay (down), Searchers submit bids for their transaction to the Express Relay auction.

pages/express-relay/contract-addresses.mdx

@@ -1,7 +1,7 @@
 # Auction
 
-The auction in Express Relay is held off-chain at the auction server. 
-Bids arrive at the auction server and compete against other bids, vying for the same [permission key](./permissioning.mdx). 
+The auction in Express Relay is held off-chain at the auction server.
+Bids arrive at the auction server and compete against other bids, vying for the same [permission key](./permissioning.mdx).
 A relayer selected by governance serves as the auctioneer and determines the auction in line with the criterion of maximizing the revenue shared back to the protocol that generated this opportunity. That means the auctioneer is expected to forward on-chain the subset of bids that maximizes the revenue back to the protocol.
 
 Thus, the Express Relay auction is analogous to a sealed-bid auction, i.e., participants in the auction will not have the contents of their bid disclosed publicly unless they win the auction and are forwarded on-chain.
@@ -10,11 +10,12 @@ The forwarded subset of transactions is submitted on-chain and first processed b
 
 Generally, the auction server expects bids to execute successfully on-chain. Falback bids are also forwarded in case of execution failures for the predicted winners.
 
-The `ExpressRelay` contract extracts the payment of the specified bid amount only if the searcher's bid is successfully executed on-chain. 
+The `ExpressRelay` contract extracts the payment of the specified bid amount only if the searcher's bid is successfully executed on-chain.
 Hence, the Express Relay auction can be seen as a generalization of a [first-price sealed-bid auction](https://en.wikipedia.org/wiki/First-price_sealed-bid_auction), in that multiple bids can win and pay their first price.
 
 The revenue from the auction is shared amongst relevant stakeholders in the Express Relay system. These stakeholders include:
+
 - the protocol that generates the relevant opportunity
 - the relayer, which handles running the off-chain components of the system
 
-The Express Relay contract enforces the exact revenue splits and is subject to change based on governance decisions.
+The Express Relay contract enforces the exact revenue splits and is subject to change based on governance decisions.

pages/express-relay/how-express-relay-works.mdx

@@ -1,6 +1,6 @@
 # Opportunities
 
-In the context of Express Relay, an opportunity refers to a potential transaction that a searcher can execute on a protocol. Typically, the term "opportunity" is used for such transactions that are lucrative and therefore competed for by many searchers. 
+In the context of Express Relay, an opportunity refers to a potential transaction that a searcher can execute on a protocol. Typically, the term "opportunity" is used for such transactions that are lucrative and therefore competed for by many searchers.
 
 In the pre-Express Relay world, opportunities therefore corresponded to MEV: a protocol generated MEV when an opportunity appeared on that protocol and searchers bid up the right to execute the opportunity at the validator level.
 
@@ -11,6 +11,7 @@ In the context of Express Relay, the value deriving from an opportunity no longe
 Opportunities do not refer to only transactions that use an oracle. In truth, any transaction that is lucrative but limited (available to only the first user(s) who executes it) generates MEV. As a result, Express Relay and the opportunity schema have been designed to be oracle-agnostic.
 
 Examples of opportunities include:
+
 - liquidations
 - open trade offers
 - NFT mints
@@ -19,6 +20,7 @@ Examples of opportunities include:
 ## Opportunity Adapter
 
 The Opportunity Adapter contract enables searchers to engage with opportunities from different protocols without needing to do any bespoke integration work per protocol. Instead of exposing lower-level fields determined by protocols (e.g. `amountCollateral`, `addressBorrower`), the Opportunity Adapter abstracts away the semantics of the opportunity and instead [exposes the fundamental traits](https://github.com/pyth-network/per/blob/30c3fc695034f518225f8255ebe8423604e8aca3/contracts/src/opportunity-adapter/Structs.sol#L20-L23) of any opportunity:
+
 - the tokens sold by the searcher
 - the tokens bought by the searcher
 - the identity of the searcher executing this opportunity

pages/express-relay/how-express-relay-works/auction.mdx

@@ -1,12 +1,12 @@
 # Permissioning
 
-`permissionId` is a `bytes` object that represents the unique identifying information of a position within the protocol. `permissionId` allows the system to distinguish between bids competing on different opportunities and thereby run more scoped and efficient auctions.
+`permissionId` is a `bytes` object that represents the unique identifier of a position within the protocol. `permissionId` allows the system to distinguish between bids competing on different opportunities and thereby run more scoped and efficient auctions.
 
-Each borrower has a unique position for some protocols, so the borrower address uniquely identifies a position. 
-In other protocols, each borrower might have multiple positions, distinguished by the address of the collateral asset or by a `uint256` ID number. 
+Each borrower has a unique position for some protocols, so the borrower address uniquely identifies a position.
+In other protocols, each borrower might have multiple positions, distinguished by the address of the collateral asset or by a `uint256` ID number.
 In those cases, the information set that uniquely identifies a position would include multiple fields.
 
-`permissionId` can be the concatenation of all these fields in bytes format. You can call `abi.encode(){:solidity}` to concatenate these fields together. 
+`permissionId` can be the concatenation of all these fields in bytes format. You can call `abi.encode(){:solidity}` to concatenate these fields together.
 
 For example, if a protocol featured a unique position per borrower, then it could form `permissionId` as
 
@@ -20,9 +20,9 @@ On the other hand, if a protocol allowed a borrower to open as many new position
 bytes memory permissionId = abi.encode(borrowerAddress, positionId);
 ```
 
-The Express Relay contract uses the `permissionId` to toggle permissions for interacting with the protocol. 
+The Express Relay contract uses the `permissionId` to toggle permissions for interacting with the protocol.
 This toggling is checked within the protocol's code to ensure that the current transaction is within the context of Express Relay so that the recaptured value can be returned to the protocol. In particular, the Express Relay contract checks the toggling of the `permissionKey`, which is the concatenation of the protocol address and the `permissionId`:
 
 ```solidity
 bytes memory permissionKey = abi.encode(protocolAddress, permissionId);
-```
+```

pages/express-relay/how-express-relay-works/opportunities.mdx

@@ -9,11 +9,11 @@ import CodeIcon from "../../components/icons/CodeIcon";
 
 Express Relay is a priority auction that enables protocols to eliminate [Maximal Extractable Value](https://www.ledger.com/academy/glossary/maximal-extractable-value-mev) (MEV).
 
-- **For Protocol Developers:** Express Relay allows protocols to recapture MEV and access a network of searchers. 
-With Express Relay, protocols don't need to spend time and energy bootstrapping a protocol-specific searcher network.
+- **For Protocol Developers:** Express Relay allows protocols to recapture MEV and access a network of searchers.
+  With Express Relay, protocols don't need to spend time and energy bootstrapping a protocol-specific searcher network.
 
-- **For Searchers:** Express Relay provides easy and unified access by aggregating liquidation and other MEV opportunities across integrated DeFi protocols. 
-Searchers integrate once and gain access to all existing and future opportunities. 
+- **For Searchers:** Express Relay provides easy and unified access by aggregating liquidation and other MEV opportunities across integrated DeFi protocols.
+  Searchers integrate once and gain access to all existing and future opportunities.
 
 ## Integration
 
@@ -50,7 +50,3 @@ To learn more about Express Relay, refer to the following resources:
   href="https://github.com/pyth-network/pyth-examples/tree/main/express-relay/easy_lend"
 />
 </Cards>
-
-
-
-

pages/express-relay/how-express-relay-works/permissioning.mdx

@@ -1,4 +1,4 @@
-import { Callout, Tabs, Steps } from 'nextra/components'
+import { Callout, Tabs, Steps } from "nextra/components";
 
 # How to Integrate Express Relay as a Protocol
 
@@ -16,7 +16,7 @@ To integrate with Express Relay, your protocol's contract must check if Express
 <Steps>
 ### Install the Express Relay SDK
 
-Pyth provides a [Solidity SDK](https://www.npmjs.com/package/@pythnetwork/express-relay-sdk-solidity) to help developers integrate Express Relay into their DeFi protocol. 
+Pyth provides a [Solidity SDK](https://www.npmjs.com/package/@pythnetwork/express-relay-sdk-solidity) to help developers integrate Express Relay into their DeFi protocol.
 The SDK exposes [`IExpressRelay`](https://github.com/pyth-network/pyth-crosschain/blob/main/express_relay/sdk/solidity/IExpressRelay.sol) and [`IExpressRelayFeeReceiver`](https://github.com/pyth-network/pyth-crosschain/blob/main/express_relay/sdk/solidity/IExpressRelayFeeReceiver.sol) interfaces to interact with Express Relay.
 
 <Tabs items={['Hardhat', 'Foundry']}>
@@ -26,6 +26,7 @@ The SDK exposes [`IExpressRelay`](https://github.com/pyth-network/pyth-crosschai
 ```bash copy
 npm install @pythnetwork/express-relay-sdk-solidity
 ```
+
   </Tabs.Tab>
   <Tabs.Tab>
   If you are using Foundry, you must create an NPM project if you don't already have one. From the root directory of your project, run:
@@ -40,6 +41,7 @@ Then add the following line to `remappings.txt` file:
 ```text copy
 @pythnetwork/express-relay-sdk-solidity/=node_modules/@pythnetwork/express-relay-sdk-solidity
 ```
+
   </Tabs.Tab>
 </Tabs>
 
@@ -48,20 +50,21 @@ Then add the following line to `remappings.txt` file:
 The following steps show how to modify your protocol's contract to verify if the current transaction is permissioned by Express Relay and to receive the auction proceeds.
 
 1. Call the [`isPermissioned`](https://github.com/pyth-network/pyth-crosschain/blob/main/express_relay/sdk/solidity/IExpressRelay.sol#L10C14-L10C28) method from `IExpressRelay` interface to make sure the current transaction is permissioned by Express Relay.
-1. Implement the [`IExpressRelayFeeReceiver`](https://github.com/pyth-network/pyth-crosschain/blob/main/express_relay/sdk/solidity/IExpressRelayFeeReceiver.sol#L4) interface to **receive** auction proceeds. 
+1. Implement the [`IExpressRelayFeeReceiver`](https://github.com/pyth-network/pyth-crosschain/blob/main/express_relay/sdk/solidity/IExpressRelayFeeReceiver.sol#L4) interface to **receive** auction proceeds.
 
 #### 1. Verify Permissioning
 
 The `isPermissioned` function takes two arguments:
+
 1. `protocolFeeReceiver`: The address to receive the protocol's share of auction proceeds.
 1. `permissionId`: A unique identifier for the opportunity.
 
 ```solidity copy
 import "@pythnetwork/express-relay-sdk-solidity/IExpressRelay.sol";
 
 // Express Relay contract address on Optimism Sepolia
-// 
-// Check https://docs.pyth.network/express-relay/contract-addresses 
+//
+// Check https://docs.pyth.network/express-relay/contract-addresses
 // for the address deployed on other networks
 address expressRelay = 0xD6e417287b875A3932c1Ff5dcB26D4D2C8b90B40;
 
@@ -73,21 +76,26 @@ require(
 		"not permissioned"
 );
 ```
+
 <Callout type="info" emoji="ℹ️">
-  The `permissionId` represents a unique identifier of an opportunity. 
-  For a liquidation opportunity, the vault address or ID could be concatenated into `bytes` format. 
-  Consult [`Permissioning`](./how-express-relay-works/permissioning.mdx) for more information on generating permission IDs. 
+  The `permissionId` represents a unique identifier of an opportunity. For a
+  liquidation opportunity, the vault address or ID could be concatenated into
+  `bytes` format. Consult
+  [`Permissioning`](./how-express-relay-works/permissioning.mdx) for more
+  information on generating permission IDs.
 </Callout>
 
 #### 2. Set up Fee Receiver
+
 Express Relay will call the `receiveAuctionProceedings` method present in `IExpressRelayFeeReceiver`. The call will transfer the protocol's share of the auction proceeds to the `protocolFeeReceiver` address.
 
 ```solidity copy
 interface IExpressRelayFeeReceiver {
- function receiveAuctionProceedings(
-        bytes calldata permissionKey
-    ) external payable;
+  function receiveAuctionProceedings(
+    bytes calldata permissionKey
+  ) external payable;
 }
+
 ```
 
 The following code snippet shows a sample Express Relay-integrated contract that performs liquidation.
@@ -144,10 +152,10 @@ contract EasyLend is IExpressRelayFeeReceiver {
             abi.encode(vaultID) // permissionId generated from the unique vault ID
             );
         require(permissioned, "invalid liquidation");
-    
+
         IERC20(vault.tokenDebt).transferFrom(msg.sender,address(this),vault.amountDebt);
         IERC20(vault.tokenCollateral).transfer(msg.sender,vault.amountCollateral);
-    
+
         _vaults[vaultID].amountCollateral = 0;
         _vaults[vaultID].amountDebt = 0;
     }
@@ -166,8 +174,8 @@ contract EasyLend is IExpressRelayFeeReceiver {
 
 }
 ```
-</Steps>
 
+</Steps>
 
 ## Expose Opportunities to Searchers
 
@@ -180,7 +188,7 @@ The JSON payload should contain opportunities in the following format:
 ```bash copy
 {
   "target_calldata": "0xdeadbeef",                                      // Calldata to execute the opportunity
-  "chain_id": "op_sepolia",                                             
+  "chain_id": "op_sepolia",
   "target_contract": "0xcA11bde05977b3631167028862bE2a173976CA11",      // Protocol contract address to call
   "permission_key": "0xcafebabe",                                       // Unique identifier for the opportunity
   "target_call_value": "1",                                             // Value (in Wei) to send to the protocol contract.
@@ -200,14 +208,12 @@ The JSON payload should contain opportunities in the following format:
 }
 ```
 
-
 Each protocol integrated with Express Relay must actively monitor for new opportunities.
 Protocols can do this by indexing the chain, listening to protocol events, or querying protocol state through an RPC provider.
 
 Check the [`monitor.ts`](https://github.com/pyth-network/pyth-crosschain/blob/main/express_relay/examples/easy_lend/src/monitor.ts) script,
 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.
 
-
 ## Additional Resources
 
 You may find these additional resources helpful for integrating Express Relay as a protocol.
@@ -227,4 +233,4 @@ The [Error Codes](./error-codes.mdx) page lists the error codes returned by Expr
 
 ### API Reference
 
-The [API Reference](https://per-staging.dourolabs.app/redoc/) provides detailed information on Express Relay APIs for submitting opportunities.
+The [API Reference](https://per-staging.dourolabs.app/redoc/) provides detailed information on Express Relay APIs for submitting opportunities.