Sourcify

https://docs.sourcify.dev/docs
Admin
Sourcify is an open-source, open-data, and open-standards source-code verification service for...
Tokens:21,394
Snippets:146
Trust Score:9.7
Update:2 days ago
Show doc for...
Tokens:
Raw
### Local chain test setup and execution

Source: https://docs.sourcify.dev/docs/chain-support/index.html

Run these commands to test a new chain locally. Requires Node 22+, docker compose, and DRPC_API_KEY and QUICKNODE_API_KEY. The script installs dependencies, generates a chain config, loads secrets, starts the Sourcify server, runs the integration test, and cleans up.

```bash
npm install
npm run generate -- --only <chainId> # multiple chains: --only 1,11155111

# Fill in the keys in .secrets and load them into your shell
cp .secrets.dev .secrets
set -a; source .secrets; set +a

# Start the Sourcify server
docker compose -f tests/docker-compose.yml up -d postgres
bash tests/migrate.sh
docker compose -f tests/docker-compose.yml up -d sourcify

# Run the test for your chain(s)
NEW_CHAIN_ID=<chainId> npm run test:integration:chain

# Clean up
docker compose -f tests/docker-compose.yml down -v
git checkout sourcify-chains-default.json
```

--------------------------------

### Install @nomicfoundation/hardhat-verify plugin

Source: https://docs.sourcify.dev/docs/verify-via-hardhat/index.html

Install the plugin as a dev dependency. It comes pre-installed in Hardhat v3 template projects, but this command adds it manually.

```bash
npm install --save-dev @nomicfoundation/hardhat-verify
```

--------------------------------

### chain-overrides.json example

Source: https://docs.sourcify.dev/docs/chain-support/index.html

Example JSON configuration for adding a chain. Includes optional fields for Etherscan API, contract creation transaction fetching, and custom RPCs. API keys are referenced by environment variable names that must be set on Sourcify servers.

```json
{
  // the chain id
  "12345": {
    "sourcifyName": "My Chain Mainnet", // the display name. Overrides the chainid.network name

    // optional
    // Only for Etherscan-compatible explorers that are not in Etherscan's chainlist
    "etherscanApi": {
      "supported": true,
      "url": "https://api.explorer.mychain.io", // the base url of the explorer API
      "apiKeyEnvName": "ETHERSCAN_API_KEY_MYCHAIN" // optional. Omit it if the explorer does not need an api key
    },

    // optional
    "fetchContractCreationTxUsing": {
      // How to find the transaction hash that created the contract
      "etherscanApi": true, // if supported by the explorer configured in etherscanApi
      "blockscoutApi": {
        // blockscout v2 instances have an api endpoint for this
        "url": "https://explorer.mychain.io/"
      },
      "avalancheApi": true // avalanche subnets at glacier-api.avax.network have an api endpoint for this
    },

    // optional
    // RPCs defined here have a higher priority than the provider and the public RPCs.
    // Leave empty to use the provider RPCs or the public RPCs from chainid.network
    "rpc": [
      "https://rpc.mychain.io", // can be a simple url
      {
        "type": "BaseRPC", // a simple url with extra information
        "url": "https://rpc.mychain.io",
        "traceSupport": "trace_transaction" // "trace_transaction" or "debug_traceTransaction" if the RPC supports tracing
      },
      {
        "type": "FetchRequest", // ethers.js FetchRequest for header authenticated RPCs
        "url": "https://rpc.mychain.io",
        "headers": [
          {
            "headerName": "X-API-Key",
            "headerEnvName": "MYCHAIN_API_KEY" // the name of the environment variable holding the api key
          }
        ]
      }
    ]
  }
}
```

--------------------------------

### Example with pagination

Source: https://docs.sourcify.dev/docs/repository/download-dataset/index.html

Use this URL to paginate through results. The marker parameter is set to the NextMarker from the previous response, and max-keys limits the number of objects returned.

