API Reference for the Mainnet Tether Service (1.0)

Download OpenAPI specification:Download

The Public Ethereum Tether service hightens the security of a permissioned blockchain running in Kaleido, by pinning signed state hashes to an Ethereum public chain. Using the service API a DApp can configure the interval to collect the state hashes and submit the signed payload to the target Ethereum network, as well as downloading a pinned state from the network to verify the integrity of the local network.

The service can be configured for the report target (mainnet or rinkeby), how often reports are generated and uploaded, as well as how the signing account is obtained.

The reports generated by each blockchain node in the Kaleido environment to capture a secure commitment of the latest state.

Configurations

Configure the signing key for the service to use to deploy the Tether smart contract and submit reports

Authorizations:

bearer_token

path Parameters

service_id

required

string

Request Body schema: application/json

private_key

string

0x prefixed Hexadecimal string for the private signing key

Responses

AWS US API base endpoint

https://console.kaleido.io/api/v1/tether/{service_id}/account

AWS EU API base endpoint

https://console-eu.kaleido.io/api/v1/tether/{service_id}/account

AWS Sydney API base endpoint

https://console-ap.kaleido.io/api/v1/tether/{service_id}/account

AWS Seoul API base endpoint

https://console-ko.kaleido.io/api/v1/tether/{service_id}/account

Azure US API base endpoint

https://console-us1.kaleido.io/api/v1/tether/{service_id}/account

Request samples

Payload

Content type

application/json

{"private_key": "string"
}

Response samples

201

Content type

application/json

{"address": "string"
}

Configure the Tether smart contract address to submit reports to. Note that the uploaded private key must be the deployer of the smart contract. Otherwise any attempted submission will be rejected by the contract.

Authorizations:

bearer_token

path Parameters

service_id

required

string

Request Body schema: application/json

address

string

0x prefixed Hexadecimal string for the deployed Tether Smart Contract address

Responses

AWS US API base endpoint

https://console.kaleido.io/api/v1/tether/{service_id}/arbitratorAddress

AWS EU API base endpoint

https://console-eu.kaleido.io/api/v1/tether/{service_id}/arbitratorAddress

AWS Sydney API base endpoint

https://console-ap.kaleido.io/api/v1/tether/{service_id}/arbitratorAddress

AWS Seoul API base endpoint

https://console-ko.kaleido.io/api/v1/tether/{service_id}/arbitratorAddress

Azure US API base endpoint

https://console-us1.kaleido.io/api/v1/tether/{service_id}/arbitratorAddress

Request samples

Payload

Content type

application/json

{"address": "string"
}

Response samples

201

Content type

application/json

{"environment_id": "string",
"config": {"arbitratorAddress": "string",
"targetNetwork": "mainnet",
"nodelist": ["string"
],
"uploadInterval": 0,
"started": true
},
"account": {"address": "string"
}
}

Configure the Tether smart contract address to submit reports to. Note that the uploaded private key must be the deployer of the smart contract. Otherwise any attempted submission will be rejected by the contract.

Authorizations:

bearer_token

path Parameters

service_id

required

string

Request Body schema: application/json

interval

integer

Number of minutes between state generations and uploads

Responses

AWS US API base endpoint

https://console.kaleido.io/api/v1/tether/{service_id}/interval

AWS EU API base endpoint

https://console-eu.kaleido.io/api/v1/tether/{service_id}/interval

AWS Sydney API base endpoint

https://console-ap.kaleido.io/api/v1/tether/{service_id}/interval

AWS Seoul API base endpoint

https://console-ko.kaleido.io/api/v1/tether/{service_id}/interval

Azure US API base endpoint

https://console-us1.kaleido.io/api/v1/tether/{service_id}/interval

Request samples

Payload

Content type

application/json

{"interval": 0
}

Response samples

201

Content type

application/json

{"environment_id": "string",
"config": {"arbitratorAddress": "string",
"targetNetwork": "mainnet",
"nodelist": ["string"
],
"uploadInterval": 0,
"started": true
},
"account": {"address": "string"
}
}

Configure the target Ethereum network to submit reports to.

Authorizations:

bearer_token

path Parameters

service_id

required

string

Request Body schema: application/json

network

string

Enum: "mainnet" "rinkeby"

Responses

AWS US API base endpoint

https://console.kaleido.io/api/v1/tether/{service_id}/targetNetwork

AWS EU API base endpoint

https://console-eu.kaleido.io/api/v1/tether/{service_id}/targetNetwork

