Jump to

• Request
• Response

Import Contract Manifest and Metadata

post

/v1/contracts/manifests/import

Imports a manifest and contract-version metadata for the addresses in `contracts`. To update an existing manifest, set `update=true` and provide `manifestLayoutId`. For updates, `contracts` entries can include an address and metadata for versions associated with that manifest.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Match One Schema

Show Source

• object ManifestAppendImportRequest
  Title: ManifestAppendImportRequest
• object ManifestUpdateImportRequest
  Title: ManifestUpdateImportRequest

{
    "oneOf":[
        {
            "title":"ManifestAppendImportRequest",
            "type":"object",
            "required":[
                "manifest",
                "contracts"
            ],
            "properties":{
                "manifest":{
                    "type":"object",
                    "description":"OpenZeppelin/Hardhat manifest JSON"
                },
                "update":{
                    "type":"boolean",
                    "const":false,
                    "default":false,
                    "description":"Omit or set to `false` to import contract-version metadata."
                },
                "contracts":{
                    "type":"array",
                    "minItems":1,
                    "description":"Contract addresses with ABI, creation bytecode, and exactly one block reference.",
                    "items":{
                        "type":"object",
                        "required":[
                            "address",
                            "abi",
                            "bytecode"
                        ],
                        "oneOf":[
                            {
                                "required":[
                                    "blockNum"
                                ]
                            },
                            {
                                "required":[
                                    "txHash"
                                ]
                            }
                        ],
                        "properties":{
                            "address":{
                                "type":"string",
                                "description":"20-byte address in 0x-prefixed hexadecimal format."
                            },
                            "abi":{
                                "type":"array",
                                "description":"Standard JSON ABI entries.",
                                "items":{
                                    "type":"object"
                                }
                            },
                            "bytecode":{
                                "type":"string",
                                "description":"Creation bytecode in 0x-prefixed hexadecimal format."
                            },
                            "blockNum":{
                                "type":"string",
                                "description":"Block number in 0x-prefixed hexadecimal or decimal format."
                            },
                            "txHash":{
                                "type":"string",
                                "description":"32-byte transaction hash in 0x-prefixed hexadecimal format."
                            },
                            "role":{
                                "type":[
                                    "string",
                                    "null"
                                ],
                                "description":"Optional contract classification. Supported values are `regular`, `proxy`, `implementation`, and `library`; other values are treated as `regular`."
                            },
                            "metadata":{
                                "anyOf":[
                                    {
                                        "$ref":"#/components/schemas/ContractUserMetadata"
                                    },
                                    {
                                        "type":"null"
                                    }
                                ],
                                "description":"Optional user-facing metadata stored with this contract version."
                            }
                        }
                    }
                }
            }
        },
        {
            "title":"ManifestUpdateImportRequest",
            "type":"object",
            "required":[
                "update",
                "manifest",
                "manifestLayoutId"
            ],
            "properties":{
                "update":{
                    "type":"boolean",
                    "const":true,
                    "description":"Set true to update an existing manifest layout."
                },
                "manifestLayoutId":{
                    "type":"integer",
                    "format":"int64",
                    "description":"Identifier of the existing manifest layout to update."
                },
                "manifest":{
                    "type":"object",
                    "description":"OpenZeppelin/Hardhat manifest JSON"
                },
                "contracts":{
                    "type":"array",
                    "description":"Optional metadata updates for versions associated with `manifestLayoutId`. Omitted metadata leaves existing metadata unchanged, `null` clears it, and an object replaces it.",
                    "items":{
                        "type":"object",
                        "required":[
                            "address"
                        ],
                        "properties":{
                            "address":{
                                "type":"string",
                                "description":"20-byte 0x-prefixed address"
                            },
                            "role":{
                                "type":[
                                    "string",
                                    "null"
                                ],
                                "description":"Optional contract classification update. Supported values are `regular`, `proxy`, `implementation`, and `library`; other values are treated as `regular`."
                            },
                            "metadata":{
                                "anyOf":[
                                    {
                                        "$ref":"#/components/schemas/ContractUserMetadata"
                                    },
                                    {
                                        "type":"null"
                                    }
                                ],
                                "description":"Optional user-facing metadata patch for this contract version."
                            }
                        }
                    }
                }
            }
        }
    ]
}

Nested Schema : ManifestAppendImportRequest

Type: object