```text
https://export.sourcify.dev/?prefix=v2/verified_contracts/&max-keys=2&marker=v2/verified_contracts/verified_contracts_1000000_2000000.parquet
```

--------------------------------

### GET https://export.sourcify.dev/

Source: https://docs.sourcify.dev/docs/repository/download-dataset/index.html

Lists all files in the export bucket. Use the prefix parameter to filter by table or path.

```APIDOC
## GET /

### Description
Lists all files in the export bucket. Use the prefix parameter to filter by table or path.

### Method
GET

### Endpoint
https://export.sourcify.dev/

### Parameters
#### Query Parameters
- **prefix** (string) - Optional - Filter results to objects whose names begin with this prefix (e.g., `?prefix=v2/verified_contracts/`)
- **marker** (string) - Optional - Start listing after this object name (for pagination)
- **max-keys** (integer) - Optional - Maximum number of objects to return in one response

### Response
#### Success Response (200)
- **ListBucketResult** (object) - The response follows the Google Cloud Storage XML API specification.
- **IsTruncated** (boolean) - Indicates if the response is truncated.
- **NextMarker** (string) - Use this as the marker parameter for the next page.
- **Contents** (array) - List of file objects, each with fields: Key, Generation, MetaGeneration, LastModified, ETag, Size.

#### Response Example
```xml
<ListBucketResult xmlns="http://doc.s3.amazonaws.com/2006-03-01">
  <Name>sourcify-parquet-export</Name>
  <Prefix>v2/</Prefix>
  <Marker/>
  <IsTruncated>false</IsTruncated>
  <Contents>
    <Key>v2/code/code_0_100000.parquet</Key>
    <Generation>1766065018286394</Generation>
    <MetaGeneration>1</MetaGeneration>
    <LastModified>2025-12-18T13:36:58.292Z</LastModified>
    <ETag>"ba687acd0afab85ed203a593479f0ce3"</ETag>
    <Size>101591414</Size>
  </Contents>
</ListBucketResult>
```
```

--------------------------------

### Listing API XML response example

Source: https://docs.sourcify.dev/docs/repository/download-dataset/index.html

Example XML response from the listing API. It includes metadata fields such as Key, LastModified, ETag, and Size. The IsTruncated field indicates whether the response is truncated.

```xml
<ListBucketResult xmlns="http://doc.s3.amazonaws.com/2006-03-01">
  <Name>sourcify-parquet-export</Name>
  <Prefix>v2/</Prefix>
  <Marker/>
  <IsTruncated>false</IsTruncated>
  <Contents>
    <Key>v2/code/code_0_100000.parquet</Key>
    <Generation>1766065018286394</Generation>
    <MetaGeneration>1</MetaGeneration>
    <LastModified>2025-12-18T13:36:58.292Z</LastModified>
    <ETag>"ba687acd0afab85ed203a593479f0ce3"</ETag>
    <Size>101591414</Size>
  </Contents>
  <!-- More entries... -->
</ListBucketResult>
```

--------------------------------

### Deploy test contract commands

Source: https://docs.sourcify.dev/docs/chain-support/index.html

Commands to install dependencies, generate the chain configuration file, and deploy a Storage.sol contract using the provided script. Requires an account private key and the chain ID.

```bash
npm install
npm run generate -- --only <chainId>
npx tsx scripts/deployContracts.ts --chainId=<chainId> --privateKey=<privateKey>
```

--------------------------------

### Sync dataset with AWS CLI

Source: https://docs.sourcify.dev/docs/repository/download-dataset/index.html

Downloads the entire dataset on the first run and only new or modified files on subsequent runs. Requires the AWS CLI to be installed.

```bash
aws s3 sync s3://sourcify-production-parquet-export/v2/ ./sourcify-dataset --endpoint-url https://storage.googleapis.com --no-sign-request
```

--------------------------------

### Example CBOR data

Source: https://docs.sourcify.dev/docs/immutables/index.html

A concrete example of the CBOR data structure for a Vyper contract.

