From 5f4fd4e95a7b8f9751939ade0ec4401f13a181fa Mon Sep 17 00:00:00 2001 From: Carl Cervone <42869436+ccerv1@users.noreply.github.com> Date: Mon, 3 Jun 2024 09:55:10 -0400 Subject: [PATCH] chore: update docs for any_evm tags (#1577) --- apps/docs/docs/contribute/project-data.md | 9 +++++++-- apps/docs/docs/how-oso-works/oss-directory/artifact.md | 9 +++++---- 2 files changed, 12 insertions(+), 6 deletions(-) diff --git a/apps/docs/docs/contribute/project-data.md b/apps/docs/docs/contribute/project-data.md index 1806d81e1..17eb34a01 100644 --- a/apps/docs/docs/contribute/project-data.md +++ b/apps/docs/docs/contribute/project-data.md @@ -46,10 +46,15 @@ The schema currently contains the following fields: ### Supported Blockchain Networks and Tags +:::tip +The simplest way to add all contracts and factories associated with your project is to just add the deployer address in the project file. We will then automatically index all contracts and factories associated with the deployer address. If the deployer is on multiple EVM networks, you can use the `any_evm` tag instead of listing each network individually. +::: + The OSS Directory currently supports the following blockchain networks, which can be enumerated in the `networks` field of a blockchain address: +- `any_evm`: Any Ethereum Virtual Machine (EVM) network. This is the recommended tag for EOAs that deploy contracts on multiple EVM networks. - `mainnet`: The Ethereum mainnet. -- `arbitrum-one`: The Arbitrum L2 network. +- `arbitrum_one`: The Arbitrum L2 network. - `optimism`: The Optimism L2 network. - `base`: The Base L2 network. - `metal`: The Metal L2 network. @@ -158,7 +163,7 @@ If you run into issues, check out [GitHub's instructions](https://docs.github.co - wallet - address: "0x5cBd6362e6F222D2A0Feb89f32566ebd27091B98" networks: - - arbitrum-one + - arbitrum_one tags: - safe - wallet diff --git a/apps/docs/docs/how-oso-works/oss-directory/artifact.md b/apps/docs/docs/how-oso-works/oss-directory/artifact.md index 6f687cb0e..8f60ecde8 100644 --- a/apps/docs/docs/how-oso-works/oss-directory/artifact.md +++ b/apps/docs/docs/how-oso-works/oss-directory/artifact.md @@ -68,7 +68,7 @@ If you are referencing a Safe multi-sig address, remember to remove the chain id The `networks` field is an array used to identify the blockchain network(s) that the address is associated with. Currently supported options are: - `mainnet`: The Ethereum mainnet. -- `arbitrum-one`: The Arbitrum L2 network. +- `arbitrum_one`: The Arbitrum L2 network. - `optimism`: The Optimism L2 network. - `base`: The Base L2 network. - `metal`: The Metal L2 network. @@ -169,7 +169,8 @@ The full schema for the blockchain address field is as follows. Note that it inc "minItems": 1, "items": { "enum": [ - "arbitrum-one", + "any_evm", + "arbitrum_one", "base", "frax", "mainnet", @@ -180,8 +181,8 @@ The full schema for the blockchain address field is as follows. Note that it inc "pgn", "zora", "linea", - "zksync-era", - "polygon-zkevm", + "zksync_era", + "polygon_zkevm", "scroll", "mantle" ]