Title: ManifestAppendImportRequest

Show Source

• contracts(required): array contracts
  Minimum Number of Items: 1

  Contract addresses with ABI, creation bytecode, and exactly one block reference.
• manifest(required): object manifest
  OpenZeppelin/Hardhat manifest JSON
• update: boolean
  Default Value: false

  Omit or set to `false` to import contract-version metadata.

{
    "title":"ManifestAppendImportRequest",
    "type":"object",
    "required":[
        "manifest",
        "contracts"
    ],
    "properties":{
        "manifest":{
            "type":"object",
            "description":"OpenZeppelin/Hardhat manifest JSON"
        },
        "update":{
            "type":"boolean",
            "const":false,
            "default":false,
            "description":"Omit or set to `false` to import contract-version metadata."
        },
        "contracts":{
            "type":"array",
            "minItems":1,
            "description":"Contract addresses with ABI, creation bytecode, and exactly one block reference.",
            "items":{
                "type":"object",
                "required":[
                    "address",
                    "abi",
                    "bytecode"
                ],
                "oneOf":[
                    {
                        "required":[
                            "blockNum"
                        ]
                    },
                    {
                        "required":[
                            "txHash"
                        ]
                    }
                ],
                "properties":{
                    "address":{
                        "type":"string",
                        "description":"20-byte address in 0x-prefixed hexadecimal format."
                    },
                    "abi":{
                        "type":"array",
                        "description":"Standard JSON ABI entries.",
                        "items":{
                            "type":"object"
                        }
                    },
                    "bytecode":{
                        "type":"string",
                        "description":"Creation bytecode in 0x-prefixed hexadecimal format."
                    },
                    "blockNum":{
                        "type":"string",
                        "description":"Block number in 0x-prefixed hexadecimal or decimal format."
                    },
                    "txHash":{
                        "type":"string",
                        "description":"32-byte transaction hash in 0x-prefixed hexadecimal format."
                    },
                    "role":{
                        "type":[
                            "string",
                            "null"
                        ],
                        "description":"Optional contract classification. Supported values are `regular`, `proxy`, `implementation`, and `library`; other values are treated as `regular`."
                    },
                    "metadata":{
                        "anyOf":[
                            {
                                "$ref":"#/components/schemas/ContractUserMetadata"
                            },
                            {
                                "type":"null"
                            }
                        ],
                        "description":"Optional user-facing metadata stored with this contract version."
                    }
                }
            }
        }
    }
}

Nested Schema : ManifestUpdateImportRequest

Type: object

Title: ManifestUpdateImportRequest

Show Source

• contracts: array contracts
  Optional metadata updates for versions associated with `manifestLayoutId`. Omitted metadata leaves existing metadata unchanged, `null` clears it, and an object replaces it.
• manifest(required): object manifest
  OpenZeppelin/Hardhat manifest JSON
• manifestLayoutId(required): integer (int64)
  Identifier of the existing manifest layout to update.
• update(required): boolean
  Set true to update an existing manifest layout.

{
    "title":"ManifestUpdateImportRequest",
    "type":"object",
    "required":[
        "update",
        "manifest",
        "manifestLayoutId"
    ],
    "properties":{
        "update":{
            "type":"boolean",
            "const":true,
            "description":"Set true to update an existing manifest layout."
        },
        "manifestLayoutId":{
            "type":"integer",
            "format":"int64",
            "description":"Identifier of the existing manifest layout to update."
        },
        "manifest":{
            "type":"object",
            "description":"OpenZeppelin/Hardhat manifest JSON"
        },
        "contracts":{
            "type":"array",
            "description":"Optional metadata updates for versions associated with `manifestLayoutId`. Omitted metadata leaves existing metadata unchanged, `null` clears it, and an object replaces it.",
            "items":{
                "type":"object",
                "required":[
                    "address"
                ],
                "properties":{
                    "address":{
                        "type":"string",
                        "description":"20-byte 0x-prefixed address"
                    },
                    "role":{
                        "type":[
                            "string",
                            "null"
                        ],
                        "description":"Optional contract classification update. Supported values are `regular`, `proxy`, `implementation`, and `library`; other values are treated as `regular`."
                    },
                    "metadata":{
                        "anyOf":[
                            {
                                "$ref":"#/components/schemas/ContractUserMetadata"
                            },
                            {
                                "type":"null"
                            }
                        ],
                        "description":"Optional user-facing metadata patch for this contract version."
                    }
                }
            }
        }
    }
}