```text
[167, [10], 96, {"vyper": [0, 4, 0]}]
```

--------------------------------

### GET https://export.sourcify.dev/{Key}

Source: https://docs.sourcify.dev/docs/repository/download-dataset/index.html

Downloads a specific Parquet file from the export bucket. The file path is the Key from the listing API.

```APIDOC
## GET /{Key}

### Description
Downloads a specific Parquet file from the export bucket. The file path is the Key from the listing API.

### Method
GET

### Endpoint
https://export.sourcify.dev/{Key}

### Parameters
#### Path Parameters
- **Key** (string) - Required - The file path, e.g., `v2/verified_contracts/verified_contracts_0_1000000.parquet`

### Response
#### Success Response (200)
- **body** (binary) - The Parquet file content.

#### Response Example
Binary file content.
```

--------------------------------

### Configure custom Sourcify instance in hardhat.config.ts

Source: https://docs.sourcify.dev/docs/verify-via-hardhat/index.html

If running your own Sourcify instance, specify the API URL under the 'verify' configuration. The example sets apiUrl to 'https://sourcify.dev/server'.

```typescript
export default defineConfig({
  plugins: [hardhatVerify],
  verify: {
    sourcify: {
      // Specify a different Sourcify server here
      apiUrl: "https://sourcify.dev/server",
    },
  },
});
```

--------------------------------

### Fetch verified contract data with curl (bash)

Source: https://docs.sourcify.dev/docs/api/index.html

Sends a GET request to the Sourcify contract endpoint with the fields=all parameter to retrieve all verified contract data.

```bash
curl -sS \
  'https://sourcify.dev/server/v2/contract/11155111/0x2738d13E81e30bC615766A0410e7cF199FD59A83?fields=all'
```

--------------------------------

### Check verification job status with Forge using Sourcify

Source: https://docs.sourcify.dev/docs/verify-via-foundry/index.html

Use this command to check the status of a verification job by its GUID. The GUID is returned when you submit a verification request. The --verifier sourcify flag is required to specify the verifier.

```bash
forge verify-check 64f6f3bb-2b93-40ec-b6e8-b6e90510e6b0 \
  --verifier sourcify
```

--------------------------------

### Example of deployed contract bytecode

Source: https://docs.sourcify.dev/docs/what-is-source-code-verification/index.html

Shows a hex-encoded bytecode string as it appears on-chain for a contract at address 0x7ecedB5ca848e695ee8aB33cce9Ad1E1fe7865F8 on Ethereum Holesky Testnet. This is the non-human-readable form that source code verification compares against.

```text
0x608060405234801561001057600080fd5b50600436106100365760003560e01c80632e64cec11461003b5780636057361d14610059575b600080fd5b610043610075565b60405161005091906100d9565b60405180910390f35b610073600480360381019061006e919061009d565b61007e565b005b60008054905090565b8060008190555050565b60008135905061009781610103565b92915050565b6000602082840312156100b3576100b26100fe565b5b60006100c184828501610088565b91505092915050565b6100d3816100f4565b82525050565b60006020820190506100ee60008301846100ca565b92915050565b6000819050919050565b600080fd5b61010c816100f4565b811461011757600080fd5b5056fea2646970667358221220404e37f487a89a932dca5e77faaf6ca2de3b991f93d230604b1b8daaef64766264736f6c63430008070033
```

--------------------------------

### GET /v2/verify/{verificationId}

Source: https://docs.sourcify.dev/docs/api/index.html

Retrieves the status and result of a verification job using its verificationId.

```APIDOC
## GET /v2/verify/{verificationId}

### Description
Retrieves the status and result of a verification job using its verificationId.

### Method
GET

### Endpoint
/v2/verify/{verificationId}

### Parameters
#### Path Parameters
- **verificationId** (string) - Required - The ID of the verification job.

### Response
#### Success Response (200)
- Returns the verification job result.

#### Response Example
{
  "status": "verified",
  "contract": {}
}
```

--------------------------------

### Metadata sources field JSON example

