POST 
/trusted-schemas-registry/v3/jsonrpc

The JSON-RPC API provides methods assisting the construction of blockchain transactions and interaction with the ledger.

Request

application/json

Bodyrequired

The body follows the JSON-RPC 2.0 specification.

It requires the following fields:

• jsonrpc: must be exactly "2.0"
• method: method to be invoked
• params: method parameters
• id: identifier established by the client

API Methods

insertSchema

Requires an access token with tsr_write scope and having the required attributes assigned in Trusted Policies Registry.

Call to build an unsigned transaction to insert a new schema.

Parameters:

• from: Ethereum address of the signer
• schemaId: schema ID converted into hex string
• schema: Content. This field must be a JSON stringified and converted into hex string
• metadata: Metadata of the first version. This field must be a JSON stringified and converted into hex string

updateSchema

Requires an access token with tsr_write scope and having the required attributes assigned in Trusted Policies Registry.

Call to build an unsigned transaction to update an schema.

Parameters:

• from: Ethereum address of the signer
• schemaId: Schema ID
• schema: Content. This field must be a JSON stringified and converted into hex string
• metadata: Metadata. This field must be a JSON stringified and converted into hex string

updateMetadata

Requires an access token with tsr_write scope and having the required attributes assigned in Trusted Policies Registry.

Call to build an unsigned transaction to update the metadata of a schema revision.

Parameters:

• from: Ethereum address of the signer
• schemaRevisionId: Schema revision ID
• metadata: Metadata. This field must be a JSON stringified and converted into hex string

sendSignedTransaction

Requires an access token with tsr_write scope.

Sends a signed transaction to the blockchain and returns the hash of the transaction.

Warning: the transaction is not immediately processed. Make sure to check that the transaction has been successfully included in a block before moving on.

You can get the receipt of the transaction by calling the eth_getTransactionReceipt method of Ledger API's Besu endpoint.

Receipts for pending transactions are not available, therefore you will have to wait until the transaction has been processed — usually a few seconds. We recommend you to poll the eth_getTransactionReceipt method until the receipt is available.

Once the receipt is available, you can check the status field to know if the transaction succeeded (0x1) or failed (0x0). If the transaction failed, the revertReason field will give you insights about the reason for the failure. You can learn more about the format of the revert reason in Besu's documentation.

jsonrpc stringrequired

Must be exactly "2.0"

method stringrequired

Method that needs to be invoked

params object[]required

Array of parameters

id integerrequired

Identifier established by the client

Responses

200

Response

application/json

Schema

Schema

jsonrpc string

Must be exactly "2.0"

id integer

Same identifier established by the client in the call

result object
Result of the call
oneOf
MOD2
string

Build tx

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "from": "0x416e6e6162656c2e4c65652e452d412d506f652e",
    "to": "0xFde86148db58f57787C06BeAf63a9c3f789357b3",
    "data": "0x0000...",
    "nonce": "0x00",
    "chainId": "0x1b3b",
    "gasLimit": "0x10000",
    "gasPrice": "0x00",
    "value": "0x00"
  }
}

Send Transaction

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": "0xe670ec64341771606e55d6b4ca35a1a6b75ee3d5145a99d05921026d1527331"
}

400

Bad request

application/problem+json

Schema

Schema

type uri

Default value: about:blank

An absolute URI that identifies the problem type. When dereferenced, it SHOULD provide human-readable documentation for the problem type.

title string

A short summary of the problem type.

status int32

Possible values: >= 400 and <= 600

The HTTP status code generated by the origin server for this occurrence of the problem.

detail string

A human readable explanation specific to this occurrence of the problem.

instance uri

An absolute URI that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

Bad Request

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Bad request"
}

Loading...