Class Address

Hierarchy

Address

Index

Constructors

Properties

address clientProvider index privateKey

Methods

balance send sendAll toString utxos

Constructors

constructor

new Address(clientProvider: ClientProvider, index: number, address: string, privateKey: PrivateKey): Address
Parameters
- clientProvider: ClientProvider
- index: number
- address: string
- privateKey: PrivateKey
Returns Address
- Defined in lib/Address.ts:18

Properties

address

address: string

clientProvider

clientProvider: ClientProvider

index

index: number

privateKey

privateKey: PrivateKey

Methods

balance

balance(): Promise<bigint>
Return balance of the address

Returns Promise<bigint>
- Defined in lib/Address.ts:107

send

send(__namedParameters: AddressSendProps & SendCommonProps): Promise<SubmitTransactionResponseMessage>
Create and submit a transaction, where ouputs can contain multiple recipient
Parameters
- __namedParameters: AddressSendProps & SendCommonProps
Returns Promise<SubmitTransactionResponseMessage>
- Defined in lib/Address.ts:72

sendAll

sendAll(__namedParameters: SendAllProps): Promise<SubmitTransactionResponseMessage>
Sends all the available balance to the specified recipient
Parameters
- __namedParameters: SendAllProps
Returns Promise<SubmitTransactionResponseMessage>
- Defined in lib/Address.ts:33

toString

toString(): string
Return a string representation of the address e.g. kaspa:xxxxxx

Returns string
- Defined in lib/Address.ts:130

utxos

utxos(): Promise<UtxosByAddressesEntry[]>
Return a list of UTXOs for the address

Returns Promise<UtxosByAddressesEntry[]>
- Defined in lib/Address.ts:118

Generated using TypeDoc