Source: https://docs.sourcify.dev/docs/exact-match-vs-match/index.html

Shows the structure of the 'sources' field in a Sourcify metadata file, including keccak256 hashes, licenses, and URLs for local and remote source files. The keccak256 hash changes if any byte in the source file changes, which is used to detect changes via the metadata hash appended to the bytecode.

```json
{
  ...
  "sources": {
    "contracts/1_Storage.sol": {
      "keccak256": "0xb6ee9d528b336942dd70d3b41e2811be10a473776352009fd73f85604f5ed206",
      "license": "GPL-3.0",
      "urls": [
        "bzz-raw://fe52c6e3c04ba5d83ede6cc1a43c45fa43caa435b207f64707afb17d3af1bcf1",
        "dweb:/ipfs/QmawU3NM1WNWkBauRudYCiFvuFE1tTLHB98akyBvb9UWwA"
      ]
    },
    "https://github.com/OpenZeppelin/openzeppelin-contracts/blob/release-v3.2.0-solc-0.7/contracts/math/SafeMath.sol": {
      "keccak256": "0xba96bc371ba999f452985a98717cca1e4c4abb598dc038a9a9c3db08129b1ba4",
      "license": "MIT",
      "urls": [
        "bzz-raw://26e50e3f7b6482fb6f598f2e006994a74aa492687daa4b3eee7fd4fb5398ce7f",
        "dweb:/ipfs/QmZudqoPSkA4USLMFsBBmt19dDPZFS8aaAmL5R7pECXu6t"
      ]
    },
  }
}
```

--------------------------------

### Metadata libraries field example

Source: https://docs.sourcify.dev/docs/libraries/index.html

Shows the 'libraries' field in contract metadata, mapping library names to their deployed addresses. These addresses must be passed to the compiler for linking before compilation.

```json
  "libraries": {
    "ExchangeAdmins": "0x919551e7c778539f6238e3483358a2afbdaa83c9",
    "ExchangeBlocks": "0xb01e1b1ee285c16429e750aca67546d5bcc797f3",
    "ExchangeGenesis": "0xa2f3346c484ac1f55ef468fd2fe427b9730afb9f",
    "ExchangeTokens": "0x432bcd4fade6e54f8b0773546af44bf7c90fa7f6",
    "ExchangeWithdrawals": "0x4d6924ac10b840a17ac841b2e3d446c9e0d88d68"
  },
```

--------------------------------

### Fetch verified contract data with JavaScript (fetch)

Source: https://docs.sourcify.dev/docs/api/index.html

Uses the Fetch API to GET contract data from the Sourcify endpoint with fields=all and logs the resulting JSON object.

```javascript
const response = await fetch(
    "https://sourcify.dev/server/v2/contract/11155111/0x2738d13E81e30bC615766A0410e7cF199FD59A83?fields=all"
);

const contract = await response.json();
console.log(contract);
```

--------------------------------

### GET /v2/contract/{chainId}/{address}?fields=all

Source: https://docs.sourcify.dev/docs/api/index.html

Fetches verified contract data for a given chain and address. The fields parameter can be used to specify which fields to include.

```APIDOC
## GET /v2/contract/{chainId}/{address}?fields=all

### Description
Fetches verified contract data for a given chain and address. The fields parameter can be used to specify which fields to include.

### Method
GET

### Endpoint
/v2/contract/{chainId}/{address}?fields=all

### Parameters
#### Path Parameters
- **chainId** (integer) - Required - The chain ID of the network.
- **address** (string) - Required - The address of the contract.

#### Query Parameters
- **fields** (string) - Optional - Comma-separated list of fields to include. Use "all" to include all fields.

### Response
#### Success Response (200)
- Returns the contract data.

#### Response Example
{
  "name": "Storage",
  "abi": [],
  "sources": {}
}
```

--------------------------------

### Query a single Parquet file with DuckDB using HTTPS URL

Source: https://docs.sourcify.dev/docs/repository/download-dataset/index.html

