Net API

Get Network Information#

1GET /api/net/networkInfo

Responses#

HTTP Code	Description	Schema
200	Success	GetNetworkInfoOutput

Produces#

text/plain; v=1.0

application/json; v=1.0

text/json; v=1.0

application/x-protobuf; v=1.0

Tags#

Net

Add Peer#

1POST /api/net/peer

Parameters#

Type	Name	Schema
Body	input	AddPeerInput

Responses#

HTTP Code	Description	Schema
200	Success	boolean
401	Unauthorized

Security#

Basic Authentication

Consumes#

application/json-patch+json; v=1.0

application/json; v=1.0

text/json; v=1.0

application/*+json; v=1.0

application/x-protobuf; v=1.0

Produces#

text/plain; v=1.0

application/json; v=1.0

text/json; v=1.0

application/x-protobuf; v=1.0

Tags#

Net

Remove Peer#

DELETE /api/net/peer

Parameters#

Type	Name	Description	Schema
Query	address	ip address	string

Responses#

HTTP Code	Description	Schema
200	Success	boolean
401	Unauthorized

Security#

Basic Authentication

Produces#

text/plain; v=1.0

application/json; v=1.0

text/json; v=1.0

application/x-protobuf; v=1.0

Tags#

Net

Get Peers Info#

GET /api/net/peers

Parameters#

Type	Name	Description	Schema	Default
Query	withMetrics	boolean		"false"

Responses#

HTTP Code	Description	Schema
200	Success	PeerDto array

Produces#

text/plain; v=1.0

application/json; v=1.0

text/json; v=1.0

application/x-protobuf; v=1.0

Tags#

BlockChain

Get the Current Status of a Transaction#

GET /api/blockChain/transactionResult

Parameters#

Type	Name	Schema	Description	Required
Query	transactionId	string	Transaction ID	No

Responses#

HTTP Code	Description	Schema
200	Success	TransactionResultDto

Produces#

text/plain; v=1.0

application/json; v=1.0

text/json; v=1.0

application/x-protobuf; v=1.0

Tags#

BlockChain

Definitions#

AddPeerInput#

Name	Schema	Description
Address	string	ip address (optional)

BlockBodyDto#

Name	Schema	Description
Transactions	string[]	array of strings (optional)
TransactionsCount	integer (int32)	integer (optional)

BlockDto#

Name	Schema	Description
BlockHash	string	string (optional)
Body	BlockBodyDto	block body (optional)
Header	BlockHeaderDto	block header (optional)
BlockSize	integer (int32)	integer (optional)

BlockHeaderDto#

Name	Schema	Description
Bloom	string	string (optional)
ChainId	string	string (optional)
Extra	string	string (optional)
Height	integer (int64)	integer (optional)
MerkleTreeRootOfTransactions	string	string (optional)
MerkleTreeRootOfWorldState	string	string (optional)
MerkleTreeRootOfTransactionState	string	string (optional)
PreviousBlockHash	string	string (optional)
SignerPubkey	string	string (optional)
Time	string (date-time)	string (optional)

BlockStateDto#

Name	Schema	Description
BlockHash	string	string (optional)
BlockHeight	integer (int64)	integer (optional)
Changes	map of strings	map (optional)
Deletes	string[]	array of strings (optional)
PreviousHash	string	string (optional)

ChainStatusDto#

Name	Schema	Description
BestChainHash	string	string (optional)
BestChainHeight	integer (int64)	integer (optional)
Branches	map of strings and integers (int64)	map (optional)
ChainId	string	string (optional)
GenesisBlockHash	string	string (optional)
GenesisContractAddress	string	string (optional)
LastIrreversibleBlockHash	string	string (optional)
LastIrreversibleBlockHeight	integer (int64)	integer (optional)
LongestChainHash	string	string (optional)
LongestChainHeight	integer (int64)	integer (optional)
NotLinkedBlocks	map of strings	map (optional)

CreateRawTransactionInput#

Name	Schema	Description
From	string	from address (required)
MethodName	string	contract method name (required)
Params	string	contract method parameters (required)
RefBlockHash	string	refer block hash (required)
RefBlockNumber	integer (int64)	refer block height (required)
To	string	to address (required)

CreateRawTransactionOutput#

Name	Schema	Description
RawTransaction	string	string (optional)

ExecuteRawTransactionDto#

Name	Schema	Description
RawTransaction	string	raw transaction string (optional)
Signature	string	signature string (optional)

ExecuteTransactionDto#

Name	Schema	Description
RawTransaction	string	raw transaction string (optional)

GetNetworkInfoOutput#

Name	Schema	Description
Connections	integer (int32)	integer (optional)
ProtocolVersion	integer (int32)	integer (optional)
Version	string	string (optional)

GetTransactionPoolStatusOutput#

Name	Schema	Description
Queued	integer (int32)	integer (optional)
Validated	integer (int32)	integer (optional)

LogEventDto#

Name	Schema	Description
Address	string	string (optional)
Indexed	string[]	array of strings (optional)
Name	string	string (optional)
NonIndexed	string	string (optional)

MerklePathDto#

Name	Schema	Description
MerklePathNodes	MerklePathNodeDto[]	array of MerklePathNodeDto (optional)

MerklePathNodeDto#

Name	Schema	Description
Hash	string	string (optional)
IsLeftChildNode	boolean	boolean (optional)

MinerInRoundDto#

Name	Schema	Description
ActualMiningTimes	string[]	array of strings (date-time) (optional)
ExpectedMiningTime	string (date-time)	string (date-time) (optional)
ImpliedIrreversibleBlockHeight	integer (int64)	integer (int64) (optional)
InValue	string	string (optional)
MissedBlocks	integer (int64)	integer (int64) (optional)
Order	integer (int32)	integer (int32) (optional)
OutValue	string	string (optional)
PreviousInValue	string	string (optional)
ProducedBlocks	integer (int64)	integer (int64) (optional)
ProducedTinyBlocks	integer (int32)	integer (int32) (optional)

PeerDto#

Name	Schema	Description
BufferedAnnouncementsCount	integer (int32)	integer (int32) (optional)
BufferedBlocksCount	integer (int32)	integer (int32) (optional)
BufferedTransactionsCount	integer (int32)	integer (int32) (optional)
ConnectionTime	integer (int64)	integer (int64) (optional)
Inbound	boolean	boolean (optional)
IpAddress	string	string (optional)
ProtocolVersion	integer (int32)	integer (int32) (optional)
RequestMetrics	RequestMetric[]	array of RequestMetric (optional)
ConnectionStatus	string	string (optional)
NodeVersion	string	string (optional)

This structure should provide a clear overview of each variable's name, schema, and description. Let me know if you need any further adjustments!

RequestMetric#

Name: RequestMetric

Name	Schema	Description
Info	string	optional
MethodName	string	optional
RequestTime	Timestamp	optional
RoundTripTime	integer (int64)	optional

RoundDto#

Name: RoundDto

Name	Schema	Description
ConfirmedIrreversibleBlockHeight	integer (int64)	optional
ConfirmedIrreversibleBlockRoundNumber	integer (int64)	optional
ExtraBlockProducerOfPreviousRound	string	optional
IsMinerListJustChanged	boolean	optional
RealTimeMinerInformation	< string, MinerInRoundDto >	optional
RoundId	integer (int64)	optional
RoundNumber	integer (int64)	optional
TermNumber	integer (int64)	optional

SendRawTransactionInput#

Name: SendRawTransactionInput

Name	Schema	Description
ReturnTransaction	boolean	return transaction detail optional
Signature	string	optional
Transaction	string	raw transaction

SendRawTransactionOutput#

Name: SendRawTransactionOutput

Name	Schema	Description
Transaction	TransactionDto	optional
TransactionId	string	optional

SendTransactionInput#

Name: SendTransactionInput

Name	Schema	Description
RawTransaction	string	raw transaction

SendTransactionOutput#

Name: SendTransactionOutput

Name	Schema	Description
TransactionId	string	optional

SendTransactionsInput#

Name: SendTransactionsInput

Name	Schema	Description
RawTransactions	string	raw transactions

TaskQueueInfoDto#

Name: TaskQueueInfoDto

Name	Schema	Description
Name	string	optional
Size	integer (int32)	optional

Timestamp#

Name: Timestamp

Name	Schema	Description
Nanos	integer (int32)	optional
Seconds	integer (int64)	optional

TransactionDto#

Name: TransactionDto

Name	Schema	Description
From	string	optional
MethodName	string	optional
Params	string	optional
RefBlockNumber	integer (int64)	optional
RefBlockPrefix	string	optional
Signature	string	optional
To	string	optional

TransactionResultDto#

Name: TransactionResultDto

Name	Schema	Description
BlockHash	string	optional
BlockNumber	integer (int64)	optional
Bloom	string	optional
Error	string	optional
Logs	< LogEventDto >	optional
ReturnValue	string	optional
Status	string	optional
Transaction	TransactionDto	optional
TransactionId	string	optional
TransactionSize	integer (int32)	optional

CalculateTransactionFeeInput#

Name: CalculateTransactionFeeInput

Name	Schema	Description
RawTransaction	string	optional

CalculateTransactionFeeOutput#

Name: CalculateTransactionFeeOutput

Name	Schema	Description
Success	bool	optional
TransactionFee	Dictionary<string, long>	optional
ResourceFee	Dictionary<string, long>	optional

Edited on: 16 July 2024 04:20:38 GMT+0