Skip to content

Commit

Permalink
chore: update docs for any_evm tags (#1577)
Browse files Browse the repository at this point in the history
  • Loading branch information
ccerv1 committed Jun 3, 2024
1 parent c411ea6 commit 5f4fd4e
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 6 deletions.
9 changes: 7 additions & 2 deletions apps/docs/docs/contribute/project-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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
Expand Down
9 changes: 5 additions & 4 deletions apps/docs/docs/how-oso-works/oss-directory/artifact.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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",
Expand All @@ -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"
]
Expand Down

0 comments on commit 5f4fd4e

Please sign in to comment.