Nested Schema : contracts

Type: array

Minimum Number of Items: 1

Contract addresses with ABI, creation bytecode, and exactly one block reference.

Show Source

• Array of: object items

{
    "type":"array",
    "minItems":1,
    "description":"Contract addresses with ABI, creation bytecode, and exactly one block reference.",
    "items":{
        "type":"object",
        "required":[
            "address",
            "abi",
            "bytecode"
        ],
        "oneOf":[
            {
                "required":[
                    "blockNum"
                ]
            },
            {
                "required":[
                    "txHash"
                ]
            }
        ],
        "properties":{
            "address":{
                "type":"string",
                "description":"20-byte address in 0x-prefixed hexadecimal format."
            },
            "abi":{
                "type":"array",
                "description":"Standard JSON ABI entries.",
                "items":{
                    "type":"object"
                }
            },
            "bytecode":{
                "type":"string",
                "description":"Creation bytecode in 0x-prefixed hexadecimal format."
            },
            "blockNum":{
                "type":"string",
                "description":"Block number in 0x-prefixed hexadecimal or decimal format."
            },
            "txHash":{
                "type":"string",
                "description":"32-byte transaction hash in 0x-prefixed hexadecimal format."
            },
            "role":{
                "type":[
                    "string",
                    "null"
                ],
                "description":"Optional contract classification. Supported values are `regular`, `proxy`, `implementation`, and `library`; other values are treated as `regular`."
            },
            "metadata":{
                "anyOf":[
                    {
                        "$ref":"#/components/schemas/ContractUserMetadata"
                    },
                    {
                        "type":"null"
                    }
                ],
                "description":"Optional user-facing metadata stored with this contract version."
            }
        }
    }
}

Nested Schema : manifest

Type: object

OpenZeppelin/Hardhat manifest JSON

Nested Schema : items

Type: object

Show Source

• abi(required): array abi
  Standard JSON ABI entries.
• address(required): string
  20-byte address in 0x-prefixed hexadecimal format.
• blockNum: string
  Block number in 0x-prefixed hexadecimal or decimal format.
• bytecode(required): string
  Creation bytecode in 0x-prefixed hexadecimal format.
• metadata:
  Optional user-facing metadata stored with this contract version.
• role: [ "string", "null" ]
  Optional contract classification. Supported values are `regular`, `proxy`, `implementation`, and `library`; other values are treated as `regular`.
• txHash: string
  32-byte transaction hash in 0x-prefixed hexadecimal format.

{
    "type":"object",
    "required":[
        "address",
        "abi",
        "bytecode"
    ],
    "oneOf":[
        {
            "required":[
                "blockNum"
            ]
        },
        {
            "required":[
                "txHash"
            ]
        }
    ],
    "properties":{
        "address":{
            "type":"string",
            "description":"20-byte address in 0x-prefixed hexadecimal format."
        },
        "abi":{
            "type":"array",
            "description":"Standard JSON ABI entries.",
            "items":{
                "type":"object"
            }
        },
        "bytecode":{
            "type":"string",
            "description":"Creation bytecode in 0x-prefixed hexadecimal format."
        },
        "blockNum":{
            "type":"string",
            "description":"Block number in 0x-prefixed hexadecimal or decimal format."
        },
        "txHash":{
            "type":"string",
            "description":"32-byte transaction hash in 0x-prefixed hexadecimal format."
        },
        "role":{
            "type":[
                "string",
                "null"
            ],
            "description":"Optional contract classification. Supported values are `regular`, `proxy`, `implementation`, and `library`; other values are treated as `regular`."
        },
        "metadata":{
            "anyOf":[
                {
                    "$ref":"#/components/schemas/ContractUserMetadata"
                },
                {
                    "type":"null"
                }
            ],
            "description":"Optional user-facing metadata stored with this contract version."
        }
    }
}

Match One Schema

Show Source

