Class WalletBackend

Example:

const [address, error] = wallet.addSubWallet();

if (!error) {
     console.log(`Created subwallet with address of ${address}`);
}

Example:

const destinations = [
     ['Zexyz...', 1000],
     ['Zezyx...', 10000],
];

const creation = await wallet.sendTransactionAdvanced(
     destinations,
     undefined, // mixin
     undefined, // fee
     undefined, // payment ID
     undefined, // subWalletsToTakeFrom
     undefined, // changeAddress
     false // relay to network
);

if (creation.success)
     // Inspect certain transaction properties before sending if desired
     if (creation.fee > 100000) {
         console.log('Fee is quite high! You may wish to attempt optimizing your wallet');
         return;
     }

     const result = await wallet.sendRawPreparedTransaction(creation.preparedTransaction);

     if (result.success) {
         console.log(`Sent transaction, hash ${result.transactionHash}, fee ${WB.prettyPrintAmount(result.fee)}`);
     } else {
         console.log(`Failed to relay transaction: ${result.error.toString()}`);
     }
} else {
     console.log(`Failed to send transaction: ${creation.error.toString()}`);
     wallet.deletePreparedTransaction(creation.transactionHash);
}

Example:

const error = wallet.deleteSubWallet('Ze3GSL9kqRAHteE7P2R5ue4Jj2ZHiDj4qi1BXvrU4GnYLbDn4cEuSn4N7mdLmqBhErGo99MaRVJEzhyUpoMwMEp122fubUUCW');

if (error) {
     console.log(`Failed to delete subwallet: ${error.toString()}`);
}

The downsides are that sometimes your wallet will 'unexpectedly' have locked funds.

The upside is that when you come to sending a large transaction, it should nearly always succeed.

This flag is ENABLED by default.

Example:

wallet.enableAutoOptimization(false);

This will take some time (Roughly a second on a modern PC) - it runs 500,000 iterations of pbkdf2.

Example:

const saved = wallet.encryptWalletToString('hunter2');

Example:

let i = 1;

for (const address of wallet.getAddresses()) {
     console.log(`Address [${i}]: ${address}`);
     i++;
}

Example:

const [unlockedBalance, lockedBalance] = wallet.getBalance();

For this reason, there are two additional properties - sslDetermined, and daemonTypeDetermined which let you verify that we have managed to contact the daemon and detect its specifics.

Example:

const daemonInfo = wallet.getDaemonConnectionInfo();
console.log(`Connected to ${daemonInfo.ssl ? 'https://' : 'http://'}${daemonInfo.host}:${daemonInfo.port}`);

Example:

const [seed, err] = wallet.getMnemonicSeed();

if (err) {
     console.log('Wallet is not a deterministic wallet: ' + err.toString());
}

Example:

const [seed, err] = wallet.getMnemonicSeedForAddress('Ze...');

if (err) {
     console.log('Address does not belong to a deterministic wallet: ' + err.toString());
}

Fees returned will be zero if you have not yet awaited start.

Example:

const [nodeFeeAddress, nodeFeeAmount] = wallet.getNodeFee();

if (nodeFeeAmount === 0) {
     console.log('Yay, no fees!');
}

Note that it probably is more effective to subscribe to the transaction related events to update your UI, rather than polling for the number of transactions.

Example:

let numTransactions = 0;

while (true) {
     const tmpNumTransactions = wallet.getNumTransactions();

     if (numTransactions != tmpNumTransactions) {
         console.log(tmpNumTransactions - numTransactions + ' new transactions found!');
         numTransactions = tmpNumTransactions;
     }
}

Example:

const address = wallet.getPrimaryAddress();

Example:

const [privateSpendKey, privateViewKey] = wallet.getPrimaryAddressPrivateKeys();

Example:

const privateViewKey = wallet.getPrivateViewKey();

Note: secret key will be 00000... (64 zeros) if this wallet is a view only wallet.

Example:

const [publicSpendKey, privateSpendKey, err] = wallet.getSpendKeys('Zexyz...');

if (err) {
     console.log('Failed to get spend keys for address: ' + err.toString());
}

Example:

const [walletBlockCount, localDaemonBlockCount, networkBlockCount] =
     wallet.getSyncStatus();

Example:

