Class ZephyrWalletFull
- All Implemented Interfaces:
ZephyrWallet
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected Set<ZephyrWalletListenerI>The registered listeners, in the order they were added.Fields inherited from interface zephyr.wallet.ZephyrWallet
DEFAULT_LANGUAGE -
Method Summary
Modifier and TypeMethodDescriptionintaddAddressBookEntry(String address, String description) Add an address book entry.voidaddListener(ZephyrWalletListenerI listener) Register a listener to receive wallet notifications.voidchangePassword(String oldPassword, String newPassword) Change the wallet password.checkReserveProof(String address, String message, String signature) Proves a wallet has a disposable reserve using a signature.booleancheckSpendProof(String txHash, String message, String signature) Prove a spend using a signature.checkTxKey(String txHash, String txKey, String address) Check a transaction in the blockchain with its secret key.checkTxProof(String txHash, String address, String message, String signature) Prove a transaction by checking its signature.voidclose()Close the wallet (does not save).voidclose(boolean save) Optionally save then close the wallet.Create a new account.createAccount(String label) Create a new account with a label for the first subaddress.createSubaddress(int accountIdx) Create a subaddress within an account and without a label.createSubaddress(int accountIdx, String label) Create a subaddress within an account.createTx(ZephyrTxConfig config) Create a transaction to transfer funds from this wallet.createTxs(ZephyrTxConfig config) Create one or more transactions to transfer funds from this wallet.static ZephyrWalletFullcreateWallet(ZephyrWalletConfig config) Create a wallet using JNI bindings to wallet2.h.decodeIntegratedAddress(String integratedAddress) Decode an integrated address to get its standard address and payment id.voiddeleteAddressBookEntry(int entryIdx) Delete an address book entry.describeMultisigTxSet(String multisigTxHex) Describe a tx set from multisig tx hex.describeTxSet(ZephyrTxSet txSet) Describe a tx set containing unsigned or multisig tx hex to a new tx set containing structured transactions.describeUnsignedTxSet(String unsignedTxHex) Describe a tx set from unsigned tx hex.voideditAddressBookEntry(int index, boolean setAddress, String address, boolean setDescription, String description) Edit an address book entry.exchangeMultisigKeys(List<String> multisigHexes, String password) Exchange multisig hex with participants in a M/N multisig wallet.Export key images since the last export.exportKeyImages(boolean all) Export signed key images.Export this wallet's multisig info as hex for other participants.Export outputs since the last export.exportOutputs(boolean all) Export outputs in hex format.voidfreezeOutput(String keyImage) Freeze an output.getAccount(int accountIdx) Get an account without subaddress information.getAccount(int accountIdx, boolean includeSubaddresses) Get an account.Get all accounts.getAccounts(boolean includeSubaddresses) Get all accounts.getAccounts(boolean includeSubaddresses, String tag) Get accounts with a given tag.getAccounts(String tag) Get accounts with a given tag.Return all account tags.getAddress(int accountIdx, int subaddressIdx) Get the address of a specific subaddress.Get all address book entries.getAddressBookEntries(List<Integer> entryIndices) Get address book entries.getAddressIndex(String address) Get the account and subaddress index of the given address.getAttribute(String key) Get an attribute.Get the wallet's balance per asset.getBalance(Integer accountIdx) Get the balance of each subaddress of an account, per asset.getBalance(String assetType, Integer accountIdx) Get an account's balance of one asset.getBalance(String assetType, Integer accountIdx, Integer subaddressIdx) Get a subaddress's balance of one asset.Get the circulating supply per asset.Get the wallet's daemon connection.longGet the blockchain's height.longGet the maximum height of the peers the wallet's daemon is connected to.byte[][]getData()Get the wallet's keys and cache data.longGet the block height that the wallet is synced to.longgetHeightByDate(int year, int month, int day) Get the blockchain's height by date as a conservative estimate for scanning.Get all of the wallet's incoming transfers.Get incoming transfers that meet a query.Get an integrated address based on this wallet's primary address and a randomly generated payment ID.getIntegratedAddress(String standardAddress, String paymentId) Get an integrated address based on the given standard address and payment ID.Get the listeners registered with the wallet.Get the wallet's mnemonic phrase.Get the language of the wallet's mnemonic phrase.Get a list of available languages for the wallet's mnemonic phrase.Get multisig info about this wallet.Get the wallet's network type (mainnet, testnet, or stagenet).Get new key images from the last imported outputs.Get all of the wallet's outgoing transfers.Get outgoing transfers that meet a query.Get outputs created from previous transactions that belong to the wallet (i.e.getOutputs(ZephyrOutputQuery query) Get outputs which meet the criteria defined in a query object.getPath()Get the wallet's path.getPaymentUri(ZephyrTxConfig request) Creates a payment URI from a send configuration.Get the wallet's primary address.Get the wallet's private spend key.Get the wallet's private view key.Get the wallet's public spend key.Get the wallet's public view key.Get the state of the Zephyr reserve as the core reports it.getReserveProofAccount(int accountIdx, BigInteger amount, String message) Generate a signature to prove an available amount in an account.getReserveProofWallet(String message) Generate a signature to prove the entire balance of the wallet.longGet the height of the first block that the wallet scans.getSpendProof(String txHash) Generate a signature to prove a spend.getSpendProof(String txHash, String message) Generate a signature to prove a spend.getSubaddress(int accountIdx, int subaddressIdx) Get a subaddress.getSubaddresses(int accountIdx) Get all subaddresses in an account.getSubaddresses(int accountIdx, List<Integer> subaddressIndices) Get subaddresses in an account.Get all incoming and outgoing transfers to and from this wallet.getTransfers(int accountIdx) Get incoming and outgoing transfers to and from an account.getTransfers(int accountIdx, int subaddressIdx) Get incoming and outgoing transfers to and from a subaddress.getTransfers(ZephyrTransferQuery query) Get tranfsers that meet the criteria defined in a query object.Get a wallet transaction by hash.Get a transaction's secret key from its hash.Get a transaction note.getTxNotes(List<String> txHashes) Get notes for multiple transactions.getTxProof(String txHash, String address) Get a transaction signature to prove it.getTxProof(String txHash, String address, String message) Get a transaction signature to prove it.getTxs()Get all wallet transactions.Get wallet transactions by hash.Get wallet transactions by hash.getTxs(List<String> txHashes, Collection<String> missingTxHashes) Get wallet transactions by hash and collect missing tx hashes.getTxs(ZephyrTxQuery query) Get wallet transactions that meet the criteria defined in a query object.getTxs(ZephyrTxQuery query, Collection<String> missingTxHashes) Get wallet transactions that meet the criteria defined in a query object.Get the wallet's unlocked balance per asset.getUnlockedBalance(Integer accountIdx) Get the unlocked balance of each subaddress of an account, per asset.getUnlockedBalance(String assetType, Integer accountIdx) Get an account's unlocked balance of one asset.getUnlockedBalance(String assetType, Integer accountIdx, Integer subaddressIdx) Get a subaddress's unlocked balance of one asset.Returns the wallet version.importKeyImages(List<ZephyrKeyImage> keyImages) Import signed key images and verify their spent status.intimportMultisigHex(String... multisigHexes) Import multisig info as hex from other participants.intimportMultisigHex(List<String> multisigHexes) Import multisig info as hex from other participants.intimportOutputs(String outputsHex) Import outputs in hex format.booleanisClosed()Indicates if this wallet is closed or not.booleanIndicates if the wallet is connected a daemon.booleanIndicates if the wallet's daemon is synced with the network.booleanIndicates if this wallet is a multisig wallet.booleanIndicates if importing multisig data is needed for returning a correct balance.booleanisOutputFrozen(String keyImage) Check if an output is frozen.booleanisSynced()Indicates if the wallet is synced with the daemon.booleanIndicates if the wallet is view-only, meaning it does not have the private spend key and can therefore only observe incoming outputs.makeMultisig(List<String> multisigHexes, int threshold, String password) Make this wallet multisig by importing multisig hex from participants.voidMove the wallet from its current path to the given path.protected ZephyrTransferQueryReturns a copy of the query (a new query for null) whose tx query refers back to it, so that the transfer filter and the tx filter can be applied together.static ZephyrWalletFullopenWallet(String path, String password, ZephyrNetworkType networkType) Open an existing wallet from its files, without a daemon connection.static ZephyrWalletFullopenWallet(String path, String password, ZephyrNetworkType networkType, String daemonUri) Open an existing wallet from its files and connect it to a daemon.static ZephyrWalletFullopenWallet(String path, String password, ZephyrNetworkType networkType, ZephyrRpcConnection daemonConnection) Open an existing wallet using JNI bindings to wallet2.h.static ZephyrWalletFullopenWallet(ZephyrWalletConfig config) Open an existing wallet using JNI bindings to wallet2.h.static ZephyrWalletFullopenWalletData(String password, ZephyrNetworkType networkType, byte[] keysData, byte[] cacheData, ZephyrRpcConnection daemonConnection) Open an existing wallet from byte[] data using JNI bindings to wallet2.hparsePaymentUri(String uri) Parses a payment URI to a transaction configuration.Get multisig info as hex to share with participants to begin creating a multisig wallet.Relay a previously created transaction.Relay a previously created transaction.relayTxs(Collection<String> txMetadatas) Relay previously created transactions.relayTxs(List<ZephyrTxWallet> txs) Relay previously created transactions.voidremoveListener(ZephyrWalletListenerI listener) Unregister a listener to receive wallet notifications.voidRescan the blockchain from scratch, losing any information which cannot be recovered from the blockchain itself.voidRescan the blockchain for spent outputs.voidsave()Save the wallet at its current path.voidscanTxs(Collection<String> txHashes) Scan transactions by their hash/id.voidsetAccountLabel(int accountIdx, String label) Set an account label.voidsetAccountTagLabel(String tag, String label) Sets a human-readable description for a tag.voidsetAttribute(String key, String val) Set an arbitrary attribute.voidSet the wallet's daemon connection.voidsetDaemonConnection(String uri, String username, String password) Set the wallet's daemon connection.voidsetDaemonConnection(ZephyrRpcConnection daemonConnection) Set the wallet's daemon connection.voidsetProxyUri(String uri) Set the Tor proxy to the daemon.voidsetRestoreHeight(long syncHeight) Set the height of the first block that the wallet scans.voidsetSubaddressLabel(int accountIdx, int subaddressIdx, String label) Set a subaddress label.voidSet a note for a specific transaction.voidsetTxNotes(List<String> txHashes, List<String> notes) Set notes for multiple transactions.signMessage(String message) Sign a message.signMessage(String msg, ZephyrMessageSignatureType signatureType, int accountIdx, int subaddressIdx) Sign a message.signMultisigTxHex(String multisigTxHex) Sign multisig transactions from a multisig wallet.Sign unsigned transactions from a view-only wallet.voidstartMining(Long numThreads, Boolean backgroundMining, Boolean ignoreBattery) Start mining.voidStart background synchronizing.voidstartSyncing(Long syncPeriodInMs) Start background synchronizing with a maximum period between syncs.voidStop mining.voidStop synchronizing the wallet with the daemon.submitMultisigTxHex(String signedMultisigTxHex) Submit signed multisig transactions from a multisig wallet.Submit signed transactions from a view-only wallet.sweepDust(boolean relay) Sweep all unmixable dust outputs back to the wallet to make them easier to spend and mix.sweepOutput(ZephyrTxConfig config) Sweep an output with a given key image.sweepUnlocked(ZephyrTxConfig config) Sweep all unlocked funds according to the given config.sync()Synchronize the wallet with the daemon as a one-time synchronous process.Synchronize the wallet with the daemon as a one-time synchronous process.sync(Long startHeight, ZephyrWalletListenerI listener) Synchronize the wallet with the daemon as a one-time synchronous process.sync(ZephyrWalletListenerI listener) Synchronize the wallet with the daemon as a one-time synchronous process.voidtagAccounts(String tag, Collection<Integer> accountIndices) Tag accounts.voidthawOutput(String keyImage) Thaw a frozen output.voiduntagAccounts(Collection<Integer> accountIndices) Untag acconts.verifyMessage(String msg, String address, String signature) Verify a signature on a message.static booleanwalletExists(String path) Indicates if a wallet exists at the given path.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface zephyr.wallet.ZephyrWallet
getOutputAssetType
-
Field Details
-
listeners
The registered listeners, in the order they were added.
-
-
Method Details
-
walletExists
Indicates if a wallet exists at the given path.- Parameters:
path- is the path to check for a wallet- Returns:
- true if a wallet exists at the given path, false otherwise
-
openWallet
public static ZephyrWalletFull openWallet(String path, String password, ZephyrNetworkType networkType, ZephyrRpcConnection daemonConnection) Open an existing wallet using JNI bindings to wallet2.h.- Parameters:
path- is the path to the wallet file to openpassword- is the password of the wallet file to opennetworkType- is the wallet's network typedaemonConnection- is connection configuration to a daemon (default = an unconnected wallet)- Returns:
- the opened wallet
-
openWallet
public static ZephyrWalletFull openWallet(String path, String password, ZephyrNetworkType networkType) Open an existing wallet from its files, without a daemon connection.- Parameters:
path- is the path to the wallet file to openpassword- is the password of the wallet file to opennetworkType- is the wallet's network type- Returns:
- the opened wallet
-
openWallet
public static ZephyrWalletFull openWallet(String path, String password, ZephyrNetworkType networkType, String daemonUri) Open an existing wallet from its files and connect it to a daemon.- Parameters:
path- is the path to the wallet file to openpassword- is the password of the wallet file to opennetworkType- is the wallet's network typedaemonUri- is the daemon's URI (null for an unconnected wallet)- Returns:
- the opened wallet
-
openWalletData
public static ZephyrWalletFull openWalletData(String password, ZephyrNetworkType networkType, byte[] keysData, byte[] cacheData, ZephyrRpcConnection daemonConnection) Open an existing wallet from byte[] data using JNI bindings to wallet2.h- Parameters:
password- the password of the wallet file to opennetworkType- the wallet's network typekeysData- the wallet's keys datacacheData- the wallet's cache datadaemonConnection- connection configuration to a daemon (default = an unconnected wallet)- Returns:
- the opened wallet
-
openWallet
Open an existing wallet using JNI bindings to wallet2.h.
Example:
ZephyrWallet wallet = ZephyrWalletFull.openWallet(new ZephyrWalletConfig()
.setPath("mywallet")
.setPassword("supersecretpassword")
.setNetworkType(ZephyrNetworkType.STAGENET)
.setServerUri("http://localhost:38083"));
All supported configuration:
path - path of the wallet to open
password - password of the wallet to open
networkType - network type of the wallet to open (one of ZephyrNetworkType.MAINNET|TESTNET|STAGENET)
serverUri - uri of the wallet's daemon (optional)
serverUsername - username to authenticate with the daemon (optional)
serverPassword - password to authenticate with the daemon (optional)
server - ZephyrRpcConnection providing server configuration (optional)
- Parameters:
config- configures the wallet to open- Returns:
- the wallet instance
-
createWallet
Create a wallet using JNI bindings to wallet2.h.
Examples:
// create stagenet wallet with randomly generated mnemonic
ZephyrWallet wallet1 = ZephyrWalletFull.createWallet(new ZephyrWalletConfig()
.setPath("/mywallets/wallet1")
.setPassword("supersecretpassword")
.setNetworkType(ZephyrNetworkType.STAGENET)
.setServerUri("http://localhost:38081") // leave blank for offline wallet
.setServerUsername("superuser")
.setServerPassword("abctesting123"));
// restore mainnet wallet from mnemonic
ZephyrWallet wallet2 = ZephyrWalletFull.createWallet(new ZephyrWalletConfig()
.setPath("/mywallets/wallet2") // leave blank for in-memory wallet
.setPassword("abctesting123")
.setNetworkType("mainnet")
.setServerUri("http://localhost:18081")
.setServerUsername("superuser")
.setServerPassword("abctesting123")
.setMnemonic("biggest duets beware eskimos coexist igloo...")
.setRestoreHeight(573800l));
All supported configuration:
path - path of the wallet to create (optional, in-memory wallet if not given)
password - password of the wallet to create
networkType - network type of the wallet to create (one of ZephyrNetworkType.MAINNET|TESTNET|STAGENET)
mnemonic - mnemonic of the wallet to create (optional, random wallet created if neither mnemonic nor keys given)
seedOffset - the offset used to derive a new seed from the given mnemonic to recover a secret wallet from the mnemonic phrase
primaryAddress - primary address of the wallet to create (only provide if restoring from keys)
privateViewKey - private view key of the wallet to create (optional)
privateSpendKey - private spend key of the wallet to create (optional)
restoreHeight - block height to start scanning from (defaults to 0 unless generating random wallet)
language - language of the wallet's mnemonic phrase (defaults to "English" or auto-detected)
serverUri - uri of the wallet's daemon (optional)
serverUsername - username to authenticate with the daemon (optional)
serverPassword - password to authenticate with the daemon (optional)
server - ZephyrRpcConnection providing server configuration (optional)
accountLookahead - number of accounts to scan (optional)
subaddressLookahead - number of subaddresses per account to scan (optional)
- Parameters:
config- configures the wallet to create- Returns:
- the wallet instance
-
getMnemonicLanguages
Get a list of available languages for the wallet's mnemonic phrase.- Returns:
- the available languages for the wallet's mnemonic phrase
-
getDaemonMaxPeerHeight
public long getDaemonMaxPeerHeight()Get the maximum height of the peers the wallet's daemon is connected to.- Returns:
- the maximum height of the peers the wallet's daemon is connected to
-
isDaemonSynced
public boolean isDaemonSynced()Indicates if the wallet's daemon is synced with the network.- Returns:
- true if the daemon is synced with the network, false otherwise
-
isSynced
public boolean isSynced()Indicates if the wallet is synced with the daemon.- Returns:
- true if the wallet is synced with the daemon, false otherwise
-
getNetworkType
Get the wallet's network type (mainnet, testnet, or stagenet).- Returns:
- the wallet's network type
-
getRestoreHeight
public long getRestoreHeight()Get the height of the first block that the wallet scans.- Returns:
- the height of the first block that the wallet scans
-
setRestoreHeight
public void setRestoreHeight(long syncHeight) Set the height of the first block that the wallet scans.- Parameters:
syncHeight- is the height of the first block that the wallet scans
-
moveTo
Move the wallet from its current path to the given path.- Parameters:
path- is the new wallet's path
-
addListener
Description copied from interface:ZephyrWalletRegister a listener to receive wallet notifications.- Specified by:
addListenerin interfaceZephyrWallet- Parameters:
listener- is the listener to receive wallet notifications
-
removeListener
Description copied from interface:ZephyrWalletUnregister a listener to receive wallet notifications.- Specified by:
removeListenerin interfaceZephyrWallet- Parameters:
listener- is the listener to unregister
-
getListeners
Description copied from interface:ZephyrWalletGet the listeners registered with the wallet.- Specified by:
getListenersin interfaceZephyrWallet- Returns:
- the registered listeners
-
isViewOnly
public boolean isViewOnly()Description copied from interface:ZephyrWalletIndicates if the wallet is view-only, meaning it does not have the private spend key and can therefore only observe incoming outputs.- Returns:
- {bool} true if the wallet is view-only, false otherwise
-
setDaemonConnection
Set the wallet's daemon connection. AnhttporhttpsURI without a port gets the scheme's default port (80 or 443) before it reaches the native core, which would otherwise connect to port 0;getDaemonConnection()then reports the URI with that port. Anhttporhttpsscheme in another case (HTTPS://) reaches the core in lower case, since the core switches TLS on only for a lowercasehttps. For anhttpsURI,ZephyrTlsapplies its root certificates first when they are due.- Parameters:
daemonConnection- the daemon connection, or null to disconnect
-
setProxyUri
Description copied from interface:ZephyrWalletSet the Tor proxy to the daemon.- Parameters:
uri- the Tor proxy URI
-
getDaemonConnection
Description copied from interface:ZephyrWalletGet the wallet's daemon connection.- Returns:
- the wallet's daemon connection
-
isConnectedToDaemon
public boolean isConnectedToDaemon()Description copied from interface:ZephyrWalletIndicates if the wallet is connected a daemon.- Returns:
- true if the wallet is connected to a daemon, false otherwise
-
getVersion
Description copied from interface:ZephyrWalletReturns the wallet version.- Returns:
- the wallet version
-
getPath
Description copied from interface:ZephyrWalletGet the wallet's path.- Returns:
- the path the wallet can be opened with
-
getMnemonic
Description copied from interface:ZephyrWalletGet the wallet's mnemonic phrase.- Returns:
- the wallet's mnemonic phrase
-
getMnemonicLanguage
Description copied from interface:ZephyrWalletGet the language of the wallet's mnemonic phrase.- Returns:
- the language of the wallet's mnemonic phrase
-
getPrivateViewKey
Description copied from interface:ZephyrWalletGet the wallet's private view key.- Returns:
- the wallet's private view key
-
getPrivateSpendKey
Description copied from interface:ZephyrWalletGet the wallet's private spend key.- Returns:
- the wallet's private spend key
-
getPublicViewKey
Description copied from interface:ZephyrWalletGet the wallet's public view key.- Returns:
- the wallet's public view key
-
getPublicSpendKey
Description copied from interface:ZephyrWalletGet the wallet's public spend key.- Returns:
- the wallet's public spend key
-
getIntegratedAddress
Description copied from interface:ZephyrWalletGet an integrated address based on the given standard address and payment ID. Uses the wallet's primary address if an address is not given. Generates a random payment ID if a payment ID is not given.- Parameters:
standardAddress- is the standard address to generate the integrated address from (wallet's primary address if null)paymentId- is the payment ID to generate an integrated address from (randomly generated if null)- Returns:
- the integrated address
-
decodeIntegratedAddress
Description copied from interface:ZephyrWalletDecode an integrated address to get its standard address and payment id.- Parameters:
integratedAddress- is an integrated address to decode- Returns:
- the decoded integrated address including standard address and payment id
-
getHeight
public long getHeight()Description copied from interface:ZephyrWalletGet the block height that the wallet is synced to.- Returns:
- the block height that the wallet is synced to
-
getDaemonHeight
public long getDaemonHeight()Description copied from interface:ZephyrWalletGet the blockchain's height.- Returns:
- the blockchain's height
-
getHeightByDate
public long getHeightByDate(int year, int month, int day) Description copied from interface:ZephyrWalletGet the blockchain's height by date as a conservative estimate for scanning.- Parameters:
year- year of the height to getmonth- month of the height to get as a number between 1 and 12day- day of the height to get as a number between 1 and 31- Returns:
- the blockchain's approximate height at the given date
-
sync
Description copied from interface:ZephyrWalletSynchronize the wallet with the daemon as a one-time synchronous process.- Specified by:
syncin interfaceZephyrWallet- Parameters:
startHeight- is the start height to sync from (defaults to the last synced block)listener- listener to receive notifications during synchronization- Returns:
- the sync result
-
startSyncing
Description copied from interface:ZephyrWalletStart background synchronizing with a maximum period between syncs.- Parameters:
syncPeriodInMs- maximum period between syncs in milliseconds
-
stopSyncing
public void stopSyncing()Description copied from interface:ZephyrWalletStop synchronizing the wallet with the daemon. -
scanTxs
Description copied from interface:ZephyrWalletScan transactions by their hash/id.- Parameters:
txHashes- tx hashes to scan
-
rescanSpent
public void rescanSpent()Description copied from interface:ZephyrWalletRescan the blockchain for spent outputs. Note: this can only be called with a trusted daemon. Example use case: peer multisig hex is import when connected to an untrusted daemon, so the wallet will not rescan spent outputs. Then the wallet connects to a trusted daemon. This method should be manually invoked to rescan outputs. -
rescanBlockchain
public void rescanBlockchain()Description copied from interface:ZephyrWalletRescan the blockchain from scratch, losing any information which cannot be recovered from the blockchain itself. WARNING: This method discards local wallet data like destination addresses, tx secret keys, tx notes, etc. -
getAccounts
Description copied from interface:ZephyrWalletGet accounts with a given tag.- Parameters:
includeSubaddresses- specifies if subaddresses should be includedtag- is the tag for filtering accounts, all accounts if null- Returns:
- all accounts with the given tag
-
getAccount
Description copied from interface:ZephyrWalletGet an account.- Parameters:
accountIdx- specifies the account to getincludeSubaddresses- specifies if subaddresses should be included- Returns:
- the retrieved account
-
createAccount
Description copied from interface:ZephyrWalletCreate a new account with a label for the first subaddress.- Parameters:
label- specifies the label for account's first subaddress (optional)- Returns:
- the created account
-
getSubaddresses
Description copied from interface:ZephyrWalletGet subaddresses in an account.- Parameters:
accountIdx- specifies the account to get subaddresses withinsubaddressIndices- are specific subaddresses to get (optional)- Returns:
- the retrieved subaddresses
-
createSubaddress
Description copied from interface:ZephyrWalletCreate a subaddress within an account.- Parameters:
accountIdx- specifies the index of the account to create the subaddress withinlabel- specifies the the label for the subaddress (optional)- Returns:
- the created subaddress
-
setSubaddressLabel
Description copied from interface:ZephyrWalletSet a subaddress label.- Parameters:
accountIdx- index of the account to set the label forsubaddressIdx- index of the subaddress to set the label forlabel- the label to set
-
getAddress
Description copied from interface:ZephyrWalletGet the address of a specific subaddress.- Parameters:
accountIdx- specifies the account index of the address's subaddresssubaddressIdx- specifies the subaddress index within the account- Returns:
- the receive address of the specified subaddress
-
getAddressIndex
Description copied from interface:ZephyrWalletGet the account and subaddress index of the given address.- Parameters:
address- is the address to get the account and subaddress index from- Returns:
- the account and subaddress indices
-
getBalance
Description copied from interface:ZephyrWalletGet the wallet's balance per asset. Amounts are in atomic units (10^12 per coin for every asset). The asset is an open string; the constants of the current assets are in ZephyrAssets.- Returns:
- the wallet's balance per asset
-
getBalance
Description copied from interface:ZephyrWalletGet the balance of each subaddress of an account, per asset. The map is keyed by subaddress index and may omit subaddresses that never held funds. Amounts are in atomic units (10^12 per coin for every asset). The asset is an open string; the constants of the current assets are in ZephyrAssets.- Parameters:
accountIdx- index of the account to get the balances of (required)- Returns:
- the balance per asset of each subaddress of the account, keyed by subaddress index
-
getBalance
Description copied from interface:ZephyrWalletGet a subaddress's balance of one asset. Throws ZephyrError "Must provide account index" if the account index is null, which includes a subaddress index given without an account index.- Parameters:
assetType- the asset to get the balance of (an open string, see ZephyrAssets)accountIdx- index of the account to get the balance of (required)subaddressIdx- index of the subaddress to get the balance of (the whole account if null)- Returns:
- the requested balance of the asset in atomic units (10^12 per coin)
-
getUnlockedBalance
Description copied from interface:ZephyrWalletGet the wallet's unlocked balance per asset. Amounts are in atomic units (10^12 per coin for every asset). The asset is an open string; the constants of the current assets are in ZephyrAssets.- Returns:
- the wallet's unlocked balance per asset
-
getUnlockedBalance
Description copied from interface:ZephyrWalletGet the unlocked balance of each subaddress of an account, per asset. The map is keyed by subaddress index and may omit subaddresses that never held funds. Amounts are in atomic units (10^12 per coin for every asset). The asset is an open string; the constants of the current assets are in ZephyrAssets.- Parameters:
accountIdx- index of the account to get the unlocked balances of (required)- Returns:
- the unlocked balance per asset of each subaddress of the account, keyed by subaddress index
-
getUnlockedBalance
Description copied from interface:ZephyrWalletGet a subaddress's unlocked balance of one asset. Throws ZephyrError "Must provide account index" if the account index is null, which includes a subaddress index given without an account index.- Parameters:
assetType- the asset to get the unlocked balance of (an open string, see ZephyrAssets)accountIdx- index of the account to get the unlocked balance of (required)subaddressIdx- index of the subaddress to get the unlocked balance of (the whole account if null)- Returns:
- the requested unlocked balance of the asset in atomic units (10^12 per coin)
-
getReserveInfo
Description copied from interface:ZephyrWalletGet the state of the Zephyr reserve as the core reports it.- Returns:
- the reserve state (amounts in atomic units, ratios dimensionless)
-
getCirculatingSupply
Description copied from interface:ZephyrWalletGet the circulating supply per asset.- Returns:
- the circulating supply per asset in atomic units (10^12 per coin for every asset)
-
getTxs
Description copied from interface:ZephyrWalletGet wallet transactions that meet the criteria defined in a query object.
Transactions must meet every criteria defined in the query in order to be returned. All criteria are optional and no filtering is applied when not defined.
If querying transactions by hash, unfound or unmet transaction hashes are added to the provided collection.
All supported query criteria:
isConfirmed - path of the wallet to open
password - password of the wallet to open
networkType - network type of the wallet to open (one of ZephyrNetworkType.MAINNET|TESTNET|STAGENET)
serverUri - uri of the wallet's daemon (optional)
serverUsername - username to authenticate with the daemon (optional)
serverPassword - password to authenticate with the daemon (optional)
server - ZephyrRpcConnection providing server configuration (optional)
isConfirmed - get txs that are confirmed or not (optional)
inTxPool - get txs that are in the tx pool or not (optional)
isRelayed - get txs that are relayed or not (optional)
isFailed - get txs that are failed or not (optional)
isMinerTx - get miner txs or not (optional)
hash - get a tx with the hash (optional)
hashes - get txs with the hashes (optional)
paymentId - get transactions with the payment id (optional)
paymentIds - get transactions with the payment ids (optional)
hasPaymentId - get transactions with a payment id or not (optional)
minHeight - get txs with height greater than or equal to the given height (optional)
maxHeight - get txs with height less than or equal to the given height (optional)
isOutgoing - get txs with an outgoing transfer or not (optional)
isIncoming - get txs with an incoming transfer or not (optional)
transferQuery - get txs that have a transfer that meets this query (optional)
includeOutputs - specifies that tx outputs should be returned with tx results (optional)
- Parameters:
query- specifies properties of the transactions to getmissingTxHashes- populated with hashes of unfound or unmet transactions that were queried by hash (throws error if null and queried transaction hashes are unfound or unmet)- Returns:
- wallet transactions that meet the query
-
getTransfers
Description copied from interface:ZephyrWalletGet tranfsers that meet the criteria defined in a query object.
Transfers must meet every criteria defined in the query in order to be returned. All criteria are optional and no filtering is applied when not defined.
All supported query criteria:
isOutgoing - get transfers that are outgoing or not (optional)
isIncoming - get transfers that are incoming or not (optional)
address - wallet's address that a transfer either originated from (if outgoing) or is destined for (if incoming) (optional)
accountIndex - get transfers that either originated from (if outgoing) or are destined for (if incoming) a specific account index (optional)
subaddressIndex - get transfers that either originated from (if outgoing) or are destined for (if incoming) a specific subaddress index (optional)
subaddressIndices - get transfers that either originated from (if outgoing) or are destined for (if incoming) specific subaddress indices (optional)
amount - amount being transferred (optional)
destinations - individual destinations of an outgoing transfer, which is local wallet data and NOT recoverable from the blockchain (optional)
hasDestinations - get transfers that have destinations or not (optional)
txQuery - get transfers whose transaction meets this query (optional)- Parameters:
query- specifies attributes of transfers to get- Returns:
- wallet transfers that meet the query
-
getOutputs
Description copied from interface:ZephyrWalletGet outputs which meet the criteria defined in a query object.
Outputs must meet every criteria defined in the query in order to be returned. All criteria are optional and no filtering is applied when not defined.
All supported query criteria:
accountIndex - get outputs associated with a specific account index (optional)
subaddressIndex - get outputs associated with a specific subaddress index (optional)
subaddressIndices - get outputs associated with specific subaddress indices (optional)
amount - get outputs with a specific amount (optional)
minAmount - get outputs greater than or equal to a minimum amount (optional)
maxAmount - get outputs less than or equal to a maximum amount (optional)
isSpent - get outputs that are spent or not (optional)
keyImage - get outputs that match the fields defined in the given key image (optional)
txQuery - get outputs whose transaction meets this filter (optional)
Zephyr: in the full wallet (
ZephyrWalletFull) the outputs carry no asset (ZephyrOutputWallet.getAssetType()isnull): the core keeps an output's asset but does not serialize it.ZephyrWallet.getOutputAssetType(ZephyrOutputWallet)takes the asset from the output's transaction. See the user guide,docs/guide/08-known-limitations.md, section "getOutputs() reports no asset".- Parameters:
query- specifies attributes of outputs to get- Returns:
- the queried outputs
-
exportOutputs
Description copied from interface:ZephyrWalletExport outputs in hex format.- Parameters:
all- exports all outputs if true, else exports the outputs since the last export- Returns:
- outputs in hex format
-
importOutputs
Description copied from interface:ZephyrWalletImport outputs in hex format.- Parameters:
outputsHex- are outputs in hex format- Returns:
- the number of outputs imported
-
exportKeyImages
Description copied from interface:ZephyrWalletExport signed key images.- Parameters:
all- exports all key images if true, else exports the key images since the last export- Returns:
- signed key images
-
importKeyImages
Description copied from interface:ZephyrWalletImport signed key images and verify their spent status.- Parameters:
keyImages- are key images to import and verify (requires hex and signature)- Returns:
- results of the import
-
getNewKeyImagesFromLastImport
Description copied from interface:ZephyrWalletGet new key images from the last imported outputs.- Returns:
- the key images from the last imported outputs
-
freezeOutput
Description copied from interface:ZephyrWalletFreeze an output.- Parameters:
keyImage- key image of the output to freeze
-
thawOutput
Description copied from interface:ZephyrWalletThaw a frozen output.- Parameters:
keyImage- key image of the output to thaw
-
isOutputFrozen
Description copied from interface:ZephyrWalletCheck if an output is frozen.- Parameters:
keyImage- key image of the output to check if frozen- Returns:
- true if the output is frozen, false otherwise
-
createTxs
Description copied from interface:ZephyrWalletCreate one or more transactions to transfer funds from this wallet.All supported configuration:
address - single destination address (required unless `destinations` provided)
amount - single destination amount (required unless `destinations` provided)
accountIndex - source account index to transfer funds from (required)
subaddressIndex - source subaddress index to transfer funds from (optional)
subaddressIndices - source subaddress indices to transfer funds from (optional)
relay - relay the transactions to peers to commit to the blockchain (default false)
priority - transaction priority (default ZephyrTxPriority.NORMAL)
destinations - addresses and amounts in a multi-destination tx (required unless `address` and `amount` provided)
paymentId - transaction payment ID (optional)
unlockHeight - minimum height for the transactions to unlock (default 0)
canSplit - allow funds to be transferred using multiple transactions (default true)
- Parameters:
config- configures the transactions to create- Returns:
- the created transactions
-
sweepOutput
Description copied from interface:ZephyrWalletSweep an output with a given key image.All supported configuration:
address - single destination address (required)
keyImage - key image to sweep (required)
relay - relay the transaction to peers to commit to the blockchain (default false)
unlockHeight - minimum height for the transaction to unlock (default 0)
priority - transaction priority (default ZephyrTxPriority.NORMAL)
- Parameters:
config- configures the sweep transaction- Returns:
- the created transaction
-
sweepUnlocked
Description copied from interface:ZephyrWalletSweep all unlocked funds according to the given config.All supported configuration:
address - single destination address (required)
accountIndex - source account index to sweep from (optional, defaults to all accounts)
subaddressIndex - source subaddress index to sweep from (optional, defaults to all subaddresses)
subaddressIndices - source subaddress indices to sweep from (optional)
relay - relay the transactions to peers to commit to the blockchain (default false)
priority - transaction priority (default ZephyrTxPriority.NORMAL)
unlockHeight - minimum height for the transactions to unlock (default 0)
sweepEachSubaddress - sweep each subaddress individually if true (default false)
- Parameters:
config- is the sweep configuration- Returns:
- the created transactions
-
sweepDust
Description copied from interface:ZephyrWalletSweep all unmixable dust outputs back to the wallet to make them easier to spend and mix. NOTE: Dust only exists pre RCT, so this method will throw "no dust to sweep" on new wallets.- Parameters:
relay- specifies if the resulting transaction should be relayed (defaults to false i.e. not relayed)- Returns:
- the created transactions
-
relayTxs
Description copied from interface:ZephyrWalletRelay previously created transactions.- Parameters:
txMetadatas- are transaction metadata previously created without relaying- Returns:
- the hashes of the relayed txs
-
describeTxSet
Description copied from interface:ZephyrWalletDescribe a tx set containing unsigned or multisig tx hex to a new tx set containing structured transactions.- Parameters:
txSet- is a tx set containing unsigned or multisig tx hex- Returns:
- the tx set containing structured transactions
-
signTxs
Description copied from interface:ZephyrWalletSign unsigned transactions from a view-only wallet.- Parameters:
unsignedTxHex- is unsigned transaction hex from when the transactions were created- Returns:
- the signed transaction hex
-
submitTxs
Description copied from interface:ZephyrWalletSubmit signed transactions from a view-only wallet.- Parameters:
signedTxHex- is signed transaction hex from signTxs()- Returns:
- the resulting transaction hashes
-
checkTxKey
Description copied from interface:ZephyrWalletCheck a transaction in the blockchain with its secret key.Zephyr: in the full wallet (
ZephyrWalletFull) the received amount of the result is 0 for every current transaction. The core reads the amount of the assetZEPHonly, and since hard fork 11 (height 536,000) no output isZEPH.ZephyrCheck.isGood()and the confirmations are right. Read the amount fromZephyrWallet.getTxs(String...)instead: the receiver's incoming transfers, or the sender's outgoing destinations, each with its asset. See the user guide,docs/guide/08-known-limitations.md, section "checkTxKey returns amount 0".- Parameters:
txHash- specifies the transaction to checktxKey- is the transaction's secret keyaddress- is the destination public address of the transaction- Returns:
- the result of the check
-
getTxProof
Description copied from interface:ZephyrWalletGet a transaction signature to prove it.- Parameters:
txHash- specifies the transaction to proveaddress- is the destination public address of the transactionmessage- is a message to include with the signature to further authenticate the proof (optional)- Returns:
- the transaction signature
-
checkTxProof
Description copied from interface:ZephyrWalletProve a transaction by checking its signature.Zephyr: in the full wallet (
ZephyrWalletFull) the received amount of the result is 0 for every current transaction, from the same core code asZephyrWallet.checkTxKey(java.lang.String, java.lang.String, java.lang.String): the core reads the amount of the assetZEPHonly, which no output has carried since hard fork 11.ZephyrCheck.isGood()and the confirmations are right. Read the amount fromZephyrWallet.getTxs(String...)instead. See the user guide,docs/guide/08-known-limitations.md, section "checkTxKey returns amount 0".- Parameters:
txHash- specifies the transaction to proveaddress- is the destination public address of the transactionmessage- is a message included with the signature to further authenticate the proof (optional)signature- is the transaction signature to confirm- Returns:
- the result of the check
-
getSpendProof
Description copied from interface:ZephyrWalletGenerate a signature to prove a spend. Unlike proving a transaction, it does not require the destination public address.- Parameters:
txHash- specifies the transaction to provemessage- is a message to include with the signature to further authenticate the proof (optional)- Returns:
- the transaction signature
-
checkSpendProof
Description copied from interface:ZephyrWalletProve a spend using a signature. Unlike proving a transaction, it does not require the destination public address.- Parameters:
txHash- specifies the transaction to provemessage- is a message included with the signature to further authenticate the proof (optional)signature- is the transaction signature to confirm- Returns:
- true if the signature is good, false otherwise
-
getReserveProofWallet
Description copied from interface:ZephyrWalletGenerate a signature to prove the entire balance of the wallet.- Parameters:
message- is a message included with the signature to further authenticate the proof (optional)- Returns:
- the reserve proof signature
-
getReserveProofAccount
Description copied from interface:ZephyrWalletGenerate a signature to prove an available amount in an account.- Parameters:
accountIdx- specifies the account to prove ownership of the amountamount- is the minimum amount to prove as available in the accountmessage- is a message to include with the signature to further authenticate the proof (optional)- Returns:
- the reserve proof signature
-
checkReserveProof
Description copied from interface:ZephyrWalletProves a wallet has a disposable reserve using a signature.- Parameters:
address- is the public wallet addressmessage- is a message included with the signature to further authenticate the proof (optional)signature- is the reserve proof signature to check- Returns:
- the result of checking the signature proof
-
signMessage
public String signMessage(String msg, ZephyrMessageSignatureType signatureType, int accountIdx, int subaddressIdx) Description copied from interface:ZephyrWalletSign a message.- Parameters:
msg- the message to signsignatureType- sign with spend key or view keyaccountIdx- the account index of the message signature (default 0)subaddressIdx- the subaddress index of the message signature (default 0)- Returns:
- the signature
-
verifyMessage
Description copied from interface:ZephyrWalletVerify a signature on a message.- Parameters:
msg- is the signed messageaddress- is the signing addresssignature- is the signature- Returns:
- the message signature verification result
-
getTxKey
Description copied from interface:ZephyrWalletGet a transaction's secret key from its hash.- Parameters:
txHash- is the transaction's hash- Returns:
- is the transaction's secret key
-
getTxNotes
Description copied from interface:ZephyrWalletGet notes for multiple transactions.- Parameters:
txHashes- identify the transactions to get notes for- Returns:
- notes for the transactions
-
setTxNotes
Description copied from interface:ZephyrWalletSet notes for multiple transactions.- Parameters:
txHashes- specify the transactions to set notes fornotes- are the notes to set for the transactions
-
getAddressBookEntries
Description copied from interface:ZephyrWalletGet address book entries.- Parameters:
entryIndices- are indices of the entries to get (optional)- Returns:
- the address book entries
-
addAddressBookEntry
Description copied from interface:ZephyrWalletAdd an address book entry.- Parameters:
address- is the entry addressdescription- is the entry description (optional)- Returns:
- the index of the added entry
-
editAddressBookEntry
public void editAddressBookEntry(int index, boolean setAddress, String address, boolean setDescription, String description) Description copied from interface:ZephyrWalletEdit an address book entry.- Parameters:
index- is the index of the address book entry to editsetAddress- specifies if the address should be updatedaddress- is the updated addresssetDescription- specifies if the description should be updateddescription- is the updated description
-
deleteAddressBookEntry
public void deleteAddressBookEntry(int entryIdx) Description copied from interface:ZephyrWalletDelete an address book entry.- Parameters:
entryIdx- is the index of the entry to delete
-
tagAccounts
Description copied from interface:ZephyrWalletTag accounts.- Parameters:
tag- is the tag to apply to the specified accountsaccountIndices- are the indices of the accounts to tag
-
untagAccounts
Description copied from interface:ZephyrWalletUntag acconts.- Parameters:
accountIndices- are the indices of the accounts to untag
-
getAccountTags
Description copied from interface:ZephyrWalletReturn all account tags.- Returns:
- the wallet's account tags
-
setAccountTagLabel
Description copied from interface:ZephyrWalletSets a human-readable description for a tag.- Parameters:
tag- is the tag to set a description forlabel- is the label to set for the tag
-
getPaymentUri
Description copied from interface:ZephyrWalletCreates a payment URI from a send configuration.- Parameters:
request- specifies configuration for a potential tx- Returns:
- the payment uri
-
parsePaymentUri
Description copied from interface:ZephyrWalletParses a payment URI to a transaction configuration.- Parameters:
uri- is the payment uri to parse- Returns:
- the send configuration parsed from the uri
-
getAttribute
Description copied from interface:ZephyrWalletGet an attribute.- Parameters:
key- is the attribute to get the value of- Returns:
- the attribute's value
-
setAttribute
Description copied from interface:ZephyrWalletSet an arbitrary attribute.- Parameters:
key- is the attribute keyval- is the attribute value
-
startMining
Description copied from interface:ZephyrWalletStart mining.- Parameters:
numThreads- is the number of threads created for mining (optional)backgroundMining- specifies if mining should occur in the background (optional)ignoreBattery- specifies if the battery should be ignored for mining (optional)
-
stopMining
public void stopMining()Description copied from interface:ZephyrWalletStop mining. -
isMultisigImportNeeded
public boolean isMultisigImportNeeded()Description copied from interface:ZephyrWalletIndicates if importing multisig data is needed for returning a correct balance.- Returns:
- true if importing multisig data is needed for returning a correct balance, false otherwise
-
getMultisigInfo
Description copied from interface:ZephyrWalletGet multisig info about this wallet.- Returns:
- multisig info about this wallet
-
prepareMultisig
Description copied from interface:ZephyrWalletGet multisig info as hex to share with participants to begin creating a multisig wallet.- Returns:
- this wallet's multisig hex to share with participants
-
makeMultisig
Description copied from interface:ZephyrWalletMake this wallet multisig by importing multisig hex from participants.- Parameters:
multisigHexes- are multisig hex from each participantthreshold- is the number of signatures needed to sign transferspassword- is the wallet password- Returns:
- this wallet's multisig hex to share with participants
-
exchangeMultisigKeys
Description copied from interface:ZephyrWalletExchange multisig hex with participants in a M/N multisig wallet. This process must be repeated with participants exactly N-M times.- Parameters:
multisigHexes- are multisig hex from each participantpassword- is the wallet's password // TODO zephyr: redundant? wallet is created with password- Returns:
- the result which has the multisig's address xor this wallet's multisig hex to share with participants iff not done
-
exportMultisigHex
Description copied from interface:ZephyrWalletExport this wallet's multisig info as hex for other participants.- Returns:
- this wallet's multisig info as hex for other participants
-
importMultisigHex
Description copied from interface:ZephyrWalletImport multisig info as hex from other participants.- Parameters:
multisigHexes- are multisig hex from each participant- Returns:
- the number of outputs signed with the given multisig hex
-
signMultisigTxHex
Description copied from interface:ZephyrWalletSign multisig transactions from a multisig wallet.- Parameters:
multisigTxHex- represents unsigned multisig transactions as hex- Returns:
- the result of signing the multisig transactions
-
submitMultisigTxHex
Description copied from interface:ZephyrWalletSubmit signed multisig transactions from a multisig wallet.- Parameters:
signedMultisigTxHex- is signed multisig hex returned from signMultisigTxHex()- Returns:
- the resulting transaction hashes
-
getData
public byte[][] getData()Get the wallet's keys and cache data.- Returns:
- the keys and cache data, respectively
-
changePassword
Description copied from interface:ZephyrWalletChange the wallet password.- Parameters:
oldPassword- is the wallet's old passwordnewPassword- is the wallet's new password
-
save
public void save()Description copied from interface:ZephyrWalletSave the wallet at its current path. -
close
public void close(boolean save) Description copied from interface:ZephyrWalletOptionally save then close the wallet.- Parameters:
save- specifies if the wallet should be saved before being closed (default false)
-
isClosed
public boolean isClosed()Description copied from interface:ZephyrWalletIndicates if this wallet is closed or not.- Returns:
- true if the wallet is closed, false otherwise
-
setDaemonConnection
Description copied from interface:ZephyrWalletSet the wallet's daemon connection.- Specified by:
setDaemonConnectionin interfaceZephyrWallet- Parameters:
uri- is the uri of the daemon for the wallet to use
-
setDaemonConnection
Description copied from interface:ZephyrWalletSet the wallet's daemon connection.- Specified by:
setDaemonConnectionin interfaceZephyrWallet- Parameters:
uri- is the daemon's URIusername- is the username to authenticate with the daemon (optional)password- is the password to authenticate with the daemon (optional)
-
getPrimaryAddress
Description copied from interface:ZephyrWalletGet the wallet's primary address.- Specified by:
getPrimaryAddressin interfaceZephyrWallet- Returns:
- the wallet's primary address
-
getIntegratedAddress
Description copied from interface:ZephyrWalletGet an integrated address based on this wallet's primary address and a randomly generated payment ID.- Specified by:
getIntegratedAddressin interfaceZephyrWallet- Returns:
- the integrated address
-
sync
Description copied from interface:ZephyrWalletSynchronize the wallet with the daemon as a one-time synchronous process.- Specified by:
syncin interfaceZephyrWallet- Returns:
- the sync result
-
sync
Description copied from interface:ZephyrWalletSynchronize the wallet with the daemon as a one-time synchronous process.- Specified by:
syncin interfaceZephyrWallet- Parameters:
listener- listener to receive notifications during synchronization- Returns:
- the sync result
-
sync
Description copied from interface:ZephyrWalletSynchronize the wallet with the daemon as a one-time synchronous process.- Specified by:
syncin interfaceZephyrWallet- Parameters:
startHeight- is the start height to sync from (defaults to the last synced block)- Returns:
- the sync result
-
startSyncing
public void startSyncing()Description copied from interface:ZephyrWalletStart background synchronizing.- Specified by:
startSyncingin interfaceZephyrWallet
-
getBalance
Description copied from interface:ZephyrWalletGet an account's balance of one asset. Throws ZephyrError "Must provide account index" if the account index is null.- Specified by:
getBalancein interfaceZephyrWallet- Parameters:
assetType- the asset to get the balance of (an open string, see ZephyrAssets)accountIdx- index of the account to get the balance of (required)- Returns:
- the account's balance of the asset in atomic units (10^12 per coin)
-
getUnlockedBalance
Description copied from interface:ZephyrWalletGet an account's unlocked balance of one asset. Throws ZephyrError "Must provide account index" if the account index is null.- Specified by:
getUnlockedBalancein interfaceZephyrWallet- Parameters:
assetType- the asset to get the unlocked balance of (an open string, see ZephyrAssets)accountIdx- index of the account to get the unlocked balance of (required)- Returns:
- the account's unlocked balance of the asset in atomic units (10^12 per coin)
-
getAccounts
Description copied from interface:ZephyrWalletGet all accounts.- Specified by:
getAccountsin interfaceZephyrWallet- Returns:
- all accounts
-
getAccounts
Description copied from interface:ZephyrWalletGet all accounts.- Specified by:
getAccountsin interfaceZephyrWallet- Parameters:
includeSubaddresses- specifies if subaddresses should be included- Returns:
- all accounts
-
getAccounts
Description copied from interface:ZephyrWalletGet accounts with a given tag.- Specified by:
getAccountsin interfaceZephyrWallet- Parameters:
tag- is the tag for filtering accounts, all accounts if null- Returns:
- all accounts with the given tag
-
getAccount
Description copied from interface:ZephyrWalletGet an account without subaddress information.- Specified by:
getAccountin interfaceZephyrWallet- Parameters:
accountIdx- specifies the account to get- Returns:
- the retrieved account
-
createAccount
Description copied from interface:ZephyrWalletCreate a new account.- Specified by:
createAccountin interfaceZephyrWallet- Returns:
- the created account
-
setAccountLabel
Description copied from interface:ZephyrWalletSet an account label.- Specified by:
setAccountLabelin interfaceZephyrWallet- Parameters:
accountIdx- index of the account to set the label forlabel- the label to set
-
getSubaddresses
Description copied from interface:ZephyrWalletGet all subaddresses in an account.- Specified by:
getSubaddressesin interfaceZephyrWallet- Parameters:
accountIdx- specifies the account to get subaddresses within- Returns:
- the retrieved subaddresses
-
getSubaddress
Description copied from interface:ZephyrWalletGet a subaddress.- Specified by:
getSubaddressin interfaceZephyrWallet- Parameters:
accountIdx- specifies the index of the subaddress's accountsubaddressIdx- specifies index of the subaddress within the account- Returns:
- the retrieved subaddress
-
createSubaddress
Description copied from interface:ZephyrWalletCreate a subaddress within an account and without a label.- Specified by:
createSubaddressin interfaceZephyrWallet- Parameters:
accountIdx- specifies the index of the account to create the subaddress within- Returns:
- the created subaddress
-
getTx
Description copied from interface:ZephyrWalletGet a wallet transaction by hash.- Specified by:
getTxin interfaceZephyrWallet- Parameters:
txHash- is the hash of a transaction to get- Returns:
- the identified transaction or throw if not found
-
getTxs
Description copied from interface:ZephyrWalletGet all wallet transactions. Wallet transactions contain one or more transfers that are either incoming or outgoing to the wallet.- Specified by:
getTxsin interfaceZephyrWallet- Returns:
- all wallet transactions
-
getTxs
Description copied from interface:ZephyrWalletGet wallet transactions by hash.- Specified by:
getTxsin interfaceZephyrWallet- Parameters:
txHashes- are hashes of transactions to get- Returns:
- the identified transactions or throw if a transaction is not found
-
getTxs
Description copied from interface:ZephyrWalletGet wallet transactions by hash.- Specified by:
getTxsin interfaceZephyrWallet- Parameters:
txHashes- are hashes of transactions to get- Returns:
- the identified transactions or throw if a transaction is not found
-
getTxs
Description copied from interface:ZephyrWalletGet wallet transactions by hash and collect missing tx hashes.- Specified by:
getTxsin interfaceZephyrWallet- Parameters:
txHashes- are hashes of transactions to getmissingTxHashes- is populated with requested but missing tx hashes- Returns:
- the found transactions
-
getTxs
Description copied from interface:ZephyrWalletGet wallet transactions that meet the criteria defined in a query object.
Transactions must meet every criteria defined in the query in order to be returned. All criteria are optional and no filtering is applied when not defined.
All supported query criteria:
isConfirmed - path of the wallet to open
password - password of the wallet to open
networkType - network type of the wallet to open (one of ZephyrNetworkType.MAINNET|TESTNET|STAGENET)
serverUri - uri of the wallet's daemon (optional)
serverUsername - username to authenticate with the daemon (optional)
serverPassword - password to authenticate with the daemon (optional)
server - ZephyrRpcConnection providing server configuration (optional)
isConfirmed - get txs that are confirmed or not (optional)
inTxPool - get txs that are in the tx pool or not (optional)
isRelayed - get txs that are relayed or not (optional)
isFailed - get txs that are failed or not (optional)
isMinerTx - get miner txs or not (optional)
hash - get a tx with the hash (optional)
hashes - get txs with the hashes (optional)
paymentId - get transactions with the payment id (optional)
paymentIds - get transactions with the payment ids (optional)
hasPaymentId - get transactions with a payment id or not (optional)
minHeight - get txs with height greater than or equal to the given height (optional)
maxHeight - get txs with height less than or equal to the given height (optional)
isOutgoing - get txs with an outgoing transfer or not (optional)
isIncoming - get txs with an incoming transfer or not (optional)
transferQuery - get txs that have a transfer that meets this query (optional)
includeOutputs - specifies that tx outputs should be returned with tx results (optional)
- Specified by:
getTxsin interfaceZephyrWallet- Parameters:
query- specifies properties of the transactions to get- Returns:
- wallet transactions that meet the query
-
getTransfers
Description copied from interface:ZephyrWalletGet all incoming and outgoing transfers to and from this wallet. An outgoing transfer represents a total amount sent from one or more subaddresses within an account to individual destination addresses, each with their own amount. An incoming transfer represents a total amount received into a subaddress within an account. Transfers belong to transactions which are stored on the blockchain.- Specified by:
getTransfersin interfaceZephyrWallet- Returns:
- all wallet transfers
-
getTransfers
Description copied from interface:ZephyrWalletGet incoming and outgoing transfers to and from an account. An outgoing transfer represents a total amount sent from one or more subaddresses within an account to individual destination addresses, each with their own amount. An incoming transfer represents a total amount received into a subaddress within an account. Transfers belong to transactions which are stored on the blockchain.- Specified by:
getTransfersin interfaceZephyrWallet- Parameters:
accountIdx- is the index of the account to get transfers from- Returns:
- transfers to/from the account
-
getTransfers
Description copied from interface:ZephyrWalletGet incoming and outgoing transfers to and from a subaddress. An outgoing transfer represents a total amount sent from one or more subaddresses within an account to individual destination addresses, each with their own amount. An incoming transfer represents a total amount received into a subaddress within an account. Transfers belong to transactions which are stored on the blockchain.- Specified by:
getTransfersin interfaceZephyrWallet- Parameters:
accountIdx- is the index of the account to get transfers fromsubaddressIdx- is the index of the subaddress to get transfers from- Returns:
- transfers to/from the subaddress
-
getIncomingTransfers
Description copied from interface:ZephyrWalletGet all of the wallet's incoming transfers.- Specified by:
getIncomingTransfersin interfaceZephyrWallet- Returns:
- the wallet's incoming transfers
-
getIncomingTransfers
Description copied from interface:ZephyrWalletGet incoming transfers that meet a query.
All supported query criteria:
address - get incoming transfers to a specific address in the wallet (optional)
accountIndex - get incoming transfers to a specific account index (optional)
subaddressIndex - get incoming transfers to a specific subaddress index (optional)
subaddressIndices - get transfers destined for specific subaddress indices (optional)
amount - amount being transferred (optional)
txQuery - get transfers whose transaction meets this query (optional)
- Specified by:
getIncomingTransfersin interfaceZephyrWallet- Parameters:
query- specifies which incoming transfers to get- Returns:
- incoming transfers that meet the query
-
getOutgoingTransfers
Description copied from interface:ZephyrWalletGet all of the wallet's outgoing transfers.- Specified by:
getOutgoingTransfersin interfaceZephyrWallet- Returns:
- the wallet's outgoing transfers
-
getOutgoingTransfers
Description copied from interface:ZephyrWalletGet outgoing transfers that meet a query.
All supported query criteria:
address - get outgoing transfers from a specific address in the wallet (optional)
accountIndex - get outgoing transfers from a specific account index (optional)
subaddressIndex - get outgoing transfers from a specific subaddress index (optional)
subaddressIndices - get outgoing transfers from specific subaddress indices (optional)
amount - amount being transferred (optional)
destinations - individual destinations of an outgoing transfer, which is local wallet data and NOT recoverable from the blockchain (optional)
hasDestinations - get transfers that have destinations or not (optional)
txQuery - get transfers whose transaction meets this query (optional)
- Specified by:
getOutgoingTransfersin interfaceZephyrWallet- Parameters:
query- specifies which outgoing transfers to get- Returns:
- outgoing transfers that meet the query
-
getOutputs
Description copied from interface:ZephyrWalletGet outputs created from previous transactions that belong to the wallet (i.e. that the wallet can spend one time). Outputs are part of transactions which are stored in blocks on the blockchain.Zephyr: in the full wallet (
ZephyrWalletFull) the outputs carry no asset (ZephyrOutputWallet.getAssetType()isnull): the core keeps an output's asset but does not serialize it.ZephyrWallet.getOutputAssetType(ZephyrOutputWallet)takes the asset from the output's transaction. See the user guide,docs/guide/08-known-limitations.md, section "getOutputs() reports no asset".- Specified by:
getOutputsin interfaceZephyrWallet- Returns:
- all wallet outputs
-
exportOutputs
Description copied from interface:ZephyrWalletExport outputs since the last export.- Specified by:
exportOutputsin interfaceZephyrWallet- Returns:
- outputs since the last export in hex format
-
exportKeyImages
Description copied from interface:ZephyrWalletExport key images since the last export.- Specified by:
exportKeyImagesin interfaceZephyrWallet- Returns:
- signed key images since the last export
-
createTx
Description copied from interface:ZephyrWalletCreate a transaction to transfer funds from this wallet.All supported configuration:
address - single destination address (required unless `destinations` provided)
amount - single destination amount (required unless `destinations` provided)
accountIndex - source account index to transfer funds from (required)
subaddressIndex - source subaddress index to transfer funds from (optional)
subaddressIndices - source subaddress indices to transfer funds from (optional)
relay - relay the transaction to peers to commit to the blockchain (default false)
priority - transaction priority (default ZephyrTxPriority.NORMAL)
destinations - addresses and amounts in a multi-destination tx (required unless `address` and `amount` provided)
paymentId - transaction payment ID (optional)
unlockHeight - minimum height for the transaction to unlock (default 0)
- Specified by:
createTxin interfaceZephyrWallet- Parameters:
config- configures the transaction to create- Returns:
- the created transaction
-
relayTx
Description copied from interface:ZephyrWalletRelay a previously created transaction.- Specified by:
relayTxin interfaceZephyrWallet- Parameters:
txMetadata- is transaction metadata previously created without relaying- Returns:
- the hash of the relayed tx
-
relayTx
Description copied from interface:ZephyrWalletRelay a previously created transaction.- Specified by:
relayTxin interfaceZephyrWallet- Parameters:
tx- is the transaction to relay- Returns:
- the hash of the relayed tx
-
relayTxs
Description copied from interface:ZephyrWalletRelay previously created transactions.- Specified by:
relayTxsin interfaceZephyrWallet- Parameters:
txs- are the transactions to relay- Returns:
- the hashes of the relayed txs
-
describeUnsignedTxSet
Description copied from interface:ZephyrWalletDescribe a tx set from unsigned tx hex.- Specified by:
describeUnsignedTxSetin interfaceZephyrWallet- Parameters:
unsignedTxHex- unsigned tx hex- Returns:
- the tx set containing structured transactions
-
describeMultisigTxSet
Description copied from interface:ZephyrWalletDescribe a tx set from multisig tx hex.- Specified by:
describeMultisigTxSetin interfaceZephyrWallet- Parameters:
multisigTxHex- multisig tx hex- Returns:
- the tx set containing structured transactions
-
signMessage
Description copied from interface:ZephyrWalletSign a message.- Specified by:
signMessagein interfaceZephyrWallet- Parameters:
message- is the message to sign- Returns:
- the signature
-
getTxProof
Description copied from interface:ZephyrWalletGet a transaction signature to prove it.- Specified by:
getTxProofin interfaceZephyrWallet- Parameters:
txHash- specifies the transaction to proveaddress- is the destination public address of the transaction- Returns:
- the transaction signature
-
getSpendProof
Description copied from interface:ZephyrWalletGenerate a signature to prove a spend. Unlike proving a transaction, it does not require the destination public address.- Specified by:
getSpendProofin interfaceZephyrWallet- Parameters:
txHash- specifies the transaction to prove- Returns:
- the transaction signature
-
getTxNote
Description copied from interface:ZephyrWalletGet a transaction note.- Specified by:
getTxNotein interfaceZephyrWallet- Parameters:
txHash- specifies the transaction to get the note of- Returns:
- the tx note
-
setTxNote
Description copied from interface:ZephyrWalletSet a note for a specific transaction.- Specified by:
setTxNotein interfaceZephyrWallet- Parameters:
txHash- specifies the transactionnote- specifies the note
-
getAddressBookEntries
Description copied from interface:ZephyrWalletGet all address book entries.- Specified by:
getAddressBookEntriesin interfaceZephyrWallet- Returns:
- the address book entries
-
isMultisig
public boolean isMultisig()Description copied from interface:ZephyrWalletIndicates if this wallet is a multisig wallet.- Specified by:
isMultisigin interfaceZephyrWallet- Returns:
- true if this is a multisig wallet, false otherwise
-
importMultisigHex
Description copied from interface:ZephyrWalletImport multisig info as hex from other participants.- Specified by:
importMultisigHexin interfaceZephyrWallet- Parameters:
multisigHexes- are multisig hex from each participant- Returns:
- the number of outputs signed with the given multisig hex
-
close
public void close()Description copied from interface:ZephyrWalletClose the wallet (does not save).- Specified by:
closein interfaceZephyrWallet
-
normalizeTransferQuery
Returns a copy of the query (a new query for null) whose tx query refers back to it, so that the transfer filter and the tx filter can be applied together.- Parameters:
query- is the transfer query (null for every transfer)- Returns:
- the normalized copy
-