Documentation Github

Global

Methods

# OptionsRequest(undefined) → {Promise.<(GetBlockHashesResponse|GetBlockHashesResponseLogicalTimes)>}

getBlockHashes params.options

Parameters:
Name Type Description
undefined GetBlockHashes
Properties:
Name Type Description
noOrphans boolean

Will only include blocks on the main chain
logicalTimes boolean

Will include logical timestamps with hashes

View Source methods/blockchain/blockchain.ts, line 374

Promise.<(GetBlockHashesResponse|GetBlockHashesResponseLogicalTimes)>

# TemplateRequest(undefined) → {Promise.<GetBlockTemplateResponse>}

getBlockTemplate params.template_request

Parameters:
Name Type Description
undefined GetBlockTemplate
Properties:
Name Type Attributes Description
template string <optional>

This must be set to "template", "proposal" (see BIP 23), or omitted
capabilities Array <optional>

A list of strings. Client side supported feature: 'longpoll', 'coinbasetxn', 'coinbasevalue', 'proposal', 'serverlist', 'workid'
rules Array <optional>

A list of strings. Client side supported softfork deployment.

View Source methods/mining/mining.ts, line 259

Promise.<GetBlockTemplateResponse>

Type Definitions

object

# AbandonTransaction

AbandonTransaction

Properties:
Name Type Description
txid string

View Source methods/wallet/types.ts, line 37

object

# AcceptanceTest

AcceptanceTest

Properties:
Name Type Description
txid string

The transaction hash in hex
allowed boolean

If the mempool allows this tx to be inserted
undefined string

Rejection string (only present when 'allowed' is false)

View Source methods/raw-transactions/types.ts, line 341

object

# AddMultisigAddress

AddMultisigAddress

Properties:
Name Type Attributes Description
nrequired number
keys Array
account string <optional>

View Source methods/wallet/types.ts, line 41

object

# AddMultisigAddressResponse

AddMultisigAddressResponse

Properties:
Name Type Description
address string

View Source methods/wallet/types.ts, line 47

object

# AddNode

AddNode

Properties:
Name Type Description
node string
command 'add' | 'remove' | 'onetry'

View Source methods/net/types.ts, line 37

object

# AddWitnessAddress

AddWitnessAddress

Properties:
Name Type Description
address string

View Source methods/wallet/types.ts, line 51

object

# AddWitnessAddressResponse

AddWitnessAddressResponse

Properties:
Name Type Description
witnessaddress string

View Source methods/wallet/types.ts, line 55

object

# BackupWallet

BackupWallet

Properties:
Name Type Description
destination string

View Source methods/wallet/types.ts, line 59

object

# BatchResults

BatchResults

Properties:
Name Type Description
transaction_id string
error_txn_rejected string
total_amount number
fee number
expected_count number
actual_count number

View Source methods/rewards/types.ts, line 59

object

# BumpFee

BumpFee

Properties:
Name Type Description
txid string
options BumpFeeOptions

View Source methods/wallet/types.ts, line 63

object

# BumpFeeOptions

BumpFeeOptions

Properties:
Name Type Attributes Description
confTarget number <optional>

Confirmation target (in blocks)
totalFee number <optional>

Total fee (NOT feerate) To pay, in satoshis. , In rare cases, the actual fee paid might be slightly higher than the specified totalFee if the tx change output has to be removed because it is too close to the dust threshold.
replaceable boolean <optional>

Default = true. Whether the new transaction should still be , marked bip-125 replaceable. If true, the sequence numbers in the transaction will , be left unchanged from the original. If false, any input sequence numbers in the , original transaction that were less than 0xfffffffe will be increased to 0xfffffffe , so the new transaction will not be explicitly bip-125 replaceable (though it may , still be replaceable in practice, for example if it has unconfirmed ancestors which are replaceable).
estimate_mode 'UNSET' | 'ECONOMICAL' | 'CONSERVATIVE' <optional>

Default = UNSET. The fee estimate mode, must be one of:

View Source methods/wallet/types.ts, line 68

object

# BumpFeeResponse

BumpFeeResponse

Properties:
Name Type Description
txid string

The id of the new transaction
origfee number

Fee of the replaced transaction
fee number

Fee of the new transaction
errors Array

Json array of strings. Errors encountered during processing (may be empty)

View Source methods/wallet/types.ts, line 87

object

# CancelSnapshotRequest

CancelSnapshotRequest

Properties:
Name Type Description
asset_name string
block_height number

View Source methods/rewards/types.ts, line 33

object

# CancelSnapshotRequestResponse

CancelSnapshotRequestResponse

Properties:
Name Type Description
request_status string

View Source methods/rewards/types.ts, line 38

object

# CombineRawTransaction

CombineRawTransaction

Properties:
Name Type Description
txs Array

A json array of hex strings of partially signed transactions

View Source methods/raw-transactions/types.ts, line 293

string

# CombineRawTransactionHexstring

CombineRawTransactionHexstring

View Source methods/raw-transactions/types.ts, line 297

object

# CreateMultisig

CreateMultisig

Properties:
Name Type Description
nrequired number
keys Array

View Source methods/misc/types.ts, line 72

object

# CreateMultisigResponse

CreateMultisigResponse

Properties:
Name Type Description
address string

The value of the new multisig address.
redeemScript string

The string value of the hex-encoded redemption script.

View Source methods/misc/types.ts, line 77

object

# CreateRawTransaction

CreateRawTransaction

Properties:
Name Type Attributes Description
inputs Array
outputs Outputs
locktime number <optional>

Default = 0. Raw locktime. Non-0 value also locktime-activates inputs

View Source methods/raw-transactions/types.ts, line 52

object

# DecodeBlock

DecodeBlock

Properties:
Name Type Description
blockhex string

View Source methods/blockchain/types.ts, line 94

object

# DecodeBlockResponse

DecodeBlockResponse

Properties:
Name Type Description
hash string

The block hash (same as provided)
size number

The block size
strippedsize number

The block size excluding witness data
weight number

The block weight as defined in BIP 141
height number

The block height or index
version number

The block version
versionHex string

The block version formatted in hexadecimal
merkleroot string

The merkle root
tx Array

The transaction ids
time number

The block time in seconds since epoch (Jan 1 1970 GMT)
nonce number

The nonce
bits string

The bits

View Source methods/blockchain/types.ts, line 98

object

# DecodeRawTransaction

DecodeRawTransaction

Properties:
Name Type Description
hexstring string

View Source methods/raw-transactions/types.ts, line 209

object

# DecodeRawTransactionResponse

DecodeRawTransactionResponse

Properties:
Name Type Description
txi string

The transaction id
hash string

The transaction hash (differs from txid for witness transactions)
size number

The transaction size
vsize number

The virtual transaction size (differs from size for witness transactions)
version number

The version
locktime number

The lock time
vin Array
vout Array

View Source methods/raw-transactions/types.ts, line 213

object

# DecodeRawTransactionVin

DecodeRawTransactionVin

Properties:
Name Type Attributes Description
txid string

The transaction id
vout number

The output number
scriptSig RawTransactionScriptSig
txinwitness Array <optional>

hex-encoded witness data (if any)
sequence number

The script sequence number

View Source methods/raw-transactions/types.ts, line 224

object

# DecodeRawTransactionVout

DecodeRawTransactionVout

Properties:
Name Type Description
value number

The value in " + CURRENCY_UNIT + "
n number

Index
scriptPubKey DecodeRawTransactionVoutScriptPubKey

View Source methods/raw-transactions/types.ts, line 237

object

# DecodeRawTransactionVoutScriptPubKey

DecodeRawTransactionVoutScriptPubKey

Properties:
Name Type Attributes Description
asm string
hex string
regSigs number

The required sigs
type string

The type, eg 'pubkeyhash'
asset DecodeRawTransactionVoutScriptPubKeyAsset <optional>
addresses Array

View Source methods/raw-transactions/types.ts, line 243

object

# DecodeRawTransactionVoutScriptPubKeyAsset

DecodeRawTransactionVoutScriptPubKeyAsset

Properties:
Name Type Attributes Description
name string

The asset name
amount number

The amount of asset that was sent
message string <optional>

The message if one was sent
expire_time number <optional>

The message epoch expiration time if one was set

View Source methods/raw-transactions/types.ts, line 252

object

# DecodeScript

DecodeScript

Properties:
Name Type Description
hexstring string

View Source methods/raw-transactions/types.ts, line 259

object

# DecodeScriptResponse

DecodeScriptResponse

Properties:
Name Type Attributes Description
asm string

Script public key
hex string

Hex encoded public key
type string

The output type
asset DecodeScriptResponseAsset
addresses Array
p2sh string

Address of P2SH script wrapping this redeem script (not returned if the script is already a P2SH). , The following only appears if the script is an asset script
asset_name string <optional>

Name of the asset.
amount number <optional>

The amount of assets interacted with.
units number <optional>

