Jump to

• Request
• Response

Get Contract Deployment by Address

get

/v1/contracts/{address}

Returns the full metadata for a registered contract at a particular address, if it is available in the contract registry.

Request

Path Parameters

• address(required): string
  Deployed contract address.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Returns the requested contract deployment metadata, including ABI and bytecode.

Body ()

Root Schema : VersionRecord

Type: object

Metadata for a specific version of a deployed contract.

Show Source

• abi: array abi
  Contract ABI entries associated with this version.
• asOf: object AsOf
  Chain reference that identifies a contract version snapshot.
• bytecode: [ "string", "null" ]
  Creation bytecode associated with this version, when available.
• bytecodeHash: [ "string", "null" ]
  Hash of the stored bytecode for integrity verification and lookup.
• implementationAddress: [ "string", "null" ]
  Implementation address for `proxy` deployments, when available.
• metadata:
  User-facing metadata associated with this version.
• storageLayouts: array storageLayouts
  Storage layout variants associated with this version.
• version: integer
  Contract version number.

{
    "type":"object",
    "description":"Metadata for a specific version of a deployed contract.",
    "properties":{
        "version":{
            "type":"integer",
            "description":"Contract version number."
        },
        "asOf":{
            "$ref":"#/components/schemas/AsOf",
            "description":"Chain reference used to identify the version snapshot."
        },
        "abi":{
            "type":"array",
            "description":"Contract ABI entries associated with this version.",
            "items":{
                "type":"object"
            }
        },
        "bytecode":{
            "type":[
                "string",
                "null"
            ],
            "description":"Creation bytecode associated with this version, when available."
        },
        "bytecodeHash":{
            "type":[
                "string",
                "null"
            ],
            "description":"Hash of the stored bytecode for integrity verification and lookup."
        },
        "storageLayouts":{
            "type":"array",
            "description":"Storage layout variants associated with this version.",
            "items":{
                "$ref":"#/components/schemas/StorageLayoutVariantRef"
            }
        },
        "implementationAddress":{
            "type":[
                "string",
                "null"
            ],
            "description":"Implementation address for `proxy` deployments, when available."
        },
        "metadata":{
            "anyOf":[
                {
                    "$ref":"#/components/schemas/ContractUserMetadata"
                },
                {
                    "type":"null"
                }
            ],
            "description":"User-facing metadata associated with this version."
        }
    }
}

Nested Schema : abi

Type: array

Contract ABI entries associated with this version.

Show Source

• Array of: object items

{
    "type":"array",
    "description":"Contract ABI entries associated with this version.",
    "items":{
        "type":"object"
    }
}

Nested Schema : AsOf

Type: object

Chain reference that identifies a contract version snapshot.

Show Source

• blockNum(required): string
  Block number in 0x-prefixed hexadecimal or decimal format.
• timestamp: [ "string", "null" ]
  Timestamp associated with the version snapshot, when available.
• txHash: [ "string", "null" ]
  Transaction hash used to identify the version snapshot, when available.

{
    "type":"object",
    "description":"Chain reference that identifies a contract version snapshot.",
    "required":[
        "blockNum"
    ],
    "properties":{
        "txHash":{
            "type":[
                "string",
                "null"
            ],
            "description":"Transaction hash used to identify the version snapshot, when available."
        },
        "blockNum":{
            "type":"string",
            "description":"Block number in 0x-prefixed hexadecimal or decimal format."
        },
        "timestamp":{
            "type":[
                "string",
                "null"
            ],
            "description":"Timestamp associated with the version snapshot, when available."
        }
    }
}

Nested Schema : storageLayouts

Type: array

Storage layout variants associated with this version.

Show Source

• Array of: object StorageLayoutVariantRef
  Storage layout variant associated with a contract version.

{
    "type":"array",
    "description":"Storage layout variants associated with this version.",
    "items":{
        "$ref":"#/components/schemas/StorageLayoutVariantRef"
    }
}

Nested Schema : items

Type: object

Nested Schema : StorageLayoutVariantRef

Type: object

Storage layout variant associated with a contract version.

Show Source

• capturedAt: [ "string", "null" ]
  Capture timestamp for this storage layout variant, when available.
• content: [ "object", "null" ]
  Storage layout content.
• schemaVersion: string
  Schema version for the storage layout representation.
• sourceKind: string
  Source category used to obtain the storage layout.
• sourceToolchain: [ "string", "null" ]
  Toolchain metadata associated with the storage layout source.
• type: string
  Storage layout representation type identifier.

{
    "type":"object",
    "description":"Storage layout variant associated with a contract version.",
    "properties":{
        "type":{
            "type":"string",
            "description":"Storage layout representation type identifier."
        },
        "schemaVersion":{
            "type":"string",
            "description":"Schema version for the storage layout representation."
        },
        "capturedAt":{
            "type":[
                "string",
                "null"
            ],
            "description":"Capture timestamp for this storage layout variant, when available."
        },
        "sourceKind":{
            "type":"string",
            "description":"Source category used to obtain the storage layout."
        },
        "sourceToolchain":{
            "type":[
                "string",
                "null"
            ],
            "description":"Toolchain metadata associated with the storage layout source."
        },
        "content":{
            "type":[
                "object",
                "null"
            ],
            "description":"Storage layout content."
        }
    }
}

Examples

Select an example response_200_contract_version_record

404 Response

Contract not found.

Back to Top