Helios API/ API Reference/ Interfaces/
Wallet
An interface type for a wallet that manages a user's UTxOs and addresses.
Implemented by
Index
Properties
collateral
• collateral: Promise<TxInput[]>
isMainnet
• isMainnet: () => Promise<boolean>
Type declaration
▸ (): Promise<boolean>
Returns true if the wallet is connected to the mainnet.
Returns
Promise<boolean>
rewardAddresses
• rewardAddresses: Promise<StakeAddress[]>
Returns a list of the reward addresses.
signData
• signData: (addr: Address, sigStructure: string) => Promise<{ key: string ; signature: string }>
Type declaration
▸ (addr, sigStructure): Promise<{ key: string ; signature: string }>
Signs a message, returning an object containing the signature and key that can be used to verify/authenticate the message later.
Parameters
| Name | Type |
|---|---|
addr | Address |
sigStructure | string |
Returns
Promise<{ key: string ; signature: string }>
signTx
• signTx: (tx: Tx) => Promise<Signature[]>
Type declaration
▸ (tx): Promise<Signature[]>
Signs a transaction, returning a list of signatures needed for submitting a valid transaction.
Parameters
| Name | Type |
|---|---|
tx | Tx |
Returns
Promise<Signature[]>
submitTx
• submitTx: (tx: Tx) => Promise<TxId>
Type declaration
▸ (tx): Promise<TxId>
Submits a transaction to the blockchain and returns the id of that transaction upon success.
Parameters
| Name | Type |
|---|---|
tx | Tx |
Returns
Promise<TxId>
unusedAddresses
• unusedAddresses: Promise<Address[]>
Returns a list of unique unused addresses which can be used to send UTxOs to with increased anonimity.
usedAddresses
• usedAddresses: Promise<Address[]>
Returns a list of addresses which already contain UTxOs.
utxos
• utxos: Promise<TxInput[]>
Returns a list of all the utxos controlled by the wallet.