Use this SQL to query a single Parquet file directly from export.sourcify.dev without downloading or credentials. It installs and loads the httpfs extension, then counts rows in the specified file.

```sql
INSTALL httpfs;
LOAD httpfs;

SELECT count(*)
FROM 'https://export.sourcify.dev/v2/verified_contracts/verified_contracts_0_1000000.parquet';
```

--------------------------------

### Deploy and verify a contract with Forge using Sourcify

Source: https://docs.sourcify.dev/docs/verify-via-foundry/index.html

Use this command to deploy a contract and automatically verify it with Sourcify. The --verifier sourcify flag is required if an Etherscan API key is set, as Sourcify is the default verifier otherwise. Replace placeholders like <your_rpc_url> and <your_private_key> with actual values.

```bash
forge create --rpc-url <your_rpc_url> \
  --constructor-args "ForgeUSD" "FUSD" 18 1000000000000000000000 \
  --private-key <your_private_key> \
  src/MyToken.sol:MyToken \
  --verify \
  --verifier sourcify
```

--------------------------------

### Write metadata to file with solc --metadata

Source: https://docs.sourcify.dev/docs/metadata/index.html

Redirect the solc --metadata output to a file named metadata.json.

```bash
solc --metadata MyContract.sol > metadata.json
```

--------------------------------

### List all files

Source: https://docs.sourcify.dev/docs/repository/download-dataset/index.html

Use this URL to list all files in the export bucket. The response is XML following the Google Cloud Storage XML API specification.

```text
https://export.sourcify.dev/?prefix=v2/
```

--------------------------------

### Generate metadata with solc --metadata

Source: https://docs.sourcify.dev/docs/metadata/index.html

Use the --metadata flag with the Solidity command line compiler to print the metadata output for a contract.

```bash
solc --metadata MyContract.sol
```

--------------------------------

### List files for a specific table

Source: https://docs.sourcify.dev/docs/repository/download-dataset/index.html

Use this URL to list files for a specific table, e.g., verified_contracts. The prefix parameter filters results to objects whose names begin with the given prefix.

```text
https://export.sourcify.dev/?prefix=v2/verified_contracts/
```

--------------------------------

### Verify on all services with hardhat verify

Source: https://docs.sourcify.dev/docs/verify-via-hardhat/index.html

After deploying, run this command to verify on Etherscan, Blockscout, and Sourcify simultaneously. Replace DEPLOYED_CONTRACT_ADDRESS with the actual address.

```bash
npx hardhat verify --network mainnet DEPLOYED_CONTRACT_ADDRESS
```

--------------------------------

### Enable external verification in Sourcify server config

Source: https://docs.sourcify.dev/docs/external-verifiers/index.html

Add WStorageIdentifiers.EtherscanVerify, BlockscoutVerify, and RoutescanVerify to the writeOrWarn array in services/server/src/config/local.js to enable external verification for each service.

```json
// services/server/src/config/local.js
{
  ...
  storage: {
    ...
    writeOrWarn: [
      ...
      WStorageIdentifiers.EtherscanVerify,
      WStorageIdentifiers.BlockscoutVerify,
      WStorageIdentifiers.RoutescanVerify,
      ...
    ],
    ...
  },
  ...
}
```

--------------------------------

### Download dataset with curl

Source: https://docs.sourcify.dev/docs/repository/download-dataset/index.html

Downloads the entire dataset by listing files from the export endpoint and fetching each one. Use this command to download all files under the v2/ prefix.

```bash
curl -s 'https://export.sourcify.dev/?prefix=v2/' | \
  grep -oP '(?<=<Key>)[^<]+' | \
  xargs -I {} curl -L -O https://export.sourcify.dev/{}
```

--------------------------------

### Set API keys for external verifiers in .env

Source: https://docs.sourcify.dev/docs/external-verifiers/index.html

Specify BLOCKSCOUT_API_KEY, ROUTESCAN_API_KEY, and ETHERSCAN_API_KEY in services/server/.env. Etherscan has a strict rate limit of 200 verifications per day.

