JSON-RPC is a protocol where the client sends a request message in JSON format to the node, which processes it and returns the result in a JSON format response message.
It stands for Remote Procedure Call (RPC) protocol, which is a method for communication.
LocusChain nodes provide a JSON-RPC API. Through nodes run by individuals or provided by some public services, users can easily query information from the blockchain network.
It can be used to check if the node responds correctly to RPC calls.
The current time is added to the input value and returned in the response.
| Key | Type | Description |
|---|
| - | string | String |
| Key | Type | Description |
|---|
| - | string | Input string + current time |
To receive current synchronization status of the node.
[None]
| Key | Type | Description |
|---|
| SyncState | string | NODE_STATE_IN_INIT
NODE_STATE_IN_SYNC
NODE_STATE_IN_RESYNC
NODE_STATE_SYNC_COMPLETE
NODE_STATE_STABLE
Unknown NodeState |
Retrieve the address of the Genesis account.
[None]
| Key | Type | Description |
|---|
| Genesis | base32 | Genesis account address |
Register the account on the Locus Chain network.
| Key | Type | Description |
|---|
| Account | base32 | Target account address |
| Sender | base32 | Account that sent the coin |
| Index | int | The height of the Tx that sent the coin |
| Pk | base32 | Normal public key |
| KeySign | base32 | Master public key |
| Sig | base64 | Signature |
| Key | Type | Description |
|---|
| Hash | base64 | Tx Hash |
| Tx | string | Generated Tx |
| Success | bool | Success status |
Set the specified account as host for the node.
The specified account should have no guests, and the node must be an empty node without a host.
| Key | Type | Description |
|---|
| Account | base32 | Account to be the host |
| Sig | base64 | Signature |
| Key | Type | Description |
|---|
| Hash | base64 | Tx Hash |
| Tx | string | Generated Tx |
| Success | bool | Success status |
Set the specified account as guest for the node.
The specified account should have no guests, and the node must have an existing host.
| Key | Type | Description |
|---|
| Account | base32 | Account to be the guest |
| Sig | base64 | Signature |
| Key | Type | Description |
|---|
| Hash | base64 | Tx Hash |
| Tx | string | Generated Tx |
| Success | bool | Success status |
Change the account's normal key.
| Key | Type | Description |
|---|
| Account | base32 | Account whose key is to be changed |
| MasterPkey | base32 | Master public key |
| NewNormalPkey | base32 | New Normal public key |
| SignByMasterKey | base64 | Value signed of New Normal public key with Master public key |
| Sig | base64 | Signature |
| Key | Type | Description |
|---|
| Hash | base64 | Tx Hash |
| Tx | string | Generated Tx |
| Success | bool | Success status |
Send coins to another account.
| Key | Type | Description |
|---|
| From | base32 | Sender account |
| To | base32 | Recipient account |
| Amount | string | Amount to send |
| Sig | base64 | Signature |
| Key | Type | Description |
|---|
| Hash | base64 | Tx Hash |
| Tx | string | Generated Tx |
| Success | bool | Success status |
Retrieve the Tx information for a specific Height of the account.
| Key | Type | Description |
|---|
| Account | base32 | Account |
| Height | int | Height of Account |
| Key | Type | Description |
|---|
| Tx | string | Tx Information |
Retrieve the list of Heights for the accounts.
| Key | Type | Description |
|---|
| Accounts | []base32 | List of accounts for which you want to retrieve the Height. |
| Key | Type | Description |
|---|
| Heights | []string | The Height values to correspond to the order of accounts in the parameters. |
locus_getAccountHistory
Retrieve the list of Tx for the account.
| Key | Type | Description |
|---|
| Account | base32 | Account |
| Height | int | Retrieve the starting Height
Height is -1, start from the latest Tx. |
| Count | int | Number of Tx to retrieve (number of previous Tx from the starting position). |
| Key | Type | Description |
|---|
| Txs | []string | Tx string list |
Retrieve detailed information of the account.
| Key | Type | Description |
|---|
| Account | base32 | Account |
| Key | Type | Description |
|---|
| Identity | string | Host : Host account of the node
Guest : Guest account of the node
Neighbor : Neighboring accounts of the shard to which the node belongs. This is the state at the time of the query and may be inaccurate depending on the synchronization status.
no identity : None of the above applies, meaning it either does not exist or belongs to a different shard |
| FromNoAlive | bool | This 'flag' is set to 'true' if the OpenAccount has been made but has not yet been included in the consensus. |
| Balance | string | Amount of Locus Coins in posession |
| UnactBalance | string | Balance that cannot be used since it has not been activated yet. |
| Representative | base32 | Delegated Account (Host Account) |
| Grant | uint64 | Grant in posession |
| PublickKey | base32 | Account's Normal public key |
| TxChainHeight | int | Account's Height |
| TxLink | string | Last Tx link |
Retrieve the list of World Round States (WRS).
| Key | Type | Description |
|---|
| Round | int | Starting Round to retrieve |
| Count | int | Number of items to retrieve (number of previous ones from the starting position), Max 500. |
| Key | Type | Description |
|---|
| NextRoundList | []int | WRS list |
Retrieve detailed information of the World Round State (WRS)
| Key | Type | Description |
|---|
| Round | int | Round to retrieve |
| Key | Type | Description |
|---|
| NextRound | int | Round |
| AddShardRound | int | 0 : No shard splitting planned.
1 : Sharding is required, but the timing has not been determined yet.
2 above: Sharding is planned for the upcoming round. |
| RootHash | string | |
| EvictedHash | string | |
| CurrentHash | string | |
| PrevLink | string | |
| PrevNextRound | int | |
| SigHash | string | The hash value of the signature information below. The signature information below may be pruned. |
| ValidatorsWeight | int | Total sum of the Validator's weights |
| Validators | []{base32,uint16,string} | {Validator's Addr, Weight, Sign} |
| MultiSign | string | Multi-signature |
| AggregatedNonce | string | aggregated nonce of Multi-signature |
| CoSigners | []base32 | Account of the multi-signature participant |
Retrieve the list of Tx for the account that has not been activated yet.
| Key | Type | Description |
|---|
| Account | base32 | Account |
| Key | Type | Description |
|---|
| TimeOutTxs | []{Sender base32, Index int32, Tx string} | List of Tx that timed out due to the first target not being activated. |
| Txs | []{Sender base32, Index int32, Tx string} | List of Tx with completed consensus on the sender's side. |
| UnconfirmedTxs | []{Sender base32, Index int32, Tx string} | List of Tx awaiting consensus on the sender's side. |
| PendingTxs | []{Sender base32, Index int32, Tx string} | List of Tx proposed for less than 10 seconds. |
| ConflictedTxs | []{Sender base32, Index int32, Tx string} | List of conflicting Tx. |
Retrieve the account's Mont (Monitoring sent) list.
You can only retrieve those associated with the node's host/guest accounts.
| Key | Type | Description |
|---|
| Account | base32 | Account |
| Key | Type | Description |
|---|
| ActivatedTxs | []{Index int32, Tx string} | List of Tx that are included in the Receiver's shard's Recv list and have completed consensus. These may not yet be written to the Receiver's chain. |
| ProofedTxs | []{Index int32, Tx string} | List of Tx with completed consensus on the sender's side. |
| PendingTxs | []{Index int32, Tx string} | List of Tx that have only been proposed. |
Generating System Token.
Each account can create one system token.
| Key | Type | Description |
|---|
| Account | base32 | Account to create token |
| TokenBalance | string | Quantity of tokens to Generate |
| Sig | base64 | Signature |
| Key | Type | Description |
|---|
| TokenID | base32 | Generated Token ID |
| Hash | Tx Hash | |
| Tx | string | Generated Tx |
| Success | bool | Success status |
Send tokens to another account.
| Key | Type | Description |
|---|
| From | base32 | Account sending the token |
| To | base32 | Account Receiving the token |
| Amount | string | Quantity of token to be sent |
| TokenID | base32 | Token ID of token to be sent |
| Sig | base64 | Signature |
| Key | Type | Description |
|---|
| Hash | Tx Hash | |
| Tx | string | Generated Tx |
| Success | bool | Success status |
Retrieve the list of tokens owned by the account and their balances.
| Key | Type | Description |
|---|
| Account | base32 | Account generating token |
| Key | Type | Description |
|---|
| TokenList | map[base32]string | {"TokenID": Balance} |
Check if the account has created a system token, and if so, retrieve the token ID.
| Key | Type | Description |
|---|
| Account | base32 | Account |
| Key | Type | Description |
|---|
| Having | bool | Status of whether the system token exists |
| TokenID | string | If Having is true, return the system token ID. |
locus_postData
Post the data.
| Key | Type | Description |
|---|
| Account | base32 | Account |
| Label | int | Transactions with the same label are linked within the chain. When verifying the proof for a given Tx, this is used to check if there is a more recent Tx with the same label. |
| Data | base64 | Data to be posted |
| Sig | base64 | Signature |
| Key | Type | Description |
|---|
| Hash | Tx Hash | |
| Tx | string | Generated Tx |
| Success | bool | Success status |
Retrieve the list of Tx and their corresponding proofs for the account.
| Key | Type | Description |
|---|
| Account | base32 | Account |
| BaseHeight | int | Starting Height |
| Count | uint | Number of items to retrieve (how many previous ones from the starting position). |
| Key | Type | Description |
|---|
| Account | base32 | Account |
| Txs | []string | Tx string list |
| Proof | MerkleProof | Merkle Proof of the requested Tx list |
| CheckRoundP1 | int | Round + 1 in which the Proof was generated |
Verify the proof of the Tx list.
| Key | Type | Description |
|---|
| Account | base32 | Account |
| Txs | []string | List of Tx to verify |
| Proof | MerkleProof | Merkle Proof of the list of Tx to verify |
| CheckRoundP1 | int | Round + 1 in which the Proof was generated |
| Key | Type | Description |
|---|
| - | bool | Verification Success status |
Lock the stake.
| Key | Type | Description |
|---|
| Account | base32 | Account |
| LockAmount | uint32 | The amount of Stake to lock (1 UnitStakeLock = 100 Locus). |
| Sig | base64 | Signature |
| Key | Type | Description |
|---|
| Hash | Tx Hash | |
| Tx | string | Generated Tx |
| Success | bool | Success status |
Unlock the Stake.
| Key | Type | Description |
|---|
| Account | base32 | Account |
| UnlockAmount | uint32 | Stake to unlock (1 UnitStakeLock = 100 Locus). |
| Sig | base64 | Signature |
| Key | Type | Description |
|---|
| Hash | Tx Hash | |
| Tx | string | Generated Tx |
| Success | bool | Success status |
Deploy the Core Script.
| Key | Type | Description |
|---|
| Provider | base32 | Account to deploy the script |
| Target | base32 | The account that will activate the coins or tokens sent by the provider by executing the Core script within the time lock. |
| TargetAfterTimeLock | base32 | The account that will automatically activate the coins or tokens sent by the provider after the time lock. |
| TimeLock | int | The round duration for the time lock, with the current max = 30 and min = 3. |
| Args | []hex | Arguments to be used when the target executes the provider's script (ScriptSig), with a maximum of 4 arguments allowed. |
| ScriptProvide | hex | The provider's script to be executed by the target, with the current MaxSize = 32 bytes. |
| ScriptAccept | hex | The script to be executed by the target, with the current MaxSize = 32 bytes. |
| Amount | string | The coin amount that can be activated if the target successfully executes the Core script. |
| TokenAmounts | []{TokenID base32, AmountToken string} | The token amounts that can be activated if the target successfully executes the Core script. |
| Sig | base64 | Signature |
| Key | Type | Description |
|---|
| Hash | Tx Hash | |
| Tx | string | Generated Tx |
| Success | bool | Success status |
Execute Core Script.
| Key | Type | Description |
|---|
| Acceptor | base32 | The account that will activate the Core script specified as the target in TxProvideScript. Activation is only possible within the time lock. |
| Provider | base32 | The account that deployed the TxProvideScript. |
| Index | int | height of LeadTx(TxProvideScript) |
| Args | []hex | Arguments to be used when the target executes the target's script (ScriptSig), with a maximum of 4 arguments allowed. |
| Sig | base64 | Signature |
| Key | Type | Description |
|---|
| Hash | Tx Hash | |
| Tx | string | Generated Tx |
| Success | bool | Success status |
Retrieve the full address with key address.
| Key | Type | Description |
|---|
| Addr | base32 | Key Address |
| Key | Type | Description |
|---|
| Addr | base32 | Full Address |