Class: Memo

Memo(type, value)

new Memo(type, value)

`Memo` represents memos attached to transactions.
Parameters:
Name Type Description
type string `MemoNone`, `MemoID`, `MemoText`, `MemoHash` or `MemoReturn`
value * `string` for `MemoID`, `MemoText`, buffer of hex string for `MemoHash` or `MemoReturn`
Source:
See:
  • [Transactions concept](https://www.stellar.org/developers/learn/concepts/transactions.html)

Members

type

Contains memo type: `MemoNone`, `MemoID`, `MemoText`, `MemoHash` or `MemoReturn`
Source:

value

Contains memo value: * `null` for `MemoNone`, * `string` for `MemoID`, * `Buffer` for `MemoText` after decoding using `fromXDRObject`, original value otherwise, * `Buffer` for `MemoHash`, `MemoReturn`.
Source:

Methods

(static) fromXDRObject(object) → {Memo}

Returns Memo from XDR memo object.
Parameters:
Name Type Description
object xdr.Memo
Source:
Returns:
Type
Memo

(static) hash(hash) → {Memo}

Creates and returns a `MemoHash` memo.
Parameters:
Name Type Description
hash array | string 32 byte hash or hex encoded string
Source:
Returns:
Type
Memo

(static) id(id) → {Memo}

Creates and returns a `MemoID` memo.
Parameters:
Name Type Description
id string 64-bit number represented as a string
Source:
Returns:
Type
Memo

(static) none() → {Memo}

Returns an empty memo (`MemoNone`).
Source:
Returns:
Type
Memo

(static) return(hash) → {Memo}

Creates and returns a `MemoReturn` memo.
Parameters:
Name Type Description
hash array | string 32 byte hash or hex encoded string
Source:
Returns:
Type
Memo

(static) text(text) → {Memo}

Creates and returns a `MemoText` memo.
Parameters:
Name Type Description
text string memo text
Source:
Returns:
Type
Memo

toXDRObject() → {xdr.Memo}

Returns XDR memo object.
Source:
Returns:
Type
xdr.Memo