Express Relay Docs

components/AddressTable.tsx

@@ -0,0 +1,51 @@
+import { StyledTd } from "./Table";
+
+const AddressTable = ({
+  entries,
+  explorer,
+}: {
+  entries: { name: string; value: string }[];
+  explorer: string;
+}) => {
+  return (
+    <table>
+      <tbody>
+        {entries.map(({ name, value }) => {
+          const component = (
+            <code
+              className={
+                "nx-border-black nx-border-opacity-[0.04] nx-bg-opacity-[0.03] nx-bg-black nx-break-words nx-rounded-md nx-border nx-py-0.5 nx-px-[.25em] nx-text-[.9em] dark:nx-border-white/10 dark:nx-bg-white/10  "
+              }
+            >
+              {value}
+            </code>
+          );
+          const addLink =
+            explorer.includes("$ADDRESS") && value.startsWith("0x");
+          return (
+            <tr key={name}>
+              <StyledTd>{name}</StyledTd>
+              <StyledTd>
+                {addLink ? (
+                  <a
+                    href={explorer.replace("$ADDRESS", value)}
+                    className={
+                      "nx-text-primary-600 nx-underline nx-decoration-from-font [text-underline-position:from-font]"
+                    }
+                    target={"_blank"}
+                  >
+                    {component}
+                  </a>
+                ) : (
+                  component
+                )}
+              </StyledTd>
+            </tr>
+          );
+        })}
+      </tbody>
+    </table>
+  );
+};
+
+export default AddressTable;

components/icons/CodeIcon.tsx

