Documentation GitHub npm

Class

Address

Address(address)

Create a new Address object.

Address represents a single address in the Stellar network that can be inputted to or outputted by a smart contract. An address can represent an account, muxed account, contract, claimable balance, or a liquidity pool (the latter two can only be present as the output of Core in the form of an event, never an input to a smart contract).

Constructor

# new Address(address)

Parameters:
Name Type Description
address string

a StrKey of the address value

View Source js-stellar-base/src/address.js, line 17

Classes

Address

Methods

# toBuffer() → {Buffer}

Return the raw public key bytes for this address.

View Source js-stellar-base/src/address.js, line 210

Buffer

# toScAddress() → {xdr.ScAddress}

Convert this Address to an xdr.ScAddress type.

View Source js-stellar-base/src/address.js, line 173

xdr.ScAddress

# toScVal() → {xdr.ScVal}

Convert this Address to an xdr.ScVal type.

View Source js-stellar-base/src/address.js, line 164

xdr.ScVal

# toString() → {string}

Serialize an address to string.

View Source js-stellar-base/src/address.js, line 142

string

# static account(buffer) → {Address}

Creates a new account Address object from a buffer of raw bytes.

Parameters:
Name Type Description
buffer Buffer

The bytes of an address to parse.

View Source js-stellar-base/src/address.js, line 55

Address

# static claimableBalance(buffer) → {Address}

Creates a new claimable balance Address object from a buffer of raw bytes.

Parameters:
Name Type Description
buffer Buffer

The bytes of a claimable balance ID to parse.

View Source js-stellar-base/src/address.js, line 75

Address

# static contract(buffer) → {Address}

Creates a new contract Address object from a buffer of raw bytes.

Parameters:
Name Type Description
buffer Buffer

The bytes of an address to parse.

View Source js-stellar-base/src/address.js, line 65

Address

# static fromScAddress(scAddress) → {Address}

Convert this from an xdr.ScAddress type

Parameters:
Name Type Description
scAddress xdr.ScAddress

The xdr.ScAddress type to parse

View Source js-stellar-base/src/address.js, line 115

Address

# static fromScVal(scVal) → {Address}

Convert this from an xdr.ScVal type.

Parameters:
Name Type Description
scVal xdr.ScVal

The xdr.ScVal type to parse

View Source js-stellar-base/src/address.js, line 105

Address

# static fromString(address) → {Address}

Parses a string and returns an Address object.

Parameters:
Name Type Description
address string

The address to parse. ex. GB3KJPLFUYN5VL6R3GU3EGCGVCKFDSD7BEDX42HWG5BWFKB3KQGJJRMA

View Source js-stellar-base/src/address.js, line 45

Address

# static liquidityPool(buffer) → {Address}

Creates a new liquidity pool Address object from a buffer of raw bytes.

Parameters:
Name Type Description
buffer Buffer

The bytes of an LP ID to parse.

View Source js-stellar-base/src/address.js, line 85

Address

# static muxedAccount(buffer) → {Address}

Creates a new muxed account Address object from a buffer of raw bytes.

Parameters:
Name Type Description
buffer Buffer

The bytes of an address to parse.

View Source js-stellar-base/src/address.js, line 95

Address