AE

@aeternity/aepp-sdk/es/ae

Ae module

Example

import Ae from '@aeternity/aepp-sdk/es/ae'

• @aeternity/aepp-sdk/es/ae
  • Ae([options]) ⇒ Object ⏏
    • instance
      • .destroyInstance() ⇒ void
      • async
        • .spend(amount, recipientId, options) ⇒ String | String
        • .transferFunds(percentage, recipientId, options) ⇒ String | String
    • inner
      • ~resolveRecipientName(nameOrAddress, verify) ⇒ String

Ae([options]) ⇒ Object ⏏

Basic Ae Stamp

Attempting to create instances from the Stamp without overwriting all abstract methods using composition will result in an exception.

Ae objects are the composition of three basic building blocks: * module:@aeternity/aepp-sdk/es/tx--Tx * Account * module:@aeternity/aepp-sdk/es/chain--Chain Only by providing the joint functionality of those three, most more advanced operations, i.e. the ones with actual use value on the chain, become available.

Kind: Exported function
Returns: Object - Ae instance
rtype: Stamp

Param	Type	Default	Description
[options]	Object	{}	Initializer object

ae.destroyInstance() ⇒ void

Remove all listeners for RPC

Kind: instance method of Ae

ae.spend(amount, recipientId, options) ⇒ String | String

Send tokens to another account

Kind: instance method of Ae
Returns: String | String - Transaction or transaction hash
Category: async
rtype: (amount: Number|String, recipientId: String, options?: Object) => Promise[String]

Param	Type	Description
amount	Number | String	Amount to spend
recipientId	String	Address or Name of recipient account
options	Object	Options

ae.transferFunds(percentage, recipientId, options) ⇒ String | String

Send a percentage of funds to another account

Kind: instance method of Ae
Returns: String | String - Transaction or transaction hash
Category: async
rtype: (percentage: Number|String, recipientId: String, options?: Object) => Promise[String]

Param	Type	Description
percentage	Number | String	Percentage of amount to spend
recipientId	String	Address of recipient account
options	Object	Options

Ae~resolveRecipientName(nameOrAddress, verify) ⇒ String

Resolve AENS name and return name hash

Kind: inner method of Ae
Returns: String - Address or AENS name hash

Param	Type
nameOrAddress	String
verify	Boolean