Jump to

• Request
• Response

List Contract Deployments

get

/v1/contracts

Returns a list of all contract deployments saved in the registry. It doesn't return the associated ABI or bytecode.

Request

There are no request parameters for this operation.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Returns the contract deployments without ABI or bytecode.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object ContractSummary
  Summary of the latest metadata for a deployed contract.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ContractSummary"
    }
}

Nested Schema : ContractSummary

Type: object

Summary of the latest metadata for a deployed contract.

Show Source

• address: string
  Contract deployment address.
• blockNum: [ "string", "null" ]
  Block number for the most recent contract version.
• contractRole: string
  Contract role classification: `regular`, `proxy`, `implementation`, or `library`.
• currentVersion: integer
  Most recent contract version number.
• implementationAddress: [ "string", "null" ]
  Implementation contract address for `proxy` deployments, when available.
• metadata:
  User-facing metadata associated with the most recent contract version.
• txHash: [ "string", "null" ]
  Transaction hash associated with the most recent contract version.
• updatedAt: [ "string", "null" ]
  Timestamp when the summary was last updated.

{
    "type":"object",
    "description":"Summary of the latest metadata for a deployed contract.",
    "properties":{
        "address":{
            "type":"string",
            "description":"Contract deployment address."
        },
        "contractRole":{
            "type":"string",
            "description":"Contract role classification: `regular`, `proxy`, `implementation`, or `library`."
        },
        "currentVersion":{
            "type":"integer",
            "description":"Most recent contract version number."
        },
        "implementationAddress":{
            "type":[
                "string",
                "null"
            ],
            "description":"Implementation contract address for `proxy` deployments, when available."
        },
        "txHash":{
            "type":[
                "string",
                "null"
            ],
            "description":"Transaction hash associated with the most recent contract version."
        },
        "blockNum":{
            "type":[
                "string",
                "null"
            ],
            "description":"Block number for the most recent contract version."
        },
        "updatedAt":{
            "type":[
                "string",
                "null"
            ],
            "description":"Timestamp when the summary was last updated."
        },
        "metadata":{
            "anyOf":[
                {
                    "$ref":"#/components/schemas/ContractUserMetadata"
                },
                {
                    "type":"null"
                }
            ],
            "description":"User-facing metadata associated with the most recent contract version."
        }
    }
}

Examples

Select an example Two contract summaries

Back to Top