```bash
# services/server/.env
BLOCKSCOUT_API_KEY=
ROUTESCAN_API_KEY=
# warn: Etherscan have a very strict rate limit of 200 verifications / day.
ETHERSCAN_API_KEY=
```

--------------------------------

### Configure hardhat.config.ts with hardhatVerify plugin

Source: https://docs.sourcify.dev/docs/verify-via-hardhat/index.html

Import and register the hardhatVerify plugin in the Hardhat configuration file. This enables automatic Sourcify verification when running 'hardhat verify'.

```typescript
import { defineConfig } from "hardhat/config";
import hardhatVerify from "@nomicfoundation/hardhat-verify";

export default defineConfig({
  plugins: [hardhatVerify],
});
```

--------------------------------

### Verify contract with curl (bash)

Source: https://docs.sourcify.dev/docs/api/index.html

Sends a POST request to the Sourcify verification endpoint with a Solidity source file and metadata. If a verificationId is returned, it polls the status endpoint; otherwise it prints the error response.

```bash
verification_result=$(
  curl -sS -X POST \
    'https://sourcify.dev/server/v2/verify/11155111/0x2738d13E81e30bC615766A0410e7cF199FD59A83' \
    -H 'Content-Type: application/json' \
    --data-raw '{"stdJsonInput":{"language":"Solidity","sources":{"contracts/Storage.sol":{"content":"// SPDX-License-Identifier: MIT\npragma solidity ^0.8.0;\n\ncontract Storage {\n    uint256 number;\n\n    function setNumber(uint256 newNumber) public {\n        number = newNumber;\n    }\n\n    function getNumber() public view returns (uint256) {\n        return number;\n    }\n}\n"}},"settings":{"optimizer":{"enabled":false,"runs":200}}},"compilerVersion":"0.8.7+commit.e28d00a7","contractIdentifier":"contracts/Storage.sol:Storage","creationTransactionHash":"0xb6ee9d528b336942dd70d3b41e2811be10a473776352009fd73f85604f5ed206"}'
)

verification_id=$(echo "$verification_result" | jq -r '.verificationId // empty')

if [ -n "$verification_id" ]; then
  curl -sS \
    "https://sourcify.dev/server/v2/verify/${verification_id}"
else
  echo "$verification_result"
fi
```

--------------------------------

### Verify an existing contract with Forge using Sourcify

Source: https://docs.sourcify.dev/docs/verify-via-foundry/index.html

Use this command to verify an already deployed contract on a specific chain. The --chain flag specifies the chain ID (e.g., 11155111 for Sepolia). The contract address and source file path are provided as arguments.

```bash
forge verify-contract 0x55f7d4279CE387067f12561e7E0c194f5186cFba \
  src/MyToken.sol:MyToken \
  --chain 11155111 \
  --verifier sourcify
```

--------------------------------

### Query all Parquet files of a table with DuckDB using S3-compatible API

Source: https://docs.sourcify.dev/docs/repository/download-dataset/index.html

Use this SQL to query all files of a table via the S3-compatible API, which supports wildcards like *.parquet. It creates a secret for the Sourcify export endpoint and aggregates deployments by chain_id.

```sql
INSTALL httpfs;
LOAD httpfs;

CREATE SECRET sourcify_export (
  TYPE s3,
  PROVIDER config,
  KEY_ID '',
  SECRET '',
  ENDPOINT 'storage.googleapis.com',
  URL_STYLE 'path'
);

SELECT chain_id, count(*) AS deployments
FROM 's3://sourcify-production-parquet-export/v2/contract_deployments/*.parquet'
GROUP BY chain_id
ORDER BY deployments DESC;
```

--------------------------------

### Download a specific file

Source: https://docs.sourcify.dev/docs/repository/download-dataset/index.html

Use this URL to download a specific Parquet file. The file path is the Key from the listing API response.

