Contains functions that probe the blockchain or federation servers to collect datas.
- Source:
Methods
(static) account(address) → {Object}
Returns the AccountResponse object for address.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
address |
string
|
A public key or a federated address |
Returns:
- Type:
-
Object
The AccountResponse
(async, static) address(address)
Returns the federation server Account for address.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
address |
string
|
A Stellar public key or a federated address |
Returns:
Resolve to federation server response
(static) horizon(networkopt)
Returns the curent Horizon node URL, or the Horizon node URL for network if provided.
- Source:
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
network |
string
|
<optional> |
A network name or passphrase. |
(async, static) isAccountEmpty(address) → {boolean}
Returns true if address account is empty, false otherwise.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
address |
string
|
Public key or federated address |
Returns:
- Type:
-
boolean
(static) networkName(networkPassphrase) → {string}
Returns the network name for network passphrase, or undefined.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
networkPassphrase |
string
|
Returns:
- Type:
-
string
(static) networkPassphrase()
Returns the current network passphrase, or the passphrase for network is provided.
- Source:
(static) server(networkopt, horizonopt) → {Server}
Returns the Server object for horizon, or for network, or for the current network.
- Source:
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
network |
string
|
<optional> |
'public', 'test' or a network passphrase |
horizon |
string
|
<optional> |
A horizon URL |
Returns:
- Type:
-
Server
A StellarSdk Server object
(static) txSigners(transaction) → {Object}
Returns an object such as:
{
$accountId: $accountSigners
...
}
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
transaction |
Transaction
|
Returns:
- Type:
-
Object
(static) txSignersList(transaction) → {Array}
Returns an Array containing the keys for all legit signers of transaction.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
transaction |
Transaction
|
Returns:
- Type:
-
Array
(static) txSourceAccount(addressopt, sequenceopt) → {AccountResponse}
Returns the account object for transaction source address` with sequence set at sequence if provided. If address is not provided, returns the neutral account object instead (as in SEP-0007 specifications).
- Source:
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
address |
string
|
<optional> |
|
sequence |
string
|
numbre
|
<optional> |
Returns:
- Type:
-
AccountResponse
(static) txSources(transaction) → {Array}
Returns the array of all source accounts ID involved in transaction.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
transaction |
Transaction
|
Returns:
- Type:
-
Array
(static) useNetwork(networkopt) → {Server}
Switch to the current network, or to network if provided.
- Deprecated:
- StellarSdk global `Network` setting is deprecated.
- Source:
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
network |
string
|
<optional> |
'public', 'test' or a network passphrase |
Returns:
- Type:
-
Server
A StellarSdk Server object
(inner) makeAccountResponse(publicKey, sequence) → {AccountResponse}
Creates an AccountResponse object with signers set for an empty account.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
publicKey |
string
|
|
sequence |
string
|
[description] |
Returns:
- Type:
-
AccountResponse