Jump to

• Request
• Response

Import Contract Storage Layout, ABI, and Bytecode

post

/v1/contracts/solc/import

By default, imports metadata as a new contract version. For a new version, asOf is required and must include at least one of blockNum or txHash.

• If only txHash is provided, the response identifies the corresponding blockNum.
• If both blockNum and txHash are provided, both are accepted as provided.

Set update=true to update an existing version identified by exactly one of updateVersion or updateTxHash. The supplied creation bytecode is retained as provided; the response does not include runtime bytecode from the chain.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• abi(required): array abi
• address(required): string
  Deployed contract address.
• asOf: object asOf
  Required when creating a new version. Provide at least one of blockNum or txHash.
• bytecode(required): string
  Creation bytecode in 0x-prefixed hexadecimal format.
• layout(required): object layout
  Solidity compiler storage-layout JSON. Must include storage and types.
• metadata:
  Optional user-facing metadata stored with this contract version.
• role: string
  Optional contract classification (regular, proxy, implementation, or library). Defaults to regular.
• update: boolean
  Default Value: false

  When true, update an existing contract version.
• updateTxHash: [ "string", "null" ]
  Existing transaction hash that identifies the version to update. Required when update=true unless updateVersion is provided.
• updateVersion: [ "integer", "null" ]
  Existing version number to update. Required when update=true unless updateTxHash is provided.

{
    "type":"object",
    "required":[
        "address",
        "layout",
        "abi",
        "bytecode"
    ],
    "properties":{
        "address":{
            "type":"string",
            "description":"Deployed contract address."
        },
        "role":{
            "type":"string",
            "description":"Optional contract classification (<code>regular</code>, <code>proxy</code>, <code>implementation</code>, or <code>library</code>). Defaults to <code>regular</code>."
        },
        "update":{
            "type":"boolean",
            "default":false,
            "description":"When <code>true</code>, update an existing contract version."
        },
        "updateVersion":{
            "type":[
                "integer",
                "null"
            ],
            "description":"Existing version number to update. Required when <code>update=true</code> unless <code>updateTxHash</code> is provided."
        },
        "updateTxHash":{
            "type":[
                "string",
                "null"
            ],
            "description":"Existing transaction hash that identifies the version to update. Required when <code>update=true</code> unless <code>updateVersion</code> is provided."
        },
        "asOf":{
            "type":"object",
            "description":"Required when creating a new version. Provide at least one of <code>blockNum</code> or <code>txHash</code>.",
            "anyOf":[
                {
                    "required":[
                        "blockNum"
                    ]
                },
                {
                    "required":[
                        "txHash"
                    ]
                }
            ],
            "properties":{
                "txHash":{
                    "type":[
                        "string",
                        "null"
                    ],
                    "description":"81642776211137670000000000000000000000000"
                },
                "blockNum":{
                    "type":"string",
                    "description":"74254541910102660000000000000"
                },
                "timestamp":{
                    "type":[
                        "string",
                        "null"
                    ]
                }
            }
        },
        "layout":{
            "type":"object",
            "description":"Solidity compiler storage-layout JSON. Must include <code>storage</code> and <code>types</code>."
        },
        "abi":{
            "type":"array",
            "items":{
                "type":"object"
            }
        },
        "bytecode":{
            "type":"string",
            "description":"Creation bytecode in 0x-prefixed hexadecimal format."
        },
        "metadata":{
            "anyOf":[
                {
                    "$ref":"#/components/schemas/ContractUserMetadata"
                },
                {
                    "type":"null"
                }
            ],
            "description":"Optional user-facing metadata stored with this contract version."
        }
    }
}

Nested Schema : abi

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : asOf

Type: object

Required when creating a new version. Provide at least one of blockNum or txHash.

Show Source

• blockNum: string
  74254541910102660000000000000
• timestamp: [ "string", "null" ]
• txHash: [ "string", "null" ]
  81642776211137670000000000000000000000000

