API Documentation¶

ConnectionManager¶

connect()¶

public connect(host: string, name = "main")

Connect to the given connection.

Parameters¶

Return value¶

Connection

disconnect()¶

public disconnect(name?: string)

Disconnect from the given connection.

Parameters¶

Return value¶

void

connection()¶

public connection(name?: string)

Get a connection instance.

Parameters¶

Return value¶

Connection

getDefaultConnection()¶

public getDefaultConnection()

Get the default connection name.

Return value¶

string

setDefaultConnection()¶

public setDefaultConnection(name: string)

Set the default connection name.

Parameters¶

Return value¶

void

getConnections()¶

public getConnections()

Return all of the created connections.

Return value¶

Record<string, Connection>

Connection¶

constructor()¶

public constructor(private readonly host: string)

Create a new Connection class instance.

Parameters¶

api()¶

public api<T = any>(name: string)

Instantiate new Api.

Parameters¶

Return value¶

T

withOptions()¶

public withOptions(opts: Record<string, any>)

Apply options to future connection requests.

Parameters¶

Return value¶

this

get()¶

public async get<T = any>(url: string, opts?: Record<string, any>)

Send a GET request with query parameters.

Parameters¶

Return value¶

Promise<IResponse<T>>

post()¶

public async post<T = any>(url: string, opts?: Record<string, any>): Promise<IResponse<T>>

Send a POST request with JSON-encoded parameters.

Parameters¶

Return value¶

Promise<IResponse<T>>

RequestError¶

constructor()¶

public constructor(error)

Create a new RequestError class instance.

Parameters¶

Resources\Blockchain¶

blockchain()¶

public async blockchain<T = any>(query?: Record<string, any>)

Get all blockchains.

Parameters¶

Return value¶

Promise<IResponse<T>>

search()¶

public async search<T = any>(payload?: Record<string, any>)

Filter all blockchains by the given parameters.

Parameters¶

Return value¶

Promise<IResponse<T>>

Resources\Blocks¶

all()¶

public async all<T = any>(query?: Record<string, any>)

Get all blocks.

Parameters¶

Return value¶

Promise<IResponse<T>>

first()¶

public async first<T = any>(query?: Record<string, any>)

Get the first block.

Parameters¶

Return value¶

Promise<IResponse<T>>

last()¶

public async last<T = any>(query?: Record<string, any>)

Get the last (most recent) block.

Parameters¶

Return value¶

Promise<IResponse<T>>

get()¶

public async get<T = any>(id: string)

Get a block by the given id.

Parameters¶

Return value¶

Promise<IResponse<T>>

transactions()¶

public async transactions<T = any>(id: string, query?: Record<string, any>)

Get all transactions by the given block.

Parameters¶

Return value¶

Promise<IResponse<T>>

missed()¶

public async missed<T = any>(payload?: Record<string, any>)

Shows all the missed blocks by all delegates in the last 30 days

Parameters¶

Return value¶

Promise<IResponse<T>>

Resources\Locks¶

all()¶

public async all<T = any>(query?: Record<string, any>)

Get all locks.

Parameters¶

Return value¶

Promise<IResponse<T>>

get()¶

public async get<T = any>(id: string)

Get a lock by the given id.

Parameters¶

Return value¶

Promise<IResponse<T>>

unlocked()¶

public async unlocked<T = any>(payload?: Record<string, any>)

Search for unlocked locks.

Parameters¶

Return value¶

Promise<IResponse<T>>

Resources\Delegates¶

all()¶

public async all<T = any>(query?: Record<string, any>)

Get all accounts.

Parameters¶

Return value¶

Promise<IResponse<T>>

get()¶

public async get<T = any>(id: string)

Get a delegate by the given id.

Parameters¶

Return value¶

Promise<IResponse<T>>

blocks()¶

public async blocks<T = any>(id: string, query?: Record<string, any>)

Get all blocks for the given delegate.

Parameters¶

Return value¶

Promise<IResponse<T>>

missed()¶

public async missed<T = any>(id: string, query?: Record<string, any>)

List Recent Missed Blocks of a Delegate

Parameters¶

Return value¶

Promise<IResponse<T>>

voters()¶

public async voters<T = any>(id: string, query?: Record<string, any>)

Get all voters for the given delegate.

