Documentation

accounts.go

@@ -9,6 +9,8 @@ import (
 	"github.com/decred/dcrwallet/errors/v2"
 )
 
+// GetAccounts returns a json.Marshal of an
+// account information in a wallet.
 func (wallet *Wallet) GetAccounts(requiredConfirmations int32) (string, error) {
 	accountsResponse, err := wallet.GetAccountsRaw(requiredConfirmations)
 	if err != nil {
@@ -19,6 +21,7 @@ func (wallet *Wallet) GetAccounts(requiredConfirmations int32) (string, error) {
 	return string(result), nil
 }
 
+// GetAccountsRaw returns all the information about an existing account.
 func (wallet *Wallet) GetAccountsRaw(requiredConfirmations int32) (*Accounts, error) {
 	resp, err := wallet.internal.Accounts(wallet.shutdownContext())
 	if err != nil {
@@ -51,6 +54,8 @@ func (wallet *Wallet) GetAccountsRaw(requiredConfirmations int32) (*Accounts, er
 	}, nil
 }
 
+// AccountsIterator returns an iterator that can be
+// used to loop through the accounts of a wallet.
 func (wallet *Wallet) AccountsIterator(requiredConfirmations int32) (*AccountsIterator, error) {
 	accounts, err := wallet.GetAccountsRaw(requiredConfirmations)
 	if err != nil {
@@ -63,6 +68,8 @@ func (wallet *Wallet) AccountsIterator(requiredConfirmations int32) (*AccountsIt
 	}, nil
 }
 
+// Next returns the account on the current iterator
+// index and increments the current index.
 func (accountsInterator *AccountsIterator) Next() *Account {
 	if accountsInterator.currentIndex < len(accountsInterator.accounts) {
 		account := accountsInterator.accounts[accountsInterator.currentIndex]
@@ -73,10 +80,13 @@ func (accountsInterator *AccountsIterator) Next() *Account {
 	return nil
 }
 
+// Reset sets the current iterator's index to 0.
 func (accountsInterator *AccountsIterator) Reset() {
 	accountsInterator.currentIndex = 0
 }
 
+// GetAccount fetches an account and all the accompanying
+// information and properties of the said account.
 func (wallet *Wallet) GetAccount(accountNumber int32, requiredConfirmations int32) (*Account, error) {
 	props, err := wallet.internal.AccountProperties(wallet.shutdownContext(), uint32(accountNumber))
 	if err != nil {
@@ -102,6 +112,8 @@ func (wallet *Wallet) GetAccount(accountNumber int32, requiredConfirmations int3
 	return account, nil
 }
 
+// GetAccountBalance returns all the balance
+// information in a given account.
 func (wallet *Wallet) GetAccountBalance(accountNumber int32, requiredConfirmations int32) (*Balance, error) {
 	balance, err := wallet.internal.CalculateAccountBalance(wallet.shutdownContext(), uint32(accountNumber), requiredConfirmations)
 	if err != nil {
@@ -119,6 +131,8 @@ func (wallet *Wallet) GetAccountBalance(accountNumber int32, requiredConfirmatio
 	}, nil
 }
 
+// SpendableForAccount returns the spendable
+// balance in a given account.
 func (wallet *Wallet) SpendableForAccount(account int32, requiredConfirmations int32) (int64, error) {
 	bals, err := wallet.internal.CalculateAccountBalance(wallet.shutdownContext(), uint32(account), requiredConfirmations)
 	if err != nil {
@@ -128,6 +142,8 @@ func (wallet *Wallet) SpendableForAccount(account int32, requiredConfirmations i
 	return int64(bals.Spendable), nil
 }
 
+// NextAccount creates the account and returns the
+// account number.
 func (wallet *Wallet) NextAccount(accountName string, privPass []byte) (int32, error) {
 	lock := make(chan time.Time, 1)
 	defer func() {
@@ -149,6 +165,7 @@ func (wallet *Wallet) NextAccount(accountName string, privPass []byte) (int32, e
 	return int32(accountNumber), err
 }
 
+// RenameAccount sets the name for an account number to newName.
 func (wallet *Wallet) RenameAccount(accountNumber int32, newName string) error {
 	err := wallet.internal.RenameAccount(wallet.shutdownContext(), uint32(accountNumber), newName)
 	if err != nil {
@@ -158,6 +175,7 @@ func (wallet *Wallet) RenameAccount(accountNumber int32, newName string) error {
 	return nil
 }
 
+// AccountName returns the name for the passed account number.
 func (wallet *Wallet) AccountName(accountNumber int32) string {
 	name, err := wallet.AccountNameRaw(uint32(accountNumber))
 	if err != nil {
@@ -167,14 +185,18 @@ func (wallet *Wallet) AccountName(accountNumber int32) string {
 	return name
 }
 
+// AccountNameRaw returns the name for the passed account number.
 func (wallet *Wallet) AccountNameRaw(accountNumber uint32) (string, error) {
 	return wallet.internal.AccountName(wallet.shutdownContext(), accountNumber)
 }
 
+// Returns an account number for the corresponding account name.
 func (wallet *Wallet) AccountNumber(accountName string) (uint32, error) {
 	return wallet.internal.AccountNumber(wallet.shutdownContext(), accountName)
 }
 
+// HDPathForAccount returns the HD path for the passed account based
+// on the coin-type and the net type of the wallet.
 func (wallet *Wallet) HDPathForAccount(accountNumber int32) (string, error) {
 	cointype, err := wallet.internal.CoinType(wallet.shutdownContext())
 	if err != nil {

address.go

@@ -11,19 +11,24 @@ import (
 )
 
 // AddressInfo holds information about an address
-// If the address belongs to the querying wallet, IsMine will be true and the AccountNumber and AccountName values will be populated
+// If the address belongs to the querying wallet,
+// IsMine will be true and the AccountNumber and
+// AccountName values will be populated.
 type AddressInfo struct {
 	Address       string
 	IsMine        bool
 	AccountNumber uint32
 	AccountName   string
 }
 
+// IsAddressValid decodes an address string and checks if
+// it is valid for the current net type.
 func (wallet *Wallet) IsAddressValid(address string) bool {
 	_, err := dcrutil.DecodeAddress(address, wallet.chainParams)
 	return err == nil
 }
 
+// HaveAddress returns whether wallet is the owner of the address.
 func (wallet *Wallet) HaveAddress(address string) bool {
 	addr, err := dcrutil.DecodeAddress(address, wallet.chainParams)
 	if err != nil {
@@ -38,6 +43,7 @@ func (wallet *Wallet) HaveAddress(address string) bool {
 	return have
 }
 
+// AccountOfAddress returns the account name of the passed wallet address.
 func (wallet *Wallet) AccountOfAddress(address string) string {
 	addr, err := dcrutil.DecodeAddress(address, wallet.chainParams)
 	if err != nil {
@@ -48,6 +54,8 @@ func (wallet *Wallet) AccountOfAddress(address string) string {
 	return wallet.AccountName(int32(info.Account()))
 }
 
+// AddressInfo returns information for an address such as
+// the address, account number and name of the account.
 func (wallet *Wallet) AddressInfo(address string) (*AddressInfo, error) {
 	addr, err := dcrutil.DecodeAddress(address, wallet.chainParams)
 	if err != nil {
@@ -69,6 +77,7 @@ func (wallet *Wallet) AddressInfo(address string) (*AddressInfo, error) {
 	return addressInfo, nil
 }
 
+// CurrentAddress returns the next unused address of an account.
 func (wallet *Wallet) CurrentAddress(account int32) (string, error) {
 	if wallet.IsRestored && !wallet.HasDiscoveredAccounts {
 		return "", errors.E(ErrAddressDiscoveryNotDone)
@@ -82,6 +91,8 @@ func (wallet *Wallet) CurrentAddress(account int32) (string, error) {
 	return addr.Address(), nil
 }
 
+// NextAddress returns a new external address
+// for the passed account.
 func (wallet *Wallet) NextAddress(account int32) (string, error) {
 	if wallet.IsRestored && !wallet.HasDiscoveredAccounts {
 		return "", errors.E(ErrAddressDiscoveryNotDone)
@@ -95,6 +106,7 @@ func (wallet *Wallet) NextAddress(account int32) (string, error) {
 	return addr.Address(), nil
 }
 
+// AddressPubKey returns the public key of the passed address.
 func (wallet *Wallet) AddressPubKey(address string) (string, error) {
 	addr, err := dcrutil.DecodeAddress(address, wallet.chainParams)
 	if err != nil {

addresshelper/helper.go

@@ -19,6 +19,8 @@ func PkScript(address string, net dcrutil.AddressParams) ([]byte, error) {
 	return txscript.PayToAddrScript(addr)
 }
 
+// PkScriptAddresses extracts and returns the addresses from
+// the passed script.
 func PkScriptAddresses(params *chaincfg.Params, pkScript []byte) ([]string, error) {
 	_, addresses, _, err := txscript.ExtractPkScriptAddrs(scriptVersion, pkScript, params)
 	if err != nil {

badgerdb/db.go

@@ -45,13 +45,17 @@ type transaction struct {
 	writable bool
 }
 
+// ReadBucket returns a structure within the
+// database allowed to perform read operations.
 func (tx *transaction) ReadBucket(key []byte) walletdb.ReadBucket {
 	if tx.db.closed {
 		return nil
 	}
 	return tx.ReadWriteBucket(key)
 }
 
+// ReadWriteBucket returns a structure within the database
+// allowed to perform read and write operations.
 func (tx *transaction) ReadWriteBucket(key []byte) walletdb.ReadWriteBucket {
 	if tx.db.closed {
 		return nil
@@ -69,6 +73,8 @@ func (tx *transaction) ReadWriteBucket(key []byte) walletdb.ReadWriteBucket {
 	return readWriteBucket
 }
 
+// CreateTopLevelBucket creates a new bucket with
+// ability to perform read and write operations.
 func (tx *transaction) CreateTopLevelBucket(key []byte) (walletdb.ReadWriteBucket, error) {
 	if tx.db.closed {
 		return nil, errors.E(errors.Invalid)
@@ -82,6 +88,8 @@ func (tx *transaction) CreateTopLevelBucket(key []byte) (walletdb.ReadWriteBucke
 	return bucket, nil
 }
 
+// DeleteTopLevelBucket removes a bucket (structure within
+// database that allows for read or write operations).
 func (tx *transaction) DeleteTopLevelBucket(key []byte) error {
 	if tx.db.closed {
 		return errors.E(errors.Invalid)
@@ -186,6 +194,7 @@ func (b *Bucket) NestedReadWriteBucket(key []byte) walletdb.ReadWriteBucket {
 	return nestedBucket
 }
 
+// NestedReadBucket returns a read and write bucket interface implementation.
 func (b *Bucket) NestedReadBucket(key []byte) walletdb.ReadBucket {
 	if b.dbTransaction.db.closed {
 		return nil
@@ -293,6 +302,8 @@ func (b *Bucket) Delete(key []byte) error {
 	return convertErr(b.delete(key))
 }
 
+// ReadCursor returns a bucket cursor that can be
+// positioned at the start and end of the bucket.
 func (b *Bucket) ReadCursor() walletdb.ReadCursor {
 	if b.dbTransaction.db.closed {
 		return nil
@@ -589,10 +600,14 @@ func (db *db) beginTx(writable bool) (*transaction, error) {
 	return tran, nil
 }
 
+// BeginReadTx returns a database transaction
+// that can be used for reads.
 func (db *db) BeginReadTx() (walletdb.ReadTx, error) {
 	return db.beginTx(false)
 }
 
+// BeginReadWriteTx returns a database transactions
+// that can be used for reads and writes.
 func (db *db) BeginReadWriteTx() (walletdb.ReadWriteTx, error) {
 	return db.beginTx(true)
 }

message.go

@@ -9,6 +9,8 @@ import (
 	w "github.com/decred/dcrwallet/wallet/v3"
 )
 
+// SignMessage returns the signature of a signed message
+// using an address associated private key.
 func (wallet *Wallet) SignMessage(passphrase []byte, address string, message string) ([]byte, error) {
 	lock := make(chan time.Time, 1)
 	defer func() {
@@ -45,6 +47,7 @@ func (wallet *Wallet) SignMessage(passphrase []byte, address string, message str
 	return sig, nil
 }
 
+// VerifyMessage verifies that signatureBase64 is a valid signature.
 func (wallet *Wallet) VerifyMessage(address string, message string, signatureBase64 string) (bool, error) {
 	var valid bool