```text
https://export.sourcify.dev/v2/verified_contracts/verified_contracts_0_1000000.parquet
```

--------------------------------

### Verify on Sourcify only with hardhat verify sourcify

Source: https://docs.sourcify.dev/docs/verify-via-hardhat/index.html

Use this command to verify only on Sourcify, skipping Etherscan and Blockscout. Replace DEPLOYED_CONTRACT_ADDRESS with the actual address.

```bash
npx hardhat verify sourcify --network mainnet DEPLOYED_CONTRACT_ADDRESS
```

--------------------------------

### Verify contract with JavaScript (fetch)

Source: https://docs.sourcify.dev/docs/api/index.html

Uses the Fetch API to POST a verification request to the Sourcify endpoint. If a verificationId is returned, it fetches the status endpoint and logs the result; otherwise it logs the error response.

```javascript
const verificationResponse = await fetch(
  "https://sourcify.dev/server/v2/verify/11155111/0x2738d13E81e30bC615766A0410e7cF199FD59A83",
  {
    method: "POST",
    headers: {
        "Content-Type": "application/json",
    },
    body: JSON.stringify({
      stdJsonInput: {
        language: "Solidity",
        sources: {
            "contracts/Storage.sol": {
                content: "// SPDX-License-Identifier: MIT\npragma solidity ^0.8.0;\n\ncontract Storage {\n    uint256 number;\n\n    function setNumber(uint256 newNumber) public {\n        number = newNumber;\n    }\n\n    function getNumber() public view returns (uint256) {\n        return number;\n    }\n}\n",
            },
        },
        settings: {
            optimizer: {
                enabled: false,
                runs: 200,
            },
        },
      },
      compilerVersion: "0.8.7+commit.e28d00a7",
      contractIdentifier: "contracts/Storage.sol:Storage",
      creationTransactionHash: "0xb6ee9d528b336942dd70d3b41e2811be10a473776352009fd73f85604f5ed206",
    }),
  }
);

const verificationResult = await verificationResponse.json();
const { verificationId } = verificationResult;

if (verificationId) {
  const jobResponse = await fetch(
    `https://sourcify.dev/server/v2/verify/${verificationId}`
  );

  const jobResult = await jobResponse.json();
  console.log(jobResult);
} else {
  console.log(verificationResult);
}
```

--------------------------------

### POST /v2/verify/{chainId}/{address}

Source: https://docs.sourcify.dev/docs/api/index.html

Verifies a contract by submitting its source code and metadata. Returns a verificationId if successful, or an error.

```APIDOC
## POST /v2/verify/{chainId}/{address}

### Description
Verifies a contract by submitting its source code and metadata. Returns a verificationId if successful, or an error.

### Method
POST

### Endpoint
/v2/verify/{chainId}/{address}

### Parameters
#### Path Parameters
- **chainId** (integer) - Required - The chain ID of the network where the contract is deployed.
- **address** (string) - Required - The address of the contract to verify.

#### Request Body
- **stdJsonInput** (object) - Required - The standard JSON input containing the contract source code and settings.
  - **language** (string) - Required - The language of the source code (e.g., "Solidity").
  - **sources** (object) - Required - A map of source file names to their content.
    - **<file>** (object) - Required - Contains the source code content.
      - **content** (string) - Required - The source code of the contract.
  - **settings** (object) - Required - Compiler settings.
    - **optimizer** (object) - Required - Optimizer settings.
      - **enabled** (boolean) - Required - Whether the optimizer is enabled.
      - **runs** (integer) - Required - The number of optimizer runs.
- **compilerVersion** (string) - Required - The compiler version used to compile the contract.
- **contractIdentifier** (string) - Required - The identifier of the contract in the format "file.sol:ContractName".
- **creationTransactionHash** (string) - Required - The transaction hash of the contract creation.