Parameters¶

Return value¶

Promise<IResponse<T>>

Resources\Node¶

configuration()¶

public async configuration<T = any>()

Get the node configuration.

Return value¶

Promise<IResponse<T>>

status()¶

public async status<T = any>()

Get the node status.

Return value¶

Promise<IResponse<T>>

syncing()¶

public async syncing<T = any>()

Get the node syncing status.

Return value¶

Promise<IResponse<T>>

crypto()¶

public async crypto<T = any>()

Get the node crypto configuration.

Return value¶

Promise<IResponse<T>>

fees()¶

public async fees<T = any>(days: number)

Get the node fee statistics.

Parameters¶

Return value¶

Promise<IResponse<T>>

Resources\Peers¶

all()¶

public async all<T = any>(query?: Record<string, any>)

Get all peers.

Parameters¶

Return value¶

Promise<IResponse<T>>

get()¶

public async get<T = any>(ip: string)

Get a peer by the given IP address.

Parameters¶

Return value¶

Promise<IResponse<T>>

Resources\Rounds¶

delegates()¶

public async delegates<T = any>(id: number)

Get delegates for a round.

Parameters¶

Return value¶

Promise<IResponse<T>>

Resources\Transactions¶

create()¶

public async create<T = any>(payload: object[])

Create a new transaction.

Parameters¶

Return value¶

Promise<IResponse<T>>

get()¶

public async get<T = any>(id: string)

Get a transaction by the given id.

Parameters¶

Return value¶

Promise<IResponse<T>>

all()¶

public async all<T = any>(query?: Record<string, any>)

Get all transactions.

Parameters¶

Return value¶

Promise<IResponse<T>>

allUnconfirmed()¶

public async allUnconfirmed<T = any>(query?: Record<string, any>)

Get all unconfirmed transactions.

Parameters¶

Return value¶

Promise<IResponse<T>>

getUnconfirmed()¶

public async getUnconfirmed<T = any>(id: string)

Get an unconfirmed transaction by the given id.

Parameters¶

Return value¶

Promise<IResponse<T>>

schemas()¶

public async search<T = any>(payload: Record<string, any>)

Get a list of transaction schemas.

Parameters¶

Return value¶

Promise<IResponse<T>>

types()¶

public async types<T = any>()

Get a list of valid transaction types.

Return value¶

Promise<IResponse<T>>

fees()¶

public async fees<T = any>(): Promise<IResponse<T>>

Get the node fee statistics.

Return value¶

Promise<IResponse<T>>

Resources\Votes¶

all()¶

public async all<T = any>(query?: Record<string, any>)

Get all votes.

Parameters¶

Return value¶

Promise<IResponse<T>>

get()¶

public async get<T = any>(id: string)

Get a vote by the given id.

Parameters¶

Return value¶

Promise<IResponse<T>>

Resources\Wallets¶

all()¶

public async all<T = any>(query?: Record<string, any>)

Get all wallets.

Parameters¶

Return value¶

Promise<IResponse<T>>

get()¶

public async get<T = any>(id: string)

Get a wallet by the given id.

Parameters¶

Return value¶

Promise<IResponse<T>>

locks()¶

public async locks<T = any>(id: string, query?: Record<string, any>)

Get a wallet by the given id.

Parameters¶

Return value¶

Promise<IResponse<T>>

transactions()¶

public async transactions<T = any>(id: string, query?: Record<string, any>)

Get all transactions for the given wallet.

Parameters¶

Return value¶

Promise<IResponse<T>>

transactionsReceived()¶

public async transactionsReceived<T = any>(id: string, query?: Record<string, any>)

Get all transactions received by the given wallet.

Parameters¶

Return value¶

Promise<IResponse<T>>

transactionsSent()¶

public async transactionsSent<T = any>(id: string, query?: Record<string, any>)

Get all transactions sent by the given wallet.

Parameters¶

Return value¶

Promise<IResponse<T>>

votes()¶

public async votes<T = any>(id: string)

Get all votes by the given wallet.

Parameters¶

Return value¶

Promise<IResponse<T>>

top()¶

public async top<T = any>(query?: Record<string, any>)

Get all wallets sorted by balance in descending order.

Parameters¶

Return value¶

Promise<IResponse<T>>