AWS Sydney API base endpoint

https://console-ap.kaleido.io/api/v1/tether/{service_id}/targetNetwork

AWS Seoul API base endpoint

https://console-ko.kaleido.io/api/v1/tether/{service_id}/targetNetwork

Azure US API base endpoint

https://console-us1.kaleido.io/api/v1/tether/{service_id}/targetNetwork

Request samples

Payload

Content type

application/json

{"network": "mainnet"
}

Response samples

201

Content type

application/json

{"environment_id": "string",
"config": {"arbitratorAddress": "string",
"targetNetwork": "mainnet",
"nodelist": ["string"
],
"uploadInterval": 0,
"started": true
},
"account": {"address": "string"
}
}

Deploy the Tether Smart Contract to the target Ethereum network.

Authorizations:

bearer_token

path Parameters

service_id

required

string

Responses

AWS US API base endpoint

https://console.kaleido.io/api/v1/tether/{service_id}/deploy

AWS EU API base endpoint

https://console-eu.kaleido.io/api/v1/tether/{service_id}/deploy

AWS Sydney API base endpoint

https://console-ap.kaleido.io/api/v1/tether/{service_id}/deploy

AWS Seoul API base endpoint

https://console-ko.kaleido.io/api/v1/tether/{service_id}/deploy

Azure US API base endpoint

https://console-us1.kaleido.io/api/v1/tether/{service_id}/deploy

Response samples

201

Content type

application/json

{"arbitratorAddress": "string"
}

Activate the relay to start generating the state reports and sending to the target network at the configured interval.

Authorizations:

bearer_token

path Parameters

service_id

required

string

Responses

AWS US API base endpoint

https://console.kaleido.io/api/v1/tether/{service_id}/activate

AWS EU API base endpoint

https://console-eu.kaleido.io/api/v1/tether/{service_id}/activate

AWS Sydney API base endpoint

https://console-ap.kaleido.io/api/v1/tether/{service_id}/activate

AWS Seoul API base endpoint

https://console-ko.kaleido.io/api/v1/tether/{service_id}/activate

Azure US API base endpoint

https://console-us1.kaleido.io/api/v1/tether/{service_id}/activate

Response samples

201

Content type

application/json

{"success": true
}

De-activate the relay to stop sending reports.

Authorizations:

bearer_token

path Parameters

service_id

required

string

Responses

AWS US API base endpoint

https://console.kaleido.io/api/v1/tether/{service_id}/deactivate

AWS EU API base endpoint

https://console-eu.kaleido.io/api/v1/tether/{service_id}/deactivate

AWS Sydney API base endpoint

https://console-ap.kaleido.io/api/v1/tether/{service_id}/deactivate

AWS Seoul API base endpoint

https://console-ko.kaleido.io/api/v1/tether/{service_id}/deactivate

Azure US API base endpoint

https://console-us1.kaleido.io/api/v1/tether/{service_id}/deactivate

Response samples

201

Content type

application/json

{"success": true
}

Account

Returns the Ethereum account used by the Tether service to submit transactions to the public Ethereum network

Authorizations:

app_creds

Responses

Response samples

200

Content type

application/json

{"address": "string",
"balance": "string"
}

Returns the Ether balance for the signing account on the target Ethereum network (mainnet or rinkeby)

Authorizations:

app_creds

path Parameters

network

required

string

Enum: "mainnet" "rinkeby"

Name of the Ethereum network

Responses

Response samples

200

Content type

application/json

{"address": "string",
"balance": "string"
}

Reports

Returns the number of signed hash reports that have been uploaded to the target Ethereum network

Authorizations:

app_creds

Responses

Response samples

200

Content type

application/json

{"count": "string"
}

Returns the latest signed hash report that has been uploaded to the target Ethereum network

Authorizations:

app_creds

Responses

Response samples

200

Content type

application/json

{"nodeIdHash": "string",
"blockNumber": 0,
"blockHash": "string",
"checksum": "string",
"signature": {"v": "string",
"r": "string",
"s": "string"
}
}

Returns the latest signed hash report that has been uploaded to the target Ethereum network

Authorizations:

app_creds

path Parameters

report_index

required

integer

Responses

Response samples

200

Content type

application/json

{"nodeIdHash": "string",
"blockNumber": 0,
"blockHash": "string",
"checksum": "string",
"signature": {"v": "string",
"r": "string",
"s": "string"
}
}