### Request Example
{
  "stdJsonInput": {
    "language": "Solidity",
    "sources": {
      "contracts/Storage.sol": {
        "content": "// SPDX-License-Identifier: MIT\npragma solidity ^0.8.0;\n\ncontract Storage {\n    uint256 number;\n\n    function setNumber(uint256 newNumber) public {\n        number = newNumber;\n    }\n\n    function getNumber() public view returns (uint256) {\n        return number;\n    }\n}\n"
      }
    },
    "settings": {
      "optimizer": {
        "enabled": false,
        "runs": 200
      }
    }
  },
  "compilerVersion": "0.8.7+commit.e28d00a7",
  "contractIdentifier": "contracts/Storage.sol:Storage",
  "creationTransactionHash": "0xb6ee9d528b336942dd70d3b41e2811be10a473776352009fd73f85604f5ed206"
}

### Response
#### Success Response (200)
- **verificationId** (string) - The ID of the verification job.

#### Response Example
{
  "verificationId": "..."
}

#### Error Response
- Returns an error object if verification fails.
```

--------------------------------

### Solidity recompiled bytecode with immutable reference as zeros

Source: https://docs.sourcify.dev/docs/immutables/index.html

Excerpt from the recompiled bytecode of a Sepolia contract showing the immutable variable reference as 64 consecutive zeros in hex.

```text
...050565b7f000000000000000000000000000000000000000000000000000000000000000081565b8280...
```

--------------------------------

### Solidity deployed bytecode with immutable value filled

Source: https://docs.sourcify.dev/docs/immutables/index.html

The same bytecode excerpt after deployment, where the immutable reference has been replaced with the value 11155111 (hex 0xa36a7).

```text
...050565b7f0000000000000000000000000000000000000000000000000000000000aa36a781565b8280...
```

--------------------------------

### Add metadata to outputSelection in Standard JSON

Source: https://docs.sourcify.dev/docs/metadata/index.html

Add 'metadata' to the outputSelection of the Solidity Standard JSON input to include metadata in the compilation output.

```json
    "outputSelection": {
      "*": {
        "*": [
          "metadata", // <--
          "evm.bytecode",
          "evm.bytecode.sourceMap"
        ],
        ...
      },
      ...
    }
```

--------------------------------

### External verification status response from /v2/verify/{verificationId}

Source: https://docs.sourcify.dev/docs/external-verifiers/index.html

The v2 verification job endpoint returns an externalVerifications object with a blockscout entry containing verificationId, statusUrl, and explorerUrl. Poll statusUrl to track verification status.

```json
{
    ...,
    externalVerifications: {
        blockscout: {
            verificationId: "x3ryqcqr1zdknhfhkimqmizlcqpxncqc6nrvp3pgrcpfsqedqi",
            statusUrl: "https://api.etherscan.io/v2/api?chainid=1&module=contract&action=checkverifystatus&guid=x3ryqcqr1zdknhfhkimqmizlcqpxncqc6nrvp3pgrcpfsqedqi",
            explorerUrl: "https://etherscan.io/address/0x0D41E0B7bbdEBDBc684020dcb64ADe76C0338222#code",
        }
    }
    ...
}
```

--------------------------------

### additional-chains.json entry

Source: https://docs.sourcify.dev/docs/chain-support/index.html

Add a chain to additional-chains.json when it only needs a name and public RPCs from chainid.network. Only the sourcifyName is required; the generator adds supported: true and public RPCs at output time.

```json
{
  "12345": { "sourcifyName": "My Chain Mainnet" }
}
```

--------------------------------

### Vyper CBOR auxdata structure

Source: https://docs.sourcify.dev/docs/immutables/index.html

Text representation of the CBOR array appended by Vyper at the end of the creation bytecode, listing its elements.

```text
[
  integrity_hash,    // Hash of the contract's source code, included starting with Vyper 0.4.1
  runtime_size,      // Size of the runtime bytecode
  data_sizes,        // Array of data section sizes
  immutable_size,    // Total size of all immutable variables
  compiler          // Compiler information, e.g. {"vyper": [0, 4, 0]}
]
```
Tokens:
Raw