Protected
cachedProtected
configProtected
listenersProtected
pollProtected
processProtected
proxyStatic
Protected
Readonly
DEFAULT_Static
Protected
Readonly
DEFAULT_Static
Protected
Readonly
MAX_Static
Protected
Readonly
NUM_Register a listener to receive daemon notifications.
listener to receive daemon notifications
Check for update.
the result
Download an update.
Optional
path: stringpath to download the update (optional)
the result
Get alternative chains seen by the node.
alternative chains
Protected
getGet a block by hash.
hash of the block to get
with the given hash
Get a block by height.
height of the block to get
with the given height
Get block hashes as a binary request to the daemon.
specify block hashes to fetch; first 10 blocks hash goes sequential, next goes in pow(2,n) offset, like 2, 4, 8, 16, 32, 64 and so on, and the last one is always genesis block
starting height of block hashes to return
requested block hashes
Get a block header by its hash.
hash of the block to get the header of
block's header
Get a block header by its height.
height of the block to get the header of
block's header
Protected
getRetrieves a header by height from the cache or fetches and caches a header range if not already in the cache.
height of the header to retrieve from the cache
maximum height of headers to cache
Get block headers for the given range.
Optional
startHeight: numberstart height lower bound inclusive (optional)
Optional
endHeight: numberend height upper bound inclusive (optional)
for the given range
Get a block template for mining a new block.
address of the wallet to receive miner transactions if block is successfully mined
Optional
reserveSize: numberreserve size (optional)
is a block template for mining a new block
Get blocks by hash.
array of hashes; first 10 blocks hashes goes sequential, next goes in pow(2,n) offset, like 2, 4, 8, 16, 32, 64 and so on, and the last one is always genesis block
start height to get blocks by hash
Optional
prune: boolean = falsespecifies if returned blocks should be pruned (defaults to false) // TODO: test default
retrieved blocks
Get blocks at the given heights.
heights of the blocks to get
are blocks at the given heights
Get blocks in the given height range.
Optional
startHeight: numberstart height lower bound inclusive (optional)
Optional
endHeight: numberend height upper bound inclusive (optional)
are blocks in the given height range
Get blocks in the given height range as chunked requests so that each request is not too big.
Optional
startHeight: numberstart height lower bound inclusive (optional)
Optional
endHeight: numberend height upper bound inclusive (optional)
Optional
maxChunkSize: numbermaximum chunk size in any one request (default 3,000,000 bytes)
blocks in the given height range
Get mining fee estimates per kB.
Optional
graceBlocks: numberTODO
mining fee estimates per kB
Look up information regarding hard fork voting and readiness.
contains hard fork information
Get general information about the state of the node and the network.
is general information about the node and network
Get the spent status of the given key image.
key image hex to get the status of
status of the key image
Get the spent status of each given key image.
are hex key images to get the statuses of
status for each key image
Get known peers including their last known online status.
the daemon's known peers
Get the last block's header.
last block's header
Get the listeners registered with the daemon.
the registered listeners
Protected
getGet a contiguous chunk of blocks starting from a given height up to a maximum height or amount of block data fetched from the blockchain, whichever comes first.
Optional
startHeight: anystart height to retrieve blocks (default 0)
Optional
maxHeight: anymaximum end height to retrieve blocks (default blockchain height)
Optional
maxReqSize: anymaximum amount of block data to fetch from the blockchain in bytes (default 3,000,000 bytes)
are the resulting chunk of blocks
Gets the total emissions and fees from the genesis block to the current height.
height to start computing the miner sum
number of blocks to include in the sum
encapsulates the total emissions and fees since the genesis block
Get the daemon's mining status.
daemon's mining status
Get a histogram of output amounts. For all amounts (possibly filtered by parameters), gives the number of outputs on the chain for that amount. RingCT outputs counts as 0 amount.
Optional
amounts: bigint[]amounts of outputs to make the histogram with
Optional
minCount: numberTODO
Optional
maxCount: numberTODO
Optional
isUnlocked: booleanmakes a histogram with outputs with the specified lock state
Optional
recentCutoff: numberTODO
are entries meeting the parameters
Get outputs identified by a list of output amounts and indices as a binary request.
identify each output by amount and index
identified outputs
Get peers with active incoming or outgoing connections to the node.
the daemon's peers
Get synchronization information.
contains sync information
Get a transaction by hash.
Optional
txHash: stringhash of the transaction to get
specifies if the returned tx should be pruned (defaults to false)
transaction with the given hash or undefined if not found
Get transaction pool statistics.
contains statistics about the transaction pool
Gets the version of the daemon.
the version of the daemon
Prune the blockchain.
specifies to check the pruning (default false)
the prune result
Protected
refreshUnregister a listener to receive daemon notifications.
listener to unregister
Protected
setBan a peer node.
contains information about a node to ban
Ban peers nodes.
specify which peers to ban
Start mining.
address given miner rewards if the daemon mines a block
Optional
numThreads: numbernumber of mining threads to run (default 1)
Optional
isBackground: booleanspecifies if the miner should run in the background or not (default false)
Optional
ignoreBattery: booleanspecifies if the battery state (e.g. on laptop) should be ignored or not (default false)
Submits a transaction to the daemon's pool.
raw transaction hex to submit
specifies if the tx should be relayed (default false, i.e. relay)
contains submission results
Get the header of the next block added to the chain.
header of the next block added to the chain
Static
Protected
checkStatic
connectOptional
username: stringOptional
password: stringStatic
Protected
convertStatic
Protected
convertStatic
Protected
convertStatic
Protected
convertStatic
Protected
convertStatic
Protected
convertStatic
Protected
convertStatic
Protected
convertStatic
Protected
convertStatic
Protected
convertStatic
Protected
convertStatic
Protected
convertStatic
Protected
convertStatic
Protected
convertInitializes sync info from RPC sync info.
rpc map to initialize the sync info from
is sync info initialized from the map
Static
Protected
convertTransfers RPC tx fields to a given MoneroTx without overwriting previous values.
TODO: switch from safe set
RPC map containing transaction fields
MoneroTx to populate with values (optional)
tx - same tx that was passed in or a new one if none given
Static
Protected
convertStatic
Protected
convertStatic
Protected
convertStatic
Protected
convertStatic
Protected
normalizeOptional
username: stringOptional
password: stringStatic
Protected
prefixedStatic
Protected
startGenerated using TypeDoc
Implements a MoneroDaemon as a client of monerod.