Blockchain link (Beta)

Update a blockchain

Updates the declared properties of an existing blockchain identified by its ID. Only the fields supplied in the request are modified.

put/blockchain_link/blockchains/{blockchainId}

Request

Path parameters

blockchainIdstring required
Example:f47ac10b-58cc-4372-a567-0e02b2c3d479

ID of the blockchain to update (supplied as a path parameter).

Headers

Idempotency-Keystring

A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.

Request body

chainNamestring required

Human-readable name of the blockchain.

chainIdnumber required

EVM chain ID of the blockchain.

symbolNamestring required

Native asset symbol of the blockchain.

decimalsnumber

Number of decimals for the native asset.

rpcUrlsstring[] required

RPC endpoint URLs for the blockchain.

environmentType'ENVIRONMENT_TYPE_MAINNET' | 'ENVIRONMENT_TYPE_TESTNET' required

Network environment (mainnet or testnet).

blockExplorerUrlstring

Base URL of the block explorer.

blockExplorerTransactionPathstring

Path template for a transaction on the block explorer.

blockExplorerAddressPathstring

Path template for an address on the block explorer.

networkIdnumber

EVM network ID of the blockchain.

hasFeeboolean

Whether the blockchain charges transaction fees.

isPoaboolean

Whether the blockchain uses proof-of-authority consensus.

hasLayeredFeeboolean

Whether the blockchain uses a layered fee model.

nodeType'NODE_TYPE_CORE_GETH' | 'NODE_TYPE_FANTOM' | 'NODE_TYPE_ERIGON' | 'NODE_TYPE_PARITY' | 'NODE_TYPE_BESU'

Node client type for the blockchain.

transactionFormatnumber

Transaction format identifier.

baseAssetTenantIdsstring[]

Tenant IDs that share this base asset.

explorerApiUrlstring

Block explorer API base URL.

explorerApiKeystring

API key for the block explorer API.

isTraceEnabledboolean

Whether trace/debug RPC methods are enabled.

Example request

{
  "chainName": "Ethereum",
  "chainId": 1,
  "symbolName": "ETH",
  "decimals": 18,
  "rpcUrls": [
    "https://rpc.example.com"
  ],
  "environmentType": "ENVIRONMENT_TYPE_MAINNET",
  "blockExplorerUrl": "https://etherscan.io",
  "blockExplorerTransactionPath": "/tx",
  "blockExplorerAddressPath": "/address",
  "networkId": 1,
  "hasFee": true,
  "nodeType": "NODE_TYPE_CORE_GETH",
  "baseAssetTenantIds": [
    "f47ac10b-58cc-4372-a567-0e02b2c3d479"
  ],
  "explorerApiUrl": "https://api.etherscan.io",
  "explorerApiKey": "my-explorer-api-key",
  "rpcAuth": {
    "type": "RPC_AUTH_BASIC",
    "username": "rpc_user",
    "password": "my-password",
    "token": "my-bearer-token",
    "headerName": "X-Custom-Auth",
    "headerValue": "my-header-value"
  }
}

Response

OK

messagestring required

Human-readable result message.

Example response

{
  "blockchain": {
    "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
    "blockchainState": "BLOCKCHAIN_STATE_ACTIVATED",
    "declaredProperties": {
      "chainName": "Ethereum",
      "chainId": 1,
      "symbolName": "ETH",
      "decimals": 18,
      "rpcUrls": [
        "https://rpc.example.com"
      ],
      "environmentType": "ENVIRONMENT_TYPE_MAINNET",
      "blockExplorerUrl": "https://etherscan.io",
      "blockExplorerTransactionPath": "/tx",
      "blockExplorerAddressPath": "/address",
      "networkId": 1,
      "hasFee": true,
      "nodeType": "NODE_TYPE_CORE_GETH",
      "baseAssetTenantIds": [
        "f47ac10b-58cc-4372-a567-0e02b2c3d479"
      ],
      "explorerApiUrl": "https://api.etherscan.io",
      "explorerApiKey": "my-explorer-api-key",
      "rpcAuth": {
        "type": "RPC_AUTH_BASIC",
        "username": "rpc_user",
        "password": "my-password",
        "token": "my-bearer-token",
        "headerName": "X-Custom-Auth",
        "headerValue": "my-header-value"
      }
    },
    "createdAtUtc": 1700000000000,
    "updatedAtUtc": 1700000000000,
    "validationSessionId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
    "validationStatus": "VALIDATION_STATUS_SUCCEEDED",
    "validationCreatedAtUtc": 1700000000000,
    "validationUpdatedAtUtc": 1700000000000,
    "validationCompletedAtUtc": 1700000000000,
    "validationFailureReasons": [
      "RPC endpoint unreachable"
    ],
    "failedStep": "FAILED_STEP_CONFIGURATION"
  },
  "message": "Blockchain updated successfully"
}

Changes

No recorded changes to this operation across all 1 revision of this API.