{
    "type":"object",
    "description":"Required when creating a new version. Provide at least one of <code>blockNum</code> or <code>txHash</code>.",
    "anyOf":[
        {
            "required":[
                "blockNum"
            ]
        },
        {
            "required":[
                "txHash"
            ]
        }
    ],
    "properties":{
        "txHash":{
            "type":[
                "string",
                "null"
            ],
            "description":"81642776211137670000000000000000000000000"
        },
        "blockNum":{
            "type":"string",
            "description":"74254541910102660000000000000"
        },
        "timestamp":{
            "type":[
                "string",
                "null"
            ]
        }
    }
}

Nested Schema : layout

Type: object

Solidity compiler storage-layout JSON. Must include storage and types.

Nested Schema : items

Type: object

Examples

Select an example request_solc_import_payload

Back to Top

Response

Supported Media Types

• application/json

202 Response

Returns the accepted contract metadata import request.

Body ()

Root Schema : SolcIngestResult

Type: object

Result of an asynchronous Solidity compiler metadata import request.

Show Source

• address: string
  Contract address associated with the ingested metadata.
• update: boolean
  Indicates whether the operation updated an existing contract version record.
• version: [ "integer", "null" ]
  Logical contract version number associated with the ingest result, when available.
• versionRowId:
  Identifier of the affected version record, when available.

{
    "type":"object",
    "description":"Result of an asynchronous Solidity compiler metadata import request.",
    "properties":{
        "update":{
            "type":"boolean",
            "description":"Indicates whether the operation updated an existing contract version record."
        },
        "address":{
            "type":"string",
            "description":"Contract address associated with the ingested metadata."
        },
        "version":{
            "type":[
                "integer",
                "null"
            ],
            "description":"Logical contract version number associated with the ingest result, when available."
        },
        "versionRowId":{
            "anyOf":[
                {
                    "type":"integer",
                    "format":"int64"
                },
                {
                    "type":"null"
                }
            ],
            "description":"Identifier of the affected version record, when available."
        }
    }
}

400 Response

Validation failed.

Body ()

Root Schema : ErrorResponse

Type: object

Error response returned by the service.

Show Source

• decodedError:
  Returned only when `decode.errors=true` and decodable revert bytes are present.
• error: string
  Short error summary suitable for display.
• hint: [ "string", "null" ]
  Optional guidance for resolving the error.
• message: [ "string", "null" ]
  Additional error details, when available.
• policy:
  Present for policy warnings or denials such as preflight failure.
• preflight:
  Present for preflight-gated transaction submission errors.
• requestId: [ "string", "null" ]
  Client-provided correlation ID echoed in the response.
• upstreamCode: [ "integer", "null" ]
  Besu node error code, when provided by the RPC endpoint.
• upstreamData: [ "string", "null" ]
  Error data returned by the Besu node in 0x-prefixed hexadecimal or JSON format, when available.
• upstreamError: [ "object", "null" ] upstreamError
  Additional Properties Allowed: true

  Complete error object returned by the Besu node, including code, message, and data fields, when available.

{
    "type":"object",
    "description":"Error response returned by the service.",
    "properties":{
        "error":{
            "type":"string",
            "description":"Short error summary suitable for display."
        },
        "message":{
            "type":[
                "string",
                "null"
            ],
            "description":"Additional error details, when available."
        },
        "hint":{
            "type":[
                "string",
                "null"
            ],
            "description":"Optional guidance for resolving the error."
        },
        "upstreamCode":{
            "type":[
                "integer",
                "null"
            ],
            "description":"Besu node error code, when provided by the RPC endpoint."
        },
        "upstreamData":{
            "type":[
                "string",
                "null"
            ],
            "description":"Error data returned by the Besu node in 0x-prefixed hexadecimal or JSON format, when available."
        },
        "upstreamError":{
            "type":[
                "object",
                "null"
            ],
            "additionalProperties":true,
            "description":"Complete error object returned by the Besu node, including code, message, and data fields, when available."
        },
        "decodedError":{
            "anyOf":[
                {
                    "$ref":"#/components/schemas/DecodedError"
                },
                {
                    "type":"null"
                }
            ],
            "description":"Returned only when `decode.errors=true` and decodable revert bytes are present."
        },
        "preflight":{
            "anyOf":[
                {
                    "$ref":"#/components/schemas/TransactionPreflightResult"
                },
                {
                    "type":"null"
                }
            ],
            "description":"Present for preflight-gated transaction submission errors."
        },
        "policy":{
            "anyOf":[
                {
                    "$ref":"#/components/schemas/TransactionPolicyDecision"
                },
                {
                    "type":"null"
                }
            ],
            "description":"Present for policy warnings or denials such as preflight failure."
        },
        "requestId":{
            "type":[
                "string",
                "null"
            ],
            "description":"Client-provided correlation ID echoed in the response."
        }
    }
}

