Interface RosettaOptions

The options that will be sent directly to /construction/metadata by the caller.

Export

Interface

RosettaOptions

Hierarchy

  • RosettaOptions

Properties

amount? burn_block_height? contract_address? contract_name? decimals? delegate_to? fee? gas_limit? gas_price? max_fee? memo? number_of_cycles? pox_addr? sender_address? size? status? suggested_fee_multiplier? symbol? token_transfer_recipient_address? type?

Properties

Optional amount

amount?: string

Amount to be transfered.

Memberof

RosettaOptions

Optional burn_block_height

burn_block_height?: number

Set the burnchain (BTC) block for stacking lock to start.

Memberof

RosettaOptions

Optional contract_address

contract_address?: string

Address of the contract to call.

Memberof

RosettaOptions

Optional contract_name

contract_name?: string

Name of the contract to call.

Memberof

RosettaOptions

Optional decimals

decimals?: number

Number of decimal places

Memberof

RosettaOptions

Optional delegate_to

delegate_to?: string

Delegator address for when calling delegate-stacking.

Memberof

RosettaOptions

Optional fee

fee?: string

Fee for this transaction

Memberof

RosettaOptions

Optional gas_limit

gas_limit?: number

Maximum price a user is willing to pay.

Memberof

RosettaOptions

Optional gas_price

gas_price?: number

Cost necessary to perform a transaction on the network

Memberof

RosettaOptions

Optional max_fee

max_fee?: string

Maximum fee user is willing to pay

Memberof

RosettaOptions

Optional memo

memo?: string

STX token transfer memo.

Memberof

RosettaOptions

Optional number_of_cycles

number_of_cycles?: number

Number of cycles when stacking.

Memberof

RosettaOptions

Optional pox_addr

pox_addr?: string

The reward address for stacking transaction. It should be a valid Bitcoin address

Memberof

RosettaOptions

Optional sender_address

sender_address?: string

sender's address

Memberof

RosettaOptions

Optional size

size?: number

Transaction approximative size (used to calculate total fee).

Memberof

RosettaOptions

Optional status

status?: string

This value indicates the state of the operations

Memberof

RosettaOptions

Optional suggested_fee_multiplier

suggested_fee_multiplier?: number

A suggested fee multiplier to indicate that the suggested fee should be scaled. This may be used to set higher fees for urgent transactions or to pay lower fees when there is less urgency.

Memberof

RosettaOptions

Optional symbol

symbol?: string

Currency symbol e.g STX

Memberof

RosettaOptions

Optional token_transfer_recipient_address

token_transfer_recipient_address?: string

Recipient's address

Memberof

RosettaOptions

Optional type

type?: string

Type of operation e.g transfer

Memberof

RosettaOptions

Settings

Member Visibility

Theme

Generated using TypeDoc