offchain

Documentation

Index

• type Address
• type BroadcastResult
• type WithdrawalResponse
• type WithdrawalResponseData

Types

type Address

type Address struct {
	Address string
	/**
	 * Currency of generated address. BTC, LTC, BCH, ETH, XRP, ERC20.
	 * @type {string}
	 * @memberof Address
	 */
	Currency string
	/**
	 * Derivation key index for given address.
	 * @type {number}
	 * @memberof Address
	 */
	DerivationKey uint32
	/**
	 * Extended public key to derive address from. In case of XRP, this is account address,
	 * since address is defined as DestinationTag, which is address field. In case of XLM, this is account address, since address is defined as message, which is address field.
	 * @type {string}
	 * @memberof Address
	 */
	Xpub string
	/**
	 * In case of XRP, destinationTag is the distinguisher of the account.
	 * @type {number}
	 * @memberof Address
	 */
	DestinatinTag uint64
	/**
	 * In case of XLM, message is the distinguisher of the account.
	 * @type {string}
	 * @memberof Address
	 */
	Message string
}

type BroadcastResult

type BroadcastResult struct {
	TxHash *common.TxHash
	Id     string
}

type WithdrawalResponse

type WithdrawalResponse struct {

	/**
	 * Transaction reference of the transaction connected to this withdrawal.
	 * @type {string}
	 * @memberof WithdrawalResponse
	 */
	Reference string
	/**
	 *
	 * @type {Array<WithdrawalResponseData>}
	 * @memberof WithdrawalResponse
	 */
	Data []WithdrawalResponseData
	/**
	 * ID of withdrawal
	 * @type {string}
	 * @memberof WithdrawalResponse
	 */
	Id string
}

type WithdrawalResponseData

type WithdrawalResponseData struct {

	/**
	 *
	 * @type {Address}
	 * @memberof WithdrawalResponseData
	 */
	Address *Address
	/**
	 * Amount of unprocessed transaction outputs, that can be used for withdrawal. Bitcoin, Litecoin, Bitcoin Cash only.
	 * @type {number}
	 * @memberof WithdrawalResponseData
	 */
	Amount int64
	/**
	 * Last used unprocessed transaction output, that can be used.
	 * Bitcoin, Litecoin, Bitcoin Cash only. If -1, it indicates prepared vOut with amount to be transferred to pool address.
	 * @type {string}
	 * @memberof WithdrawalResponseData
	 */
	VIn string
	/**
	 * Index of last used unprocessed transaction output in raw transaction, that can be used. Bitcoin, Litecoin, Bitcoin Cash only.
	 * @type {number}
	 * @memberof WithdrawalResponseData
	 */
	VInIndex uint32
	/**
	 * Script of last unprocessed UTXO. Bitcoin SV only.
	 * @type {string}
	 * @memberof WithdrawalResponseData
	 */
	ScriptPubKey string
}