(new_asset
reissuable boolean <optional>

(new_asset
hasIPFS boolean <optional>

(new_asset
ipfs_hash string <optional>

(new_asset
new_ipfs_hash string <optional>

If new ipfs hash (Only appears in type. (reissue_asset))

View Source methods/raw-transactions/types.ts, line 263

object

# DecodeScriptResponseAsset

DecodeScriptResponseAsset

Properties:
Name Type Attributes Description
name string

The asset name
amount number

The amount of asset that was sent
message string <optional>

The message if one was sent
expire_time number <optional>

The message epoch expiration time if one was set

View Source methods/raw-transactions/types.ts, line 281

object

# DisconnectNode

DisconnectNode

Properties:
Name Type Attributes Description
address string <optional>
nodeid number <optional>

View Source methods/net/types.ts, line 42

object

# DistributeReward

DistributeReward

Properties:
Name Type Description
asset_name string
snapshot_height number
distribution_asset_name string
gross_distribution_amount number
exception_addresses string
change_address string

View Source methods/rewards/types.ts, line 42

object

# DistributeRewardResponse

DistributeRewardResponse

Properties:
Name Type Attributes Description
error_txn_gen_failed string <optional>
error_nsf string <optional>
error_rejects string <optional>
error_db_update string <optional>
batch_results Array <optional>

View Source methods/rewards/types.ts, line 51

object

# DumpPrivKey

DumpPrivKey

Properties:
Name Type Description
address string

View Source methods/wallet/types.ts, line 94

object

# DumpPrivKeyResponse

DumpPrivKeyResponse

Properties:
Name Type Description
key string

The private key

View Source methods/wallet/types.ts, line 98

object

# DumpWallet

DumpWallet

Properties:
Name Type Description
filename string

View Source methods/wallet/types.ts, line 102

object

# DumpWalletResponse

DumpWalletResponse

Properties:
Name Type Description
filename string

View Source methods/wallet/types.ts, line 106

object

# EncryptWallet

EncryptWallet

Properties:
Name Type Description
passphrase string

View Source methods/wallet/types.ts, line 110

object

# EstimateFee

EstimateFee

Properties:
Name Type Description
nblocks number

View Source methods/mining/types.ts, line 116

object

# EstimateRawFee

EstimateRawFee

Properties:
Name Type Attributes Description
conf_target number
threshold number <optional>

View Source methods/mining/types.ts, line 131

object

# EstimateRawFeeResponse

EstimateRawFeeResponse

Properties:
Name Type Attributes Description
short EstimateRawFeeResponseShort <optional>

Estimate for short time horizon
medium any <optional>

Dstimate for medium time horizon
long any

Dstimate for long time horizon

View Source methods/mining/types.ts, line 136

object

# EstimateRawFeeResponseShort

EstimateRawFeeResponseShort

Properties:
Name Type Attributes Description
feerate number <optional>

Estimate fee rate in " + CURRENCY_UNIT + "/kB
decay number

Exponential decay (per block) for historical moving average of confirmation data
scale number

The resolution of confirmation targets at this time horizon
pass EstimateRawFeeResponseShortPass <optional>

Information about the lowest range of feerates to succeed in meeting the threshold
fail any <optional>

Information about the highest range of feerates to fail to meet the threshold
errors Array <optional>

Array of strings. Errors encountered during processing

View Source methods/mining/types.ts, line 142

object

# EstimateRawFeeResponseShortPass

EstimateRawFeeResponseShortPass

Properties:
Name Type Description
startrange number

Start of feerate range
endrange number

End of feerate range
withintarget number

Number of txs over history horizon in the feerate range that were confirmed within target
totalconfirmed number

Number of txs over history horizon in the feerate range that were confirmed at any point
inmempool number

Current number of txs in mempool in the feerate range unconfirmed for at least target blocks
leftmempool number

Number of txs over history horizon in the feerate range that left mempool unconfirmed after target

View Source methods/mining/types.ts, line 151

object

# EstimateSmartFee

EstimateSmartFee

Properties:
Name Type Attributes Description
conf_target number
estimate_mode 'CONSERVATIVE' | 'UNSET' | 'ECONOMICAL' <optional>

View Source methods/mining/types.ts, line 120

object

# EstimateSmartFeeResponse

EstimateSmartFeeResponse

Properties:
Name Type Attributes Description
feerate number <optional>

Estimate fee rate in " + CURRENCY_UNIT + "/kB
errors Array <optional>

Array of strings. Errors encountered during processing
blocks number

Block number where estimate was found

View Source methods/mining/types.ts, line 125

object

# FundRawTransaction

FundRawTransaction

Properties:
Name Type Attributes Description
hexstring string
options FundRawTransactionOptions <optional>

View Source methods/wallet/types.ts, line 4

object

# FundRawTransactionOptions

FundRawTransactionOptions

Properties:
Name Type Attributes Description
changeAddress string <optional>

Default pool address. The avian address to receive the change
changePosition number <optional>

Default random. The index of the change output
includeWatching boolean <optional>

Default false. Also select inputs which are watch only
lockUnspents boolean <optional>

Default false. Lock selected unspent outputs
feeRate number <optional>

Default not set: makes wallet determine the fee) Set a specific fee rate in " + CURRENCY_UNIT + "/kB
subtractFeeFromOutputs Array

A json array of integers. , The fee will be equally deducted from the amount of each specified output. , The outputs are specified by their zero-based index, before any change output is added. , Those recipients will receive less avians than you enter in their corresponding amount field. , If no outputs are specified here, the sender pays the fee. , [vout_index,...]
replaceable boolean <optional>

Marks this transaction as BIP125 replaceable.
conf_target number <optional>

Confirmation target (in blocks)
estimate_mode 'UNSET' | 'ECONOMICAL' | 'CONSERVATIVE'

Default = 'UNSET'. The fee estimate mode, must be one of:

View Source methods/wallet/types.ts, line 9

object

# FundRawTransactionResponse

FundRawTransactionResponse

Properties:
Name Type Description
hex string

The resulting raw transaction (hex-encoded string)
fee number

Fee in " + CURRENCY_UNIT + " the resulting transaction pays
changepos number

The position of the added change output, or -1

View Source methods/wallet/types.ts, line 31

object

# Generate

Generate

Properties:
Name Type Attributes Description
nblocks number
maxtries number <optional>

View Source methods/wallet/types.ts, line 557

object

# GenerateToAddress

GenerateToAddress

Properties:
Name Type Attributes Description
nblocks number
address string
maxtries number <optional>

View Source methods/mining/types.ts, line 110

object

# GetAccount

GetAccount

Properties:
Name Type Description
address string

View Source methods/wallet/types.ts, line 122

object

# GetAccountAddress

GetAccountAddress

Properties:
Name Type Description
account string

View Source methods/wallet/types.ts, line 114

object

# GetAccountAddressResponse

GetAccountAddressResponse

Properties:
Name Type Description
address string

The account avian address

View Source methods/wallet/types.ts, line 118

object

# GetAccountResponse

GetAccountResponse

Properties:
Name Type Description
accountname string

View Source methods/wallet/types.ts, line 126

object

# GetAddedNodeInfo

GetAddedNodeInfo

Properties:
Name Type Attributes Description
node string <optional>

View Source methods/net/types.ts, line 47

object

# GetAddedNodeInfoResponse

GetAddedNodeInfoResponse

Properties:
Name Type Attributes Description
addednode string

The node IP address or name (as provided to addnode)
connected boolean

If connected
addresses Array <optional>

Only when connected = true

View Source methods/net/types.ts, line 51

object

# GetAddedNodeInfoResponseAddress

GetAddedNodeInfoResponseAddress

Properties:
Name Type Description
address string

The avian server IP and port we're connected to
connected string

connection, inbound or outbound

View Source methods/net/types.ts, line 57

object

# GetAddressBalance

GetAddressBalance

Properties:
Name Type Attributes Description
addresses Array
includeAssets boolean <optional>

View Source methods/misc/types.ts, line 152

object

# GetAddressBalanceResponse

GetAddressBalanceResponse

Properties:
Name Type Description
balance string

The current balance in satoshis
received string

The total number of satoshis received (including change)

View Source methods/misc/types.ts, line 157

object

# GetAddressBalanceResponseWithAsset

GetAddressBalanceResponseWithAsset

Properties:
Name Type Description
assetName string

The asset associated with the balance (AVN for Avian)

View Source methods/misc/types.ts, line 162

object

# GetAddressDeltas

GetAddressDeltas

Properties:
Name Type Attributes Description
addresses Array
start number
end number
chainInfo boolean
assetName string <optional>

View Source methods/misc/types.ts, line 129

object

# GetAddressDeltasResponse

GetAddressDeltasResponse

Properties:
Name Type Description
assetName string

The asset associated with the delta (AVN for Avian)
satoshis number

The difference of satoshis
txid string

The related txid
index number

The related input or output index
height number

The block height
address string

The base58check encoded address

View Source methods/misc/types.ts, line 137

object

# GetAddressMempool

GetAddressMempool

Properties:
Name Type Attributes Description
addresses Array

Array of base58check encoded address
includeAssets boolean <optional>

View Source methods/misc/types.ts, line 97

object

# GetAddressMempoolResponse

GetAddressMempoolResponse

Properties:
Name Type Description
address string

The base58check encoded address
assetName string

The name of the associated asset (AVN for Avian)
txid string

The related txid
index number

The related input or output index
satoshis number

The difference of satoshis
timestamp number

The time the transaction entered the mempool (seconds)
prevtxid string

The previous txid (if spending)
prevout string

The previous transaction output index (if spending)

View Source methods/misc/types.ts, line 102

object

# GetAddressTxIds

GetAddressTxIds

Properties:
Name Type Attributes Description
addresses Array
start number <optional>
end number <optional>

View Source methods/misc/types.ts, line 146

object

# GetAddressUtxos

GetAddressUtxos

Properties:
Name Type Attributes Description
addresses Array
chainInfo boolean <optional>
assetName string <optional>

View Source methods/misc/types.ts, line 113

object

# GetAddressUtxosResponse

GetAddressUtxosResponse

Properties:
Name Type Description
address string

The address base58check encoded
assetName string

The asset associated with the UTXOs (AVN for Avian)
txid string

The output txid
height number

The block height
outputIndex number

The output index
script string

The script hex encoded
satoshis number

The number of satoshis of the output

View Source methods/misc/types.ts, line 119

object

# GetAddressesByAccount

GetAddressesByAccount

Properties:
Name Type Description
account string

View Source methods/wallet/types.ts, line 130

object

# GetAddressesByAccountResponse

GetAddressesByAccountResponse

Properties:
Name Type Description
address string

View Source methods/wallet/types.ts, line 134

object

# GetBalance

GetBalance

Properties:
Name Type Attributes Description
account string <optional>
minconf number <optional>
include_watchonly boolean <optional>

View Source methods/wallet/types.ts, line 138

object

# GetBalanceResponse

GetBalanceResponse

Properties:
Name Type Description
account number

View Source methods/wallet/types.ts, line 144

object

# GetBlock

GetBlock

Properties:
Name Type Attributes Description
blockhash string
verbosity number <optional>

View Source methods/blockchain/types.ts, line 60

object

# GetBlockDeltas

GetBlockDeltas

Properties:
Name Type Description
blockhash string

View Source methods/blockchain/types.ts, line 113

object

# GetBlockDeltasResponse

GetBlockDeltasResponse

Properties:
Name Type Attributes Description
hash string
confirmations number
size number
height number
version number
merkleroot string
deltas any
time number
mediantime number
nonce number
bits string
difficulty number
chainwork string
previousblockhash string <optional>
nextblockhash string <optional>

View Source methods/blockchain/types.ts, line 117

object

# GetBlockHash

GetBlockHash

Properties:
Name Type Description
height number

View Source methods/blockchain/types.ts, line 155

object

# GetBlockHashes

GetBlockHashes

Properties:
Name Type Description
high number
low number
options GetBlockHashesOptions

View Source methods/blockchain/types.ts, line 135

object

# GetBlockHashesOptions

GetBlockHashesOptions

Properties:
Name Type Description
noOrphans boolean

Will only include blocks on the main chain
logicalTimes boolean

Will include logical timestamps with hashes

View Source methods/blockchain/types.ts, line 141

object

# GetBlockHashesResponse

GetBlockHashesResponse

Properties:
Name Type Description
hash string

The block hash

View Source methods/blockchain/types.ts, line 146

object

# GetBlockHashesResponseLogicalTimes

GetBlockHashesResponseLogicalTimes

Properties:
Name Type Description
blockhash string

The block hash
logicalts number

The logical timestamp

View Source methods/blockchain/types.ts, line 150

object

# GetBlockHeader

GetBlockHeader

Properties:
Name Type Attributes Description
hash string
verbose boolean <optional>

View Source methods/blockchain/types.ts, line 159

object

# GetBlockHeaderResponseFalse

GetBlockHeaderResponseFalse

Properties:
Name Type Description
data string

A string that is serialized, hex-encoded data for block 'hash'.

View Source methods/blockchain/types.ts, line 164

object

# GetBlockHeaderResponseTrue

GetBlockHeaderResponseTrue

Properties:
Name Type Description
hash string

The block hash (same as provided)
confirmations number

The number of confirmations, or -1 if the block is not on the main chain
height number

The block height or index
version number

The block version
versionHex string

The block version formatted in hexadecimal
merkleroot string

The merkle root
time number

The block time in seconds since epoch (Jan 1 1970 GMT)
mediantime number

The median block time in seconds since epoch (Jan 1 1970 GMT)
nonce number

The nonce
bits string

The bits
difficulty number

The difficulty
chainwork string

Expected number of hashes required to produce the current chain (in hex)
previousblockhash string

The hash of the previous block
nextblockhash string

The hash of the next block

View Source methods/blockchain/types.ts, line 168

object

# GetBlockTemplate

GetBlockTemplate

Properties:
Name Type Attributes Description
template_request GetBlockTemplateTemplateRequest <optional>

View Source methods/mining/types.ts, line 28

object

# GetBlockTemplateResponse

GetBlockTemplateResponse

Properties:
Name Type Attributes Description
capabilities Array <optional>
version number

The preferred block version
rules Array

Specific block rules that are to be enforced
vbavailable object
key: number

number
vbrequired number

Bit mask of versionbits the server requires set in submissions
previousblockhash string

The hash of current highest block
transactions Array

Contents of non-coinbase transactions that should be included in the next block
coinbaseaux object
flags string

Key name is to be ignored, and value included in scriptSig
coinbasevalue number

Maximum allowable input to coinbase transaction, including the generation award and transaction fees (in satoshis)
longpollid string <optional>
coinbasetxn any

Information for coinbase transaction
target string

The hash target
mintime number

The minimum timestamp appropriate for next block time in seconds since epoch (Jan 1 1970 GMT)
mutable Array

A way the block template may be changed, e.g. 'time', 'transactions', 'prevblock'
noncerange string

A range of valid nonces
sigoplimit number

Limit of sigops in blocks
sizelimit number

Limit of block size
weightlimit number

Limit of block weight
curtime number

Current timestamp in seconds since epoch (Jan 1 1970 GMT)
bits string

Compressed target of next block
height number

The height of the next block
default_witness_commitment string <optional>
pprpcheader string <optional>
pprpcepoch number <optional>

View Source methods/mining/types.ts, line 38

object

# GetBlockTemplateResponseTransaction

GetBlockTemplateResponseTransaction

Properties:
Name Type Description
data string

Transaction data encoded in hexadecimal (byte-for-byte)
txid string

Transaction id encoded in little-endian hexadecimal
hash string

Hash encoded in little-endian hexadecimal (including witness data)
depends Array

Transactions before this one (by 1-based index in 'transactions' list) that must be present in the final block if this one is
fee number

Difference in value between transaction inputs and outputs (in satoshis); for coinbase transactions, this is a negative Number of the total collected block fees (ie, not including the block subsidy); if key is not present, fee is unknown and clients MUST NOT assume there isn't one
sigops number

Total SigOps cost, as counted for purposes of block limits; if key is not present, sigop cost is unknown and clients MUST NOT assume it is zero
weight number

Total transaction weight, as counted for purposes of block limits
required boolean

If provided and true, this transaction must be in the final block

View Source methods/mining/types.ts, line 67

object

# GetBlockTemplateTemplateRequest

GetBlockTemplateTemplateRequest

Properties:
Name Type Attributes Description
template string <optional>
capabilities Array <optional>
rules Array <optional>

View Source methods/mining/types.ts, line 32

object

# GetBlockVerbosity0

GetBlockVerbosity0

Properties:
Name Type Description
data string

A string that is serialized, hex-encoded data for block 'hash'.

View Source methods/blockchain/types.ts, line 65

object

# GetBlockVerbosity1

GetBlockVerbosity1

Properties:
Name Type Description
hash string

The block hash (same as provided)
confirmations number

The number of confirmations, or -1 if the block is not on the main chain
size number

The block size
strippedsize number

The block size excluding witness data
weight number

The block weight as defined in BIP 141
height number

The block height or index
version number

The block version
versionHex string

The block version formatted in hexadecimal
merkleroot string

The merkle root
tx Array

The transaction ids
time number

The block time in seconds since epoch (Jan 1 1970 GMT)
mediantime number

The median block time in seconds since epoch (Jan 1 1970 GMT)
nonce number

The nonce
bits string

The bits
difficulty number

The difficulty
chainwork string

Expected number of hashes required to produce the chain up to this block (in hex)
previousblockhash string

The hash of the previous block
nextblockhash string

The hash of the next block

View Source methods/blockchain/types.ts, line 69

object

# GetBlockVerbosity2

GetBlockVerbosity2

Properties:
Name Type Description
tx Array

The transactions in the format of the getrawtransaction RPC. Different from verbosity = 1 "tx" result.

View Source methods/blockchain/types.ts, line 90

object

# GetBlockchainInfoResponse

GetBlockchainInfoResponse

Properties:
Name Type Description
chain string

Current network name as defined in BIP70 (main, test, regtest)
blocks number

The current number of blocks processed in the server
headers number

The current number of headers we have validated
bestblockhash string

The hash of the currently best block
difficulty number

The current difficulty
difficulty_algorithm string

DGW-180 or BTC
mediantime number

Median time for the current best block
verificationprogress number

Estimate of verification progress [0..1]
chainwork string

Total amount of work in active chain, in hexadecimal
size_on_disk number

The estimated size of the block and undo files on disk
pruned boolean

If the blocks are subject to pruning
pruneheight number

Lowest-height complete block stored (only present if pruning is enabled)
automatic_pruning boolean

Whether automatic pruning is enabled (only present if pruning is enabled)
prune_target_size number

The target size used by pruning (only present if automatic pruning is enabled)
softforks Array

Status of softforks in progress
bip9_softforks GetBlockchainInfoResponseBip9SoftFork

Status of BIP9 softforks in progress
warnings string

Any network and blockchain warnings.

View Source methods/blockchain/types.ts, line 4

object

# GetBlockchainInfoResponseBip9SoftFork

GetBlockchainInfoResponseBip9SoftFork

Properties:
Name Type Attributes Description
{...} object
status string

Oone of "defined", "started", "locked_in", "active", "failed"
bit number <optional>

The bit (0-28) in the block version field used to signal this softfork (only for "started" status)
startTime number

The minimum median time past of a block at which the bit gains its meaning
timeout number

The median time past of a block at which the deployment is considered failed if not yet locked in
since number

Height of the first block to which the status applies
statistics object <optional>
statistics.period number

The length in blocks of the BIP9 signalling period
statistics.threshold number

The number of blocks with the version bit set required to activate the feature
statistics.elapsed number

The number of blocks elapsed since the beginning of the current period
statistics.count number

The number of blocks with the version bit set in the current period
statistics.possible number

Returns false if there are not enough blocks left in this period to pass activation threshold

View Source methods/blockchain/types.ts, line 31

object

# GetBlockchainInfoResponseSoftFork

GetBlockchainInfoResponseSoftFork

Properties:
Name Type Description
id string

Name of softfork
version number

Block version
reject object
status boolean

True if threshold reached

View Source methods/blockchain/types.ts, line 24

object

# GetChainTipsResponse

GetChainTipsResponse

Properties:
Name Type Description
height number

Height of the chain tip
hash string

Block hash of the tip
branchlen number

Zero for main chain. Length of branch connecting the tip to the main chain
status 'invalid' | 'headers-only' | 'valid-headers' | 'valid-fork' | 'active'

Status of the chain (active, valid-fork, valid-headers, headers-only, invalid) , invalid - This branch contains at least one invalid block , headers-only - Not all blocks for this branch are available, but the headers are valid , valid-headers - All blocks are available for this branch, but they were never fully validated , valid-fork - This branch is not part of the active chain, but is fully validated , active - This is the tip of the active main chain, which is certainly valid

View Source methods/blockchain/types.ts, line 185

object

# GetChainTxStats

GetChainTxStats

Properties:
Name Type Attributes Description
nblocks number <optional>
blockhash string <optional>

View Source methods/blockchain/types.ts, line 46

object

# GetChainTxStatsResponse

GetChainTxStatsResponse

Properties:
Name Type Description
time number

The timestamp for the final block in the window in UNIX format.
txcount number

The total number of transactions in the chain up to that point.
window_block_count number

Size of the window in number of blocks.
window_tx_count number

The number of transactions in the window. Only returned if "window_block_count" is > 0.
window_interval number

The elapsed time in the window in seconds. Only returned if "window_block_count" is > 0.
txrate number

The average rate of transactions per second in the window. Only returned if "window_interval" is > 0.

View Source methods/blockchain/types.ts, line 51

object

# GetDistributeStatus

GetDistributeStatus

Properties:
Name Type Attributes Description
asset_name string
snapshot_height number
distribution_asset_name string
gross_distribution_amount number
exception_addresses string <optional>

View Source methods/rewards/types.ts, line 68

object

# GetDistributeStatusResponse

GetDistributeStatusResponse

Properties:
Name Type Description
undefined string
Height string
undefined string
undefined number
Status number

View Source methods/rewards/types.ts, line 76

object

# GetInfoResponse

GetInfoResponse

Properties:
Name Type Description
deprecation string

Sarning that the getinfo command is deprecated and will be removed in 0.16
version number

The server version
protocolversion number

The protocol version
walletversion number

The wallet version
balance number

The total Avian balance of the wallet
blocks number

The current number of blocks processed in the server
timeoffset number

The time offset
connections number

The number of connections
proxy string

The proxy used by the server
difficulty number

The current difficulty
testnet boolean

If the server is using testnet or not
keypoololdest number

The timestamp (seconds since Unix epoch) of the oldest pre-generated key in the key pool
keypoolsize number

How many new keys are pre-generated
unlocked_until number

The timestamp in seconds since epoch (midnight Jan 1 1970 GMT) that the wallet is unlocked for transfers, or 0 if the wallet is locked
paytxfee number

The transaction fee set in " + CURRENCY_UNIT + "/kB
relayfee number

Minimum relay fee for transactions in " + CURRENCY_UNIT + "/kB
errors string

Any error messages

View Source methods/misc/types.ts, line 4

object

# GetKawpowHash

GetKawpowHash

Properties:
Name Type Attributes Description
header_hash string
mix_hash string
nonce string
height number
target string <optional>

View Source methods/mining/types.ts, line 89

object

# GetKawpowHashResponse

GetKawpowHashResponse

Properties:
Name Type Attributes Description
result boolean
digest string
mix_hash string
info string
meets_target boolean <optional>

View Source methods/mining/types.ts, line 97

object

# GetMasterKeyInfoResponse

GetMasterKeyInfoResponse

Properties:
Name Type Description
bip32_root_private string

Extended master private key
bip32_root_public string

Extended master public key
account_derivation_path string

The derivation path to the account public/private keys
account_extended_private_key string

Extended account private key
account_extended_public_key string

Extended account public key,

View Source methods/wallet/types.ts, line 148

object

# GetMemoryInfo

GetMemoryInfo

Properties:
Name Type Description
mode 'stats' | 'mallocinfo'

Determines what kind of information is returned. This argument is optional, the default mode is "stats". ,

, stats - Returns general statistics about memory usage in the daemon. ,

, mallocinfo - Returns an XML string describing low-level heap state (only available if compiled with glibc 2.10+).

View Source methods/misc/types.ts, line 24

object

# GetMemoryInfoResponse

GetMemoryInfoResponse

Properties:
Name Type Description
locked GetMemoryInfoResponseLocked

Information about locked memory manager

View Source methods/misc/types.ts, line 36

object

# GetMemoryInfoResponseLocked

GetMemoryInfoResponseLocked

Properties:
Name Type Description
used number

Number of bytes used
free number

Number of bytes available in current arenas
total number

Total number of bytes managed
locked number

Amount of bytes that succeeded locking. If this number is smaller than total, locking pages failed at some point and key data could be swapped to disk.
chunks_used number

Number allocated chunks
chunks_free number

Number unused chunks

View Source methods/misc/types.ts, line 40

object

# GetMempoolAncestors

GetMempoolAncestors

Properties:
Name Type Attributes Description
txid string
verbose boolean <optional>

View Source methods/blockchain/types.ts, line 202

string

# GetMempoolAncestorsResponseVerboseFalse

GetMempoolAncestorsResponseVerboseFalse

View Source methods/blockchain/types.ts, line 207

object

# GetMempoolAncestorsResponseVerboseTrue

GetMempoolAncestorsResponseVerboseTrue

Properties:
Name Type Description
{...} any

key = transactionid

View Source methods/blockchain/types.ts, line 210

object

# GetMempoolDescendants

GetMempoolDescendants

Properties:
Name Type Attributes Description
txid string
verbose boolean <optional>

View Source methods/blockchain/types.ts, line 214

string

# GetMempoolDescendantsResponseVerboseFalse

GetMempoolDescendantsResponseVerboseFalse

View Source methods/blockchain/types.ts, line 219

object

# GetMempoolDescendantsResponseVerboseTrue

GetMempoolDescendantsResponseVerboseTrue

Properties:
Name Type Description
{...} any

key = transactionid

View Source methods/blockchain/types.ts, line 222

object

# GetMempoolEntry

GetMempoolEntry

Properties:
Name Type Description
txid string

View Source methods/blockchain/types.ts, line 226

object

# GetMempoolInfoResponse

GetMempoolInfoResponse

Properties:
Name Type Description
size number

Current tx count
bytes number

Sum of all virtual transaction sizes as defined in BIP 141. Differs from actual serialized size because witness data is discounted
usage number

Total memory usage for the mempool
maxmempool number

Maximum memory usage for the mempool
mempoolminfee number

Minimum fee rate in " + CURRENCY_UNIT + "/kB for tx to be accepted

View Source methods/blockchain/types.ts, line 230

object

# GetMiningInfoResponse

GetMiningInfoResponse

Properties:
Name Type Attributes Description
blocks number

The current block
currentblockweight number

The last block weight
currentblocktx number

The last block transaction
difficulty number

The current difficulty
networkhashps number

The network hashes per second
hashespersec number

The hashes per second of built-in miner
pooledtx number

The size of the mempool
chain string

current network name as defined in BIP70 (main, test, regtest)
warnings string

any network and blockchain warnings
errors string <optional>

DEPRECATED. Same as warnings. Only shown when aviand is started with -deprecatedrpc=getmininginfo

View Source methods/mining/types.ts, line 9

object

# GetMyWordsResponse

GetMyWordsResponse

Properties:
Name Type Attributes Description
word_list string

A string of words separated by spaces
passphrase string <optional>

Only show if passphrase was used when creating the wallet

View Source methods/wallet/types.ts, line 156

object

# GetNetTotalsresponse

GetNetTotalsresponse

Properties:
Name Type Description
totalbytesrecv number

Total bytes received
totalbytessent number

Total bytes sent
timemillis number

Current UNIX time in milliseconds
uploadtarget GetNetTotalsresponseUploadTarget

View Source methods/net/types.ts, line 62

object

# GetNetTotalsresponseUploadTarget

GetNetTotalsresponseUploadTarget

Properties:
Name Type Description
timeframe number

Length of the measuring timeframe in seconds
target number

Target in bytes
target_reached boolean

True if target is reached
serve_historical_blocks boolean

True if serving historical blocks
bytes_left_in_cycle number

Bytes left in current time cycle
time_left_in_cycle number

Seconds left in current time cycle

View Source methods/net/types.ts, line 69

object

# GetNetworkHashPs

GetNetworkHashPs

Properties:
Name Type Attributes Description
nblocks number <optional>
height number <optional>

View Source methods/mining/types.ts, line 4

object

# GetNetworkInfoResponse

GetNetworkInfoResponse

Properties:
Name Type Attributes Description
version number

The server version
subversion string

Satoshi:x.x.the server subversion string
protocolversion number

The protocol version
localservices string

The services we offer to the network
localrelay boolean

True if transaction relay is requested from peers
timeoffset number

The time offset
connections number

The number of connections
networkactive boolean <optional>

Whether p2p networking is enabled
networks Array

Information per network
relayfee number

Minimum relay fee for transactions in " + CURRENCY_UNIT + "/kB
incrementalfee number

Minimum fee increment for mempool limiting or BIP 125 replacement in " + CURRENCY_UNIT + "/kB
localaddresses Array

List of local addresses
warnings string

Any network and blockchain warnings

View Source methods/net/types.ts, line 78

object

# GetNetworkInfoResponseLocalAddress

GetNetworkInfoResponseLocalAddress

Properties:
Name Type Description
address string

Network address
port number

Network port
score number

Relative score

View Source methods/net/types.ts, line 102

object

# GetNetworkInfoResponseNetwork

GetNetworkInfoResponseNetwork

Properties:
Name Type Description
name string

Network (ipv4, ipv6 or onion)
limited boolean

Is the network limited using -onlynet?
reachable boolean

Is the network reachable?
proxy string

The proxy that is used for this network, or empty if none
proxy_randomize_credentials boolean

Whether randomized credentials are used

View Source methods/net/types.ts, line 94

object

# GetNewAddress

GetNewAddress

Properties:
Name Type Attributes Description
account string <optional>

View Source methods/wallet/types.ts, line 161

object

# GetNewAddressResponse

GetNewAddressResponse

Properties:
Name Type Description
address string

The new avian address

View Source methods/wallet/types.ts, line 165

object

# GetPeerInfoResponse

GetPeerInfoResponse

Properties:
Name Type Description
id number

Peer index
addr string

The IP address and port of the peer
addrbind string

Bind address of the connection to the peer
addrlocal string

Local address as reported by the peer
services string

The services offered
relaytxes boolean

Whether peer has asked us to relay transactions to it
lastsend number

The time in seconds since epoch (Jan 1 1970 GMT) of the last send
lastrecv number

The time in seconds since epoch (Jan 1 1970 GMT) of the last receive
bytessent number

The total bytes sent
bytesrecv number

The total bytes received
conntime number

The connection time in seconds since epoch (Jan 1 1970 GMT)
timeoffset number

The time offset in seconds
pingtime number

Ping time (if available)
minping number

Minimum observed ping time (if any at all)
pingwait number

Ping wait (if non-zero)
version number

The peer version, such as 7001
subver string

The string version
inbound boolean

Inbound (true) or Outbound (false)
addnode boolean

Whether connection was due to addnode/-connect or if it was an automatic/inbound connection
startingheight number

The starting height (block) of the peer
banscore number

The ban score
synced_headers number

The last header we have in common with this peer
synced_blocks number

The last block we have in common with this peer
inflight Array

The heights of blocks we're currently asking from this peer
whitelisted boolean

Whether the peer is whitelisted
bytessent_per_msg object
addr number

The total bytes sent aggregated by message type
bytesrecv_per_msg object
addr number

The total bytes received aggregated by message type

View Source methods/net/types.ts, line 4

object

# GetRawChangeAddressResponse

GetRawChangeAddressResponse

Properties:
Name Type Description
address string

The address

View Source methods/wallet/types.ts, line 169

object

# GetRawMempool

GetRawMempool

Properties:
Name Type Attributes Description
verbose boolean <optional>

View Source methods/blockchain/types.ts, line 238

string

# GetRawMempoolResponseVerboseFalse

GetRawMempoolResponseVerboseFalse

View Source methods/blockchain/types.ts, line 242

object

# GetRawMempoolResponseVerboseTrue

GetRawMempoolResponseVerboseTrue

Properties:
Name Type Description
{...} any

key = transactionid

View Source methods/blockchain/types.ts, line 245

object

# GetRawTransaction

GetRawTransaction

Properties:
Name Type Attributes Description
txid string
verbose boolean <optional>

View Source methods/raw-transactions/types.ts, line 4

object

# GetRawTransactionResponse

GetRawTransactionResponse

Properties:
Name Type Description
hex string

The serialized, hex-encoded data for 'txid'
txid string

The transaction id (same as provided)
hash string

The transaction hash (differs from txid for witness transactions)
size number

The serialized transaction size
vsize number

The virtual transaction size (differs from size for witness transactions)
version number

The version
locktime number

The lock time
vin GetRawTransactionVin
vout GetRawTransactionVout
blockhash string

The block hash
confirmations number

The confirmations
time number

The transaction time in seconds since epoch (Jan 1 1970 GMT)
blocktime number

The block time in seconds since epoch (Jan 1 1970 GMT)

View Source methods/raw-transactions/types.ts, line 9

object

# GetRawTransactionVin

GetRawTransactionVin

Properties:
Name Type Description
txid string

The transaction id
vout number
scriptSig VinScriptSig
sequence number

The script sequence number
txinwitness Array

hex-encoded witness data (if any)

View Source methods/raw-transactions/types.ts, line 25

object

# GetRawTransactionVout

GetRawTransactionVout

Properties:
Name Type Description
value number

The value in " + CURRENCY_UNIT + "
n number

index
scriptPubKey VoutScriptPubKey

View Source methods/raw-transactions/types.ts, line 38

object

# GetReceivedByAccount

GetReceivedByAccount

Properties:
Name Type Attributes Description
account string
minconf number <optional>

View Source methods/wallet/types.ts, line 173

object

# GetReceivedByAccountResponse

GetReceivedByAccountResponse

Properties:
Name Type Description
amount number

The total amount in " + CURRENCY_UNIT + " received for this account.

View Source methods/wallet/types.ts, line 178

object

# GetReceivedByAddress

GetReceivedByAddress

Properties:
Name Type Attributes Description
address string
minconf number <optional>

View Source methods/wallet/types.ts, line 182

object

# GetReceivedByAddressResponse

GetReceivedByAddressResponse

Properties:
Name Type Description
amount number

The total amount in " + CURRENCY_UNIT + " received at this address.

View Source methods/wallet/types.ts, line 187

object

# GetSnapshotRequest

GetSnapshotRequest

Properties:
Name Type Description
asset_name string
block_height number

View Source methods/rewards/types.ts, line 13

object

# GetSnapshotRequestResponse

GetSnapshotRequestResponse

Properties:
Name Type Description
asset_name string
block_height number

View Source methods/rewards/types.ts, line 18

object

# GetSpentInfo

GetSpentInfo

Properties:
Name Type Description
txid string
index number

View Source methods/misc/types.ts, line 166

object

# GetSpentInfoResponse

GetSpentInfoResponse

Properties:
Name Type Description
txid string

The transaction id
index number

The spending input index

View Source methods/misc/types.ts, line 171

object

# GetTransaction

GetTransaction

Properties:
Name Type Attributes Description
txid string
include_watchonly boolean <optional>

View Source methods/wallet/types.ts, line 191

object

# GetTransactionResponse

GetTransactionResponse

Properties:
Name Type Attributes Description
amount number

The transaction amount in " + CURRENCY_UNIT + "
fee number

The amount of the fee in " + CURRENCY_UNIT + ". This is negative and only available for the 'send' category of transactions.
confirmations number

The number of confirmations
blockhash number

The block hash
blockindex number

The index of the transaction in the block that includes it
blocktime number

The time in seconds since epoch (1 Jan 1970 GMT)
txid number

The transaction id.
time number

The transaction time in seconds since epoch (1 Jan 1970 GMT)
timereceived number

The time received in seconds since epoch (1 Jan 1970 GMT)
undefined 'yes' | 'no' | 'unknown'

Whether this transaction could be replaced due to BIP125 (replace-by-fee);
details Array <optional>

May be unknown for unconfirmed transactions not in the mempool
asset_details Array
hex string

Raw data for transaction

View Source methods/wallet/types.ts, line 196

object

# GetTransactionResponseAssetDetails

GetTransactionResponseAssetDetails

Properties:
Name Type Description
asset_type 'new_asset' | 'transfer_asset' | 'reissue_asset'

The type of asset transaction
asset_name string

The name of the asset
amount number

The amount in " + CURRENCY_UNIT + "
address string

The avian address involved in the transaction
vout number

The vout value
category 'send' | 'receive'

The category, either 'send' or 'receive'

View Source methods/wallet/types.ts, line 223

object

# GetTransactionResponseDetails

GetTransactionResponseDetails

Properties:
Name Type Attributes Description
account string <optional>

DEPRECATED. The account name involved in the transaction, can be "" for the default account.
address string

The avian address involved in the transaction
category string

The category, either 'send' or 'receive'
amount number

The amount in " + CURRENCY_UNIT + "
label string

A comment for the address/transaction, if any
vout number

The vout value
fee number

The amount of the fee in " + CURRENCY_UNIT + ". This is negative and only available for the 'send' category of transactions.
abandoned boolean

'true' if the transaction has been abandoned (inputs are respendable). Only available for the 'send' category of transactions.

View Source methods/wallet/types.ts, line 212

object

# GetTxOut

GetTxOut

Properties:
Name Type Attributes Description
txid string
n number
include_mempool boolean <optional>

View Source methods/blockchain/types.ts, line 249

object

# GetTxOutProof

GetTxOutProof

Properties:
Name Type Attributes Description
txids Array

An array of txids to filter , A transaction hash
blockhash string <optional>

If specified, looks for txid in the block with this hash

View Source methods/raw-transactions/types.ts, line 347

object

# GetTxOutProofResponse

GetTxOutProofResponse

Properties:
Name Type Description
data string

View Source methods/raw-transactions/types.ts, line 354

object

# GetTxOutResponse

GetTxOutResponse

Properties:
Name Type Description
bestblock string

The block hash
confirmations number

The number of confirmations
value number

The transaction value in " + CURRENCY_UNIT + "
scriptPubKey GetTxOutResponseScriptPubKey
coinbase boolean

Coinbase or not

View Source methods/blockchain/types.ts, line 255

object

# GetTxOutResponseScriptPubKey

GetTxOutResponseScriptPubKey

Properties:
Name Type Description
asm string

code
hex string

hex
reqSigs number

Number of required signatures
type string

The type, eg pubkeyhash
addresses Array

Array of avian addresses

View Source methods/blockchain/types.ts, line 263

object

# GetWalletInfoResponse

GetWalletInfoResponse

Properties:
Name Type Attributes Description
walletname string

The wallet name
walletversion number

The wallet version
balance number

The total confirmed balance of the wallet in " + CURRENCY_UNIT + "
unconfirmed_balance number

The total unconfirmed balance of the wallet in " + CURRENCY_UNIT + "
immature_balance number

The total immature balance of the wallet in " + CURRENCY_UNIT + "
txcount number

The total number of transactions in the wallet
keypoololdest number

The timestamp (seconds since Unix epoch) of the oldest pre-generated key in the key pool
keypoolsize number

How many new keys are pre-generated (only counts external keys)
keypoolsize_hd_internal number

How many new keys are pre-generated for internal use (used for change outputs, only appears if the wallet is using this feature, otherwise external keys are used)
unlocked_until number

The timestamp in seconds since epoch (midnight Jan 1 1970 GMT) That the wallet is unlocked for transfers, or 0 if the wallet is locked
paytxfee number

The transaction fee configuration, set in " + CURRENCY_UNIT + "/kB
hdseedid string <optional>

The Hash160 of the HD seed (only present when HD is enabled)
hdmasterkeyid string <optional>

Alias for hdseedid retained for backwards-compatibility. Will be removed in V0.18.

View Source methods/wallet/types.ts, line 232

object

# ImportAddress

ImportAddress

Properties:
Name Type Attributes Description
script string
label string <optional>
rescan boolean <optional>
p2sh boolean <optional>

View Source methods/wallet/types.ts, line 295

object

# ImportMulti

ImportMulti

Properties:
Name Type Attributes Description
requests Array
options ImportMultiOptions <optional>

View Source methods/wallet/types.ts, line 248

object

# ImportMultiOptions

ImportMultiOptions

Properties:
Name Type Attributes Description
rescan boolean <optional>

Default = true. Stating if should rescan the blockchain after all imports

View Source methods/wallet/types.ts, line 274

object

# ImportMultiRequests

ImportMultiRequests

Properties:
Name Type Attributes Description
scriptPubKey string

{ "address":"

" } Type of scriptPubKey (string for script, json for address)
timestamp number

Creation time of the key in seconds since epoch (Jan 1 1970 GMT), , or the string "now" to substitute the current synced blockchain time. The timestamp of the oldest , key will determine how far back blockchain rescans need to begin for missing wallet transactions. , "now" can be specified to bypass scanning, for keys which are known to never have been used, and , 0 can be specified to scan the entire blockchain. Blocks up to 2 hours before the earliest key , creation time of all keys being imported by the importmulti call will be scanned.
redeemscript string <optional>

Allowed only if the scriptPubKey is a P2SH address or a P2SH scriptPubKey
pubkeys Array <optional>

Array of strings giving pubkeys that must occur in the output or redeemscript
keys Array <optional>

Array of strings giving private keys whose corresponding public keys must occur in the output or redeemscript
internal boolean <optional>

Default = false. Stating whether matching outputs should be treated as not incoming payments
watchonly boolean <optional>

Default = false. Stating whether matching outputs should be considered watched even when they're not spendable, only allowed if keys are empty
label string <optional>

Label to assign to the address (aka account name, for now), only allowed with internal=false

View Source methods/wallet/types.ts, line 253

object

# ImportMultiResponse

ImportMultiResponse

Properties:
Name Type Attributes Description
success boolean
error object <optional>
code number
message string

View Source methods/wallet/types.ts, line 278

object

# ImportPrivKey

ImportPrivKey

Properties:
Name Type Attributes Description
privkey string
label string <optional>
rescan boolean <optional>

View Source methods/wallet/types.ts, line 285

object

# ImportPrunedFunds

ImportPrunedFunds

Properties:
Name Type Description
rawtransaction string
txoutproof string

View Source methods/wallet/types.ts, line 302

object

# ImportPubKey

ImportPubKey

Properties:
Name Type Attributes Description
pubkey string
label string <optional>
rescan boolean <optional>

View Source methods/wallet/types.ts, line 307

object

# ImportWallet

ImportWallet

Properties:
Name Type Description
filename string

View Source methods/wallet/types.ts, line 291

object

# Input

Input

Properties:
Name Type Attributes Description
txid string

The transaction id
vout number

The output number
sequence number <optional>

The sequence number

View Source methods/raw-transactions/types.ts, line 58

object

# InvalidateBlock

InvalidateBlock

Properties:
Name Type Description
blockhash string

View Source methods/blockchain/types.ts, line 295

object

# KeypoolRefill

KeypoolRefill

Properties:
Name Type Attributes Description
newsize number <optional>

View Source methods/wallet/types.ts, line 313

object

# ListAccounts

ListAccounts

Properties:
Name Type Attributes Description
minconf number <optional>
include_watchonly boolean <optional>

View Source methods/wallet/types.ts, line 317

object

# ListAccountsResponse

ListAccountsResponse

Properties:
Name Type Description
{...} number

The property name is the account name, and the value is the total balance for the account.

View Source methods/wallet/types.ts, line 322

object

# ListAddressGroupingsResponse

ListAddressGroupingsResponse

Properties:
Name Type Description
{...} number | string

The avian address and the amount in " + CURRENCY_UNIT + " OR DEPRECATED. The account

View Source methods/wallet/types.ts, line 326

object

# ListBannedResponse

ListBannedResponse

Properties:
Name Type Description
address string
banned_until number
ban_created number
ban_reason string

View Source methods/net/types.ts, line 115

object

# ListLockUnspentResponse

ListLockUnspentResponse

Properties:
Name Type Description
txid string

The transaction id locked
vout number

The vout value

View Source methods/wallet/types.ts, line 330

object

# ListReceivedByAccount

ListReceivedByAccount

Properties:
Name Type Attributes Description
minconf number <optional>
include_empty boolean <optional>
include_watchonly boolean <optional>

View Source methods/wallet/types.ts, line 335

object

# ListReceivedByAccountResponse

ListReceivedByAccountResponse

Properties:
Name Type Description
involvesWatchonly boolean

Only returned if imported addresses were involved in transaction
account string

The account name of the receiving account
amount number

The total amount received by addresses with this account
confirmations number

The number of confirmations of the most recent transaction included
label string

A comment for the address/transaction, if any

View Source methods/wallet/types.ts, line 341

object

# ListReceivedByAddress

ListReceivedByAddress

Properties:
Name Type Attributes Description
minconf number <optional>
include_empty boolean <optional>
include_watchonly boolean <optional>

View Source methods/wallet/types.ts, line 349

object

# ListReceivedByAddressResponse

ListReceivedByAddressResponse

Properties:
Name Type Attributes Description
involvesWatchonly boolean

Only returned if imported addresses were involved in transaction
address string

The receiving address
account string <optional>

DEPRECATED. The account of the receiving address. The default account is "".
amount number

The total amount in " + CURRENCY_UNIT + " received by the address
confirmations number

The number of confirmations of the most recent transaction included
label string

A comment for the address/transaction, if any
txids Array

Array of transaction ids received with the address

View Source methods/wallet/types.ts, line 355

object

# ListSinceBlock

ListSinceBlock

Properties:
Name Type Attributes Description
blockhash string <optional>
target_confirmations number <optional>
include_watchonly boolean <optional>
include_removed boolean <optional>

View Source methods/wallet/types.ts, line 365

object

# ListSinceBlockResponse

ListSinceBlockResponse

Properties:
Name Type Description
transactions Array
removed Array

<structure is the same as "transactions" above, only present if include_removed=true>. Note: transactions that were readded in the active chain will appear as-is in this array, and may thus have a positive confirmation count.
lastblock string

The hash of the block (target_confirmations-1) from the best block on the main chain. This is typically used to feed back into listsinceblock the next time you call it. So you would generally use a target_confirmations of say 6, so you will be continually re-notified of transactions until they've reached 6 confirmations plus any new ones

View Source methods/wallet/types.ts, line 372

object

# ListSinceBlockResponseTransaction

ListSinceBlockResponseTransaction

Properties:
Name Type Attributes Description
account string <optional>

DEPRECATED. The account name associated with the transaction. Will be "" for the default account.
address string

The avian address of the transaction. Not present for move transactions (category = move).
category string

The transaction category. 'send' has negative amounts, 'receive' has positive amounts.
amount number

The amount in " + CURRENCY_UNIT + ". This is negative for the 'send' category, and for the 'move' category for moves outbound. It is positive for the 'receive' category, and for the 'move' category for inbound funds.
vout number

The vout value
fee number

The amount of the fee in " + CURRENCY_UNIT + ". This is negative and only available for the 'send' category of transactions.
confirmations number

The number of confirmations for the transaction. Available for 'send' and 'receive' category of transactions. When it's < 0, it means the transaction conflicted that many blocks ago.
blockhash number

The block hash containing the transaction. Available for 'send' and 'receive' category of transactions.
blockindex number

The index of the transaction in the block that includes it. Available for 'send' and 'receive' category of transactions.
blocktime number

The block time in seconds since epoch (1 Jan 1970 GMT).
txid string

The transaction id. Available for 'send' and 'receive' category of transactions.
time number

The transaction time in seconds since epoch (Jan 1 1970 GMT).
timereceived number

The time received in seconds since epoch (Jan 1 1970 GMT). Available for 'send' and 'receive' category of transactions.
undefined 'yes' | 'no' | 'unknown'

Whether this transaction could be replaced due to BIP125 (replace-by-fee); may be unknown for unconfirmed transactions not in the mempool
abandoned boolean

'true' if the transaction has been abandoned (inputs are respendable). Only available for the 'send' category of transactions.
comment string

If a comment is associated with the transaction.
label string

A comment for the address/transaction, if any
to string

If a comment to is associated with the transaction.

View Source methods/wallet/types.ts, line 378

object

# ListSnapshotRequests

ListSnapshotRequests

Properties:
Name Type Attributes Description
asset_name string <optional>
block_height number <optional>

View Source methods/rewards/types.ts, line 23

object

# ListSnapshotRequestsResponse

ListSnapshotRequestsResponse

Properties:
Name Type Description
asset_name string
block_height number

View Source methods/rewards/types.ts, line 28

object

# ListTransactions

ListTransactions

Properties:
Name Type Attributes Description
account string <optional>
count number <optional>
skip number <optional>
include_watchonly boolean <optional>

View Source methods/wallet/types.ts, line 399

object

# ListTransactionsResponse

ListTransactionsResponse

Properties:
Name Type Attributes Description
account string <optional>

DEPRECATED. The account name associated with the transaction. It will be "" for the default account.
address string

The avian address of the transaction. Not present for move transactions (category = move).
category string

The transaction category. 'move' is a local (off blockchain) Transaction between accounts, and not associated with an address, transaction id or block. 'send' and 'receive' transactions are associated with an address, transaction id and block details
amount number

The amount in " + CURRENCY_UNIT + ". This is negative for the 'send' category, and for the 'move' category for moves outbound. It is positive for the 'receive' category, and for the 'move' category for inbound funds.
label string

A comment for the address/transaction, if any
vout number

The vout value
fee number

The amount of the fee in " + CURRENCY_UNIT + ". This is negative and only available for the 'send' category of transactions.
confirmations number

The number of confirmations for the transaction. Available for 'send' and 'receive' category of transactions. Negative confirmations indicate the transaction conflicts with the block chain
trusted boolean

Whether we consider the outputs of this unconfirmed transaction safe to spend.
blockhash number

The block hash containing the transaction. Available for 'send' and 'receive' category of transactions.
blockindex number

The index of the transaction in the block that includes it. Available for 'send' and 'receive' category of transactions.
blocktime number

The block time in seconds since epoch (1 Jan 1970 GMT).
txid number

The transaction id. Available for 'send' and 'receive' category of transactions.
time number

The transaction time in seconds since epoch (midnight Jan 1 1970 GMT).
timereceived number

The time received in seconds since epoch (midnight Jan 1 1970 GMT). Available for 'send' and 'receive' category of transactions.
comment string

If a comment is associated with the transaction.
otheraccount string <optional>

DEPRECATED. For the 'move' category of transactions, the account the funds came from (for receiving funds, positive amounts), or went to (for sending funds, negative amounts).
undefined 'yes' | 'no' | 'unknown'

Whether this transaction could be replaced due to BIP125 (replace-by-fee); may be unknown for unconfirmed transactions not in the mempool
abandoned boolean

'true' if the transaction has been abandoned (inputs are respendable). Only available for the 'send' category of transactions.

View Source methods/wallet/types.ts, line 406

object

# ListUnspent

ListUnspent

Properties:
Name Type Attributes Description
minconf number <optional>
maxconf number <optional>
addresses Array
include_unsafe boolean <optional>
query_options ListUnspentQueryOptions <optional>

View Source methods/wallet/types.ts, line 428

object

# ListUnspentQueryOptions

ListUnspentQueryOptions

Properties:
Name Type Description
minimumAmount string | number

Default = 0. Minimum value of each UTXO in " + CURRENCY_UNIT + "
maximumAmount string | number

Default = unlimited. Maximum value of each UTXO in " + CURRENCY_UNIT + "
maximumCount string | number

Default = unlimited. Maximum number of UTXOs
minimumSumAmount string | number

Default = unlimited. Minimum sum value of all UTXOs in " + CURRENCY_UNIT + "

View Source methods/wallet/types.ts, line 436

object

# ListUnspentResponse

ListUnspentResponse

Properties:
Name Type Attributes Description
txid string

The transaction id
vout number

The vout value
address string

The avian address
account string <optional>

DEPRECATED. The associated account, or "" for the default account
scriptPubKey string

The script key
amount number

The transaction output amount in " + CURRENCY_UNIT + "
confirmations number

The number of confirmations
redeemScript string

The redeemScript if scriptPubKey is P2SH
spendable boolean

Whether we have the private keys to spend this output
solvable boolean

Whether we know how to spend this output, ignoring the lack of keys
safe boolean

Whether this output is considered safe to spend. Unconfirmed transactions from outside keys and unconfirmed replacement transactions are considered unsafe and are not eligible for spending by fundrawtransaction and sendtoaddress.

View Source methods/wallet/types.ts, line 443

object

# LockUnspent

LockUnspent

Properties:
Name Type Description
unlock boolean
transactions Array

View Source methods/wallet/types.ts, line 457

object

# LockUnspentTransaction

LockUnspentTransaction

Properties:
Name Type Description
txid string

The transaction id
vout number

The output number

View Source methods/wallet/types.ts, line 462

object

# MoveCmd

MoveCmd

Properties:
Name Type Attributes Description
fromaccount string
toaccount string
amount number
dummy number <optional>
comment string <optional>

View Source methods/wallet/types.ts, line 467

Object

# OptionsRequest

getBlockHashes params.options

Properties:
Name Type Description
noOrphans boolean

Will only include blocks on the main chain
logicalTimes boolean

Will include logical timestamps with hashes

View Source methods/blockchain/blockchain.ts, line 85

object

# OutputFreezeAddresses

OutputFreezeAddresses A json object describing addresses to be frozen. The address in the key will used as the owner change address.

Properties:
Name Type Description
asset_name string

A restricted asset name (starts with ')
addresses Array

The addresses to be frozen (up to 10)

View Source methods/raw-transactions/types.ts, line 183

object

# OutputFreezeAsset

OutputFreezeAsset A json object describing an asset to be frozen. The address in the key will used as the owner change address.

Properties:
Name Type Description
asset_name string

A restricted asset name (starts with ')

View Source methods/raw-transactions/types.ts, line 197

object

# OutputIssue

Properties:
Name Type Attributes Description
asset_name string

New asset name
asset_quantity number

The number of raw units to issue
units number

Display units, between 1 (integral) to 8 (max precision)
reissuable number

[0-1] 1=reissuable asset
has_ipfs number

[0-1] 1=passing ipfs_hash
ipfs_hash string <optional>

An ipfs hash for discovering asset metadata

View Source methods/raw-transactions/types.ts, line 103

object

# OutputIssueQualifier

OutputIssueQualifier A json object describing a new qualifier to issue.

Properties:
Name Type Attributes Description
asset_name string

A qualifier name (starts with '#')
asset_quantity number <optional>

Default = 1. The number of units to be issued (1 to 10)
has_ipfs boolean <optional>

Default = false. Whether ifps hash is going to be added to the asset
ipfs_hash string <optional>

Optional but required if has_ipfs = 1. An ipfs hash or a txid hash once RIP5 is activated
root_change_address string <optional>

Only applies when issuing subqualifiers. The address where the root qualifier will be sent. If not specified, it will be sent to the output address.
change_quantity number <optional>

Default = 1. The asset change amount

View Source methods/raw-transactions/types.ts, line 156

object

# OutputIssueRestricted

OutputIssueRestricted A json object describing how restricted asset to issue

Properties:
Name Type Attributes Description
asset_name string

New asset name
asset_quantity number

The number of raw units to issue
verifier_string string

The verifier string to be used for a restricted asset transfer verification
units number

[0-8] Display units, between 0 (integral) and 8 (max precision)
reissuable number

[0-1] 1=reissuable asset
has_ipfs number

[0-1] 1=passing ipfs_hash
ipfs_hash string <optional>

An ipfs hash for discovering asset metadata
owner_change_address string <optional>

The address where the owner token will be sent to. If not given, it will be sent to the output address.

View Source methods/raw-transactions/types.ts, line 132

object

# OutputIssueUnique

OutputIssueUnique A json object describing new unique assets to issue

Properties:
Name Type Attributes Description
root_name string

Name of the asset the unique asset(s)
asset_tags Array

The unique tag for each asset which is to be issued.
ipfs_hashes Array <optional>

Ipfs hashes corresponding to each supplied tag. Should be same size as asset_tags.

View Source methods/raw-transactions/types.ts, line 114

object

# OutputReissue

OutputReissue A json object describing follow-on asset issue

Properties:
Name Type Attributes Description
asset_name string

Name of asset to be reissued
asset_quantity number

The number of raw units to issue
reissuable number <optional>

[0-1] Default is 1, 1=reissuable asset
ipfs_hash string <optional>

An ipfs hash for discovering asset metadata. Overrides the current ipfs hash if given
owner_change_address string <optional>

The address where the owner token will be sent to. If not given, it will be sent to the output address.

View Source methods/raw-transactions/types.ts, line 122

object

# OutputReissueRestricted

OutputReissueRestricted A json object describing follow-on asset issue

Properties:
Name Type Attributes Description
asset_name string

Name of asset to be reissued
asset_quantity number

The number of raw units to issue
reissuable number <optional>

[0-1] Default is 1, 1=reissuable asset
verifier_string string <optional>

The verifier string to be used for a restricted asset transfer verification
ipfs_hash string <optional>

An ipfs hash for discovering asset metadata. Overrides the current ipfs hash if given
owner_change_address string <optional>

The address where the owner token will be sent to. If not given, it will be sent to the output address

View Source methods/raw-transactions/types.ts, line 145

object

# OutputTagAddresses

OutputTagAddresses A json object describing addresses to be tagged. The address in the key will used as the asset change address.

Properties:
Name Type Attributes Description
qualifier string

A qualifier name (starts with '#')
addresses Array

The addresses to be tagged (up to 10)
change_quantity number <optional>

Defaut = 1. The asset change amount

View Source methods/raw-transactions/types.ts, line 167

object

# OutputTransfer

Properties:
Name Type Description
{...} string | number

View Source methods/raw-transactions/types.ts, line 87

object

# OutputTransferWithMessage

OutputTransferWithMessage A json object of describing the transfer and message contents to send

Properties:
Name Type Description
message string

ipfs hash or a txid hash
expire_time number

utc time in seconds to expire the message

View Source methods/raw-transactions/types.ts, line 96

object

# OutputUnfreezeAddresses

OutputUnfreezeAddresses A json object describing addresses to be frozen. The address in the key will be used as the owner change address

Properties:
Name Type Description
asset_name string

A restricted asset name (starts with ')
addresses Array

The addresses to be unfrozen (up to 10)

View Source methods/raw-transactions/types.ts, line 190

object

# OutputUnfreezeAsset

Properties:
Name Type Description
asset_name string

A restricted asset name (starts with ')

View Source methods/raw-transactions/types.ts, line 203

object

# OutputUntagAddresses

OutputUntagAddresses A json object describing addresses to be untagged. The address in the key will be used as the asset change address.

Properties:
Name Type Attributes Description
qualifier string

A qualifier name (starts with '#')
addresses Array

The addresses to be untagged (up to 10)
change_quantity number <optional>

Defaut = 1. The asset change amount

View Source methods/raw-transactions/types.ts, line 175

object

# Outputs

Outputs

Properties:
Name Type Attributes Description
{...} any

The destination avian address. Each output must have a different address. , The AVN amount , e.g. key => 'mjaX9GvK94RuHDHNBnhnyGGKXK1WKjq2Vs': 0.001
transfer OutputTransfer <optional>
transferwithmessage OutputTransferWithMessage <optional>
issue OutputIssue <optional>
issue_unique OutputIssueUnique <optional>
reissue OutputReissue <optional>
issue_restricted OutputIssueRestricted <optional>
reissue_restricted OutputReissueRestricted <optional>
issue_qualifier OutputIssueQualifier <optional>
tag_addresses OutputTagAddresses <optional>
untag_addresses OutputUntagAddresses <optional>
freeze_addresses OutputFreezeAddresses <optional>
unfreeze_addresses OutputUnfreezeAddresses <optional>
freeze_asset OutputFreezeAsset <optional>
unfreeze_asset OutputUnfreezeAsset <optional>
data string <optional>

Hex encoded data

View Source methods/raw-transactions/types.ts, line 64

object

# Pprpcsb

Pprpcsb

Properties:
Name Type Description
header_hash string
mix_hash string
nonce string

View Source methods/mining/types.ts, line 83

object

# PreciousBlock

PreciousBlock

Properties:
Name Type Description
blockhash string

View Source methods/blockchain/types.ts, line 291

object

# PrioritiseTransaction

PrioritiseTransaction

Properties:
Name Type Attributes Description
txid string
dummy number <optional>
fee_delta number

View Source methods/mining/types.ts, line 22

object

# PruneBlockchain

PruneBlockchain

Properties:
Name Type Description
height number

View Source methods/blockchain/types.ts, line 282

object

# RawTransactionScriptSig

RawTransactionScriptSig

Properties:
Name Type Description
asm string
hex string

View Source methods/raw-transactions/types.ts, line 232

object

# ReconsiderBlock

ReconsiderBlock

Properties:
Name Type Description
blockhash string

View Source methods/blockchain/types.ts, line 299

object

# RemovePrunedFunds

RemovePrunedFunds

Properties:
Name Type Description
txid string

View Source methods/wallet/types.ts, line 543

object

# RequestSnapshot

RequestSnapshot

Properties:
Name Type Description
asset_name string
block_height number

View Source methods/rewards/types.ts, line 4

object

# RequestSnapshotResponse

RequestSnapshotResponse

Properties:
Name Type Description
request_status string

View Source methods/rewards/types.ts, line 9

object

# RescanBlockchain

RescanBlockchain

Properties:
Name Type Attributes Description
start_height number <optional>
stop_height number <optional>

View Source methods/wallet/types.ts, line 547

object

# RescanBlockchainResponse

RescanBlockchainResponse

Properties:
Name Type Description
start_height number

The block height where the rescan has started. If omitted, rescan started from the genesis block.
stop_height number

The height of the last rescanned block. If omitted, rescan stopped at the chain tip.

View Source methods/wallet/types.ts, line 552

object

# SendFrom

SendFrom

Properties:
Name Type Attributes Description
fromaccount string
toaddress string
amount string | number
minconf number <optional>
comment string <optional>
comment_to string <optional>

View Source methods/wallet/types.ts, line 475

object

# SendFromAddress

SendFromAddress

Properties:
Name Type Attributes Description
from_address string
to_address string
amount number | string
comment string <optional>
comment_to string <optional>
subtractfeefromamount boolean <optional>
conf_target number <optional>
estimate_mode string <optional>

View Source methods/wallet/types.ts, line 508

object

# SendMany

SendMany

Properties:
Name Type Attributes Description
fromaccount string
amounts SendManyAmounts
minconf number <optional>
comment string <optional>
subtractfeefrom Array <optional>
conf_target number <optional>
estimate_mode 'UNSET' | 'ECONOMICAL' | 'CONSERVATIVE'

View Source methods/wallet/types.ts, line 484

object

# SendManyAmounts

SendManyAmounts

Properties:
Name Type Description
{...} string | number

View Source methods/wallet/types.ts, line 494

object

# SendMessage

SendMessage

Properties:
Name Type Attributes Description
channel_name string
ipfs_hash string
expire_time number <optional>

View Source methods/messages/types.ts, line 26

object

# SendRawTransaction

SendRawTransaction

Properties:
Name Type Attributes Description
hexstring string
allowhighfees boolean <optional>

View Source methods/raw-transactions/types.ts, line 288

object

# SendToAddress

SendToAddress

Properties:
Name Type Attributes Description
address string
amount string | number
comment string <optional>
comment_to string <optional>
subtractfeefromamount boolean <optional>
conf_target number <optional>
estimate_mode 'UNSET' | 'ECONOMICAL' | 'CONSERVATIVE' <optional>

View Source methods/wallet/types.ts, line 498

object

# SetAccount

SetAccount

Properties:
Name Type Description
address string
account string

View Source methods/wallet/types.ts, line 519

object

# SetBan

SetBan

Properties:
Name Type Attributes Description
subnet string
command string
bantime number <optional>
absolute boolean <optional>

View Source methods/net/types.ts, line 108

object

# SetGenerate

SetGenerate

Properties:
Name Type Attributes Description
generate boolean
genproclimit number <optional>

View Source methods/mining/types.ts, line 105

object

# SetMockTime

SetMockTime

Properties:
Name Type Description
timestamp number

View Source methods/misc/types.ts, line 176

object

# SetNetworkActive

SetNetworkActive

Properties:
Name Type Description
state boolean

View Source methods/net/types.ts, line 122

object

# SetTxFee

SetTxFee

Properties:
Name Type Description
amount string | number

View Source methods/wallet/types.ts, line 524

object

# SignMessage

SignMessage

Properties:
Name Type Description
address string
message string

View Source methods/wallet/types.ts, line 528

object

# SignMessageWithPrivKey

SignMessageWithPrivKey

Properties:
Name Type Description
privkey string
message string

View Source methods/misc/types.ts, line 88

object

# SignMessageWithPrivKeyResponse

SignMessageWithPrivKeyResponse

Properties:
Name Type Description
signature string

The signature of the message encoded in base 64

View Source methods/misc/types.ts, line 93

object

# SignRawTransaction

SignRawTransaction

Properties:
Name Type Attributes Description
hexstring string

The transaction hex string , An array of previous dependent transaction outputs
prevtxs Array <optional>

Array of json objects, or 'null' if none provided , A json array of base58-encoded private keys for signing
privkeys Array <optional>

Array of strings, or 'null' if none provided. Private key in base58-encoding
sighashtype 'ALL' | 'NONE' | 'SINGLE' | 'ALL|ANYONECANPAY' | 'NONE|ANYONECANPAY' | 'SINGLE|ANYONECANPAY' <optional>

View Source methods/raw-transactions/types.ts, line 300

object

# SignRawTransactionErrors

SignRawTransactionErrors

Properties:
Name Type Description
txid string

The hash of the referenced, previous transaction
vout number

The index of the output to spent and used as input
scriptSig string

The hex-encoded signature script
sequence number

Script sequence number
error string

Verification or signing error related to the input

View Source methods/raw-transactions/types.ts, line 327

object

# SignRawTransactionPrevTxs

SignRawTransactionPrevTxs

Properties:
Name Type Description
txid string

The transaction id
vout number

The output number
scriptPubKey string

Script key
redeemScript string

Redeem script. Required for P2SH or P2WSH.
amount number

The amount spent

View Source methods/raw-transactions/types.ts, line 311

object

# SignRawTransactionResponse

SignRawTransactionResponse

Properties:
Name Type Attributes Description
hex string

The hex-encoded raw transaction with signature(s)
complete boolean

If the transaction has a complete set of signatures , Script verification errors (if there are any)
errors Array <optional>

View Source methods/raw-transactions/types.ts, line 319

object

# SubmitBlock

SubmitBlock

Properties:
Name Type Attributes Description
hexdata string
dummy string <optional>

View Source methods/mining/types.ts, line 78

object

# SubscribeToChannel

SubscribeToChannel

Properties:
Name Type Description
channel_name string

View Source methods/messages/types.ts, line 18

Object

# TemplateRequest

getBlockTemplate params.template_request

Properties:
Name Type Attributes Description
template string <optional>

This must be set to "template", "proposal" (see BIP 23), or omitted
capabilities Array <optional>

A list of strings. Client side supported feature: 'longpoll', 'coinbasetxn', 'coinbasevalue', 'proposal', 'serverlist', 'workid'
rules Array <optional>

A list of strings. Client side supported softfork deployment.

View Source methods/mining/mining.ts, line 51

object

# TestMempoolAccept

TestMempoolAccept

Properties:
Name Type Attributes Description
rawtxs Array

An array of hex strings of raw transactions. Length must be one for now.
allowhighfees boolean <optional>

Default = false. Allow high fees.

View Source methods/raw-transactions/types.ts, line 335

object

# UnsubscribeFromChannel

UnsubscribeFromChannel

Properties:
Name Type Description
channel_name string

View Source methods/messages/types.ts, line 22

object

# ValidateAddress

ValidateAddress

Properties:
Name Type Description
address string

View Source methods/misc/types.ts, line 49

object

# ValidateAddressResponse

ValidateAddressResponse

Properties:
Name Type Attributes Description
isvalid boolean

If the address is valid or not. If not, this is the only property returned.
address string

The avian address validated
scriptPubKey string

The hex encoded scriptPubKey generated by the address
ismin boolean

If the address is yours or not
iswatchonly boolean

If the address is watchonly
isscript boolean

If the key is a script
script string <optional>

The output script type. Possible types: nonstandard, pubkey, pubkeyhash, scripthash, multisig, nulldata, witness_v0_keyhash, witness_v0_scripthash
hex string <optional>

The redeemscript for the p2sh address
addresses Array <optional>

Array of addresses associated with the known redeemscript
sigsrequired number <optional>

Number of signatures required to spend multisig output
pubkey string

The hex value of the raw public key
iscompressed boolean

If the address is compressed
account string

DEPRECATED. The account associated with the address, "" is the default account
timestamp number

The creation time of the key if available in seconds since epoch (Jan 1 1970 GMT)
hdkeypath string <optional>

The HD keypath if the key is HD and available
hdmasterkeyid string <optional>

The Hash160 of the HD master pubkey

View Source methods/misc/types.ts, line 53

object

# VerifyChain

VerifyChain

Properties:
Name Type Attributes Description
checklevel number <optional>
nblocks number <optional>

View Source methods/blockchain/types.ts, line 286

object

# VerifyMessage

VerifyMessage

Properties:
Name Type Description
address string
signature string
message string

View Source methods/misc/types.ts, line 82

object

# VerifyTxOutProof

VerifyTxOutProof

Properties:
Name Type Description
proof string

View Source methods/raw-transactions/types.ts, line 358

object

# VerifyTxOutProofResponse

VerifyTxOutProofResponse

Properties:
Name Type Description
txid Array

View Source methods/raw-transactions/types.ts, line 362

object

# ViewAllMessageChannelsResponse

ViewAllMessageChannelsResponse

Properties:
Name Type Description
undefined string

The asset channel name

View Source methods/messages/types.ts, line 14

object

# ViewAllMessagesResponse

ViewAllMessagesResponse

Properties:
Name Type Attributes Description
undefined string

The name of the asset the message was sent on
Message string

The IPFS hash of the message
Time Date

The time as a date in the format (YY-mm-dd Hour-minute-second)
undefined number

The height of the block the message was included in
Status string

Status of the message (READ, UNREAD, ORPHAN, EXPIRED, SPAM, HIDDEN, ERROR)
undefined Date <optional>

If the message had an expiration date assigned, it will be shown here in the format (YY-mm-dd Hour-minute-second)
undefined Date <optional>

If the message contains an expire date that is too large, the UTC number will be displayed

View Source methods/messages/types.ts, line 4

object

# ViewMyRestrictedAddressesResponse

ViewMyRestrictedAddressesResponse

Properties:
Name Type Attributes Description
Address string

The address that was restricted
undefined string

The asset that the restriction applies to
Restricted Date <optional>

The UTC datetime of the restriction or derestriction in the format (YY-mm-dd HH:MM:SS)). (Only the most recent restriction/derestriction event will be returned for each address)
Derestricted Date <optional>

The UTC datetime of the restriction or derestriction in the format (YY-mm-dd HH:MM:SS)). (Only the most recent restriction/derestriction event will be returned for each address)

View Source methods/messages/types.ts, line 39

object

# ViewMyTaggedAddressesResponse

ViewMyTaggedAddressesResponse

Properties:
Name Type Attributes Description
Address string

The address that was tagged
undefined string

The asset name
Assigned Date <optional>

The UTC datetime of the assignment or removal of the tag in the format (YY-mm-dd HH:MM:SS). (Only the most recent tagging/untagging event will be returned for each address)
Removed Date <optional>

The UTC datetime of the assignment or removal of the tag in the format (YY-mm-dd HH:MM:SS). (Only the most recent tagging/untagging event will be returned for each address)

View Source methods/messages/types.ts, line 32

object

# VinScriptSig

VinScriptSig

Properties:
Name Type Description
asm string

the asm
hex string

the hex

View Source methods/raw-transactions/types.ts, line 33

object

# VoutScriptPubKey

VoutScriptPubKey

Properties:
Name Type Description
asm string

the asm
hex string

the hex
reqSigs number

The required sigs
type string

The type, eg 'pubkeyhash'
addresses string

json array of address strings

View Source methods/raw-transactions/types.ts, line 44

object

# WaitForBlock

WaitForBlock

Properties:
Name Type Attributes Description
blockhash string
timeout number <optional>

View Source methods/blockchain/types.ts, line 312

object

# WaitForBlockHeight

WaitForBlockHeight

Properties:
Name Type Attributes Description
height number
timeout number <optional>

View Source methods/blockchain/types.ts, line 322

object

# WaitForBlockHeightResponse

WaitForBlockHeightResponse

Properties:
Name Type Description
hash string

The blockhash
height number

Block height

View Source methods/blockchain/types.ts, line 327

object

# WaitForBlockResponse

WaitForBlockResponse

Properties:
Name Type Description
hash string

The blockhash
height number

Block height

View Source methods/blockchain/types.ts, line 317

object

# WaitForNewBlock

WaitForNewBlock

Properties:
Name Type Attributes Description
timeout number <optional>

View Source methods/blockchain/types.ts, line 303

object

# WaitForNewBlockResponse

WaitForNewBlockResponse

Properties:
Name Type Description
hash string

The blockhash
height number

Block height

View Source methods/blockchain/types.ts, line 307

object

# WalletPassphrase

WalletPassphrase

Properties:
Name Type Description
passphrase string
timeout number

View Source methods/wallet/types.ts, line 538

object

# WalletPassphraseChange

WalletPassphraseChange

Properties:
Name Type Description
oldpassphrase string
newpassphrase string

View Source methods/wallet/types.ts, line 533

object

# getTxOutSetInfoResponse

getTxOutSetInfoResponse

Properties:
Name Type Description
height number

The current block height (index)
bestblock string

The best block hash hex
transactions number

The number of transactions
txouts number

The number of output transactions
bogosize number

A meaningless metric for UTXO set size
hash_serialized_2 string

The serialized hash
disk_size number

The estimated size of the chainstate on disk
total_amount number

The total amount

View Source methods/blockchain/types.ts, line 271

object

# loggingRequest

loggingRequest

Properties:
Name Type Description
include Array
exclude Array

View Source methods/misc/types.ts, line 180