Documentation ¶
Index ¶
- Constants
- Variables
- func CheckMnemonic(mnemonic string) error
- func GenerateMnemonic(entropy int) (string, error)
- func OptionFee(fee amount.Amount) func(builder *txBuilder) error
- func OptionLockTime(lockTime uint32) func(builder *txBuilder) error
- func OptionMemo(memo string) func(builder *txBuilder) error
- type CRCNotMatchError
- type ExitsError
- type HistoryInfo
- type TxOption
- type Wallet
- func (w *Wallet) AddTransaction(id tx.ID) error
- func (w *Wallet) AddressCount() int
- func (w *Wallet) AddressFromPath(p string) *vault.AddressInfo
- func (w *Wallet) AddressInfo(addr string) *vault.AddressInfo
- func (w *Wallet) AddressInfos() []vault.AddressInfo
- func (w *Wallet) AllAccountAddresses() []vault.AddressInfo
- func (w *Wallet) AllValidatorAddresses() []vault.AddressInfo
- func (w *Wallet) Balance(addrStr string) (amount.Amount, error)
- func (w *Wallet) BroadcastTransaction(trx *tx.Tx) (string, error)
- func (w *Wallet) CalculateFee(amt amount.Amount, payloadType payload.Type) (amount.Amount, error)
- func (w *Wallet) Contains(addr string) bool
- func (w *Wallet) GetHistory(addr string) []HistoryInfo
- func (w *Wallet) ImportPrivateKey(password string, prv *bls.PrivateKey) error
- func (w *Wallet) IsEncrypted() bool
- func (w *Wallet) IsOffline() bool
- func (w *Wallet) Label(addr string) string
- func (w *Wallet) MakeBondTx(sender, receiver, pubKey string, amt amount.Amount, options ...TxOption) (*tx.Tx, error)
- func (w *Wallet) MakeTransferTx(sender, receiver string, amt amount.Amount, options ...TxOption) (*tx.Tx, error)
- func (w *Wallet) MakeUnbondTx(addr string, opts ...TxOption) (*tx.Tx, error)
- func (w *Wallet) MakeWithdrawTx(sender, receiver string, amt amount.Amount, options ...TxOption) (*tx.Tx, error)
- func (w *Wallet) Mnemonic(password string) (string, error)
- func (w *Wallet) Name() string
- func (w *Wallet) NewBLSAccountAddress(label string) (*vault.AddressInfo, error)
- func (w *Wallet) NewValidatorAddress(label string) (*vault.AddressInfo, error)
- func (w *Wallet) Path() string
- func (w *Wallet) PrivateKey(password, addr string) (crypto.PrivateKey, error)
- func (w *Wallet) PrivateKeys(password string, addrs []string) ([]crypto.PrivateKey, error)
- func (w *Wallet) Save() error
- func (w *Wallet) SetLabel(addr, label string) error
- func (w *Wallet) SetServerAddr(addr string)
- func (w *Wallet) SignTransaction(password string, trx *tx.Tx) error
- func (w *Wallet) Stake(addrStr string) (amount.Amount, error)
- func (w *Wallet) TotalBalance() amount.Amount
- func (w *Wallet) UpdatePassword(oldPassword, newPassword string) error
Constants ¶
const ( AddressTypeBLSAccount string = "bls_account" AddressTypeValidator string = "validator" )
Variables ¶
var ( // ErrInvalidNetwork describes an error in which the network is invalid. ErrInvalidNetwork = errors.New("invalid network") // ErrOffline describes an error in which the wallet is offline. ErrOffline = errors.New("wallet is in offline mode") // ErrHistoryExists describes an error in which the transaction already exists // in history. ErrHistoryExists = errors.New("transaction already exists") )
Functions ¶
func CheckMnemonic ¶ added in v0.13.0
CheckMnemonic is a wrapper for `vault.CheckMnemonic`.
func GenerateMnemonic ¶
GenerateMnemonic is a wrapper for `vault.GenerateMnemonic`.
func OptionLockTime ¶ added in v0.15.0
func OptionMemo ¶
Types ¶
type CRCNotMatchError ¶ added in v0.15.0
CRCNotMatchError describes an error in which the wallet CRC is not macthed.
func (CRCNotMatchError) Error ¶ added in v0.15.0
func (e CRCNotMatchError) Error() string
type ExitsError ¶ added in v0.15.0
type ExitsError struct {
Path string
}
ExitsError describes an error in which a wallet exists in the given path.
func (ExitsError) Error ¶ added in v0.15.0
func (e ExitsError) Error() string
type HistoryInfo ¶
type Wallet ¶
type Wallet struct {
// contains filtered or unexported fields
}
func Open ¶ added in v0.10.0
Open tries to open a wallet at the given path. If the wallet doesn’t exist on this path, it returns an error. A wallet can be opened in offline or online modes. Offline wallet doesn’t have any connection to any node. Online wallet has a connection to one of the pre-defined servers.
func (*Wallet) AddressCount ¶
AddressCount returns the number of addresses inside the wallet.
func (*Wallet) AddressFromPath ¶ added in v0.18.0
func (w *Wallet) AddressFromPath(p string) *vault.AddressInfo
func (*Wallet) AddressInfo ¶
func (w *Wallet) AddressInfo(addr string) *vault.AddressInfo
func (*Wallet) AddressInfos ¶ added in v0.15.0
func (w *Wallet) AddressInfos() []vault.AddressInfo
func (*Wallet) AllAccountAddresses ¶ added in v1.1.0
func (w *Wallet) AllAccountAddresses() []vault.AddressInfo
func (*Wallet) AllValidatorAddresses ¶ added in v0.18.0
func (w *Wallet) AllValidatorAddresses() []vault.AddressInfo
func (*Wallet) BroadcastTransaction ¶
func (*Wallet) CalculateFee ¶
func (*Wallet) GetHistory ¶
func (w *Wallet) GetHistory(addr string) []HistoryInfo
func (*Wallet) ImportPrivateKey ¶
func (w *Wallet) ImportPrivateKey(password string, prv *bls.PrivateKey) error
func (*Wallet) IsEncrypted ¶
func (*Wallet) MakeBondTx ¶
func (w *Wallet) MakeBondTx(sender, receiver, pubKey string, amt amount.Amount, options ...TxOption, ) (*tx.Tx, error)
MakeBondTx creates a new bond transaction based on the given parameters.
func (*Wallet) MakeTransferTx ¶ added in v0.13.0
func (w *Wallet) MakeTransferTx(sender, receiver string, amt amount.Amount, options ...TxOption, ) (*tx.Tx, error)
MakeTransferTx creates a new transfer transaction based on the given parameters.
func (*Wallet) MakeUnbondTx ¶
MakeUnbondTx creates a new unbond transaction based on the given parameters.
func (*Wallet) MakeWithdrawTx ¶
func (w *Wallet) MakeWithdrawTx(sender, receiver string, amt amount.Amount, options ...TxOption, ) (*tx.Tx, error)
MakeWithdrawTx creates a new withdraw transaction based on the given parameters.
func (*Wallet) NewBLSAccountAddress ¶ added in v0.15.0
func (w *Wallet) NewBLSAccountAddress(label string) (*vault.AddressInfo, error)
NewBLSAccountAddress create a new BLS-based account address and associates it with the given label.
func (*Wallet) NewValidatorAddress ¶ added in v0.15.0
func (w *Wallet) NewValidatorAddress(label string) (*vault.AddressInfo, error)
NewValidatorAddress creates a new BLS validator address and associates it with the given label.
func (*Wallet) PrivateKey ¶
func (w *Wallet) PrivateKey(password, addr string) (crypto.PrivateKey, error)
func (*Wallet) PrivateKeys ¶ added in v0.10.0
func (*Wallet) SetServerAddr ¶ added in v1.1.0
func (*Wallet) SignTransaction ¶
func (*Wallet) TotalBalance ¶ added in v1.1.0
TotalBalance return the total available balance of the wallet.