hmyapi

README

JSON RPC

JSSDK

FireStack-Lab/Harmony-sdk-core

JSON-RPC methods

Network info related

• net_listening - check if network is connected
• hmy_protocolVersion - check protocol version
• net_version - get network id
• net_peerCount - peer count
• hmy_getNodeMetadata - get node's version, bls key

BlockChain info related

• hmy_gasPrice - return min-gas-price
• hmy_estimateGas - calculating estimate gas using signed bytes
• hmy_blockNumber - get latest block number
• hmy_getBlockByHash - get block by block hash
• hmy_getBlockByNumber
• hmy_getUncleByBlockHashAndIndex - get uncle by block hash and index number
• hmy_getUncleByBlockNumberAndIndex - get uncle by block number and index number
• hmy_getUncleCountByBlockHash - get uncle count by block hash
• hmy_getUncleCountByBlockNumber - get uncle count by block number
• hmy_syncing - Returns an object with data about the sync status
• hmy_coinbase - return coinbase address
• hmy_mining - return if mining client is mining
• hmy_hashrate - return current hash rate for blockchain

Account related

• hmy_getBalance - get balance for account address
• hmy_getTransactionCount - get nonce for account address
• hmy_accounts - return accounts that lives in node

Transactions related

• hmy_getTransactionReceipt - get transaction receipt by given transaction hash
• hmy_sendRawTransaction - send transaction bytes(signed) to blockchain
• hmy_sendTransaction - send transaction object(with signature) to blockchain
• hmy_getBlockTransactionCountByHash - get transaction count of block by block hash
• hmy_getBlockTransactionCountByNumber - get transaction count of block by block number
• hmy_getTransactionByHash - get transaction object of block by block hash
• hmy_getTransactionByBlockHashAndIndex - get transaction object of block by block hash and index number
• hmy_getTransactionByBlockNumberAndIndex - get transaction object of block by block number and index number
• hmy_sign - sign message using node specific sign method.
• hmy_pendingTransactions - returns the pending transactions list.

Contract related

• hmy_call - call contract method
• hmy_getCode - get deployed contract's byte code
• hmy_getStorageAt - get storage position at a given address
• [ ] hmy_getCompilers - DEPRECATED
• [ ] hmy_compileLLL - DEPRECATED
• [ ] hmy_compileSolidity - DEPRECATED
• [ ] hmy_compileSerpent - DEPRECATED

Subscribes

• hmy_getLogs - log subscriber
• hmy_newFilter - creates a filter object, based on filter options
• hmy_newBlockFilter - creates a filter in the node, to notify when a new block arrives
• hmy_newPendingTransactionFilter - creates a filter in the node, to notify when new pending transactions arrive
• hmy_getFilterChanges - polling method for a filter
• hmy_getFilterLogs - returns an array of all logs matching filter with given id.
• hmy_uninstallFilter - uninstalls a filter with given id

Others, not very important for current stage of work

• web3_clientVersion
• web3_sha3
• hmy_getWork
• hmy_submitWork
• hmy_submitHashrate
• hmy_getProof
• db_putString
• db_getString
• db_putHex
• db_getHex

SHH Whisper Protocol

The shh is for the whisper protocol to communicate p2p and broadcast

• shh_post
• shh_version
• shh_newIdentity
• shh_hasIdentity
• shh_newGroup
• shh_addToGroup
• shh_newFilter
• shh_uninstallFilter
• shh_getFilterChanges
• shh_getMessages

API Versions

• For API V1 you specify 1.0 version in curl
• For API V2 you specify 2.0 version in curl, V2 has output numbers were changed to decimals and also fixed few errors

Documentation

Index

• func GetAPIs(b Backend) []rpc.API
• type Backend

Functions

func GetAPIs

func GetAPIs(b Backend) []rpc.API

GetAPIs returns all the APIs.

Types

type Backend

type Backend interface {
	// NOTE(ricl): this is not in ETH Backend inteface. They put it directly in eth object.
	NetVersion() uint64
	// General Ethereum API
	// Downloader() *downloader.Downloader
	ProtocolVersion() int
	// SuggestPrice(ctx context.Context) (*big.Int, error)
	ChainDb() ethdb.Database
	EventMux() *event.TypeMux
	AccountManager() *accounts.Manager
	// ExtRPCEnabled() bool
	RPCGasCap() *big.Int // global gas cap for hmy_call over rpc: DoS protection
	// BlockChain API
	// SetHead(number uint64)
	HeaderByNumber(ctx context.Context, blockNr rpc.BlockNumber) (*block.Header, error)
	BlockByNumber(ctx context.Context, blockNr rpc.BlockNumber) (*types.Block, error)
	StateAndHeaderByNumber(ctx context.Context, blockNr rpc.BlockNumber) (*state.DB, *block.Header, error)
	GetBlock(ctx context.Context, blockHash common.Hash) (*types.Block, error)
	GetReceipts(ctx context.Context, blockHash common.Hash) (types.Receipts, error)
	// GetTd(blockHash common.Hash) *big.Int
	GetEVM(ctx context.Context, msg core.Message, state *state.DB, header *block.Header) (*vm.EVM, func() error, error)
	SubscribeChainEvent(ch chan<- core.ChainEvent) event.Subscription
	SubscribeChainHeadEvent(ch chan<- core.ChainHeadEvent) event.Subscription
	SubscribeChainSideEvent(ch chan<- core.ChainSideEvent) event.Subscription
	// TxPool API
	SendTx(ctx context.Context, signedTx *types.Transaction) error
	// GetTransaction(ctx context.Context, txHash common.Hash) (*types.Transaction, common.Hash, uint64, uint64, error)
	GetPoolTransactions() (types.Transactions, error)
	GetPoolTransaction(txHash common.Hash) *types.Transaction
	GetPoolNonce(ctx context.Context, addr common.Address) (uint64, error)
	// Stats() (pending int, queued int)
	// TxPoolContent() (map[common.Address]types.Transactions, map[common.Address]types.Transactions)
	SubscribeNewTxsEvent(chan<- core.NewTxsEvent) event.Subscription
	ChainConfig() *params.ChainConfig
	CurrentBlock() *types.Block
	// Get balance
	GetBalance(address common.Address) (*big.Int, error)
	// Get validators for a particular epoch
	GetCommittee(epoch *big.Int) (*shard.Committee, error)
	GetShardID() uint32
	// Get transactions history for an address
	GetTransactionsHistory(address, txType, order string) ([]common.Hash, error)
	// retrieve the blockHash using txID and add blockHash to CxPool for resending
	ResendCx(ctx context.Context, txID common.Hash) (uint64, bool)
	IsLeader() bool
	SendStakingTx(ctx context.Context, newStakingTx *staking.StakingTransaction) error
	GetCurrentTransactionErrorSink() []types.RPCTransactionError
	GetPendingCrossLinks() []*block.Header
	GetPendingCXReceipts() []*types.CXReceiptsProof
}

Backend interface provides the common API services (that are provided by both full and light clients) with access to necessary functions. implementations:

• hmy/api_backend.go