JSON-RPC methods
JSON RPC API Reference
getAccount
Returns the account name and balance of given address.
Parameters
string Address of account.
params: {
"account":"P2K6Sm1bUYGsFkxuzHPhia1AbANZaHBJV54RgtQi5q8oK34"
}
Returns
Account - A Account object, or error if address is invalid.
address: string - Given address.name: string - Name of given address.stakes: Array - Array of stake objects.stakes - amount: string - Amount of tokens staked.stakes - time: timestamp - Time.stakes - unclaimed: string - Amount of unclaimed tokens.storage: Array - Array of storage objects.storage - available: number - Number if decimals.storage - used: number - Storage used.storage - avatar: blob - Blob of the image.balances: Array - Array of balance objects.balance - chain: string - Name of the chain.balance - symbol: string - Token symbol.balance - amount: string - Amount of tokens.balance - decimals: number - Number if decimals.txs: Array - Array of strings.
Error return.
jsonrpc: string -String with the jsonrpc version.error: Object - Error object.error - code: number - Name of the chain.error - message: string - Error message.id: number - ID of will return 0.
Example
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"getAccount","params":{"account":"P2K6Sm1bUYGsFkxuzHPhia1AbANZaHBJV54RgtQi5q8oK34"},"id":1}'
// Result
{
"jsonrpc": "2.0",
"result": {
"address": "P2K6Sm1bUYGsFkxuzHPhia1AbANZaHBJV54RgtQi5q8oK34",
"name": "genesis",
"stakes": {
"amount": "5000000000000",
"time": 1615546566,
"unclaimed": "3000000000000"
},
"stake": "5000000000000",
"unclaimed": "3000000000000",
"relay": "0",
"validator": "Primary",
"storage": {
"available": 2048000000,
"used": 0,
"avatar": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgBAMAAACBVGfHAAAAJFBMVEWcnJz////39/etra3e3t6lpaW1tbXn5+fW1tbv7+/Ozs69vb2ss4cPAAAAk0lEQVQoz2OgJWA2QOWnKAqVIfM5BIGgAUlgIUhAAsFnEwSDBLgAC0SgAC7ABBEQhQsYQgSEMQRwa2GHGopu7QaEQxpBfBF0pzsg+3WioKAkkn9ZHcFaAuACRhBDleEaFCECQjBNQYJQoAoVcIQJiCA5Cx4iCIcjHB+IEBCFBigcSMHMRDV1IkJAEiygiBAQYmAAABD5F4JgcTScAAAAAElFTkSuQmCC"
},
"balances": [
{
"chain": "main",
"amount": "94899900000000",
"symbol": "SOUL",
"decimals": 8
},
{
"chain": "main",
"amount": "9887099232828419",
"symbol": "KCAL",
"decimals": 10
},
{
"chain": "main",
"amount": "99000",
"symbol": "MKNI",
"decimals": 0
}
],
"txs": [
"07A33AFF587DFF86DE2829D0FD2A8AA52FDF75A8580EF031A666537B60CE35ED",
"F8AC51DAFB2DA550516071F7A4AD2A9C116B87F3045E90A67CEAE268CBED9DA4",
"7DCD1157752296B514F925339AEA11CCD5F9D31ED259167BB8E8561A7ED8944B",
"3EA00C4699D3E18623A30A058B6373944540447BF87138FD47C729A0DCC7C57C",
"9F7559B2F0F66266F73E5D25BA2CDA46C90FADA70D850CC3995869A1AED3454D",
"04FF98C43E08019DDC4F1D2B152A452A3193E4EE32BA5B3ED183CA729672EF58",
"971424470FE7E0F9445A15D1378F8B0F114D9DC2C95491FEC42AF1D2655A0C4E",
"4CD1CBA53C0D62CF2DB13DB5F798E6BA17012B96E7FDF6D29E8E5E3D9768615B",
"01DEA7A6E4A47D0270399A918AF7FC1E13A24DD02A633099FFC19360766E8442",
"7316981546C0F87A3902447CB423AEAF11E60891B544B69E3E8BB1B2BDCFB1F2",
"01FC7AA79D5DE7F995A2BC42EF64809EBAA89822C4EEE779ADC2C820BA199384",
"0491253DF9424AEAF9D228C09D3390E69779D8D78C4C010EF735AF2C659FF113",
"07C9D24E2386B712A69410467C005408455D7940C6DA4799594C1E828675964D",
"07091A38DF59772C0533CD5F3AE83A3EE3D8E9074D9E212ADE335DDDEB86D941",
"F12F08527FFD81213811239BB2F236CD1E8ACDA3D268E951F06AA82950DDB0AE"
]
},
"id": 1
}
lookUpName
Returns the address that owns a given name.
Parameters
string Name of account.
params: {
"name":"phantom_force"
}
Returns
string - A string object, or error if address is invalid.
jsonrpc: string - String with the jsonrpc version.result: string - Address of given name.id: number - ID of the user.
Example
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"lookUpName","params":{"name":"phantom_force"},"id":1}'
// Result
{
"jsonrpc": "2.0",
"result": "S3dGUjVwYa31AxdthdpsuyBKgX1N65FnoQhUkSgYbUEdRp4",
"id": 1
}
getBlockHeight
Returns the height of a chain.
Parameters
string Address or name of chain.
params : {
"chainInput":"main"
}
Returns
number - A number, or error if chain is invalid.
jsonrpc: string - String with the jsonrpc version.result: string - Number of Block height.id: number - ID of the user.
Example
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"getBlockHeight","params":{"chainAddressOrName":"main","blockHash":"8FBCC7B1869EE44FF37022310A38841523B4AEDE0AB414AADB2A019D27EA17C9"},"id":1}'
// Result
{
"jsonrpc": "2.0",
"result": "77",
"id": 1
}
getBlockTransactionCountByHash
Returns the number of transactions of given block hash or error if given hash is invalid or is not found.
Parameters
string Address or name of chain.string Hash of block.
params: {
"chainAddressOrName":"main",
"blockHash":"8FBCC7B1869EE44FF37022310A38841523B4AEDE0AB414AADB2A019D27EA17C9"
}
Returns
number - A number, or error if block hash is invalid.
jsonrpc: string - String with the jsonrpc version.result: number - Number of Transactions from a specific hash.id: number - ID of the user.
Example
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"getBlockTransactionCountByHash","params":{"chainAddressOrName":"main","blockHash":"8FBCC7B1869EE44FF37022310A38841523B4AEDE0AB414AADB2A019D27EA17C9"},"id":1}'
// Result
{
"jsonrpc": "2.0",
"result": 1,
"id": 1
}
getBlockByHash
Returns information about a block by hash.
Parameters
string Hash of block.
params: {
"chainAddressOrName":"main",
"blockHash":"D717455B81E9A0EE90D6D4B7CC7C476AF4D039AFBEE0505DF1EBFC7B1E395E55"
}
Returns
Block - A Block object, or error if block hash is invalid.
hash: string - Hash of the object.previousHash: string - Previous hash of the object.timestamp: timestamp - Time when the hash was produced.height: number - Height of the hash.chainAddress: number - Address of the chain that the address is in.protocol: number - Name of given address.txs: Array - Array of txs objects.txs - hash: string - Hash of the object.txs - chainAddress: string - Address of the chain that the address is in.txs - timestamp: string - Time when the hash was produced.txs - blockHeight: string - Height of the hash block.txs - blockHash: string - Hash of the blocktxs - script: string - Script encoded.txs - payload: string - Payload encoded.txs - events: Array - Array of events objects.txs - events - address: string - Address of event.txs - events - contract: string - Type of contract.txs - events - kind: string - Type of token.txs - events - data: string - Data of the event.txs - result: string - Result of the transaction.txs - fee: string - Fee of transaction.txs - signatures: string - Array of signatures.txs - signatures - Kind: string - Type of signature.txs - signatures - Data: string - Data of signature.txs - expiration: timestamp - Experiation of the contract.validatorAddress: number - Address that validates the hash.reward: number - Reward of the hash.events: Array - Array of events objects.events - address: string - Address of event.events - contract: string - Type of contract.events - kind: string - Type of token.events - data: string - Data of the event.
Example
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"getBlockByHash","params":{"blockHash":"D717455B81E9A0EE90D6D4B7CC7C476AF4D039AFBEE0505DF1EBFC7B1E395E55"},"id":1}'
// Result
{
"jsonrpc": "2.0",
"result": {
"hash": "D717455B81E9A0EE90D6D4B7CC7C476AF4D039AFBEE0505DF1EBFC7B1E395E55",
"previousHash": "F6520F325E5E0A41B9E675914DCFCBF24F2B06EDFBF623A4E10F4E54EAA921D5",
"timestamp": 1615560444,
"height": 29,
"chainAddress": "S3d7TbZxtNPdXy11hfmBLJLYn67gZTG2ibL7fJBcVdihWU4",
"protocol": 5,
"txs": [
{
"hash": "986A082C008D5215480D038BAC401F3F16E3C54386695A39C82C0FBD1098AFE4",
"chainAddress": "S3d7TbZxtNPdXy11hfmBLJLYn67gZTG2ibL7fJBcVdihWU4",
"timestamp": 1615560444,
"blockHeight": 29,
"blockHash": "D717455B81E9A0EE90D6D4B7CC7C476AF4D039AFBEE0505DF1EBFC7B1E395E55",
"script": "0D00030328230003000D000304A086010003000D000223220000000000000000000000000000000000000000000000000000000000000000000003000D000223220100F0635964DBF97E043EA0FB5DD67CE69369F5AE19E4B4B67121ABB6C14A558A8403000D000408416C6C6F7747617303000D0004036761732D00012E010D000223220100F0635964DBF97E043EA0FB5DD67CE69369F5AE19E4B4B67121ABB6C14A558A8403000D000404706C617903000D000405736C6F74732D00012E010D000223220100F0635964DBF97E043EA0FB5DD67CE69369F5AE19E4B4B67121ABB6C14A558A8403000D0004085370656E6447617303000D0004036761732D00012E010B",
"payload": "534C4F545376312E30",
"events": [
{
"address": "P2KKxTbPSBKMRRL9vw6NYXsNCKTX1ZfoE2bvAuq6VwZSYuy",
"contract": "gas",
"kind": "TokenStake",
"data": "044B43414C0500E9A43500046D61696E"
},
{
"address": "P2KKxTbPSBKMRRL9vw6NYXsNCKTX1ZfoE2bvAuq6VwZSYuy",
"contract": "gas",
"kind": "GasEscrow",
"data": "2202000D6E4079E36703EBD37C00722F5891D28B0E2811DC114B129215123ADCCE360504A086010003282300"
},
{
"address": "P2KKxTbPSBKMRRL9vw6NYXsNCKTX1ZfoE2bvAuq6VwZSYuy",
"contract": "slots",
"kind": "TokenStake",
"data": "044B43414C0600E40B540200046D61696E"
},
{
"address": "P2KKxTbPSBKMRRL9vw6NYXsNCKTX1ZfoE2bvAuq6VwZSYuy",
"contract": "gas",
"kind": "GasPayment",
"data": "2202000D6E4079E36703EBD37C00722F5891D28B0E2811DC114B129215123ADCCE360504A0860100036F0500"
},
{
"address": "P2KKxTbPSBKMRRL9vw6NYXsNCKTX1ZfoE2bvAuq6VwZSYuy",
"contract": "gas",
"kind": "TokenClaim",
"data": "044B43414C05A0695A2D00046D61696E"
},
{
"address": "S3d9nBL5LAUFhQ14Wzyb3JJRrXXB6atUuoL1uibkT3bttjw",
"contract": "gas",
"kind": "TokenBurn",
"data": "044B43414C05607C240400046D61696E"
},
{
"address": "P2KKxTbPSBKMRRL9vw6NYXsNCKTX1ZfoE2bvAuq6VwZSYuy",
"contract": "gas",
"kind": "CrownRewards",
"data": "044B43414C058001130200046D61696E"
},
{
"address": "S3dBVkyE9kdfbBjh7HMEr1BfPTg53CeSWaj3srYzBTZ4vyK",
"contract": "gas",
"kind": "TokenClaim",
"data": "044B43414C058001130200046D61696E"
}
],
"result": "0600",
"fee": "139100000",
"signatures": [
{
"Kind": "Ed25519",
"Data": "4022E040CAB589838E2644EF94265608893615E3135272D7BE0A9CBF931077D738F6301416494C151DD7A119C03FE805C8807F957972B428413A24C41A5E54F702"
}
],
"expiration": 1615561644
}
],
"validatorAddress": "P2K6Sm1bUYGsFkxuzHPhia1AbANZaHBJV54RgtQi5q8oK34",
"reward": "0",
"events": [
{
"address": "P2K6Sm1bUYGsFkxuzHPhia1AbANZaHBJV54RgtQi5q8oK34",
"contract": "block",
"kind": "TokenClaim",
"data": "044B43414C058001130200046D61696E"
}
]
},
"id": 1
}
getRawBlockByHash
Returns a serialized string, containing information about a block by hash.
Parameters
string Hash of block.
params: {
"blockHash" : "D717455B81E9A0EE90D6D4B7CC7C476AF4D039AFBEE0505DF1EBFC7B1E395E55"
}
Returns
string - A string object, or error if block hash is invalid.
jsonrpc: string - String with the jsonrpc version.result: string - Raw block.id: number - ID of the user.
Example
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"getRawBlockByHash","params":{"blockHash" : "D717455B81E9A0EE90D6D4B7CC7C476AF4D039AFBEE0505DF1EBFC7B1E395E55"},"id":1}'
// Result
{
"jsonrpc": "2.0",
"result": "021D00FC7E4B6020D521A9EA544E0FE1A423F6FBED062B4FF2CBCF4D9175E6B9410A5E5E320F52F62202000D6E4079E36703EBD37C00722F5891D28B0E2811DC114B129215123ADCCE3605050120E4AF9810BD0F2CC8395A698643C5E3163F1F40AC8B030D4815528D002C086A980807220100F0635964DBF97E043EA0FB5DD67CE69369F5AE19E4B4B67121ABB6C14A558A840367617310044B43414C0500E9A43500046D61696E0F220100F0635964DBF97E043EA0FB5DD67CE69369F5AE19E4B4B67121ABB6C14A558A84036761732C2202000D6E4079E36703EBD37C00722F5891D28B0E2811DC114B129215123ADCCE360504A08601000328230007220100F0635964DBF97E043EA0FB5DD67CE69369F5AE19E4B4B67121ABB6C14A558A8405736C6F747311044B43414C0600E40B540200046D61696E10220100F0635964DBF97E043EA0FB5DD67CE69369F5AE19E4B4B67121ABB6C14A558A84036761732C2202000D6E4079E36703EBD37C00722F5891D28B0E2811DC114B129215123ADCCE360504A0860100036F050008220100F0635964DBF97E043EA0FB5DD67CE69369F5AE19E4B4B67121ABB6C14A558A840367617310044B43414C05A0695A2D00046D61696E062202002FE840E13244A9D748883574C1F1B7B1D7020EB39D0735B8F91EF5CF6F35173E0367617310044B43414C05607C240400046D61696E38220100F0635964DBF97E043EA0FB5DD67CE69369F5AE19E4B4B67121ABB6C14A558A840367617310044B43414C058001130200046D61696E08220200496ACA80E4D8F29FB8E8CD816C3AFB48D3F103970B3A2EE1600C08CA67326DEE0367617310044B43414C058001130200046D61696E0200020600000108220100279FB052FA82D619FB33581321E3A5F592507EAC995907B504876ABF6F62421F05626C6F636B10044B43414C058001130200046D61696E220100279FB052FA82D619FB33581321E3A5F592507EAC995907B504876ABF6F62421F0C53504B312E332D62657461310140B40C2F0239689C990B8C7B3B2321E9819B55505D3CD552738CFB82B60576F21C0777FFE0FC6392C7FC9F931E8123D622FFA242043CF0A9B308BF6780203EE90500",
"id": 1
}
getBlockByHeight
Returns information about a block by height and chain.
Parameters
string Address or name of chain.number Height of block.
params : {
"blockHash" : "D717455B81E9A0EE90D6D4B7CC7C476AF4D039AFBEE0505DF1EBFC7B1E395E55",
"height":29
}
Returns
Block - A Block object, or error if block hash is invalidor chain is invalid.
result: object - Given address.
Example
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"getBlockByHeight","params":{"blockHash" : "D717455B81E9A0EE90D6D4B7CC7C476AF4D039AFBEE0505DF1EBFC7B1E395E55","height":"29"},"id":1}'
// Result
getRawBlockByHeight
Returns a serialized string, in hex format, containing information about a block by height and chain.
Parameters
string Address or name of chain.number Height of block.
params : {
"height":"29"
}
Returns
string - A string object, or error if block hash is invalidor chain is invalid.
result: string - hash block.
Example
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"getRawBlockByHeight","params":{"height":"29"},"id":1}'
// Result
getTransactionByBlockHashAndIndex
Returns the information about a transaction requested by a block hash and transaction index.
Parameters
string Chain or Address name.string Hash of block.number Index of transaction.
params : {
"chainAddressOrName" : "main",
"blockHash":"D717455B81E9A0EE90D6D4B7CC7C476AF4D039AFBEE0505DF1EBFC7B1E395E55",
"index":"0"
}
Returns
Transaction - A Transaction object, or error if block hash is invalidor index transaction is invalid.
hash: string - Hash of the object.chainAddress: string - Address of the chain that the address is in.timestamp: string - Time when the hash was produced.blockHeight: string - Height of the hash block.blockHash: string - Hash of the blockscript: string - Script encoded.payload: string - Payload encoded.events: Array - Array of events objects.events - address: string - Address of event.events - contract: string - Type of contract.events - kind: string - Type of token.events - data: string - Data of the event.result: string - Result of the transaction.fee: string - Fee of transaction.signatures: string - Array of signatures.signatures - Kind: string - Type of signature.signatures - Data: string - Data of signature.expiration: timestamp - Experiation of the contract.
Example
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"getTransactionByBlockHashAndIndex","params":{"chainAddressOrName":"main","blockHash":"D717455B81E9A0EE90D6D4B7CC7C476AF4D039AFBEE0505DF1EBFC7B1E395E55", "index":"0"},"id":1}'
// Result
{
"jsonrpc": "2.0",
"result": {
"hash": "986A082C008D5215480D038BAC401F3F16E3C54386695A39C82C0FBD1098AFE4",
"chainAddress": "S3d7TbZxtNPdXy11hfmBLJLYn67gZTG2ibL7fJBcVdihWU4",
"timestamp": 1615560444,
"blockHeight": 29,
"blockHash": "D717455B81E9A0EE90D6D4B7CC7C476AF4D039AFBEE0505DF1EBFC7B1E395E55",
"script": "0D00030328230003000D000304A086010003000D000223220000000000000000000000000000000000000000000000000000000000000000000003000D000223220100F0635964DBF97E043EA0FB5DD67CE69369F5AE19E4B4B67121ABB6C14A558A8403000D000408416C6C6F7747617303000D0004036761732D00012E010D000223220100F0635964DBF97E043EA0FB5DD67CE69369F5AE19E4B4B67121ABB6C14A558A8403000D000404706C617903000D000405736C6F74732D00012E010D000223220100F0635964DBF97E043EA0FB5DD67CE69369F5AE19E4B4B67121ABB6C14A558A8403000D0004085370656E6447617303000D0004036761732D00012E010B",
"payload": "534C4F545376312E30",
"events": [
{
"address": "P2KKxTbPSBKMRRL9vw6NYXsNCKTX1ZfoE2bvAuq6VwZSYuy",
"contract": "gas",
"kind": "TokenStake",
"data": "044B43414C0500E9A43500046D61696E"
},
{
"address": "P2KKxTbPSBKMRRL9vw6NYXsNCKTX1ZfoE2bvAuq6VwZSYuy",
"contract": "gas",
"kind": "GasEscrow",
"data": "2202000D6E4079E36703EBD37C00722F5891D28B0E2811DC114B129215123ADCCE360504A086010003282300"
},
{
"address": "P2KKxTbPSBKMRRL9vw6NYXsNCKTX1ZfoE2bvAuq6VwZSYuy",
"contract": "slots",
"kind": "TokenStake",
"data": "044B43414C0600E40B540200046D61696E"
},
{
"address": "P2KKxTbPSBKMRRL9vw6NYXsNCKTX1ZfoE2bvAuq6VwZSYuy",
"contract": "gas",
"kind": "GasPayment",
"data": "2202000D6E4079E36703EBD37C00722F5891D28B0E2811DC114B129215123ADCCE360504A0860100036F0500"
},
{
"address": "P2KKxTbPSBKMRRL9vw6NYXsNCKTX1ZfoE2bvAuq6VwZSYuy",
"contract": "gas",
"kind": "TokenClaim",
"data": "044B43414C05A0695A2D00046D61696E"
},
{
"address": "S3d9nBL5LAUFhQ14Wzyb3JJRrXXB6atUuoL1uibkT3bttjw",
"contract": "gas",
"kind": "TokenBurn",
"data": "044B43414C05607C240400046D61696E"
},
{
"address": "P2KKxTbPSBKMRRL9vw6NYXsNCKTX1ZfoE2bvAuq6VwZSYuy",
"contract": "gas",
"kind": "CrownRewards",
"data": "044B43414C058001130200046D61696E"
},
{
"address": "S3dBVkyE9kdfbBjh7HMEr1BfPTg53CeSWaj3srYzBTZ4vyK",
"contract": "gas",
"kind": "TokenClaim",
"data": "044B43414C058001130200046D61696E"
}
],
"result": "0600",
"fee": "139100000",
"signatures": [
{
"Kind": "Ed25519",
"Data": "4022E040CAB589838E2644EF94265608893615E3135272D7BE0A9CBF931077D738F6301416494C151DD7A119C03FE805C8807F957972B428413A24C41A5E54F702"
}
],
"expiration": 1615561644
},
"id": 1
}
getAddressTransactions
Returns last X transactions of given address.
Parameters
string Address of account.number Index of page to return. number Number of items to return per page.
params : {
"account":"P2K6Sm1bUYGsFkxuzHPhia1AbANZaHBJV54RgtQi5q8oK34",
"page":"1",
"pageSize":"2"
}
Returns
AccountTransactions - A AccountTransactions object, or error if address is invalidor page is invalidor pageSize is invalid.
page: number - Page requested.pageSize: number - Size of each page.total: number - Total number of records.totalPages: number - Total number of pages.result: string - Name of given address.result - address: string - Given address.result - txs: array - Array of transactions.
Example
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"getAddressTransactions","params":{"account":"P2K6Sm1bUYGsFkxuzHPhia1AbANZaHBJV54RgtQi5q8oK34", "page":"1", "pageSize":"2"},"id":1}'
// Result
{
"jsonrpc": "2.0",
"result": {
"page": 1,
"pageSize": 2,
"total": 15,
"totalPages": 8,
"result": {
"address": "P2K6Sm1bUYGsFkxuzHPhia1AbANZaHBJV54RgtQi5q8oK34",
"txs": [
{
"hash": "F12F08527FFD81213811239BB2F236CD1E8ACDA3D268E951F06AA82950DDB0AE",
"chainAddress": "S3d7TbZxtNPdXy11hfmBLJLYn67gZTG2ibL7fJBcVdihWU4",
"timestamp": 1615832880,
"blockHeight": 77,
"blockHash": "677B3D695E5CE1902480AECF714354D2AEF2C60E684791E30FF83091ABC19FD8",
"script": "0D00030340060003000D000304A086010003000D000223220000000000000000000000000000000000000000000000000000000000000000000003000D000223220100279FB052FA82D619FB33581321E3A5F592507EAC995907B504876ABF6F62421F03000D000408416C6C6F7747617303000D0004036761732D00012E010D00030600E87648170003000D000404534F554C03000D000223220100F0635964DBF97E043EA0FB5DD67CE69369F5AE19E4B4B67121ABB6C14A558A8403000D000223220100279FB052FA82D619FB33581321E3A5F592507EAC995907B504876ABF6F62421F03000D00041652756E74696D652E5472616E73666572546F6B656E7307000D000223220100279FB052FA82D619FB33581321E3A5F592507EAC995907B504876ABF6F62421F03000D0004085370656E6447617303000D0004036761732D00012E010B",
"payload": "504754322E322E31",
"events": [
{
"address": "P2K6Sm1bUYGsFkxuzHPhia1AbANZaHBJV54RgtQi5q8oK34",
"contract": "gas",
"kind": "TokenStake",
"data": "044B43414C050068890900046D61696E"
},
{
"address": "P2K6Sm1bUYGsFkxuzHPhia1AbANZaHBJV54RgtQi5q8oK34",
"contract": "gas",
"kind": "GasEscrow",
"data": "2202000D6E4079E36703EBD37C00722F5891D28B0E2811DC114B129215123ADCCE360504A086010003400600"
},
{
"address": "P2K6Sm1bUYGsFkxuzHPhia1AbANZaHBJV54RgtQi5q8oK34",
"contract": "entry",
"kind": "TokenSend",
"data": "04534F554C0600E876481700046D61696E"
},
{
"address": "P2KKxTbPSBKMRRL9vw6NYXsNCKTX1ZfoE2bvAuq6VwZSYuy",
"contract": "entry",
"kind": "TokenReceive",
"data": "04534F554C0600E876481700046D61696E"
},
{
"address": "P2K6Sm1bUYGsFkxuzHPhia1AbANZaHBJV54RgtQi5q8oK34",
"contract": "gas",
"kind": "GasPayment",
"data": "2202000D6E4079E36703EBD37C00722F5891D28B0E2811DC114B129215123ADCCE360504A0860100037D0100"
},
{
"address": "P2K6Sm1bUYGsFkxuzHPhia1AbANZaHBJV54RgtQi5q8oK34",
"contract": "gas",
"kind": "TokenClaim",
"data": "044B43414C05E00B440700046D61696E"
},
{
"address": "S3d9nBL5LAUFhQ14Wzyb3JJRrXXB6atUuoL1uibkT3bttjw",
"contract": "gas",
"kind": "TokenBurn",
"data": "044B43414C05C0EA210100046D61696E"
},
{
"address": "P2K6Sm1bUYGsFkxuzHPhia1AbANZaHBJV54RgtQi5q8oK34",
"contract": "gas",
"kind": "CrownRewards",
"data": "044B43414C0460F59000046D61696E"
},
{
"address": "S3dBVkyE9kdfbBjh7HMEr1BfPTg53CeSWaj3srYzBTZ4vyK",
"contract": "gas",
"kind": "TokenClaim",
"data": "044B43414C04007C9200046D61696E"
}
],
"result": "",
"fee": "38100000",
"signatures": [
{
"Kind": "Ed25519",
"Data": "403C428DB33DB902AEB209B252AC6530A32A310FCC300B5AEE3CB99B6E571158D05927B8AFBF026A98CCBEE259CF4423F039841FE1F6D5EC40145E7CCC0B03BC00"
}
],
"expiration": 1615834080
},
{
"hash": "07091A38DF59772C0533CD5F3AE83A3EE3D8E9074D9E212ADE335DDDEB86D941",
"chainAddress": "S3d7TbZxtNPdXy11hfmBLJLYn67gZTG2ibL7fJBcVdihWU4",
"timestamp": 1615562324,
"blockHeight": 32,
"blockHash": "1017CBB0CDB1F0EB06EEE312F79E012246F04D91D42D1A59F57DF95205847BDD",
"script": "0D0003030F270003000D000304A086010003000D000223220000000000000000000000000000000000000000000000000000000000000000000003000D000223220100279FB052FA82D619FB33581321E3A5F592507EAC995907B504876ABF6F62421F03000D000408416C6C6F7747617303000D0004036761732D00012E010D00027E060D676574536C6F744E756D6265720300000000000A6765744A61636B706F740393000000000B636865636B57696E6E657206F7000000010466726F6D0804706C617900BD020000010466726F6D080A496E697469616C697A65003C04000001056F776E657208096F6E557067726164650095040000010466726F6D080003000D0002FD2505000D02040E52756E74696D652E52616E646F6D070204020D0303020900270203040D0203026400250402030203010D03040E52756E74696D652E52616E646F6D070304030D0403020900270304050D0303020A00250503040204020D04040E52756E74696D652E52616E646F6D070404040D050302090027040506020603020104020205230405060203042306040503050B0B000D0204044B43414C03020D02022202003B478A0A3FC655DF9DF052728812851B6B22DDF49DAA1130FF37EAFED057414F03020D0004094164647265737328290700040203020D01041252756E74696D652E47657442616C616E63650701040103010B0B00040103010D000409416464726573732829070004010D0203020600030202010303030D03040E736C6F744D616368696E6554727903030D030405736C6F747303030D0204074D61702E486173070204020A02B4020D0403020300030402010503050D05040E736C6F744D616368696E6554727903050D050405736C6F747303050D0404074D61702E476574070404040204030203050D0603026400260506070207040203060D0703020A00260607080D0603020A00270806070207050203070D080302640027070809020906020407020508190708090205070206081907080A16090A070A0789020D09022202003B478A0A3FC655DF9DF052728812851B6B22DDF49DAA1130FF37EAFED057414F03090D0004094164647265737328290700040902090806209400040A030A0D0A04044B43414C030A02010A030A02080A030A0D09041652756E74696D652E5472616E73666572546F6B656E73070902010A030A0D0A040E736C6F744D616368696E65547279030A0D09040A4D61702E52656D6F766507090D0906010103090B08B3020002010A030A0D0A040E736C6F744D616368696E65547279030A0D09040A4D61702E52656D6F7665070900000D0206010003020B0B00040103010D0004094164647265737328290700040102010303030D02041152756E74696D652E49735769746E6573730702040209020A030D03040E7769746E657373206661696C65640C03000D0203020600030202010303030D03040E736C6F744D616368696E6554727903030D030405736C6F747303030D0204074D61702E48617307020402150202090269030D03041663616C6C20636865636B57696E6E65722066697273740C03000D03022202003B478A0A3FC655DF9DF052728812851B6B22DDF49DAA1130FF37EAFED057414F03030D000409416464726573732829070004030203020D0403020A000D0503020A002C0504040D05030201002505040402040302030503050D0504044B43414C0305020205030502010503050D04041652756E74696D652E5472616E73666572546F6B656E730704062001000405020504020406030602010603060D06040E736C6F744D616368696E6554727903060D0504074D61702E5365740705030402010703070620F80004060206050B00040203020D000409416464726573732829070004020202030203010D04030622A5B98B830003040D03040F52756E74696D652E5365745365656407030D020408446174612E53657403010D00040561646D696E030007020B000D010408446174612E4765740D020405736C6F74730D000302080003000D00040561646D696E030003020701040303030D00040941646472657373282907000403040103010D0004094164647265737328290700040102030403040D02041152756E74696D652E49735769746E65737307020402090223050D04040E7769746E657373206661696C65640C04000B0B03000D000405736C6F747303000D000223220100279FB052FA82D619FB33581321E3A5F592507EAC995907B504876ABF6F62421F03000D00041752756E74696D652E55706772616465436F6E747261637407000D000223220100279FB052FA82D619FB33581321E3A5F592507EAC995907B504876ABF6F62421F03000D0004085370656E6447617303000D0004036761732D00012E010B",
"payload": "A7000000",
"events": [
{
"address": "P2K6Sm1bUYGsFkxuzHPhia1AbANZaHBJV54RgtQi5q8oK34",
"contract": "gas",
"kind": "TokenStake",
"data": "044B43414C056043993B00046D61696E"
},
{
"address": "P2K6Sm1bUYGsFkxuzHPhia1AbANZaHBJV54RgtQi5q8oK34",
"contract": "gas",
"kind": "GasEscrow",
"data": "2202000D6E4079E36703EBD37C00722F5891D28B0E2811DC114B129215123ADCCE360504A0860100030F2700"
},
{
"address": "P2K6Sm1bUYGsFkxuzHPhia1AbANZaHBJV54RgtQi5q8oK34",
"contract": "entry",
"kind": "TokenBurn",
"data": "044B43414C0687C51C34CB00046D61696E"
},
{
"address": "P2K6Sm1bUYGsFkxuzHPhia1AbANZaHBJV54RgtQi5q8oK34",
"contract": "entry",
"kind": "ContractUpgrade",
"data": "05736C6F7473"
},
{
"address": "P2K6Sm1bUYGsFkxuzHPhia1AbANZaHBJV54RgtQi5q8oK34",
"contract": "gas",
"kind": "GasPayment",
"data": "2202000D6E4079E36703EBD37C00722F5891D28B0E2811DC114B129215123ADCCE360504A0860100034D0200"
},
{
"address": "P2K6Sm1bUYGsFkxuzHPhia1AbANZaHBJV54RgtQi5q8oK34",
"contract": "gas",
"kind": "TokenClaim",
"data": "044B43414C054085163800046D61696E"
},
{
"address": "S3d9nBL5LAUFhQ14Wzyb3JJRrXXB6atUuoL1uibkT3bttjw",
"contract": "gas",
"kind": "TokenBurn",
"data": "044B43414C05C09BC00100046D61696E"
},
{
"address": "P2K6Sm1bUYGsFkxuzHPhia1AbANZaHBJV54RgtQi5q8oK34",
"contract": "gas",
"kind": "CrownRewards",
"data": "044B43414C04E04DE000046D61696E"
},
{
"address": "S3dBVkyE9kdfbBjh7HMEr1BfPTg53CeSWaj3srYzBTZ4vyK",
"contract": "gas",
"kind": "TokenClaim",
"data": "044B43414C0480D4E100046D61696E"
}
],
"result": "",
"fee": "58900000",
"signatures": [
{
"Kind": "Ed25519",
"Data": "4072936F5CDAEFD790A9C32218D5584788447E0705FAC9A8EDD1E51581E2CD1E27C0526E7FBEC64A9608CE78BBCDF65443725AFF3AF8311F2C5F7380210044A40E"
}
],
"expiration": 1615562624
}
]
}
},
"id": 1
}
getAddressTransactionCount
Get number of transactions in a specific address and chain
Parameters
string Address of account.string Name or address of chain, optional.
params:{
"account":"P2K6Sm1bUYGsFkxuzHPhia1AbANZaHBJV54RgtQi5q8oK34"
}
Returns
number - A number, or error if address is invalidor chain is invalid.
jsonrpc: string - String with the jsonrpc version.result: number - Number of transactions.id: number - ID of the user.
Example
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"getAddressTransactionCount","params":{"account":"P2K6Sm1bUYGsFkxuzHPhia1AbANZaHBJV54RgtQi5q8oK34", "page":"1", "pageSize":"2"},"id":1}'
// Result
{
"jsonrpc": "2.0",
"result": 15,
"id": 1
}
sendRawTransaction
Allows to broadcast a signed operation on the network, but it's required to build it manually.
Parameters
string Serialized transaction bytes, in hexadecimal format.
params:{
"txData" : ""
}
Returns
string - A string object, or error if rejected by mempoolor script is invalidor failed to decoded transaction.
address: string - Given address.
Example
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"sendRawTransaction","params":{"txData":""},"id":1}'
// Result
invokeRawScript
Allows to invoke script based on network state, without state changes.
Parameters
string Address or name of chain.string Serialized script bytes, in hexadecimal format.
params:{
"chainInput":"main",
"scriptData":""
}
Returns
Script - A Script object, or error if script is invalidor failed to decoded script.
address: string - Given address.
Example
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"invokeRawScript","params":{"chainInput":"main", "scriptData":""},"id":1}'
// Result
getTransaction
Returns information about a transaction by hash.
Parameters
string Hash of transaction.
params:{
"hashText":"F12F08527FFD81213811239BB2F236CD1E8ACDA3D268E951F06AA82950DDB0AE"
}
Returns
Transaction - A Transaction object, or error if hash is invalid.
result: object - Transactions object.
Example
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"getTransaction","params":{"hashText":"F12F08527FFD81213811239BB2F236CD1E8ACDA3D268E951F06AA82950DDB0AE"},"id":1}'
// Result
{
"jsonrpc": "2.0",
"result": {
"hash": "F12F08527FFD81213811239BB2F236CD1E8ACDA3D268E951F06AA82950DDB0AE",
"chainAddress": "S3d7TbZxtNPdXy11hfmBLJLYn67gZTG2ibL7fJBcVdihWU4",
"timestamp": 1615832880,
"blockHeight": 77,
"blockHash": "677B3D695E5CE1902480AECF714354D2AEF2C60E684791E30FF83091ABC19FD8",
"script": "0D00030340060003000D000304A086010003000D000223220000000000000000000000000000000000000000000000000000000000000000000003000D000223220100279FB052FA82D619FB33581321E3A5F592507EAC995907B504876ABF6F62421F03000D000408416C6C6F7747617303000D0004036761732D00012E010D00030600E87648170003000D000404534F554C03000D000223220100F0635964DBF97E043EA0FB5DD67CE69369F5AE19E4B4B67121ABB6C14A558A8403000D000223220100279FB052FA82D619FB33581321E3A5F592507EAC995907B504876ABF6F62421F03000D00041652756E74696D652E5472616E73666572546F6B656E7307000D000223220100279FB052FA82D619FB33581321E3A5F592507EAC995907B504876ABF6F62421F03000D0004085370656E6447617303000D0004036761732D00012E010B",
"payload": "504754322E322E31",
"events": [
{
"address": "P2K6Sm1bUYGsFkxuzHPhia1AbANZaHBJV54RgtQi5q8oK34",
"contract": "gas",
"kind": "TokenStake",
"data": "044B43414C050068890900046D61696E"
},
{
"address": "P2K6Sm1bUYGsFkxuzHPhia1AbANZaHBJV54RgtQi5q8oK34",
"contract": "gas",
"kind": "GasEscrow",
"data": "2202000D6E4079E36703EBD37C00722F5891D28B0E2811DC114B129215123ADCCE360504A086010003400600"
},
{
"address": "P2K6Sm1bUYGsFkxuzHPhia1AbANZaHBJV54RgtQi5q8oK34",
"contract": "entry",
"kind": "TokenSend",
"data": "04534F554C0600E876481700046D61696E"
},
{
"address": "P2KKxTbPSBKMRRL9vw6NYXsNCKTX1ZfoE2bvAuq6VwZSYuy",
"contract": "entry",
"kind": "TokenReceive",
"data": "04534F554C0600E876481700046D61696E"
},
{
"address": "P2K6Sm1bUYGsFkxuzHPhia1AbANZaHBJV54RgtQi5q8oK34",
"contract": "gas",
"kind": "GasPayment",
"data": "2202000D6E4079E36703EBD37C00722F5891D28B0E2811DC114B129215123ADCCE360504A0860100037D0100"
},
{
"address": "P2K6Sm1bUYGsFkxuzHPhia1AbANZaHBJV54RgtQi5q8oK34",
"contract": "gas",
"kind": "TokenClaim",
"data": "044B43414C05E00B440700046D61696E"
},
{
"address": "S3d9nBL5LAUFhQ14Wzyb3JJRrXXB6atUuoL1uibkT3bttjw",
"contract": "gas",
"kind": "TokenBurn",
"data": "044B43414C05C0EA210100046D61696E"
},
{
"address": "P2K6Sm1bUYGsFkxuzHPhia1AbANZaHBJV54RgtQi5q8oK34",
"contract": "gas",
"kind": "CrownRewards",
"data": "044B43414C0460F59000046D61696E"
},
{
"address": "S3dBVkyE9kdfbBjh7HMEr1BfPTg53CeSWaj3srYzBTZ4vyK",
"contract": "gas",
"kind": "TokenClaim",
"data": "044B43414C04007C9200046D61696E"
}
],
"result": "",
"fee": "38100000",
"signatures": [
{
"Kind": "Ed25519",
"Data": "403C428DB33DB902AEB209B252AC6530A32A310FCC300B5AEE3CB99B6E571158D05927B8AFBF026A98CCBEE259CF4423F039841FE1F6D5EC40145E7CCC0B03BC00"
}
],
"expiration": 1615834080
},
"id": 1
}
cancelTransaction
Removes a pending transaction from the mempool.
Parameters
string Hash of transaction.
params:{
"hashText":"F12F08527FFD81213811239BB2F236CD1E8ACDA3D268E951F06AA82950DDB0AE"
}
Returns
string - A string object, or error if hash is invalid.
Example
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"cancelTransaction","params":{"hashText":"F12F08527FFD81213811239BB2F236CD1E8ACDA3D268E951F06AA82950DDB0AE"},"id":1}'
// Result
{
"jsonrpc": "2.0",
"error": {
"code": -32603,
"message": "already in chain"
},
"id": 0
}
getChains
Returns an array of all chains deployed in Phantasma.
Parameters
none
params: {}
Returns
Chain - A Chain object.
name: string - Name of the chain.address: string - Address of the Chain.height: string - Height of the Chain.organization: string - Given Organization.contracts: array - Array of contracts in the Chain.
Example
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"getChains","params":{},"id":1}'
// Result
{
"jsonrpc": "2.0",
"result": [
{
"name": "main",
"address": "S3d7TbZxtNPdXy11hfmBLJLYn67gZTG2ibL7fJBcVdihWU4",
"height": 77,
"organization": "validators",
"contracts": [
"validator",
"governance",
"consensus",
"account",
"exchange",
"swap",
"interop",
"stake",
"storage",
"relay",
"ranking",
"privacy",
"mail",
"friends",
"market",
"sale",
"slots"
]
}
],
"id": 1
}
getNexus
Returns info about the nexus.
Parameters
boolean Extended search, Optional (default: false)
params : {}
Returns
Nexus - A Nexus object.
name: string - Name of the nexus.platforms: array - Array of platform object on the chain.token: array - Array of token object on the chain.chains: array - Array of chain object.governance: array - Array of governance.organizations: array - Array of organizations.
Example
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"getNexus","params":{},"id":1}'
// Result
{
"jsonrpc": "2.0",
"result": {
"name": "simnet",
"platforms": [
{
"platform": "neo",
"chain": "S3dEMj6oFEgfcwSpriewXBR5xcnwu4MJa9KmHgyaKqEhoM6",
"fuel": "GAS",
"tokens": [
"SOUL",
"NEO",
"GAS"
],
"interop": [
{
"local": "X54DbFHTbzhEFHFHmm3fDVjeTpDmXsAeVEz4U4GK6ZQYe6b",
"external": "Aai16mqdg9b453ZggXn3SmJH45na3oCEoU"
}
]
},
{
"platform": "ethereum",
"chain": "S3dJoptTKf9ASn2tWxHh9fkGH8xjHbhYutNNHkzR1WSmpK6",
"fuel": "ETH",
"tokens": [
"ETH"
],
"interop": [
{
"local": "X7DzbZPdeGpqeRdxHkusj6zUH8nzQjTPsrbRdFWQ5gEsmi7",
"external": "0xBF35FB8C5B4171496E052EEBFB5BEA29A932171C"
}
]
}
],
"tokens": [
{
"symbol": "SOUL",
"name": "Phantasma Stake",
"decimals": 8,
"currentSupply": "286362600000000",
"maxSupply": "0",
"burnedSupply": "0",
"address": "S3dJWaLDKYhhTHf28EfsP6ateZ5w5TeZUSV8wM9JNfaD79E",
"owner": "P2K6Sm1bUYGsFkxuzHPhia1AbANZaHBJV54RgtQi5q8oK34",
"flags": "Transferable, Fungible, Divisible, Stakable, Swappable",
"script": "0B"
},
{
"symbol": "KCAL",
"name": "Phantasma Energy",
"decimals": 10,
"currentSupply": "9988092095432583",
"maxSupply": "0",
"burnedSupply": "12907904567417",
"address": "S3dP6LRC3f3xw4ZZ2HH9BQHzYNHuHS8vetbCQpkMFvRmVEF",
"owner": "P2K6Sm1bUYGsFkxuzHPhia1AbANZaHBJV54RgtQi5q8oK34",
"flags": "Transferable, Fungible, Divisible, Fuel, Burnable",
"script": "0B"
},
{
"symbol": "USD",
"name": "Dollars",
"decimals": 8,
"currentSupply": "0",
"maxSupply": "0",
"burnedSupply": "0",
"address": "S3dHVD6WN35zQvVLEGrdZuBm3gK1YSJLhQwRNe448v9W5hS",
"owner": "P2K6Sm1bUYGsFkxuzHPhia1AbANZaHBJV54RgtQi5q8oK34",
"flags": "Transferable, Fungible, Divisible, Fiat",
"script": "0B"
},
{
"symbol": "CROWN",
"name": "Phantasma Crown",
"decimals": 0,
"currentSupply": "0",
"maxSupply": "0",
"burnedSupply": "0",
"address": "S3d79FvexQeerRioAY3pGYpNPFx7oJkMV4KazdTHdGDA5iy",
"owner": "P2K6Sm1bUYGsFkxuzHPhia1AbANZaHBJV54RgtQi5q8oK34",
"flags": "Transferable, Burnable",
"script": "0B"
},
{
"symbol": "NEO",
"name": "NEO",
"decimals": 0,
"currentSupply": "0",
"maxSupply": "100000000",
"burnedSupply": "0",
"address": "S3d8KEdUw38RGpvidVzWibp52V3MxDKboLk98s9FvWyYkEa",
"owner": "P2K6Sm1bUYGsFkxuzHPhia1AbANZaHBJV54RgtQi5q8oK34",
"flags": "Transferable, Fungible, Finite, Swappable",
"script": "0B"
},
{
"symbol": "GAS",
"name": "GAS",
"decimals": 8,
"currentSupply": "0",
"maxSupply": "10000000000000000",
"burnedSupply": "0",
"address": "S3d9YMoxd3najgNa4J5H1P7LXz9DA1jMRV7n4PiQtVV2A7b",
"owner": "P2K6Sm1bUYGsFkxuzHPhia1AbANZaHBJV54RgtQi5q8oK34",
"flags": "Transferable, Fungible, Finite, Divisible, Swappable",
"script": "0B"
},
{
"symbol": "ETH",
"name": "Ethereum",
"decimals": 18,
"currentSupply": "0",
"maxSupply": "0",
"burnedSupply": "0",
"address": "S3dP28ogxjaAbCt1bnujJCGawcsz66fEgkL9mwHvnAJUUrT",
"owner": "P2K6Sm1bUYGsFkxuzHPhia1AbANZaHBJV54RgtQi5q8oK34",
"flags": "Transferable, Fungible, Divisible, Swappable",
"script": "0B"
},
{
"symbol": "MKNI",
"name": "Mankini Token",
"decimals": 0,
"currentSupply": "100000",
"maxSupply": "100000",
"burnedSupply": "0",
"address": "S3dJhVLEaQ5H1633puCNDXfnUDthbuRaBPtUg6vnjk2aqq6",
"owner": "P2K6Sm1bUYGsFkxuzHPhia1AbANZaHBJV54RgtQi5q8oK34",
"flags": "Transferable, Fungible, Finite",
"script": "000D0402220100279FB052FA82D619FB33581321E3A5F592507EAC995907B504876ABF6F62421F03040D00040941646472657373282907000D00041152756E74696D652E49735769746E6573730700040309036B000D00040F696E76616C6964207769746E6573730C00000B"
}
],
"chains": [
{
"name": "main",
"address": "S3d7TbZxtNPdXy11hfmBLJLYn67gZTG2ibL7fJBcVdihWU4",
"height": 77,
"organization": "validators",
"contracts": [
"validator",
"governance",
"consensus",
"account",
"exchange",
"swap",
"interop",
"stake",
"storage",
"relay",
"ranking",
"privacy",
"mail",
"friends",
"market",
"sale",
"slots"
]
}
],
"governance": [
{
"name": "nexus.protocol.version",
"value": "5"
},
{
"name": "validator.count",
"value": "1"
},
{
"name": "validator.rotation.time",
"value": "120"
},
{
"name": "poll.vote.limit",
"value": "50000"
},
{
"name": "poll.max.entries",
"value": "10"
},
{
"name": "poll.max.length",
"value": "7776000"
},
{
"name": "stake.master.threshold",
"value": "5000000000000"
},
{
"name": "stake.bonus.percent",
"value": "5"
},
{
"name": "stake.bonus.max",
"value": "100"
},
{
"name": "stake.vote.threshold",
"value": "100000000000"
},
{
"name": "swap.fee.maker",
"value": "2"
},
{
"name": "swap.fee.taker",
"value": "5"
},
{
"name": "storage.stake.kb",
"value": "40"
},
{
"name": "storage.contract.kb",
"value": "1024"
},
{
"name": "nexus.contract.cost",
"value": "1000000000"
},
{
"name": "nexus.token.cost",
"value": "10000000000"
}
],
"organizations": [
"validators",
"masters",
"stakers",
"phantom_force"
]
},
"id": 1
}
getOrganization
Returns info about an organization.
Parameters
string ID of the organization
params : {
"ID":"validators"
}
Returns
Organization - A Organization object.
address: string - Given address.
Example
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"getOrganization","params":{"ID":"validators"},"id":1}'
// Result
{
"jsonrpc": "2.0",
"result": {
"id": "validators",
"name": "Block Producers",
"members": [
"P2K6Sm1bUYGsFkxuzHPhia1AbANZaHBJV54RgtQi5q8oK34"
]
},
"id": 1
}
getLeaderboard
Returns content of a Phantasma leaderboard.
Parameters
string Name of the leaderboard
params : {
"name":""
}
Returns
Leaderboard - A Leaderboard object.
address: string - Given address.
Example
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"getLeaderboard","params":{},"id":1}'
// Result
getTokens
Returns an array of tokens deployed in Phantasma.
Parameters
boolean Extended search, Optional (default: false)
params : {}
Returns
Token - A Token object.
result: array - Array of token objects.
Example
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"getTokens","params":{},"id":1}'
// Result
{
"jsonrpc": "2.0",
"result": [
{
"symbol": "SOUL",
"name": "Phantasma Stake",
"decimals": 8,
"currentSupply": "286362600000000",
"maxSupply": "0",
"burnedSupply": "0",
"address": "S3dJWaLDKYhhTHf28EfsP6ateZ5w5TeZUSV8wM9JNfaD79E",
"owner": "P2K6Sm1bUYGsFkxuzHPhia1AbANZaHBJV54RgtQi5q8oK34",
"flags": "Transferable, Fungible, Divisible, Stakable, Swappable",
"script": "0B"
},
{
"symbol": "KCAL",
"name": "Phantasma Energy",
"decimals": 10,
"currentSupply": "9988092095432583",
"maxSupply": "0",
"burnedSupply": "12907904567417",
"address": "S3dP6LRC3f3xw4ZZ2HH9BQHzYNHuHS8vetbCQpkMFvRmVEF",
"owner": "P2K6Sm1bUYGsFkxuzHPhia1AbANZaHBJV54RgtQi5q8oK34",
"flags": "Transferable, Fungible, Divisible, Fuel, Burnable",
"script": "0B"
},
{
"symbol": "USD",
"name": "Dollars",
"decimals": 8,
"currentSupply": "0",
"maxSupply": "0",
"burnedSupply": "0",
"address": "S3dHVD6WN35zQvVLEGrdZuBm3gK1YSJLhQwRNe448v9W5hS",
"owner": "P2K6Sm1bUYGsFkxuzHPhia1AbANZaHBJV54RgtQi5q8oK34",
"flags": "Transferable, Fungible, Divisible, Fiat",
"script": "0B"
},
{
"symbol": "CROWN",
"name": "Phantasma Crown",
"decimals": 0,
"currentSupply": "0",
"maxSupply": "0",
"burnedSupply": "0",
"address": "S3d79FvexQeerRioAY3pGYpNPFx7oJkMV4KazdTHdGDA5iy",
"owner": "P2K6Sm1bUYGsFkxuzHPhia1AbANZaHBJV54RgtQi5q8oK34",
"flags": "Transferable, Burnable",
"script": "0B"
},
{
"symbol": "NEO",
"name": "NEO",
"decimals": 0,
"currentSupply": "0",
"maxSupply": "100000000",
"burnedSupply": "0",
"address": "S3d8KEdUw38RGpvidVzWibp52V3MxDKboLk98s9FvWyYkEa",
"owner": "P2K6Sm1bUYGsFkxuzHPhia1AbANZaHBJV54RgtQi5q8oK34",
"flags": "Transferable, Fungible, Finite, Swappable",
"script": "0B"
},
{
"symbol": "GAS",
"name": "GAS",
"decimals": 8,
"currentSupply": "0",
"maxSupply": "10000000000000000",
"burnedSupply": "0",
"address": "S3d9YMoxd3najgNa4J5H1P7LXz9DA1jMRV7n4PiQtVV2A7b",
"owner": "P2K6Sm1bUYGsFkxuzHPhia1AbANZaHBJV54RgtQi5q8oK34",
"flags": "Transferable, Fungible, Finite, Divisible, Swappable",
"script": "0B"
},
{
"symbol": "ETH",
"name": "Ethereum",
"decimals": 18,
"currentSupply": "0",
"maxSupply": "0",
"burnedSupply": "0",
"address": "S3dP28ogxjaAbCt1bnujJCGawcsz66fEgkL9mwHvnAJUUrT",
"owner": "P2K6Sm1bUYGsFkxuzHPhia1AbANZaHBJV54RgtQi5q8oK34",
"flags": "Transferable, Fungible, Divisible, Swappable",
"script": "0B"
},
{
"symbol": "MKNI",
"name": "Mankini Token",
"decimals": 0,
"currentSupply": "100000",
"maxSupply": "100000",
"burnedSupply": "0",
"address": "S3dJhVLEaQ5H1633puCNDXfnUDthbuRaBPtUg6vnjk2aqq6",
"owner": "P2K6Sm1bUYGsFkxuzHPhia1AbANZaHBJV54RgtQi5q8oK34",
"flags": "Transferable, Fungible, Finite",
"script": "000D0402220100279FB052FA82D619FB33581321E3A5F592507EAC995907B504876ABF6F62421F03040D00040941646472657373282907000D00041152756E74696D652E49735769746E6573730700040309036B000D00040F696E76616C6964207769746E6573730C00000B"
}
],
"id": 1
}
getToken
Returns info about a specific token deployed in Phantasma.
Parameters
string Token symbol to obtain info.boolean Extended search, Optional (default: false)
params : {
"symbol":"SOUL"
}
Returns
Token - A Token object.
result: object - Token object.result - symbol: string - Symbol name.result - name: string - Full name of the symbol.result - decimals: number - Decimals of the token.result - currentSupply: string - Current supply of the token.result - maxSupply: string - Max supply of the token.result - burnedSupply: string - Burned supply of the token.result - address: string - Addres of the token.result - owner: string - Owner of the token.result - flags: string - Flags of the token.result - script: string - script of the token.
Example
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"getToken","params":{"symbol":"SOUL"},"id":1}'
// Result
{
"jsonrpc": "2.0",
"result": {
"symbol": "SOUL",
"name": "Phantasma Stake",
"decimals": 8,
"currentSupply": "286362600000000",
"maxSupply": "0",
"burnedSupply": "0",
"address": "S3dJWaLDKYhhTHf28EfsP6ateZ5w5TeZUSV8wM9JNfaD79E",
"owner": "P2K6Sm1bUYGsFkxuzHPhia1AbANZaHBJV54RgtQi5q8oK34",
"flags": "Transferable, Fungible, Divisible, Stakable, Swappable",
"script": "0B"
},
"id": 1
}
getTokenData
Returns data of a non-fungible token, in hexadecimal format.
Parameters
string Symbol of token.string ID of token.
params : {
"symbol":"SOUL",
"IDtext":"5"
}
Returns
TokenData - A TokenData object.
result: string - Given address.
Example
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"getTokenData","params":{"symbol":"SOUL","IDtext":"5"},"id":1}'
// Result
getNFT
Returns data of a non-fungible token, in hexadecimal format.
Parameters
string Token symbol.string ID of tokenboolean Extended search, Optional (default: false)
params : {
"symbol":"SOUL",
"IDtext":"5"
}
Returns
NFT - A NFT object.
result: object - NFT object.
Example
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"getNFT","params":{"symbol":"SOUL","IDtext":"5"},"id":1}'
// Result
getTokenBalance
Returns the balance for a specific token and chain, given an address.
Parameters
string Address of account.string Token symbol.string Address or name of chain.
params : {
"account":"P2K6Sm1bUYGsFkxuzHPhia1AbANZaHBJV54RgtQi5q8oK34",
"tokenSymbol":"SOUL",
"chainInput":"main"
}
Returns
Balance - A Balance object, or error if address is invalidor token is invalidor chain is invalid.
chain: string - Chain Address.amount: string - Amount of token.symbol: string - Symbol of token.decimals: string - Decimals of token.
Example
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"getTokenBalance","params":{"account":"P2K6Sm1bUYGsFkxuzHPhia1AbANZaHBJV54RgtQi5q8oK34","tokenSymbol":"SOUL","chainInput":"main"},"id":1}'
// Result
{
"jsonrpc": "2.0",
"result": {
"chain": "S3d7TbZxtNPdXy11hfmBLJLYn67gZTG2ibL7fJBcVdihWU4",
"amount": "94899900000000",
"symbol": "SOUL",
"decimals": 8
},
"id": 1
}
getAuctionsCount
Returns the number of active auctions.
Parameters
string Chain address or name where the market is located.string Token symbol used as filter.
params : {
"chainInput":"S3d7TbZxtNPdXy11hfmBLJLYn67gZTG2ibL7fJBcVdihWU4",
"tokenSymbol":"SOUL"
}
Returns
number - A number.
result: string - Number of Auctions.
Example
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"getAuctionsCount","params":{"chainInput":"S3d7TbZxtNPdXy11hfmBLJLYn67gZTG2ibL7fJBcVdihWU4","tokenSymbol" : "SOUL"},"id":1}'
// Result
{
"jsonrpc": "2.0",
"result": 0,
"id": 1
}
getAuctions
Returns the auctions available in the market.
Parameters
string Chain address or name where the market is located.string Token symbol used as filter.number Index of page to return.number Number of items to return per page.
params : {
"chainInput":"S3d7TbZxtNPdXy11hfmBLJLYn67gZTG2ibL7fJBcVdihWU4",
"tokenSymbol":"SOUL",
"page":"1",
"pageSize":"5"
}
Returns
Auction - A Auction object.
address: string - Given address.
Example
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"getAuctions","params":{"chainInput":"S3d7TbZxtNPdXy11hfmBLJLYn67gZTG2ibL7fJBcVdihWU4","tokenSymbol" : "SOUL", "page" : "1", "pageSize" : "5"},"id":1}'
// Result
{
"jsonrpc": "2.0",
"result": {
"page": 1,
"pageSize": 5,
"total": 0,
"totalPages": 0,
"result": []
},
"id": 1
}
getAuction
Returns the auction for a specific token.
Parameters
string Chain address or name where the market is located.string Token symbol.string Token ID.
params : {
"chainInput":"S3d7TbZxtNPdXy11hfmBLJLYn67gZTG2ibL7fJBcVdihWU4",
"tokenSymbol":"SOUL",
"IDText":"test"
}
Returns
Auction - A Auction object.
address: string - Given address.
Example
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"getAuction","params":{"chainInput":"S3d7TbZxtNPdXy11hfmBLJLYn67gZTG2ibL7fJBcVdihWU4","tokenSymbol" : "SOUL","IDText":"0"},"id":1}'
// Result
getArchive
Returns info about a specific archive.
Parameters
string Archive hash.
params : {
"hashText" : ""
}
Returns
Archive - A Archive object.
result: string - Archive object.
Example
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"getArchive","params":{},"id":1}'
// Result
writeArchive
Writes the contents of an incomplete archive.
Parameters
string Archive hash.int Block index, starting from 0string Block content bytes, in Base64
params : {
}
Returns
Archive - A Archive object.
result: string - Given address.
Example
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"writeArchive","params":{},"id":1}'
// Result
readArchive
Reads given archive block.
Parameters
string Archive hash.int Block index, starting from 0
params : {
"hashText":"83E0B0D032022A9D839AA92C94C8F5C6A3E602629CBE0E786D9C65F8E6F0AE5A"
"blockIndex" : ""
}
Returns
Archive - A Archive object.
result: object - An Archive object.
Example
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"readArchive","params":{},"id":1}'
// Result
getContract
Returns the ABI interface of specific contract.
Parameters
string Chain address or name where the contract is deployed.string Contract name
params : {
"chainAddressOrName":"main",
"contractName":"account"
}
Returns
Contract - A Contract object.
name: string - Name of the contract.address: string - Address of the contract.script: string - Script.methods: array - Array of methods.methods - name: string - Name of the method.methods - returnType: string - Return type of the method.methods - parameters: string - Parameters of the method.methods - parameters - name: string - Name of the parameter.methods - parameters - type: string - type of the parameter.
Example
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"getContract","params":{"chainAddressOrName":"main","contractName":"account"},"id":1}'
// Result
{
"jsonrpc": "2.0",
"result": {
"name": "account",
"address": "S3dGz1deZweAiMVPHL328X3pVNpANQVjgX4MoRGpbNNAfrB",
"script": "",
"methods": [
{
"name": "RegisterName",
"returnType": "None",
"parameters": [
{
"name": "target",
"type": "Object"
},
{
"name": "name",
"type": "String"
}
]
},
{
"name": "UnregisterName",
"returnType": "None",
"parameters": [
{
"name": "target",
"type": "Object"
}
]
},
{
"name": "RegisterScript",
"returnType": "None",
"parameters": [
{
"name": "target",
"type": "Object"
},
{
"name": "script",
"type": "Bytes"
},
{
"name": "abiBytes",
"type": "Bytes"
}
]
},
{
"name": "HasScript",
"returnType": "Bool",
"parameters": [
{
"name": "address",
"type": "Object"
}
]
},
{
"name": "LookUpAddress",
"returnType": "String",
"parameters": [
{
"name": "target",
"type": "Object"
}
]
},
{
"name": "LookUpScript",
"returnType": "Bytes",
"parameters": [
{
"name": "target",
"type": "Object"
}
]
},
{
"name": "LookUpABI",
"returnType": "Bytes",
"parameters": [
{
"name": "target",
"type": "Object"
}
]
},
{
"name": "LookUpName",
"returnType": "Object",
"parameters": [
{
"name": "name",
"type": "String"
}
]
},
{
"name": "Migrate",
"returnType": "None",
"parameters": [
{
"name": "from",
"type": "Object"
},
{
"name": "target",
"type": "Object"
}
]
}
]
},
"id": 1
}
getPeers
Returns list of known peers.
Parameters
none
params : {}
Returns
Peers - A Peer object.
url: string - URL of the program.version: string - Version of the program.flags: string - Flags of Peer.fee: string - Fee.pow: string - POW.
Example
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"getPeers","params":{},"id":1}'
// Result
{
"jsonrpc": "2.0",
"result": [
{
"url": "tcp:localhost:7777",
"version": "Spook v1.3-beta1",
"flags": "Mempool, RPC, REST",
"fee": "100000",
"pow": 0
}
],
"id": 1
}
relaySend
Writes a message to the relay network.
Parameters
string Serialized receipt, in hex.
params : {
"receiptHex":""
}
Returns
Relay - A Relay object.
resullt: string - Given address.
Example
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"relaySend","params":{},"id":1}'
// Result
relayReceive
Receives messages from the relay network.
Parameters
string Address or account name.
params:{
"account" : "genesis"
}
Returns
Relay - A Relay object.
result: string - Given address.
Example
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"relayReceive","params":{},"id":1}'
// Result
getEvents
Reads pending messages from the relay network.
Parameters
string Address or account name.
params:{
"account" : "P2K6Sm1bUYGsFkxuzHPhia1AbANZaHBJV54RgtQi5q8oK34"
}
Returns
Array - Array of events object.
result: array - Array of event objects.
Example
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"getEvents","params":{"account" : "P2K6Sm1bUYGsFkxuzHPhia1AbANZaHBJV54RgtQi5q8oK34"},"id":1}'
// Result
Returns an array of available interop platforms.
Parameters
none
params:{}
Returns
Platforms - A array of Platforms.
result: array - Array of Platformsplatform: string - Name of platform.chain: string - Chain address.fuel: string - Type of fuel.tokens: array - Array of tokens that the chain handle.interop: array - Interop.interop - local: string - Local Hash address.interop - external: string - External Hash address.
Example
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"getPlatforms","params":{},"id":1}'
// Result
{
"jsonrpc": "2.0",
"result": [
{
"platform": "neo",
"chain": "S3dEMj6oFEgfcwSpriewXBR5xcnwu4MJa9KmHgyaKqEhoM6",
"fuel": "GAS",
"tokens": [
"SOUL",
"NEO",
"GAS"
],
"interop": [
{
"local": "X54DbFHTbzhEFHFHmm3fDVjeTpDmXsAeVEz4U4GK6ZQYe6b",
"external": "Aai16mqdg9b453ZggXn3SmJH45na3oCEoU"
}
]
},
{
"platform": "ethereum",
"chain": "S3dJoptTKf9ASn2tWxHh9fkGH8xjHbhYutNNHkzR1WSmpK6",
"fuel": "ETH",
"tokens": [
"ETH"
],
"interop": [
{
"local": "X7DzbZPdeGpqeRdxHkusj6zUH8nzQjTPsrbRdFWQ5gEsmi7",
"external": "0xBF35FB8C5B4171496E052EEBFB5BEA29A932171C"
}
]
}
],
"id": 1
}
getValidators
Returns an array of available validators.
Parameters
none
params:{}
Returns
Validators - A array of Validator objects.
result: array - Array of Validator objects.address: string - Address of the validator.type: string - Type of the validator.
Example
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"getValidators","params":{},"id":1}'
// Result
{
"jsonrpc": "2.0",
"result": [
{
"address": "P2K6Sm1bUYGsFkxuzHPhia1AbANZaHBJV54RgtQi5q8oK34",
"type": "Primary"
}
],
"id": 1
}
settleSwap
Tries to settle a pending swap for a specific hash.
Parameters
string Name of platform where swap transaction was created.string Name of platform to settle.string Hash of transaction to settle.
params : {
"sourcePlatform" : "",
"destPlatform":"",
"hashText":""
}
Returns
Swap - A Swap object.
result: object - Swawp object.
Example
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"settleSwap","params":{"sourcePlatform" : "", "destPlatform":"", "hashText":""},"id":1}'
// Result
getSwapsForAddress
Returns platform swaps for a specific address.
Parameters
string Address or account name.boolean Extended search, Optional (default: false)
params:{
"account" : "P2K6Sm1bUYGsFkxuzHPhia1AbANZaHBJV54RgtQi5q8oK34"
}
Returns
Swap - A Swap object.
result: object - Swap object.
Example
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"getSwapsForAddress","params":{"account":"P2K6Sm1bUYGsFkxuzHPhia1AbANZaHBJV54RgtQi5q8oK34"},"id":1}'
// Result
getLatestSaleHash
Returns latest sale hash.
Parameters
none
params:{}
Returns
string - A Hash of the sale.
result: string - Address of the Hash.
Example
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"getLatestSaleHash","params":{},"id":1}'
// Result
{
"jsonrpc": "2.0",
"result": "E056D02E57C7DBDC88E1C120D4BC827772BA7E56E3FDF496DF7D16938AB0A639",
"id": 1
}
getSale
Returns data about a crowdsale.
Parameters
string Hash of sale.
params:{
"hashText" : "E056D02E57C7DBDC88E1C120D4BC827772BA7E56E3FDF496DF7D16938AB0A639"
}
Returns
Sale - A Sale object.
result: object - A Sale object.hash: string - Hash of the sale.name: string - Name of the sale.creator: string - Address of the owner of the sale.flags: string - Flags of the sale.startDate: timestamp - Start date of the sale.endDate: timestamp - End date of the sale.sellSymbol: string - Symbol Selling.receiveSymbol: string - Symbol Receiving.price: number - Price of the sale.globalSoftCap: string - Global soft cap.globalHardCap: string - Global hard cap.userSoftCap: string - User soft cap.userHardCap: string - User hard cap.
Example
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"getSale","params":{"hashText":"E056D02E57C7DBDC88E1C120D4BC827772BA7E56E3FDF496DF7D16938AB0A639"},"id":1}'
// Result
{
"jsonrpc": "2.0",
"result": {
"hash": "E056D02E57C7DBDC88E1C120D4BC827772BA7E56E3FDF496DF7D16938AB0A639",
"name": "Mankini sale",
"creator": "P2K6Sm1bUYGsFkxuzHPhia1AbANZaHBJV54RgtQi5q8oK34",
"flags": "None",
"startDate": 1615564569,
"endDate": 1615978569,
"sellSymbol": "MKNI",
"receiveSymbol": "SOUL",
"price": 7,
"globalSoftCap": "0",
"globalHardCap": "1000",
"userSoftCap": "1",
"userHardCap": "100"
},
"id": 1
}
