iota-client 1.4.0

## Classes

<dl>
<dt><a href="#AddressGetter">AddressGetter</a></dt>
<dd></dd>
<dt><a href="#BalanceGetter">BalanceGetter</a></dt>
<dd></dd>
<dt><a href="#Client">Client</a></dt>
<dd></dd>
<dt><a href="#ClientBuilder">ClientBuilder</a></dt>
<dd></dd>
<dt><a href="#GetAddressBuilder">GetAddressBuilder</a></dt>
<dd></dd>
<dt><a href="#MessageBuilder">MessageBuilder</a></dt>
<dd></dd>
<dt><a href="#MessageGetter">MessageGetter</a></dt>
<dd></dd>
<dt><a href="#UnspentAddressGetter">UnspentAddressGetter</a></dt>
<dd></dd>
</dl>

## Functions

<dl>
<dt><a href="#start">start()</a></dt>
<dd><p>Initializes the console error panic hook for better error messages</p>
</dd>
</dl>

<a name="AddressGetter"></a>

## AddressGetter
**Kind**: global class  

* [AddressGetter](#AddressGetter)
    * _instance_
        * [.accountIndex(index)](#AddressGetter+accountIndex) ⇒ [<code>AddressGetter</code>](#AddressGetter)
        * [.range(start, end)](#AddressGetter+range) ⇒ [<code>AddressGetter</code>](#AddressGetter)
        * [.bech32Hrp(bech32_hrp)](#AddressGetter+bech32Hrp) ⇒ [<code>AddressGetter</code>](#AddressGetter)
        * [.includeInternal()](#AddressGetter+includeInternal) ⇒ [<code>AddressGetter</code>](#AddressGetter)
        * [.get()](#AddressGetter+get) ⇒ <code>Promise.&lt;any&gt;</code>
    * _static_
        * [.new(client, seed)](#AddressGetter.new) ⇒ [<code>AddressGetter</code>](#AddressGetter)

<a name="AddressGetter+accountIndex"></a>

### addressGetter.accountIndex(index) ⇒ [<code>AddressGetter</code>](#AddressGetter)
Set the account index

**Kind**: instance method of [<code>AddressGetter</code>](#AddressGetter)  

| Param | Type |
| --- | --- |
| index | <code>number</code> | 

<a name="AddressGetter+range"></a>

### addressGetter.range(start, end) ⇒ [<code>AddressGetter</code>](#AddressGetter)
Set the address range

**Kind**: instance method of [<code>AddressGetter</code>](#AddressGetter)  

| Param | Type |
| --- | --- |
| start | <code>number</code> | 
| end | <code>number</code> | 

<a name="AddressGetter+bech32Hrp"></a>

### addressGetter.bech32Hrp(bech32_hrp) ⇒ [<code>AddressGetter</code>](#AddressGetter)
Set the bech32 hrp

**Kind**: instance method of [<code>AddressGetter</code>](#AddressGetter)  

| Param | Type |
| --- | --- |
| bech32_hrp | <code>string</code> | 

<a name="AddressGetter+includeInternal"></a>

### addressGetter.includeInternal() ⇒ [<code>AddressGetter</code>](#AddressGetter)
Include internal addresses

**Kind**: instance method of [<code>AddressGetter</code>](#AddressGetter)  
<a name="AddressGetter+get"></a>

### addressGetter.get() ⇒ <code>Promise.&lt;any&gt;</code>
Get the addresses.

**Kind**: instance method of [<code>AddressGetter</code>](#AddressGetter)  
<a name="AddressGetter.new"></a>

### AddressGetter.new(client, seed) ⇒ [<code>AddressGetter</code>](#AddressGetter)
**Kind**: static method of [<code>AddressGetter</code>](#AddressGetter)  

| Param | Type |
| --- | --- |
| client | [<code>Client</code>](#Client) | 
| seed | <code>string</code> | 

<a name="BalanceGetter"></a>

## BalanceGetter
**Kind**: global class  

* [BalanceGetter](#BalanceGetter)
    * _instance_
        * [.accountIndex(index)](#BalanceGetter+accountIndex) ⇒ [<code>BalanceGetter</code>](#BalanceGetter)
        * [.initialAddressIndex(initial_address_index)](#BalanceGetter+initialAddressIndex) ⇒ [<code>BalanceGetter</code>](#BalanceGetter)
        * [.gap_limit(gap_limit)](#BalanceGetter+gap_limit) ⇒ [<code>BalanceGetter</code>](#BalanceGetter)
        * [.get()](#BalanceGetter+get) ⇒ <code>Promise.&lt;any&gt;</code>
    * _static_
        * [.new(client, seed)](#BalanceGetter.new) ⇒ [<code>BalanceGetter</code>](#BalanceGetter)

<a name="BalanceGetter+accountIndex"></a>

### balanceGetter.accountIndex(index) ⇒ [<code>BalanceGetter</code>](#BalanceGetter)
Sets the account index

**Kind**: instance method of [<code>BalanceGetter</code>](#BalanceGetter)  

| Param | Type |
| --- | --- |
| index | <code>number</code> | 

<a name="BalanceGetter+initialAddressIndex"></a>

### balanceGetter.initialAddressIndex(initial_address_index) ⇒ [<code>BalanceGetter</code>](#BalanceGetter)
Sets the address index from which to start looking for balance

**Kind**: instance method of [<code>BalanceGetter</code>](#BalanceGetter)  

| Param | Type |
| --- | --- |
| initial_address_index | <code>number</code> | 

<a name="BalanceGetter+gap_limit"></a>

### balanceGetter.gap\_limit(gap_limit) ⇒ [<code>BalanceGetter</code>](#BalanceGetter)
Sets the gap limit to specify how many addresses will be checked each round.
If gap_limit amount of addresses in a row have no balance the function will return.

**Kind**: instance method of [<code>BalanceGetter</code>](#BalanceGetter)  

| Param | Type |
| --- | --- |
| gap_limit | <code>number</code> | 

<a name="BalanceGetter+get"></a>

### balanceGetter.get() ⇒ <code>Promise.&lt;any&gt;</code>
Get the balance.

**Kind**: instance method of [<code>BalanceGetter</code>](#BalanceGetter)  
<a name="BalanceGetter.new"></a>

### BalanceGetter.new(client, seed) ⇒ [<code>BalanceGetter</code>](#BalanceGetter)
**Kind**: static method of [<code>BalanceGetter</code>](#BalanceGetter)  

| Param | Type |
| --- | --- |
| client | [<code>Client</code>](#Client) | 
| seed | <code>string</code> | 

<a name="Client"></a>

## Client
**Kind**: global class  

* [Client](#Client)
    * [.message()](#Client+message) ⇒ [<code>MessageBuilder</code>](#MessageBuilder)
    * [.getMessage()](#Client+getMessage) ⇒ [<code>MessageGetter</code>](#MessageGetter)
    * [.getAddresses(seed)](#Client+getAddresses) ⇒ [<code>AddressGetter</code>](#AddressGetter)
    * [.getUnspentAddress(seed)](#Client+getUnspentAddress) ⇒ [<code>UnspentAddressGetter</code>](#UnspentAddressGetter)
    * [.getBalance(seed)](#Client+getBalance) ⇒ [<code>BalanceGetter</code>](#BalanceGetter)
    * [.getAddress()](#Client+getAddress) ⇒ [<code>GetAddressBuilder</code>](#GetAddressBuilder)
    * [.getInfo()](#Client+getInfo) ⇒ <code>Promise.&lt;any&gt;</code>
    * [.getNodeInfo(url, jwt, username, password)](#Client+getNodeInfo) ⇒ <code>Promise.&lt;any&gt;</code>
    * [.networkInfo()](#Client+networkInfo) ⇒ <code>Promise.&lt;any&gt;</code>
    * [.getNetworkId()](#Client+getNetworkId) ⇒ <code>Promise.&lt;any&gt;</code>
    * [.getBech32Hrp()](#Client+getBech32Hrp) ⇒ <code>Promise.&lt;any&gt;</code>
    * [.getMinPowScore()](#Client+getMinPowScore) ⇒ <code>Promise.&lt;any&gt;</code>
    * [.getHealth()](#Client+getHealth) ⇒ <code>Promise.&lt;any&gt;</code>
    * [.getTips()](#Client+getTips) ⇒ <code>Promise.&lt;any&gt;</code>
    * [.getPeers()](#Client+getPeers) ⇒ <code>Promise.&lt;any&gt;</code>
    * [.getOutput(output_id)](#Client+getOutput) ⇒ <code>Promise.&lt;any&gt;</code>
    * [.findMessages(indexation_keys, message_ids)](#Client+findMessages) ⇒ <code>Promise.&lt;any&gt;</code>
    * [.findInputs(addresses, amount)](#Client+findInputs) ⇒ <code>Promise.&lt;any&gt;</code>
    * [.findOutputs(outputs, addresses)](#Client+findOutputs) ⇒ <code>Promise.&lt;any&gt;</code>
    * [.getAddressBalances(addresses)](#Client+getAddressBalances) ⇒ <code>Promise.&lt;any&gt;</code>
    * [.getMilestone(index)](#Client+getMilestone) ⇒ <code>Promise.&lt;any&gt;</code>
    * [.getMilestoneUtxoChanges(index)](#Client+getMilestoneUtxoChanges) ⇒ <code>Promise.&lt;any&gt;</code>
    * [.getReceipts()](#Client+getReceipts) ⇒ <code>Promise.&lt;any&gt;</code>
    * [.getReceiptsMigratedAt(milestone_index)](#Client+getReceiptsMigratedAt) ⇒ <code>Promise.&lt;any&gt;</code>
    * [.getTreasury()](#Client+getTreasury) ⇒ <code>Promise.&lt;any&gt;</code>
    * [.getIncludedMessage(transaction_id)](#Client+getIncludedMessage) ⇒ <code>Promise.&lt;any&gt;</code>
    * [.postMessage(message)](#Client+postMessage) ⇒ <code>Promise.&lt;any&gt;</code>
    * [.retry(message_id)](#Client+retry) ⇒ <code>Promise.&lt;any&gt;</code>
    * [.retryUntilIncluded(message_id, interval, max_attempts)](#Client+retryUntilIncluded) ⇒ <code>Promise.&lt;any&gt;</code>
    * [.reattach(message_id)](#Client+reattach) ⇒ <code>Promise.&lt;any&gt;</code>
    * [.promote(message_id)](#Client+promote) ⇒ <code>Promise.&lt;any&gt;</code>
    * [.consolidateFunds(seed, account_index, start_index, end_index)](#Client+consolidateFunds) ⇒ <code>Promise.&lt;any&gt;</code>
    * [.bech32ToHex(address)](#Client+bech32ToHex) ⇒ <code>string</code>
    * [.hexToBech32(address, bech32)](#Client+hexToBech32) ⇒ <code>Promise.&lt;any&gt;</code>
    * [.hexPublicKeyToBech32Address(public_key, bech32)](#Client+hexPublicKeyToBech32Address) ⇒ <code>Promise.&lt;any&gt;</code>
    * [.isAddressValid(address)](#Client+isAddressValid) ⇒ <code>boolean</code>
    * [.generateMnemonic()](#Client+generateMnemonic) ⇒ <code>string</code>
    * [.mnemonicToHexSeed(mnemonic)](#Client+mnemonicToHexSeed) ⇒ <code>string</code>
    * [.getMessageId(message)](#Client+getMessageId) ⇒ <code>string</code>
    * [.getTransactionId(transaction)](#Client+getTransactionId) ⇒ <code>string</code>
    * [.getEssenceHash(essence)](#Client+getEssenceHash) ⇒ <code>string</code>

<a name="Client+message"></a>

### client.message() ⇒ [<code>MessageBuilder</code>](#MessageBuilder)
Send a message to the Tangle.

**Kind**: instance method of [<code>Client</code>](#Client)  
<a name="Client+getMessage"></a>

### client.getMessage() ⇒ [<code>MessageGetter</code>](#MessageGetter)
Get a message from the Tangle.

**Kind**: instance method of [<code>Client</code>](#Client)  
<a name="Client+getAddresses"></a>

### client.getAddresses(seed) ⇒ [<code>AddressGetter</code>](#AddressGetter)
Generate addresses.

**Kind**: instance method of [<code>Client</code>](#Client)  

| Param | Type |
| --- | --- |
| seed | <code>string</code> | 

<a name="Client+getUnspentAddress"></a>

### client.getUnspentAddress(seed) ⇒ [<code>UnspentAddressGetter</code>](#UnspentAddressGetter)
Get an unspent address.

**Kind**: instance method of [<code>Client</code>](#Client)  

| Param | Type |
| --- | --- |
| seed | <code>string</code> | 

<a name="Client+getBalance"></a>

### client.getBalance(seed) ⇒ [<code>BalanceGetter</code>](#BalanceGetter)
Get the account balance.

**Kind**: instance method of [<code>Client</code>](#Client)  

| Param | Type |
| --- | --- |
| seed | <code>string</code> | 

<a name="Client+getAddress"></a>

### client.getAddress() ⇒ [<code>GetAddressBuilder</code>](#GetAddressBuilder)
GET /api/v1/addresses/{address} endpoint

**Kind**: instance method of [<code>Client</code>](#Client)  
<a name="Client+getInfo"></a>

### client.getInfo() ⇒ <code>Promise.&lt;any&gt;</code>
Get the nodeinfo.

**Kind**: instance method of [<code>Client</code>](#Client)  
<a name="Client+getNodeInfo"></a>

### client.getNodeInfo(url, jwt, username, password) ⇒ <code>Promise.&lt;any&gt;</code>
Get the nodeinfo.

**Kind**: instance method of [<code>Client</code>](#Client)  

| Param | Type |
| --- | --- |
| url | <code>string</code> | 
| jwt | <code>string</code> \| <code>undefined</code> | 
| username | <code>string</code> \| <code>undefined</code> | 
| password | <code>string</code> \| <code>undefined</code> | 

<a name="Client+networkInfo"></a>

### client.networkInfo() ⇒ <code>Promise.&lt;any&gt;</code>
Gets the network related information such as network_id and min_pow_score
and if it's the default one, sync it first.

**Kind**: instance method of [<code>Client</code>](#Client)  
<a name="Client+getNetworkId"></a>

### client.getNetworkId() ⇒ <code>Promise.&lt;any&gt;</code>
Gets the network id of the node we're connecting to.

**Kind**: instance method of [<code>Client</code>](#Client)  
<a name="Client+getBech32Hrp"></a>

### client.getBech32Hrp() ⇒ <code>Promise.&lt;any&gt;</code>
returns the bech32_hrp

**Kind**: instance method of [<code>Client</code>](#Client)  
<a name="Client+getMinPowScore"></a>

### client.getMinPowScore() ⇒ <code>Promise.&lt;any&gt;</code>
returns the bech32_hrp

**Kind**: instance method of [<code>Client</code>](#Client)  
<a name="Client+getHealth"></a>

### client.getHealth() ⇒ <code>Promise.&lt;any&gt;</code>
Get the node health.

**Kind**: instance method of [<code>Client</code>](#Client)  
<a name="Client+getTips"></a>

### client.getTips() ⇒ <code>Promise.&lt;any&gt;</code>
Get tips.

**Kind**: instance method of [<code>Client</code>](#Client)  
<a name="Client+getPeers"></a>

### client.getPeers() ⇒ <code>Promise.&lt;any&gt;</code>
Get peers.

**Kind**: instance method of [<code>Client</code>](#Client)  
<a name="Client+getOutput"></a>

### client.getOutput(output_id) ⇒ <code>Promise.&lt;any&gt;</code>
GET /api/v1/outputs/{outputId} endpoint
Find an output by its transaction_id and corresponding output_index.

**Kind**: instance method of [<code>Client</code>](#Client)  

| Param | Type |
| --- | --- |
| output_id | <code>string</code> | 

<a name="Client+findMessages"></a>

### client.findMessages(indexation_keys, message_ids) ⇒ <code>Promise.&lt;any&gt;</code>
Find all messages by provided message IDs and/or indexation_keys.

**Kind**: instance method of [<code>Client</code>](#Client)  

| Param | Type |
| --- | --- |
| indexation_keys | <code>any</code> | 
| message_ids | <code>any</code> | 

<a name="Client+findInputs"></a>

### client.findInputs(addresses, amount) ⇒ <code>Promise.&lt;any&gt;</code>
Function to find inputs from addresses for a provided amount (useful for offline signing)

**Kind**: instance method of [<code>Client</code>](#Client)  

| Param | Type |
| --- | --- |
| addresses | <code>any</code> | 
| amount | <code>BigInt</code> | 

<a name="Client+findOutputs"></a>

### client.findOutputs(outputs, addresses) ⇒ <code>Promise.&lt;any&gt;</code>
Find all outputs based on the requests criteria. This method will try to query multiple nodes if
the request amount exceeds individual node limit.

**Kind**: instance method of [<code>Client</code>](#Client)  

| Param | Type |
| --- | --- |
| outputs | <code>any</code> | 
| addresses | <code>any</code> | 

<a name="Client+getAddressBalances"></a>

### client.getAddressBalances(addresses) ⇒ <code>Promise.&lt;any&gt;</code>
Return the balance in iota for the given addresses; No seed needed to do this since we are only checking and
already know the addresses.

**Kind**: instance method of [<code>Client</code>](#Client)  

| Param | Type |
| --- | --- |
| addresses | <code>any</code> | 

<a name="Client+getMilestone"></a>

### client.getMilestone(index) ⇒ <code>Promise.&lt;any&gt;</code>
GET /api/v1/milestones/{index} endpoint
Get the milestone by the given index.

**Kind**: instance method of [<code>Client</code>](#Client)  

| Param | Type |
| --- | --- |
| index | <code>number</code> | 

<a name="Client+getMilestoneUtxoChanges"></a>

### client.getMilestoneUtxoChanges(index) ⇒ <code>Promise.&lt;any&gt;</code>
GET /api/v1/milestones/{index}/utxo-changes endpoint
Get the milestone by the given index.

**Kind**: instance method of [<code>Client</code>](#Client)  

| Param | Type |
| --- | --- |
| index | <code>number</code> | 

<a name="Client+getReceipts"></a>

### client.getReceipts() ⇒ <code>Promise.&lt;any&gt;</code>
GET /api/v1/receipts endpoint
Get all receipts.

**Kind**: instance method of [<code>Client</code>](#Client)  
<a name="Client+getReceiptsMigratedAt"></a>

### client.getReceiptsMigratedAt(milestone_index) ⇒ <code>Promise.&lt;any&gt;</code>
GET /api/v1/receipts/{migratedAt} endpoint
Get the receipts by the given milestone index.

**Kind**: instance method of [<code>Client</code>](#Client)  

| Param | Type |
| --- | --- |
| milestone_index | <code>number</code> | 

<a name="Client+getTreasury"></a>

### client.getTreasury() ⇒ <code>Promise.&lt;any&gt;</code>
GET /api/v1/treasury endpoint
Get the treasury output.

**Kind**: instance method of [<code>Client</code>](#Client)  
<a name="Client+getIncludedMessage"></a>

### client.getIncludedMessage(transaction_id) ⇒ <code>Promise.&lt;any&gt;</code>
GET /api/v1/transactions/{transactionId}/included-message
Returns the included message of the transaction.

**Kind**: instance method of [<code>Client</code>](#Client)  

| Param | Type |
| --- | --- |
| transaction_id | <code>string</code> | 

<a name="Client+postMessage"></a>

### client.postMessage(message) ⇒ <code>Promise.&lt;any&gt;</code>
Post message.

**Kind**: instance method of [<code>Client</code>](#Client)  

| Param | Type |
| --- | --- |
| message | <code>any</code> | 

<a name="Client+retry"></a>

### client.retry(message_id) ⇒ <code>Promise.&lt;any&gt;</code>
Retries (promotes or reattaches) a message for provided message id. Message should only be
retried only if they are valid and haven't been confirmed for a while.

**Kind**: instance method of [<code>Client</code>](#Client)  

| Param | Type |
| --- | --- |
| message_id | <code>string</code> | 

<a name="Client+retryUntilIncluded"></a>

### client.retryUntilIncluded(message_id, interval, max_attempts) ⇒ <code>Promise.&lt;any&gt;</code>
Only works in browser because of the timeouts
Retries (promotes or reattaches) a message for provided message id until it's included (referenced by a
milestone). Default interval is 5 seconds and max attempts is 40. Returns reattached messages

**Kind**: instance method of [<code>Client</code>](#Client)  

| Param | Type |
| --- | --- |
| message_id | <code>string</code> | 
| interval | <code>BigInt</code> \| <code>undefined</code> | 
| max_attempts | <code>BigInt</code> \| <code>undefined</code> | 

<a name="Client+reattach"></a>

### client.reattach(message_id) ⇒ <code>Promise.&lt;any&gt;</code>
Reattaches messages for provided message id. Messages can be reattached only if they are valid and haven't been
confirmed for a while.

**Kind**: instance method of [<code>Client</code>](#Client)  

| Param | Type |
| --- | --- |
| message_id | <code>string</code> | 

<a name="Client+promote"></a>

### client.promote(message_id) ⇒ <code>Promise.&lt;any&gt;</code>
Promotes a message. The method should validate if a promotion is necessary through get_message. If not, the
method should error out and should not allow unnecessary promotions.

**Kind**: instance method of [<code>Client</code>](#Client)  

| Param | Type |
| --- | --- |
| message_id | <code>string</code> | 

<a name="Client+consolidateFunds"></a>

### client.consolidateFunds(seed, account_index, start_index, end_index) ⇒ <code>Promise.&lt;any&gt;</code>
Only works in browser because of the timeouts
Function to consolidate all funds from a range of addresses to the address with the lowest index in that range
Returns the address to which the funds got consolidated, if any were available

**Kind**: instance method of [<code>Client</code>](#Client)  

| Param | Type |
| --- | --- |
| seed | <code>string</code> | 
| account_index | <code>number</code> | 
| start_index | <code>number</code> | 
| end_index | <code>number</code> | 

<a name="Client+bech32ToHex"></a>

### client.bech32ToHex(address) ⇒ <code>string</code>
Returns a parsed hex String from bech32.

**Kind**: instance method of [<code>Client</code>](#Client)  

| Param | Type |
| --- | --- |
| address | <code>string</code> | 

<a name="Client+hexToBech32"></a>

### client.hexToBech32(address, bech32) ⇒ <code>Promise.&lt;any&gt;</code>
Returns a parsed bech32 String from hex.

**Kind**: instance method of [<code>Client</code>](#Client)  

| Param | Type |
| --- | --- |
| address | <code>string</code> | 
| bech32 | <code>string</code> \| <code>undefined</code> | 

<a name="Client+hexPublicKeyToBech32Address"></a>

### client.hexPublicKeyToBech32Address(public_key, bech32) ⇒ <code>Promise.&lt;any&gt;</code>
Transforms a hex encoded public key to a bech32 encoded address

**Kind**: instance method of [<code>Client</code>](#Client)  

| Param | Type |
| --- | --- |
| public_key | <code>string</code> | 
| bech32 | <code>string</code> \| <code>undefined</code> | 

<a name="Client+isAddressValid"></a>

### client.isAddressValid(address) ⇒ <code>boolean</code>
Checks if a String is a valid bech32 encoded address.

**Kind**: instance method of [<code>Client</code>](#Client)  

| Param | Type |
| --- | --- |
| address | <code>string</code> | 

<a name="Client+generateMnemonic"></a>

### client.generateMnemonic() ⇒ <code>string</code>
Generates a new mnemonic.

**Kind**: instance method of [<code>Client</code>](#Client)  
<a name="Client+mnemonicToHexSeed"></a>

### client.mnemonicToHexSeed(mnemonic) ⇒ <code>string</code>
Returns a hex encoded seed for a mnemonic.

**Kind**: instance method of [<code>Client</code>](#Client)  

| Param | Type |
| --- | --- |
| mnemonic | <code>string</code> | 

<a name="Client+getMessageId"></a>

### client.getMessageId(message) ⇒ <code>string</code>
Returns the message id from a provided message.

**Kind**: instance method of [<code>Client</code>](#Client)  

| Param | Type |
| --- | --- |
| message | <code>string</code> | 

<a name="Client+getTransactionId"></a>

### client.getTransactionId(transaction) ⇒ <code>string</code>
Returns the transaction id from a provided transaction payload.

**Kind**: instance method of [<code>Client</code>](#Client)  

| Param | Type |
| --- | --- |
| transaction | <code>string</code> | 

<a name="Client+getEssenceHash"></a>

### client.getEssenceHash(essence) ⇒ <code>string</code>
Get essence hash

**Kind**: instance method of [<code>Client</code>](#Client)  

| Param | Type |
| --- | --- |
| essence | <code>string</code> | 

<a name="ClientBuilder"></a>

## ClientBuilder
**Kind**: global class  

* [ClientBuilder](#ClientBuilder)
    * [new ClientBuilder()](#new_ClientBuilder_new)
    * [.node(url)](#ClientBuilder+node) ⇒ [<code>ClientBuilder</code>](#ClientBuilder)
    * [.primaryNode(url, jwt, username, password)](#ClientBuilder+primaryNode) ⇒ [<code>ClientBuilder</code>](#ClientBuilder)
    * [.primaryPowNode(url, jwt, username, password)](#ClientBuilder+primaryPowNode) ⇒ [<code>ClientBuilder</code>](#ClientBuilder)
    * [.permanode(url, jwt, username, password)](#ClientBuilder+permanode) ⇒ [<code>ClientBuilder</code>](#ClientBuilder)
    * [.nodeAuth(url, jwt, username, password)](#ClientBuilder+nodeAuth) ⇒ [<code>ClientBuilder</code>](#ClientBuilder)
    * [.nodes(urls)](#ClientBuilder+nodes) ⇒ [<code>ClientBuilder</code>](#ClientBuilder)
    * [.nodeSyncInterval(value)](#ClientBuilder+nodeSyncInterval) ⇒ [<code>ClientBuilder</code>](#ClientBuilder)
    * [.nodeSyncDisabled()](#ClientBuilder+nodeSyncDisabled) ⇒ [<code>ClientBuilder</code>](#ClientBuilder)
    * [.offlineMode()](#ClientBuilder+offlineMode) ⇒ [<code>ClientBuilder</code>](#ClientBuilder)
    * [.nodePoolUrls(node_pool_urls)](#ClientBuilder+nodePoolUrls) ⇒ <code>Promise.&lt;any&gt;</code>
    * [.quorum(value)](#ClientBuilder+quorum) ⇒ [<code>ClientBuilder</code>](#ClientBuilder)
    * [.quorumSize(value)](#ClientBuilder+quorumSize) ⇒ [<code>ClientBuilder</code>](#ClientBuilder)
    * [.quorumThreshold(value)](#ClientBuilder+quorumThreshold) ⇒ [<code>ClientBuilder</code>](#ClientBuilder)
    * [.network(network)](#ClientBuilder+network) ⇒ [<code>ClientBuilder</code>](#ClientBuilder)
    * [.localPow(value)](#ClientBuilder+localPow) ⇒ [<code>ClientBuilder</code>](#ClientBuilder)
    * [.tipsInterval(value)](#ClientBuilder+tipsInterval) ⇒ [<code>ClientBuilder</code>](#ClientBuilder)
    * [.requestTimeout(value)](#ClientBuilder+requestTimeout) ⇒ [<code>ClientBuilder</code>](#ClientBuilder)
    * [.apiTimeout(api, timeout)](#ClientBuilder+apiTimeout) ⇒ [<code>ClientBuilder</code>](#ClientBuilder)
    * [.build()](#ClientBuilder+build) ⇒ <code>Promise.&lt;any&gt;</code>

<a name="new_ClientBuilder_new"></a>

### new ClientBuilder()
Creates an IOTA client builder.

<a name="ClientBuilder+node"></a>

### clientBuilder.node(url) ⇒ [<code>ClientBuilder</code>](#ClientBuilder)
Adds an IOTA node by its URL.

**Kind**: instance method of [<code>ClientBuilder</code>](#ClientBuilder)  

| Param | Type |
| --- | --- |
| url | <code>string</code> | 

<a name="ClientBuilder+primaryNode"></a>

### clientBuilder.primaryNode(url, jwt, username, password) ⇒ [<code>ClientBuilder</code>](#ClientBuilder)
Adds an IOTA node by its URL to be used as primary node, with optional jwt and or basic authentication

**Kind**: instance method of [<code>ClientBuilder</code>](#ClientBuilder)  

| Param | Type |
| --- | --- |
| url | <code>string</code> | 
| jwt | <code>string</code> \| <code>undefined</code> | 
| username | <code>string</code> \| <code>undefined</code> | 
| password | <code>string</code> \| <code>undefined</code> | 

<a name="ClientBuilder+primaryPowNode"></a>

### clientBuilder.primaryPowNode(url, jwt, username, password) ⇒ [<code>ClientBuilder</code>](#ClientBuilder)
Adds an IOTA node by its URL to be used as primary PoW node (for remote PoW), with optional jwt and or basic
authentication

**Kind**: instance method of [<code>ClientBuilder</code>](#ClientBuilder)  

| Param | Type |
| --- | --- |
| url | <code>string</code> | 
| jwt | <code>string</code> \| <code>undefined</code> | 
| username | <code>string</code> \| <code>undefined</code> | 
| password | <code>string</code> \| <code>undefined</code> | 

<a name="ClientBuilder+permanode"></a>

### clientBuilder.permanode(url, jwt, username, password) ⇒ [<code>ClientBuilder</code>](#ClientBuilder)
Adds a permanode by its URL, with optional jwt and or basic authentication

**Kind**: instance method of [<code>ClientBuilder</code>](#ClientBuilder)  

| Param | Type |
| --- | --- |
| url | <code>string</code> | 
| jwt | <code>string</code> \| <code>undefined</code> | 
| username | <code>string</code> \| <code>undefined</code> | 
| password | <code>string</code> \| <code>undefined</code> | 

<a name="ClientBuilder+nodeAuth"></a>

### clientBuilder.nodeAuth(url, jwt, username, password) ⇒ [<code>ClientBuilder</code>](#ClientBuilder)
Adds an IOTA node by its URL with optional jwt and or basic authentication

**Kind**: instance method of [<code>ClientBuilder</code>](#ClientBuilder)  

| Param | Type |
| --- | --- |
| url | <code>string</code> | 
| jwt | <code>string</code> \| <code>undefined</code> | 
| username | <code>string</code> \| <code>undefined</code> | 
| password | <code>string</code> \| <code>undefined</code> | 

<a name="ClientBuilder+nodes"></a>

### clientBuilder.nodes(urls) ⇒ [<code>ClientBuilder</code>](#ClientBuilder)
Adds a list of IOTA nodes by their URLs.

**Kind**: instance method of [<code>ClientBuilder</code>](#ClientBuilder)  

| Param | Type |
| --- | --- |
| urls | <code>any</code> | 

<a name="ClientBuilder+nodeSyncInterval"></a>

### clientBuilder.nodeSyncInterval(value) ⇒ [<code>ClientBuilder</code>](#ClientBuilder)
Set the node sync interval (has no effect because we can't spawn another thread in wasm to sync the nodes)

**Kind**: instance method of [<code>ClientBuilder</code>](#ClientBuilder)  

| Param | Type |
| --- | --- |
| value | <code>number</code> | 

<a name="ClientBuilder+nodeSyncDisabled"></a>

### clientBuilder.nodeSyncDisabled() ⇒ [<code>ClientBuilder</code>](#ClientBuilder)
Disables the node syncing process.
Every node will be considered healthy and ready to use.

**Kind**: instance method of [<code>ClientBuilder</code>](#ClientBuilder)  
<a name="ClientBuilder+offlineMode"></a>

### clientBuilder.offlineMode() ⇒ [<code>ClientBuilder</code>](#ClientBuilder)
Allows creating the client without nodes for offline address generation or signing

**Kind**: instance method of [<code>ClientBuilder</code>](#ClientBuilder)  
<a name="ClientBuilder+nodePoolUrls"></a>

### clientBuilder.nodePoolUrls(node_pool_urls) ⇒ <code>Promise.&lt;any&gt;</code>
Get node list from the node_pool_urls

**Kind**: instance method of [<code>ClientBuilder</code>](#ClientBuilder)  

| Param | Type |
| --- | --- |
| node_pool_urls | <code>any</code> | 

<a name="ClientBuilder+quorum"></a>

### clientBuilder.quorum(value) ⇒ [<code>ClientBuilder</code>](#ClientBuilder)
Set if quroum should be used or not

**Kind**: instance method of [<code>ClientBuilder</code>](#ClientBuilder)  

| Param | Type |
| --- | --- |
| value | <code>boolean</code> | 

<a name="ClientBuilder+quorumSize"></a>

### clientBuilder.quorumSize(value) ⇒ [<code>ClientBuilder</code>](#ClientBuilder)
Set amount of nodes which should be used for quorum

**Kind**: instance method of [<code>ClientBuilder</code>](#ClientBuilder)  

| Param | Type |
| --- | --- |
| value | <code>number</code> | 

<a name="ClientBuilder+quorumThreshold"></a>

### clientBuilder.quorumThreshold(value) ⇒ [<code>ClientBuilder</code>](#ClientBuilder)
Set quorum_threshold

**Kind**: instance method of [<code>ClientBuilder</code>](#ClientBuilder)  

| Param | Type |
| --- | --- |
| value | <code>number</code> | 

<a name="ClientBuilder+network"></a>

### clientBuilder.network(network) ⇒ [<code>ClientBuilder</code>](#ClientBuilder)
Selects the type of network to get default nodes for it, only "devnet" is supported at the moment.
Nodes that don't belong to this network are ignored. Default nodes are only used when no other nodes are
provided.

**Kind**: instance method of [<code>ClientBuilder</code>](#ClientBuilder)  

| Param | Type |
| --- | --- |
| network | <code>string</code> | 

<a name="ClientBuilder+localPow"></a>

### clientBuilder.localPow(value) ⇒ [<code>ClientBuilder</code>](#ClientBuilder)
Since we can only have a single thread in wasm, local PoW is much slower

**Kind**: instance method of [<code>ClientBuilder</code>](#ClientBuilder)  

| Param | Type |
| --- | --- |
| value | <code>boolean</code> | 

<a name="ClientBuilder+tipsInterval"></a>

### clientBuilder.tipsInterval(value) ⇒ [<code>ClientBuilder</code>](#ClientBuilder)
Sets after how many seconds new tips will be requested during PoW

**Kind**: instance method of [<code>ClientBuilder</code>](#ClientBuilder)  

| Param | Type |
| --- | --- |
| value | <code>number</code> | 

<a name="ClientBuilder+requestTimeout"></a>

### clientBuilder.requestTimeout(value) ⇒ [<code>ClientBuilder</code>](#ClientBuilder)
Sets the default request timeout.

**Kind**: instance method of [<code>ClientBuilder</code>](#ClientBuilder)  

| Param | Type |
| --- | --- |
| value | <code>number</code> | 

<a name="ClientBuilder+apiTimeout"></a>

### clientBuilder.apiTimeout(api, timeout) ⇒ [<code>ClientBuilder</code>](#ClientBuilder)
Sets the request timeout for a specific API usage.

**Kind**: instance method of [<code>ClientBuilder</code>](#ClientBuilder)  

| Param | Type |
| --- | --- |
| api | <code>string</code> | 
| timeout | <code>number</code> | 

<a name="ClientBuilder+build"></a>

### clientBuilder.build() ⇒ <code>Promise.&lt;any&gt;</code>
Build the client.

**Kind**: instance method of [<code>ClientBuilder</code>](#ClientBuilder)  
<a name="GetAddressBuilder"></a>

## GetAddressBuilder
**Kind**: global class  

* [GetAddressBuilder](#GetAddressBuilder)
    * _instance_
        * [.balance(address)](#GetAddressBuilder+balance) ⇒ <code>Promise.&lt;any&gt;</code>
        * [.outputs(address, options)](#GetAddressBuilder+outputs) ⇒ <code>Promise.&lt;any&gt;</code>
    * _static_
        * [.new(client)](#GetAddressBuilder.new) ⇒ [<code>GetAddressBuilder</code>](#GetAddressBuilder)

<a name="GetAddressBuilder+balance"></a>

### getAddressBuilder.balance(address) ⇒ <code>Promise.&lt;any&gt;</code>
Consume the builder and get the balance of a given Bech32 encoded address.
If count equals maxResults, then there might be more outputs available but those were skipped for performance
reasons. User should sweep the address to reduce the amount of outputs.

**Kind**: instance method of [<code>GetAddressBuilder</code>](#GetAddressBuilder)  

| Param | Type |
| --- | --- |
| address | <code>string</code> | 

<a name="GetAddressBuilder+outputs"></a>

### getAddressBuilder.outputs(address, options) ⇒ <code>Promise.&lt;any&gt;</code>
Consume the builder and get all outputs that use a given address.
If count equals maxResults, then there might be more outputs available but those were skipped for performance
reasons. User should sweep the address to reduce the amount of outputs.

**Kind**: instance method of [<code>GetAddressBuilder</code>](#GetAddressBuilder)  

| Param | Type |
| --- | --- |
| address | <code>string</code> | 
| options | <code>any</code> | 

<a name="GetAddressBuilder.new"></a>

### GetAddressBuilder.new(client) ⇒ [<code>GetAddressBuilder</code>](#GetAddressBuilder)
**Kind**: static method of [<code>GetAddressBuilder</code>](#GetAddressBuilder)  

| Param | Type |
| --- | --- |
| client | [<code>Client</code>](#Client) | 

<a name="MessageBuilder"></a>

## MessageBuilder
**Kind**: global class  

* [MessageBuilder](#MessageBuilder)
    * _instance_
        * [.index(index)](#MessageBuilder+index) ⇒ [<code>MessageBuilder</code>](#MessageBuilder)
        * [.data(data)](#MessageBuilder+data) ⇒ [<code>MessageBuilder</code>](#MessageBuilder)
        * [.seed(seed)](#MessageBuilder+seed) ⇒ [<code>MessageBuilder</code>](#MessageBuilder)
        * [.accountIndex(account_index)](#MessageBuilder+accountIndex) ⇒ [<code>MessageBuilder</code>](#MessageBuilder)
        * [.initialAddressIndex(initial_address_index)](#MessageBuilder+initialAddressIndex) ⇒ [<code>MessageBuilder</code>](#MessageBuilder)
        * [.parents(parents)](#MessageBuilder+parents) ⇒ [<code>MessageBuilder</code>](#MessageBuilder)
        * [.input(output_id)](#MessageBuilder+input) ⇒ [<code>MessageBuilder</code>](#MessageBuilder)
        * [.inputRange(start, end)](#MessageBuilder+inputRange) ⇒ [<code>MessageBuilder</code>](#MessageBuilder)
        * [.output(address, amount)](#MessageBuilder+output) ⇒ [<code>MessageBuilder</code>](#MessageBuilder)
        * [.dustAllowanceOutput(address, amount)](#MessageBuilder+dustAllowanceOutput) ⇒ [<code>MessageBuilder</code>](#MessageBuilder)
        * [.prepareTransaction()](#MessageBuilder+prepareTransaction) ⇒ <code>Promise.&lt;any&gt;</code>
        * [.signTransaction(prepared_transaction_data, seed, input_range_start, input_range_end)](#MessageBuilder+signTransaction) ⇒ <code>Promise.&lt;any&gt;</code>
        * [.finishMessage(payload)](#MessageBuilder+finishMessage) ⇒ <code>Promise.&lt;any&gt;</code>
        * [.submit()](#MessageBuilder+submit) ⇒ <code>Promise.&lt;any&gt;</code>
    * _static_
        * [.new(client)](#MessageBuilder.new) ⇒ [<code>MessageBuilder</code>](#MessageBuilder)

<a name="MessageBuilder+index"></a>

### messageBuilder.index(index) ⇒ [<code>MessageBuilder</code>](#MessageBuilder)
Set indexation to the builder

**Kind**: instance method of [<code>MessageBuilder</code>](#MessageBuilder)  

| Param | Type |
| --- | --- |
| index | <code>Uint8Array</code> | 

<a name="MessageBuilder+data"></a>

### messageBuilder.data(data) ⇒ [<code>MessageBuilder</code>](#MessageBuilder)
Set data to the builder

**Kind**: instance method of [<code>MessageBuilder</code>](#MessageBuilder)  

| Param | Type |
| --- | --- |
| data | <code>Uint8Array</code> | 

<a name="MessageBuilder+seed"></a>

### messageBuilder.seed(seed) ⇒ [<code>MessageBuilder</code>](#MessageBuilder)
Sets the seed.

**Kind**: instance method of [<code>MessageBuilder</code>](#MessageBuilder)  

| Param | Type |
| --- | --- |
| seed | <code>string</code> | 

<a name="MessageBuilder+accountIndex"></a>

### messageBuilder.accountIndex(account_index) ⇒ [<code>MessageBuilder</code>](#MessageBuilder)
Sets the account index.

**Kind**: instance method of [<code>MessageBuilder</code>](#MessageBuilder)  

| Param | Type |
| --- | --- |
| account_index | <code>number</code> | 

<a name="MessageBuilder+initialAddressIndex"></a>

### messageBuilder.initialAddressIndex(initial_address_index) ⇒ [<code>MessageBuilder</code>](#MessageBuilder)
Sets the index of the address to start looking for balance.

**Kind**: instance method of [<code>MessageBuilder</code>](#MessageBuilder)  

| Param | Type |
| --- | --- |
| initial_address_index | <code>number</code> | 

<a name="MessageBuilder+parents"></a>

### messageBuilder.parents(parents) ⇒ [<code>MessageBuilder</code>](#MessageBuilder)
Set 1-8 custom parent message ids

**Kind**: instance method of [<code>MessageBuilder</code>](#MessageBuilder)  

| Param | Type |
| --- | --- |
| parents | <code>any</code> | 

<a name="MessageBuilder+input"></a>

### messageBuilder.input(output_id) ⇒ [<code>MessageBuilder</code>](#MessageBuilder)
Set a custom input(transaction output)

**Kind**: instance method of [<code>MessageBuilder</code>](#MessageBuilder)  

| Param | Type |
| --- | --- |
| output_id | <code>string</code> | 

<a name="MessageBuilder+inputRange"></a>

### messageBuilder.inputRange(start, end) ⇒ [<code>MessageBuilder</code>](#MessageBuilder)
Set a custom range in which to search for addresses for custom provided inputs. Default: 0..100

**Kind**: instance method of [<code>MessageBuilder</code>](#MessageBuilder)  

| Param | Type |
| --- | --- |
| start | <code>number</code> | 
| end | <code>number</code> | 

<a name="MessageBuilder+output"></a>

### messageBuilder.output(address, amount) ⇒ [<code>MessageBuilder</code>](#MessageBuilder)
Set a transfer to the builder

**Kind**: instance method of [<code>MessageBuilder</code>](#MessageBuilder)  

| Param | Type |
| --- | --- |
| address | <code>string</code> | 
| amount | <code>BigInt</code> | 

<a name="MessageBuilder+dustAllowanceOutput"></a>

### messageBuilder.dustAllowanceOutput(address, amount) ⇒ [<code>MessageBuilder</code>](#MessageBuilder)
Set a dust allowance transfer to the builder, address needs to be Bech32 encoded

**Kind**: instance method of [<code>MessageBuilder</code>](#MessageBuilder)  

| Param | Type |
| --- | --- |
| address | <code>string</code> | 
| amount | <code>BigInt</code> | 

<a name="MessageBuilder+prepareTransaction"></a>

### messageBuilder.prepareTransaction() ⇒ <code>Promise.&lt;any&gt;</code>
Prepare a transaction

**Kind**: instance method of [<code>MessageBuilder</code>](#MessageBuilder)  
<a name="MessageBuilder+signTransaction"></a>

### messageBuilder.signTransaction(prepared_transaction_data, seed, input_range_start, input_range_end) ⇒ <code>Promise.&lt;any&gt;</code>
Sign a transaction

**Kind**: instance method of [<code>MessageBuilder</code>](#MessageBuilder)  

| Param | Type |
| --- | --- |
| prepared_transaction_data | <code>any</code> | 
| seed | <code>string</code> | 
| input_range_start | <code>number</code> \| <code>undefined</code> | 
| input_range_end | <code>number</code> \| <code>undefined</code> | 

<a name="MessageBuilder+finishMessage"></a>

### messageBuilder.finishMessage(payload) ⇒ <code>Promise.&lt;any&gt;</code>
Create a message with a provided payload

**Kind**: instance method of [<code>MessageBuilder</code>](#MessageBuilder)  

| Param | Type |
| --- | --- |
| payload | <code>any</code> | 

<a name="MessageBuilder+submit"></a>

### messageBuilder.submit() ⇒ <code>Promise.&lt;any&gt;</code>
Build and sumbit the message.

**Kind**: instance method of [<code>MessageBuilder</code>](#MessageBuilder)  
<a name="MessageBuilder.new"></a>

### MessageBuilder.new(client) ⇒ [<code>MessageBuilder</code>](#MessageBuilder)
**Kind**: static method of [<code>MessageBuilder</code>](#MessageBuilder)  

| Param | Type |
| --- | --- |
| client | [<code>Client</code>](#Client) | 

<a name="MessageGetter"></a>

## MessageGetter
**Kind**: global class  

* [MessageGetter](#MessageGetter)
    * _instance_
        * [.index(index)](#MessageGetter+index) ⇒ <code>Promise.&lt;any&gt;</code>
        * [.data(message_id)](#MessageGetter+data) ⇒ <code>Promise.&lt;any&gt;</code>
        * [.raw(message_id)](#MessageGetter+raw) ⇒ <code>Promise.&lt;any&gt;</code>
        * [.children(message_id)](#MessageGetter+children) ⇒ <code>Promise.&lt;any&gt;</code>
        * [.metadata(message_id)](#MessageGetter+metadata) ⇒ <code>Promise.&lt;any&gt;</code>
    * _static_
        * [.new(client)](#MessageGetter.new) ⇒ [<code>MessageGetter</code>](#MessageGetter)

<a name="MessageGetter+index"></a>

### messageGetter.index(index) ⇒ <code>Promise.&lt;any&gt;</code>
Get message ids with an index.

**Kind**: instance method of [<code>MessageGetter</code>](#MessageGetter)  

| Param | Type |
| --- | --- |
| index | <code>Uint8Array</code> | 

<a name="MessageGetter+data"></a>

### messageGetter.data(message_id) ⇒ <code>Promise.&lt;any&gt;</code>
Get a message with the message id.

**Kind**: instance method of [<code>MessageGetter</code>](#MessageGetter)  

| Param | Type |
| --- | --- |
| message_id | <code>string</code> | 

<a name="MessageGetter+raw"></a>

### messageGetter.raw(message_id) ⇒ <code>Promise.&lt;any&gt;</code>
Get the raw message with the message id.

**Kind**: instance method of [<code>MessageGetter</code>](#MessageGetter)  

| Param | Type |
| --- | --- |
| message_id | <code>string</code> | 

<a name="MessageGetter+children"></a>

### messageGetter.children(message_id) ⇒ <code>Promise.&lt;any&gt;</code>
Get the childrens of a message with the message id.

**Kind**: instance method of [<code>MessageGetter</code>](#MessageGetter)  

| Param | Type |
| --- | --- |
| message_id | <code>string</code> | 

<a name="MessageGetter+metadata"></a>

### messageGetter.metadata(message_id) ⇒ <code>Promise.&lt;any&gt;</code>
Get the metadata of a message with the message id.

**Kind**: instance method of [<code>MessageGetter</code>](#MessageGetter)  

| Param | Type |
| --- | --- |
| message_id | <code>string</code> | 

<a name="MessageGetter.new"></a>

### MessageGetter.new(client) ⇒ [<code>MessageGetter</code>](#MessageGetter)
**Kind**: static method of [<code>MessageGetter</code>](#MessageGetter)  

| Param | Type |
| --- | --- |
| client | [<code>Client</code>](#Client) | 

<a name="UnspentAddressGetter"></a>

## UnspentAddressGetter
**Kind**: global class  

* [UnspentAddressGetter](#UnspentAddressGetter)
    * _instance_
        * [.accountIndex(index)](#UnspentAddressGetter+accountIndex) ⇒ [<code>UnspentAddressGetter</code>](#UnspentAddressGetter)
        * [.initialAddressIndex(index)](#UnspentAddressGetter+initialAddressIndex) ⇒ [<code>UnspentAddressGetter</code>](#UnspentAddressGetter)
        * [.get()](#UnspentAddressGetter+get) ⇒ <code>Promise.&lt;any&gt;</code>
    * _static_
        * [.new(client, seed)](#UnspentAddressGetter.new) ⇒ [<code>UnspentAddressGetter</code>](#UnspentAddressGetter)

<a name="UnspentAddressGetter+accountIndex"></a>

### unspentAddressGetter.accountIndex(index) ⇒ [<code>UnspentAddressGetter</code>](#UnspentAddressGetter)
Sets the account index

**Kind**: instance method of [<code>UnspentAddressGetter</code>](#UnspentAddressGetter)  

| Param | Type |
| --- | --- |
| index | <code>number</code> | 

<a name="UnspentAddressGetter+initialAddressIndex"></a>

### unspentAddressGetter.initialAddressIndex(index) ⇒ [<code>UnspentAddressGetter</code>](#UnspentAddressGetter)
Sets the index of the address to start looking for balance

**Kind**: instance method of [<code>UnspentAddressGetter</code>](#UnspentAddressGetter)  

| Param | Type |
| --- | --- |
| index | <code>number</code> | 

<a name="UnspentAddressGetter+get"></a>

### unspentAddressGetter.get() ⇒ <code>Promise.&lt;any&gt;</code>
Get an unspent address with its index.

**Kind**: instance method of [<code>UnspentAddressGetter</code>](#UnspentAddressGetter)  
<a name="UnspentAddressGetter.new"></a>

### UnspentAddressGetter.new(client, seed) ⇒ [<code>UnspentAddressGetter</code>](#UnspentAddressGetter)
**Kind**: static method of [<code>UnspentAddressGetter</code>](#UnspentAddressGetter)  

| Param | Type |
| --- | --- |
| client | [<code>Client</code>](#Client) | 
| seed | <code>string</code> | 

<a name="start"></a>

## start()
Initializes the console error panic hook for better error messages

**Kind**: global function