Node

@aeternity/aepp-sdk/es/node

Node module

Example

import Node from '@aeternity/aepp-sdk/es/node'

• @aeternity/aepp-sdk/es/node
  • Node([options]) ⇒ Object ⏏
    • ~loader(options) ⇒ function
    • ~getConsensusProtocolVersion(protocols, height) ⇒ Number
    • async
      • ~remoteSwag(url, axiosConfig) ⇒ Object

Node([options]) ⇒ Object ⏏

Swagger based Node remote API Stamp

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

Param	Type	Default	Description
[options]	Object	{}	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

Node({url: 'https://sdk-testnet.aepps.com'})

Node~loader(options) ⇒ function

Node specific loader for urlFor

Kind: inner method of Node
Returns: function - Implementation for 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

Node~getConsensusProtocolVersion(protocols, height) ⇒ Number

get consensus protocol version

Kind: inner method of Node
Returns: Number - version Protocol version

Param	Type	Description
protocols	Array	Array of protocols
height	Number	Height

Node~remoteSwag(url, axiosConfig) ⇒ Object

Obtain Swagger configuration from Node node

Kind: inner method of 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