@@ -0,0 +1,15 @@
+const CodeIcon = ({ className }: { className: string }) => {
+  return (
+    <svg
+      xmlns="http://www.w3.org/2000/svg"
+      viewBox="0 0 1024 1024"
+      fill="currentColor"
+      height="1em"
+      width="1em"
+    >
+      <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;

components/icons/ContractIcon.tsx

@@ -0,0 +1,20 @@
+const ContractIcon = ({ className }: { className: string }) => {
+  return (
+    <svg
+      xmlns="http://www.w3.org/2000/svg"
+      fill="none"
+      viewBox="0 0 24 24"
+      strokeWidth={1.5}
+      stroke="currentColor"
+      className={className}
+    >
+      <path
+        strokeLinecap="round"
+        strokeLinejoin="round"
+        d="M10.125 2.25h-4.5c-.621 0-1.125.504-1.125 1.125v17.25c0 .621.504 1.125 1.125 1.125h12.75c.621 0 1.125-.504 1.125-1.125v-9M10.125 2.25h.375a9 9 0 0 1 9 9v.375M10.125 2.25A3.375 3.375 0 0 1 13.5 5.625v1.5c0 .621.504 1.125 1.125 1.125h1.5a3.375 3.375 0 0 1 3.375 3.375M9 15l2.25 2.25L15 12"
+      />
+    </svg>
+  );
+};
+
+export default ContractIcon;

components/icons/QuestionMarkIcon.tsx

@@ -0,0 +1,18 @@
+const QuestionMarkIcon = ({ className }: { className: string }) => {
+  return (
+    <svg
+      xmlns="http://www.w3.org/2000/svg"
+      fill="currentColor"
+      viewBox="0 0 16 16"
+      height="1em"
+      width="1em"
+    >
+      <path
+        fillRule="evenodd"
+        d="M4.475 5.458c-.284 0-.514-.237-.47-.517C4.28 3.24 5.576 2 7.825 2c2.25 0 3.767 1.36 3.767 3.215 0 1.344-.665 2.288-1.79 2.973-1.1.659-1.414 1.118-1.414 2.01v.03a.5.5 0 01-.5.5h-.77a.5.5 0 01-.5-.495l-.003-.2c-.043-1.221.477-2.001 1.645-2.712 1.03-.632 1.397-1.135 1.397-2.028 0-.979-.758-1.698-1.926-1.698-1.009 0-1.71.529-1.938 1.402-.066.254-.278.461-.54.461h-.777zM7.496 14c.622 0 1.095-.474 1.095-1.09 0-.618-.473-1.092-1.095-1.092-.606 0-1.087.474-1.087 1.091S6.89 14 7.496 14z"
+      />
+    </svg>
+  );
+};
+
+export default QuestionMarkIcon;

components/icons/SearchIcon.tsx

@@ -0,0 +1,20 @@
+const SearchIcon = ({ className }: { className: string }) => {
+  return (
+    <svg
+      xmlns="http://www.w3.org/2000/svg"
+      fill="none"
+      viewBox="0 0 24 24"
+      strokeWidth={1.5}
+      stroke="currentColor"
+      className={className}
+    >
+      <path
+        strokeLinecap="round"
+        strokeLinejoin="round"
+        d="m21 21-5.197-5.197m0 0A7.5 7.5 0 1 0 5.196 5.196a7.5 7.5 0 0 0 10.607 10.607Z"
+      />
+    </svg>
+  );
+};
+
+export default SearchIcon;

pages/_meta.json

@@ -14,6 +14,11 @@
     "type": "page"
   },
 
+  "express-relay": {
+    "title": "Express Relay",
+    "type": "page"
+  },
+
   "entropy": {
     "title": "Entropy",
     "type": "page"

pages/express-relay/_meta.json

@@ -0,0 +1,45 @@
+{
+  "documentation-home": {
+    "title": "← Documentation Home",
+    "href": "/home"
+  },
+
+  "-- Express Relay": {
+    "title": "Express Relay",
+    "type": "separator"
+  },
+  "index": "Introduction",
+
+  "-- How-to Guides": {
+    "title": "How-To Guides",
+    "type": "separator"
+  },
+
+  "integrate-as-protocol": "Integrate as a Protocol",
+  "integrate-as-searcher": "Integrate as a Searcher",
+
+  "-- Reference Material": {
+    "title": "Reference Material",
+    "type": "separator"
+  },
+
+  "api-reference": {
+    "title": "HTTP API Reference ↗",
+    "href": "https://pyth-express-relay-mainnet.asymmetric.re/redoc",
+    "newWindow": true
+  },
+  "websocket-api-reference": "Websocket API Reference",
+  "contract-addresses": "Contract Addresses",
+  "errors": "Error Codes",
+  "examples": {
+    "title": "Example Application ↗",
+    "href": "https://github.com/pyth-network/pyth-examples/tree/main/express-relay/easy_lend",
+    "newWindow": true
+  },
+  "-- Understand Express Relay": {
+    "title": "Understanding Express Relay",
+    "type": "separator"
+  },
+
+  "how-express-relay-works": "How Express Relay Works"
+}

pages/express-relay/contract-addresses.mdx

@@ -0,0 +1,138 @@
+import { Tabs } from "nextra/components";
+import AddressTable from "../../components/AddressTable";
+
+Express Relay is currently deployed on the following networks:
+
+<Tabs items={['Mainnet', 'Testnet']}>
+
+<Tabs.Tab>
+Auction Server endpoint: https://pyth-express-relay-mainnet.asymmetric.re/
+
+### Mode
+
+**Network Details:**
+
+<AddressTable
+  explorer={"https://explorer.mode.network/address/$ADDRESS"}
+  entries={[
+    {
+      name: "Express Relay",
+      value: "0x5Cc070844E98F4ceC5f2fBE1592fB1ed73aB7b48",
+    },
+    {
+      name: "Opportunity Adapter Factory",
+      value: "0x59F78DE21a0b05d96Ae00c547BA951a3B905602f",
+    },
+    {
+      name: "Network Id",
+      value: "34443",
+    },
+    {
+      name: "Chain Id",
+      value: "mode",
+    },
+    {
+      name: "Public RPC",
+      value: "https://mainnet.mode.network/",
+    },
+    {
+      name: "Wrapped ETH",
+      value: "0x4200000000000000000000000000000000000006",
+    },
+    {
+      name: "Permit2 Contract",
+      value: "0x000000000022D473030F116dDEE9F6B43aC78BA3",
+    },
+  ]}
+/>
+
+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={[
+    { name: "WETH", value: "0x4200000000000000000000000000000000000006" },
+    { name: "USDC", value: "0xd988097fb8612cc24eeC14542bC03424c656005f" },
+    { name: "USDT", value: "0xf0F161fDA2712DB8b566946122a5af183995e2eD" },
+    { name: "WBTC", value: "0xcDd475325D6F564d27247D1DddBb0DAc6fA0a5CF" },
+    { name: "ezETH", value: "0x2416092f143378750bb29b79eD961ab195CcEea5" },
+    { name: "STONE", value: "0x80137510979822322193FC997d400D5A6C747bf7" },
+    { name: "wrsETH", value: "0xe7903B1F75C534Dd8159b313d92cDCfbC62cB3Cd" },
+    { name: "weETH.mode", value: "0x04C0599Ae5A44757c0af6F9eC3b93da8976c150A" },
+    { name: "M-BTC", value: "0x59889b7021243dB5B1e065385F918316cD90D46c" },
+    { name: "MODE", value: "0xDfc7C877a950e49D2610114102175A06C2e3167a" },
+  ]}
+/>
+
+</Tabs.Tab>
+<Tabs.Tab>
+Auction Server endpoint: https://per-staging.dourolabs.app/
+
+### Optimism Sepolia
+
+**Network Details:**
+
+<AddressTable
+  explorer={"https://optimism-sepolia.blockscout.com/address/$ADDRESS"}
+  entries={[
+    {
+      name: "Express Relay",
+      value: "0x2F968931d1B7326d2875E9500980211dcc535eE5",
+    },
+    {
+      name: "Opportunity Adapter Factory",
+      value: "0xfA119693864b2F185742A409c66f04865c787754",
+    },
+    {
+      name: "Network Id",
+      value: "11155420",
+    },
+    {
+      name: "Chain Id",
+      value: "op_sepolia",
+    },
+    {
+      name: "Public RPC",
+      value: "https://sepolia.optimism.io/",
+    },
+    {
+      name: "Wrapped ETH",
+      value: "0x74A4A85C611679B73F402B36c0F84A7D2CcdFDa3",
+    },
+    {
+      name: "Permit2 Contract",
+      value: "0x000000000022D473030F116dDEE9F6B43aC78BA3",
+    },
+  ]}
+/>
+
+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={[
+    {
+      name: "BTC",
+      value: "0x3745007F7C8DD8Bec89b3B35f33f13f58b008533 ",
+    },
+    {
+      name: "USDC",
+      value: "0x1e3d75F24296abBC7bd10D151F51d758bCE379Ef",
+    },
+    {
+      name: "DOGE",
+      value: "0x0160Ba0A02A910e27b4189040aC74febcc476687 ",
+    },
+    {
+      name: "SOL",
+      value: "0x193aD24BeeDfAf27f217395f52fA20C7A36D79B3",
+    },
+    {
+      name: "PYTH",
+      value: "0x20e0b5Ff7aa971dAd8f489112Ae009A70608d2D5",
+    },
+  ]}
+/>
+
+</Tabs.Tab>
+</Tabs>

pages/express-relay/errors.mdx

@@ -0,0 +1,33 @@
+# Error Codes
+
+The following table lists the error codes and their explanations for [`ExpressRelay`](https://github.com/pyth-network/per/blob/main/contracts/src/express-relay/ExpressRelay.sol) and [`OpportunityAdapter`](https://github.com/pyth-network/per/blob/main/contracts/src/opportunity-adapter/OpportunityAdapter.sol) contracts.
+They can be used to identify the cause of a failed transaction or bid.
+
+## ExpressRelay
+
+| Error                                        | Selector     | Explanation                                                                                 |
+| -------------------------------------------- | ------------ | ------------------------------------------------------------------------------------------- |
+| `Unauthorized()`                             | `0x82b42900` | This function is called by an unauthorized party.                                           |
+| `InvalidMagicValue()`                        | `0x4ed848c1` | An upgrade was attempted to a contract that does not match the ExpressRelay specification.  |
+| `InvalidPermission()`                        | `0x868a64de` | The provided permissionKey is invalid (too short).                                          |
+| `InvalidFeeSplit()`                          | `0x0601f697` | The proposed fee split is invalid (fee is larger than feePrecision, 10\*\*18).              |
+| `InvalidTargetContract()`                    | `0x5569851a` | The provided target contract is not allowed. (e.g. can not call the ExpressRelay contract). |
+| `DuplicateRelayerSubwallet()`                | `0xb40d37c3` | The provided subwallet to add has already been added.                                       |
+| `RelayerSubwalletNotFound()`                 | `0xac4d92b3` | The provided subwallet to delete does not exist in the store.                               |
+| `ExternalCallFailed(MulticallStatus status)` | `0x740d0306` | The external call failed with the following MulticallStatus output.                         |
+
+## OpportunityAdapter
+
+| Error                                  | Selector     | Explanation                                                                                                      |
+| -------------------------------------- | ------------ | ---------------------------------------------------------------------------------------------------------------- |
+| `NotCalledByExpressRelay()`            | `0xd5668c88` | The OpportunityAdapterFactory contract was not called by the ExpressRelay contract.                              |
+| `NotCalledByFactory()`                 | `0xb02436cc` | The OpportunityAdapter contract was not called by the OpportunityAdapterFactory contract.                        |
+| `AdapterOwnerMismatch()`               | `0x446f3eeb` | The provided executor field does not match the owner of the called OpportunityAdapter contract.                  |
+| `InsufficientTokenReceived()`          | `0x4af147aa` | The specified buyTokens were not received after calling the target contract.                                     |
+| `InsufficientEthToSettleBid()`         | `0x9caaa1d7` | The contract did not receive enough ETH to pay the specified bid.                                                |
+| `InsufficientWethForTargetCallValue()` | `0x5e520cd4` | The contract did not receive enough Wrapped ETH to pay the targetCallValue to the targetContract.                |
+| `TargetCallFailed(bytes returnData)`   | `0xa932c97a` | The call to targetContract failed with the specified returnData.                                                 |
+| `DuplicateToken()`                     | `0x464e3f6a` | There is a duplicate token in either the sellTokens or buyTokens.                                                |
+| `EthOrWethBalanceDecreased()`          | `0x1979776d` | The ETH or WETH balance of the contract decreased as a result of the call to targetContract and the bid payment. |
+| `TargetContractNotAllowed()`           | `0x9c86e59e` | The provided targetContract is not allowed. (e.g. can not call the Permit2 contract).                            |
+| `OnlyOwnerCanCall()`                   | `0x47a8ea58` | Only the owner of the contract can call this method.                                                             |