Skip to content

Latest commit

 

History

History
104 lines (57 loc) · 2.11 KB

README.md

File metadata and controls

104 lines (57 loc) · 2.11 KB

@iota-pico/business

Index

Classes

Interfaces

Type aliases


Type aliases

AccountData

Ƭ AccountData: object

Defined in [types/accountData.ts:8](https://github.com/iota-pico/business/tree/master/src/types/accountData.ts#L8

Account data information returned from getAccountData.

Type declaration

addresses: Address[]

balance: number

inputs: Input[]

latestAddress: Address

transfers: Bundle[]


PromoteOptions

Ƭ PromoteOptions: object

Defined in [types/promoteOptions.ts:4](https://github.com/iota-pico/business/tree/master/src/types/promoteOptions.ts#L4

Options used during promote process in promoteTransaction.

Type declaration

Optional delay: number

Delay between promotion transfers.

Optional interrupt: boolean | function

Flag or method to terminate promotion.


TransferOptions

Ƭ TransferOptions: object

Defined in [types/transferOptions.ts:9](https://github.com/iota-pico/business/tree/master/src/types/transferOptions.ts#L9

Options used during prepare transfer process prepareTransfers and sendTransfer.

Type declaration

Optional hmacKey: Trytes

Hmac key to sign the bundle.

Optional inputs: Input[]

List of inputs used for funding the transfer.

Optional remainderAddress: Address

If defined, this address will be used for sending the remainder value (of the inputs) to.

Optional security: AddressSecurity

Security level to be used for the private key / addresses.