{
    "type":"object",
    "required":[
        "address",
        "abi",
        "bytecode"
    ],
    "oneOf":[
        {
            "required":[
                "blockNum"
            ]
        },
        {
            "required":[
                "txHash"
            ]
        }
    ],
    "properties":{
        "address":{
            "type":"string",
            "description":"20-byte address in 0x-prefixed hexadecimal format."
        },
        "abi":{
            "type":"array",
            "description":"Standard JSON ABI entries.",
            "items":{
                "type":"object"
            }
        },
        "bytecode":{
            "type":"string",
            "description":"Creation bytecode in 0x-prefixed hexadecimal format."
        },
        "blockNum":{
            "type":"string",
            "description":"Block number in 0x-prefixed hexadecimal or decimal format."
        },
        "txHash":{
            "type":"string",
            "description":"32-byte transaction hash in 0x-prefixed hexadecimal format."
        },
        "role":{
            "type":[
                "string",
                "null"
            ],
            "description":"Optional contract classification. Supported values are `regular`, `proxy`, `implementation`, and `library`; other values are treated as `regular`."
        },
        "metadata":{
            "anyOf":[
                {
                    "$ref":"#/components/schemas/ContractUserMetadata"
                },
                {
                    "type":"null"
                }
            ],
            "description":"Optional user-facing metadata stored with this contract version."
        }
    }
}

Nested Schema : abi

Type: array

Standard JSON ABI entries.

Show Source

• Array of: object items

{
    "type":"array",
    "description":"Standard JSON ABI entries.",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

Nested Schema : contracts

Type: array

Optional metadata updates for versions associated with `manifestLayoutId`. Omitted metadata leaves existing metadata unchanged, `null` clears it, and an object replaces it.

Show Source

• Array of: object items

{
    "type":"array",
    "description":"Optional metadata updates for versions associated with `manifestLayoutId`. Omitted metadata leaves existing metadata unchanged, `null` clears it, and an object replaces it.",
    "items":{
        "type":"object",
        "required":[
            "address"
        ],
        "properties":{
            "address":{
                "type":"string",
                "description":"20-byte 0x-prefixed address"
            },
            "role":{
                "type":[
                    "string",
                    "null"
                ],
                "description":"Optional contract classification update. Supported values are `regular`, `proxy`, `implementation`, and `library`; other values are treated as `regular`."
            },
            "metadata":{
                "anyOf":[
                    {
                        "$ref":"#/components/schemas/ContractUserMetadata"
                    },
                    {
                        "type":"null"
                    }
                ],
                "description":"Optional user-facing metadata patch for this contract version."
            }
        }
    }
}

Nested Schema : manifest

Type: object

OpenZeppelin/Hardhat manifest JSON

Nested Schema : items

Type: object

Show Source

• address(required): string
  20-byte 0x-prefixed address
• metadata:
  Optional user-facing metadata patch for this contract version.
• role: [ "string", "null" ]
  Optional contract classification update. Supported values are `regular`, `proxy`, `implementation`, and `library`; other values are treated as `regular`.

{
    "type":"object",
    "required":[
        "address"
    ],
    "properties":{
        "address":{
            "type":"string",
            "description":"20-byte 0x-prefixed address"
        },
        "role":{
            "type":[
                "string",
                "null"
            ],
            "description":"Optional contract classification update. Supported values are `regular`, `proxy`, `implementation`, and `library`; other values are treated as `regular`."
        },
        "metadata":{
            "anyOf":[
                {
                    "$ref":"#/components/schemas/ContractUserMetadata"
                },
                {
                    "type":"null"
                }
            ],
            "description":"Optional user-facing metadata patch for this contract version."
        }
    }
}

Examples

Select an example request_manifest_import_payload request_manifest_update_metadata

Back to Top

Response

Supported Media Types

• application/json

202 Response

Returns the accepted manifest import request.

Body ()

Root Schema : ManifestImportResult

Type: object

Result of an asynchronous contract manifest import request.

Show Source

• affectedContractVersions: integer
  Number of contract versions created or updated by the import.
• manifestLayoutId: integer (int64)
  Identifier of the manifest layout affected by the import operation.
• update: boolean
  Indicates whether the operation updated an existing manifest record.

{
    "type":"object",
    "description":"Result of an asynchronous contract manifest import request.",
    "properties":{
        "update":{
            "type":"boolean",
            "description":"Indicates whether the operation updated an existing manifest record."
        },
        "manifestLayoutId":{
            "type":"integer",
            "format":"int64",
            "description":"Identifier of the manifest layout affected by the import operation."
        },
        "affectedContractVersions":{
            "type":"integer",
            "description":"Number of contract versions created or updated by the import."
        }
    }
}

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