subbridge_getBridgeInformation

The subbridge_getBridgeInformation returns the information of the given bridge contract.

JSONRPC: subbridge_getBridgeInformation

Request

application/json

Body

method stringrequired

Default value: subbridge_getBridgeInformation

Method name

id int64required

Default value: 1

Request ID, Random or Auto incrementation

jsonrpc stringrequired

Default value: 2.0

JSON-RPC Version (2.0)

params 20-byte DATA[]required

Address of a bridge contract

Responses

200

returns the information of the given bridge contract.

application/json

Schema

Schema

jsonrpc stringrequired

Default value: 2.0

id int64required

error

object

code int64required

A Number that indicates the error type that occurred. This MUST be an integer.

| code | message | description | |-----|-----|-------| | -32700 | Parse error | invalid JSON was received by the server. An error occurred on the server while parsing the JSON text. | |-32602 | Invalid params | Invalid method parameter(s). |

message string

A String providing a short description of the error. The message SHOULD be limited to a concise single sentence.

data string

A Primitive or Structured value that contains additional information about the error. This may be omitted. The value of this member is defined by the Server (e.g. detailed error information, nested errors etc.).

result

object

the information of the given bridge contract.

counterPart 20-byte DATArequired

Address of the counterpart bridge contract. (Not supported yet)

isRunning booleanrequired

true if the bridge contract is running, false otherwise.

isSubscribed booleanrequired

true if the bridge contract is subscribed, false otherwise.

onServiceChain booleanrequired

true if the bridge contact is on child (service) chain, false otherwise.

pendingEventSize hexrequired

Number of pending "request value transfer" events generated by the bridge contracts, not handled yet by the sub-bridge.

requestNonce hexrequired

Request nonce of the bridge contract.

handleNonce hexrequired

Upper handle nonce of the bridge contract.

lowerHandleNonce hexrequired

Lower handle nonce of the bridge contract.

Example (from schema)

{
  "jsonrpc": "2.0",
  "id": 0,
  "error": {
    "code": -32700,
    "message": "Parse error",
    "data": "string"
  },
  "result": {
    "counterPart": "0x0000000000000000000000000000000000000000",
    "handleNonce": 0,
    "lowerHandleNonce": 0,
    "isRunning": true,
    "isSubscribed": true,
    "onServiceChain": true,
    "pendingEventSize": 0,
    "requestNonce": 0
  }
}

Loading...