@aeternity/aepp-sdk/docs/api/node.md

SDK for the æternity blockchain

<a id="module_@aeternity/aepp-sdk/es/node"></a>

## @aeternity/aepp-sdk/es/node
Node module

**Example**  
```js
import Node from '@aeternity/aepp-sdk/es/node'
```

* [@aeternity/aepp-sdk/es/node](#module_@aeternity/aepp-sdk/es/node)
    * [Node([options])](#exp_module_@aeternity/aepp-sdk/es/node--Node) ⇒ `Object` ⏏
        * [~loader(options)](#module_@aeternity/aepp-sdk/es/node--Node..loader) ⇒ `function`
        * [~getConsensusProtocolVersion(protocols, height)](#module_@aeternity/aepp-sdk/es/node--Node..getConsensusProtocolVersion) ⇒ `Number`
        * _async_
            * [~remoteSwag(url, axiosConfig)](#module_@aeternity/aepp-sdk/es/node--Node..remoteSwag) ⇒ `Object`

<a id="exp_module_@aeternity/aepp-sdk/es/node--Node"></a>

### Node([options]) ⇒ `Object` ⏏
[Swagger](Swagger) based Node remote API Stamp

**Kind**: Exported function  
**Returns**: `Object` - Node client  
**rtype**: `Stamp`

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [options] | `Object` | <code>{}</code> | Options |
| options.url | `String` |  | Base URL for Node |
| options.internalUrl | `String` |  | Base URL for internal requests |
| options.axiosConfig | `String` |  | Object with axios configuration. Example { config: {}, errorHandler: (err) => throw err } |

**Example**  
```js
Node({url: 'https://sdk-testnet.aepps.com'})
```
<a id="module_@aeternity/aepp-sdk/es/node--Node..loader"></a>

#### Node~loader(options) ⇒ `function`
Node specific loader for `urlFor`

**Kind**: inner method of [`Node`](#exp_module_@aeternity/aepp-sdk/es/node--Node)  
**Returns**: `function` - Implementation for [urlFor](urlFor)  
**rtype**: `({url: String, internalUrl?: String}) => (path: String, definition: Object) => tx: String`

| Param | Type | Description |
| --- | --- | --- |
| options | `Object` |  |
| options.url | `String` | Base URL for Node |
| options.internalUrl | `String` | Base URL for internal requests |

<a id="module_@aeternity/aepp-sdk/es/node--Node..getConsensusProtocolVersion"></a>

#### Node~getConsensusProtocolVersion(protocols, height) ⇒ `Number`
get consensus protocol version

**Kind**: inner method of [`Node`](#exp_module_@aeternity/aepp-sdk/es/node--Node)  
**Returns**: `Number` - version Protocol version  

| Param | Type | Description |
| --- | --- | --- |
| protocols | `Array` | Array of protocols |
| height | `Number` | Height |

<a id="module_@aeternity/aepp-sdk/es/node--Node..remoteSwag"></a>

#### Node~remoteSwag(url, axiosConfig) ⇒ `Object`
Obtain Swagger configuration from Node node

**Kind**: inner method of [`Node`](#exp_module_@aeternity/aepp-sdk/es/node--Node)  
**Returns**: `Object` - Swagger configuration  
**Category**: async  
**rtype**: `(url: String) => swagger: Object`

| Param | Type | Description |
| --- | --- | --- |
| url | `String` | Node base URL |
| axiosConfig | `Object` | Axios configuration object |