const tx = wallet.getTransaction('693950eeec41dc36cfc5109eba15807ce3d63eff21f1eec20a7d1bda99563b1c');

if (tx) {
     console.log(`Tx ${tx.hash} is worth ${WB.prettyPrintAmount(tx.totalAmount())}`);
} else {
     console.log("Couldn't find transaction! Is your wallet synced?");
}

Newer transactions are at the front of the array - Unconfirmed transactions come at the very front.

Example:

for (const tx of wallet.getTransactions()) {
     console.log(`Transaction ${tx.hash} - ${WB.prettyPrintAmount(tx.totalAmount())} - ${tx.timestamp}`);
}

Example:

const count = wallet.getWalletCount();

console.log(`Wallet has ${count} subwallets`);

Example:

const [address, error] = await wallet.importSubWallet('c984628484a1a5eaab4cfb63831b2f8ac8c3a56af2102472ab35044b46742501');

if (!error) {
     console.log(`Imported subwallet with address of ${address}`);
} else {
     console.log(`Failed to import subwallet: ${error.toString()}`);
}

Example:

const [address, error] = await wallet.importViewSubWallet('c984628484a1a5eaab4cfb63831b2f8ac8c3a56af2102472ab35044b46742501');

if (!error) {
     console.log(`Imported view subwallet with address of ${address}`);
} else {
     console.log(`Failed to import view subwallet: ${error.toString()}`);
}

Example:

const syncFunc = wallet.internal().sync;
await syncFunc(true);

Note that if you want to alert the user in real time of the hashes or number of transactions sent, you can subscribe to the createdfusiontx event. This will be fired every time a fusion transaction is sent.

You may also want to consider manually creating individual transactions if you want more control over the process. See sendFusionTransactionBasic.

This method may take a very long time if your wallet is not optimized at all. It is suggested to not block the UI/mainloop of your program when using this method.

Example:

const [numberOfTransactionsSent, hashesOfSentFusionTransactions] = await wallet.optimize();

console.log(`Sent ${numberOfTransactionsSent} fusion transactions, hashes: ${hashesOfSentFusionTransactions.join(', ')}`);

This function will return once the wallet has been successfully reset, and syncing has began again.

Example:

await wallet.rescan();

This function will return once the wallet has been successfully reset, and syncing has began again.

Example:

await wallet.reset(123456);

The difference is that while reset and rescan discard all progress before the specified height, and then continues syncing from there, rewind instead retains the information previous, and only removes information after the rewind height.

This can be helpful if you suspect a transaction has been missed by the sync process, and want to only rescan a small section of blocks.

Example:

await wallet.rewind(123456);

This will take some time (Roughly a second on a modern PC) - it runs 500,000 iterations of pbkdf2.

Example:

const saved = wallet.saveWalletToFile('test.wallet', 'hunter2');

if (!saved) {
     console.log('Failed to save wallet!');
}

Example:

wallet.scanCoinbaseTransactions(true);

If you want to ensure your wallet gets fully optimized, consider using optimize.

All parameters are optional.

Example:

const result = await wallet.sendFusionTransactionAdvanced(3, undefined, 'Zexyz..');

if (result.success) {
     console.log(`Sent transaction, hash ${result.transactionHash}, fee ${WB.prettyPrintAmount(result.fee)}`);
} else {
     console.log(`Failed to send transaction: ${result.error.toString()}`);
}

If you want to ensure your wallet gets fully optimized, consider using optimize.

Example:

const result = await wallet.sendFusionTransactionBasic();

if (result.success) {
     console.log(`Sent transaction, hash ${result.transactionHash}`);
} else {
     console.log(`Failed to send transaction: ${result.error.toString()}`);
}

Example:

const destinations = [
     ['Zexyz...', 1000],
     ['Zezyx...', 10000],
];

const creation = await wallet.sendTransactionAdvanced(
     destinations,
     undefined, // mixin
     undefined, // fee
     undefined, // payment ID
     undefined, // subWalletsToTakeFrom
     undefined, // changeAddress
     false // relay to network
);

