Type Definitions
# claimtextcoinResponse
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
unit |
string
|
||
asset |
string
|
<optional> |
Object
# getaddressesResponse
Properties:
| Name | Type | Description |
|---|---|---|
address |
string
|
|
address_index |
string
|
|
is_change |
number
|
|
is_definition_public |
number
|
|
creation_ts |
string
|
Object
# getInfoResponse
Properties:
| Name | Type | Description |
|---|---|---|
connections |
number
|
|
last_mci |
number
|
|
last_stable_mci |
number
|
|
count_unhandled |
number
|
Object
# getNetworkInfoResponse
Properties:
| Name | Type | Description |
|---|---|---|
version |
string
|
|
subversion |
string
|
|
protocolversion |
string
|
|
alt |
string
|
|
connections |
number
|
|
bLight |
boolean
|
|
socksConfigured |
boolean
|
|
COUNT_WITNESSES |
number
|
|
MAJORITY_OF_WITNESSES |
number
|
|
GENESIS_UNIT |
string
|
|
BLACKBYTES_ASSET |
string
|
Object
# gettransactionResponse
Properties:
| Name | Type | Description |
|---|---|---|
action |
string
|
|
amount |
number
|
|
my_address |
string
|
|
arrPayerAddresses |
Array.<String>
|
|
confirmations |
number
|
|
unit |
string
|
|
fee |
number
|
|
time |
string
|
|
level |
number
|
|
asset |
string
|
# paymentResultCallback(error, unit, assocMnemonics)
Parameters:
| Name | Type | Description |
|---|---|---|
error |
string
|
|
unit |
string
|
|
assocMnemonics |
string
|
# signMessageCB(error, objUnit)
Parameters:
| Name | Type | Description |
|---|---|---|
error |
string
|
|
objUnit |
Object
|
undefined
|
Object
# smpOpts
Properties:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
wallet |
string
|
<optional> |
If specified, the payment will be from this wallet | |
fee_paying_wallet |
string
|
<optional> |
Fallback wallet for paying the fees, used if there is not enough bytes on the main paying wallet | |
paying_addresses |
Array.<string>
|
<optional> |
If specified, payment will be sent from these addresses | |
change_address |
string
|
Change address | ||
amount |
number
|
<optional> |
Payment amount | |
to_address |
string
|
<optional> |
Payment address of the receiver | |
base_outputs |
Array.<Object>
|
<optional> |
Array of outputs for payment in bytes | |
asset |
string
|
null
|
<optional> |
Payment asset | |
asset_outputs |
Array.<Object>
|
<optional> |
Array of outputs for payment in the specified asset | |
send_all |
boolean
|
<optional> |
Send all bytes to "to_address" | |
messages |
Array.<Object>
|
<optional> |
Array of messages to send along with the payment | |
spend_unconfirmed |
string
|
<optional> |
own | What unspent outputs to use for the payment (all - all available, own - sent by us or stable, none - only stable) |
recipient_device_address |
string
|
<optional> |
Device address for payment notification or sending the private payloads | |
recipient_device_addresses |
Array.<string>
|
<optional> |
Device addresses for payment notification or sending the private payloads | |
arrSigningDeviceAddresses |
Array.<string>
|
<optional> |
Device addresses which need to sign the transaction | |
signing_addresses |
Array.<string>
|
<optional> |
Payment addresses which need to sign the transaction | |
signWithLocalPrivateKey |
function
|
<optional> |
A function for signing the transaction with a key stored on the wallet's device | |
aa_addresses_checked |
boolean
|
<optional> |
Whether the output addresses have already been checked for being Autonomous Agent addresses and the respective bounce fees added where necessary. If false, the job will be performed by the function | |
do_not_email |
boolean
|
<optional> |
Do not send an email when sending textcoins, the caller will take care of delivery of the produced textcoins | |
email_subject |
string
|
<optional> |
Subject for the email message sent when sending textcoins | |
getPrivateAssetPayloadSavePath |
function
|
<optional> |
Function that returns the path to save the file with private payloads when sending a private textcoin |
Object
# verifymessageResponse
Properties:
| Name | Type | Description |
|---|---|---|
version |
string
|
|
signed_message |
string
|
Object
|
|
authors |
Object
|