Skip to content

WalletBasics.md

Latest commit

 

History

History
91 lines (88 loc) · 2.74 KB

WalletBasics.md

File metadata and controls

91 lines (88 loc) · 2.74 KB

Wallet Basics with Pystratis

The Strax/Cirrus wallet is a full-featured HD wallet. This tutorial will cover some basics for setting up a new wallet on a StratisFullNode using pystratis.

Note: The same wallet will be used in all of the examples. The tutorial on sending transactions can be found here.

Creating a wallet

from pystratis.nodes import StraxNode
from typing import List

node = StraxNode()
# Returns the mnemonic representing the HD wallet seed.
mnemonic: List[str] = node.wallet.create(name='ExampleWallet', password='abc123')

Loading a wallet

# Loads a known wallet from the data dir with the given name and decrypts the wallet.
node.wallet.load(name='ExampleWallet', password='abc123')

Recovering a wallet

node.wallet.recover(mnemonic=mnemonic, password='abc123', name='RecoveredWallet')

Listing wallets

wallets: dict = node.wallet.list_wallets()

Creating an account

account_name = node.wallet.account(wallet_name='ExampleWallet', password='abc123')

Listing wallet accounts

node.wallet.accounts(wallet_name='ExampleWallet')

Getting an unused address

unused_address = node.wallet.unused_address(wallet_name='ExampleWallet')

Getting all addresses

addresses = node.wallet.addresses(wallet_name='ExampleWallet')

Getting general information about a wallet

node.wallet.general_info(name='ExampleWallet')

Getting a wallet history

history = node.wallet.history(wallet_name='ExampleWallet')

Resyncing wallet

node.wallet.remove_transactions(
    wallet_name='ExampleWallet',
    remove_all=True, 
    resync=True
)

Getting the balance of a wallet

wallet_balance = node.wallet.balance(
    wallet_name='ExampleWallet', 
    include_balance_by_address=False
)

Getting the balance of a specific wallet address

Note: The wallet does not track value in non-owned addresses. If you need to check the balance of a specific address on the blockchain:

  • Ensure addressindex=1 in node configuration.
  • Use blockstore.get_addresses_balances or blockstore.get_verbose_addresses_balances API method.
wallet_balance = node.wallet.balance(
    wallet_name='ExampleWallet', 
    include_balance_by_address=True
)

Signing and verifying a message

signature = node.wallet.sign_message(
    wallet_name='ExampleWallet', 
    password='abc123', 
    external_address=unused_address,
    message='Blockchain made easy.'
)
assert node.wallet.verify_message(
    signature=signature,
    external_address=unused_address,
    message='Blockchain made easy.'
)