if (creation.success)
     // Inspect certain transaction properties before sending if desired
     if (creation.fee > 100000) {
         console.log('Fee is quite high! You may wish to attempt optimizing your wallet');
         return;
     }

     const result = await wallet.sendPreparedTransaction(creation.transactionHash);

     if (result.success) {
         console.log(`Sent transaction, hash ${result.transactionHash}, fee ${WB.prettyPrintAmount(result.fee)}`);
     } else {
         console.log(`Failed to relay transaction: ${result.error.toString()}`);
     }
} else {
     wallet.deletePreparedTransaction(creation.transactionHash);
     console.log(`Failed to send transaction: ${creation.error.toString()}`);
}

Example:

const destinations = [
     ['Zexyz...', 1000],
     ['Zezyx...', 10000],
];

const creation = await wallet.sendTransactionAdvanced(
     destinations,
     undefined, // mixin
     undefined, // fee
     undefined, // payment ID
     undefined, // subWalletsToTakeFrom
     undefined, // changeAddress
     false // relay to network
);

if (creation.success)
     // Inspect certain transaction properties before sending if desired
     if (creation.fee > 100000) {
         console.log('Fee is quite high! You may wish to attempt optimizing your wallet');
         return;
     }

     const result = await wallet.sendRawPreparedTransaction(creation.preparedTransaction);

     if (result.success) {
         console.log(`Sent transaction, hash ${result.transactionHash}, fee ${WB.prettyPrintAmount(result.fee)}`);
     } else {
         console.log(`Failed to relay transaction: ${result.error.toString()}`);
     }
} else {
     console.log(`Failed to send transaction: ${creation.error.toString()}`);
     wallet.deletePreparedTransaction(creation.transactionHash);
}

All parameters are optional aside from destinations.

Example:

const destinations = [
     ['Zexyz...', 1000],
     ['Zezyx...', 10000],
];

const result = await wallet.sendTransactionAdvanced(
     destinations,
     undefined,
     undefined,
     'c59d157d1d96f280ece0816a8925cae8232432b7235d1fa92c70faf3064434b3'
);

if (result.success) {
     console.log(`Sent transaction, hash ${result.transactionHash}, fee ${WB.prettyPrintAmount(result.fee)}`);
} else {
     console.log(`Failed to send transaction: ${result.error.toString()}`);
}

Network fee is set to default, mixin is set to default, all subwallets are taken from, primary address is used as change address.

If you need more control, use sendTransactionAdvanced.

Example:

const result = await wallet.sendTransactionBasic('Zexyz...', 1234);

if (result.success) {
     console.log(`Sent transaction, hash ${result.transactionHash}, fee ${WB.prettyPrintAmount(result.fee)}`);
} else {
     console.log(`Failed to send transaction: ${result.error.toString()}`);
}

Note that if you're in a node environment, this library will use C++ code with node-gyp, so it will be nearly as fast as C++ implementations. You only need to worry about this in less conventional environments, like react-native, or possibly the web.

If you don't know what you're doing, DO NOT TOUCH THIS - YOU WILL BREAK WALLET SYNCING

Note you don't have to set the globalIndex properties on returned inputs. We will fetch them from the daemon if needed. However, if you have them, return them, to save us a daemon call.

Your function should return an array of [publicSpendKey, TransactionInput]. The public spend key is the corresponding subwallet that the transaction input belongs to.

Return an empty array if no inputs are found that belong to the user.

Example:

wallet.setBlockOutputProcessFunc(mySuperSpeedyFunction);

Logging by default occurs to stdout. See setLoggerCallback to modify this, or gain more control over what is logged.

Example:

wallet.setLogLevel(WB.LogLevel.DEBUG);

Ensure that you have enabled logging for this function to take effect. See setLogLevel for more details.

Example:

wallet.setLoggerCallback((prettyMessage, message, level, categories) => {
      if (categories.includes(WB.LogCategory.SYNC)) {
          console.log(prettyMessage);
      }
  });

Example:

await wallet.start();

If you want the node process to close cleanly (i.e, without using process.exit()), you need to call this function. Otherwise, the library will keep firing callbacks, and so your script will hang.

Example:

wallet.stop();

Example:

const daemon = new WB.Daemon('seedpro2.zent.cash', 21698);
await wallet.swapNode(daemon);
const daemonInfo = wallet.getDaemonConnectionInfo();
console.log(`Connected to ${daemonInfo.ssl ? 'https://' : 'http://'}${daemonInfo.host}:${daemonInfo.port}`);

Example:

const walletData = wallet.toJSONString();