Nested Schema : upstreamError

Type: object

Additional Properties Allowed: true

Complete error object returned by the Besu node, including code, message, and data fields, when available.

500 Response

Unexpected service error.

Body ()

Root Schema : ErrorResponse

Type: object

Error response returned by the service.

Show Source

• decodedError:
  Returned only when `decode.errors=true` and decodable revert bytes are present.
• error: string
  Short error summary suitable for display.
• hint: [ "string", "null" ]
  Optional guidance for resolving the error.
• message: [ "string", "null" ]
  Additional error details, when available.
• policy:
  Present for policy warnings or denials such as preflight failure.
• preflight:
  Present for preflight-gated transaction submission errors.
• requestId: [ "string", "null" ]
  Client-provided correlation ID echoed in the response.
• upstreamCode: [ "integer", "null" ]
  Besu node error code, when provided by the RPC endpoint.
• upstreamData: [ "string", "null" ]
  Error data returned by the Besu node in 0x-prefixed hexadecimal or JSON format, when available.
• upstreamError: [ "object", "null" ] upstreamError
  Additional Properties Allowed: true

  Complete error object returned by the Besu node, including code, message, and data fields, when available.

{
    "type":"object",
    "description":"Error response returned by the service.",
    "properties":{
        "error":{
            "type":"string",
            "description":"Short error summary suitable for display."
        },
        "message":{
            "type":[
                "string",
                "null"
            ],
            "description":"Additional error details, when available."
        },
        "hint":{
            "type":[
                "string",
                "null"
            ],
            "description":"Optional guidance for resolving the error."
        },
        "upstreamCode":{
            "type":[
                "integer",
                "null"
            ],
            "description":"Besu node error code, when provided by the RPC endpoint."
        },
        "upstreamData":{
            "type":[
                "string",
                "null"
            ],
            "description":"Error data returned by the Besu node in 0x-prefixed hexadecimal or JSON format, when available."
        },
        "upstreamError":{
            "type":[
                "object",
                "null"
            ],
            "additionalProperties":true,
            "description":"Complete error object returned by the Besu node, including code, message, and data fields, when available."
        },
        "decodedError":{
            "anyOf":[
                {
                    "$ref":"#/components/schemas/DecodedError"
                },
                {
                    "type":"null"
                }
            ],
            "description":"Returned only when `decode.errors=true` and decodable revert bytes are present."
        },
        "preflight":{
            "anyOf":[
                {
                    "$ref":"#/components/schemas/TransactionPreflightResult"
                },
                {
                    "type":"null"
                }
            ],
            "description":"Present for preflight-gated transaction submission errors."
        },
        "policy":{
            "anyOf":[
                {
                    "$ref":"#/components/schemas/TransactionPolicyDecision"
                },
                {
                    "type":"null"
                }
            ],
            "description":"Present for policy warnings or denials such as preflight failure."
        },
        "requestId":{
            "type":[
                "string",
                "null"
            ],
            "description":"Client-provided correlation ID echoed in the response."
        }
    }
}

Nested Schema : upstreamError

Type: object

Additional Properties Allowed: true

Complete error object returned by the Besu node, including code, message, and data fields, when available.

Back to Top