wallet

Documentation

Index

• Variables
• func CheckSubmitTransactionRequest(req *walletpb.SubmitTransactionRequest) commands.Errors
• type Handler
  • func NewHandler(store Store) *Handler
  • func (h *Handler) CreateWallet(name, passphrase string) error
  • func (h *Handler) GenerateKeyPair(name, passphrase string) (KeyPair, error)
  • func (h *Handler) GetPublicKey(name, pubKey string) (*PublicKey, error)
  • func (h *Handler) GetWalletPath(name string) (string, error)
  • func (h *Handler) ListPublicKeys(name string) ([]PublicKey, error)
  • func (h *Handler) LoginWallet(name, passphrase string) error
  • func (h *Handler) LogoutWallet(name string)
  • func (h *Handler) SecureGenerateKeyPair(name, passphrase string) (string, error)
  • func (h *Handler) SignAny(name, inputData, pubKey string) ([]byte, error)
  • func (h *Handler) SignTx(name, tx, pubKey string, blockHeight uint64) (SignedBundle, error)
  • func (h *Handler) SignTxV2(name string, req *walletpb.SubmitTransactionRequest, height uint64) (*commandspb.Transaction, error)
  • func (h *Handler) TaintKey(name, pubKey, passphrase string) error
  • func (h *Handler) UpdateMeta(name, pubKey, passphrase string, meta []Meta) error
  • func (h *Handler) VerifyAny(name, inputData, sig, pubKey string) (bool, error)
  • func (h *Handler) WalletExists(name string) bool
• type KeyPair
  • func GenKeypair(algorithm string) (*KeyPair, error)
  • func (k *KeyPair) DeepCopy() KeyPair
  • func (k *KeyPair) MarshalJSON() ([]byte, error)
  • func (k *KeyPair) Sign(marshalledData []byte) (*commandspb.Signature, error)
  • func (k *KeyPair) Taint() error
  • func (k *KeyPair) ToPublicKey() *PublicKey
  • func (k *KeyPair) UnmarshalJSON(data []byte) error
• type KeyRing
  • func NewKeyRing() KeyRing
  • func (r KeyRing) FindPair(pubKey string) (KeyPair, error)
  • func (r KeyRing) GetPublicKeys() []PublicKey
  • func (r *KeyRing) Upsert(pair KeyPair)
• type Meta
• type PublicKey
• type RSAKeys
  • func GenerateRSAKeys() (*RSAKeys, error)
• type Signature
• type SignedBundle
  • func (s *SignedBundle) IntoProto() *typespb.SignedBundle
  • func (s SignedBundle) MarshalJSON() ([]byte, error)
• type Store
• type Wallet
  • func New(owner string) Wallet
  • func NewWallet(name string) *Wallet

Variables

var (
	ErrWalletDoesNotExists = errors.New("wallet does not exist")
	ErrWalletAlreadyExists = errors.New("a wallet with the same name already exists")
)

var (
	ErrPubKeyDoesNotExist   = errors.New("public key does not exist")
	ErrPubKeyAlreadyTainted = errors.New("public key is already tainted")
)

var (
	ErrPubKeyIsTainted = errors.New("public key is tainted")
)

Functions

func CheckSubmitTransactionRequest

func CheckSubmitTransactionRequest(req *walletpb.SubmitTransactionRequest) commands.Errors

Types

type Handler

type Handler struct {
	// contains filtered or unexported fields
}

func NewHandler

func NewHandler(store Store) *Handler

func (*Handler) CreateWallet

func (h *Handler) CreateWallet(name, passphrase string) error

func (*Handler) GenerateKeyPair

func (h *Handler) GenerateKeyPair(name, passphrase string) (KeyPair, error)

func (*Handler) GetPublicKey

func (h *Handler) GetPublicKey(name, pubKey string) (*PublicKey, error)

func (*Handler) GetWalletPath

func (h *Handler) GetWalletPath(name string) (string, error)

func (*Handler) ListPublicKeys

func (h *Handler) ListPublicKeys(name string) ([]PublicKey, error)

func (*Handler) LoginWallet

func (h *Handler) LoginWallet(name, passphrase string) error

func (*Handler) LogoutWallet

func (h *Handler) LogoutWallet(name string)

func (*Handler) SecureGenerateKeyPair

func (h *Handler) SecureGenerateKeyPair(name, passphrase string) (string, error)

func (*Handler) SignAny

func (h *Handler) SignAny(name, inputData, pubKey string) ([]byte, error)

func (*Handler) SignTx

func (h *Handler) SignTx(name, tx, pubKey string, blockHeight uint64) (SignedBundle, error)

func (*Handler) SignTxV2

func (h *Handler) SignTxV2(name string, req *walletpb.SubmitTransactionRequest, height uint64) (*commandspb.Transaction, error)

func (*Handler) TaintKey

func (h *Handler) TaintKey(name, pubKey, passphrase string) error

func (*Handler) UpdateMeta

func (h *Handler) UpdateMeta(name, pubKey, passphrase string, meta []Meta) error

func (*Handler) VerifyAny

func (h *Handler) VerifyAny(name, inputData, sig, pubKey string) (bool, error)

func (*Handler) WalletExists

func (h *Handler) WalletExists(name string) bool

type KeyPair

type KeyPair struct {
	Pub       string                    `json:"pub"`
	Priv      string                    `json:"priv,omitempty"`
	Algorithm crypto.SignatureAlgorithm `json:"algo"`
	Tainted   bool                      `json:"tainted"`
	Meta      []Meta                    `json:"meta"`
	// contains filtered or unexported fields
}

func GenKeypair

func GenKeypair(algorithm string) (*KeyPair, error)

func (*KeyPair) DeepCopy

func (k *KeyPair) DeepCopy() KeyPair

func (*KeyPair) MarshalJSON

func (k *KeyPair) MarshalJSON() ([]byte, error)

func (*KeyPair) Sign

func (k *KeyPair) Sign(marshalledData []byte) (*commandspb.Signature, error)

func (*KeyPair) Taint

func (k *KeyPair) Taint() error

func (*KeyPair) ToPublicKey

func (k *KeyPair) ToPublicKey() *PublicKey

ToPublicKey ensures the sensitive information doesn't leak outside.

func (*KeyPair) UnmarshalJSON

func (k *KeyPair) UnmarshalJSON(data []byte) error

type KeyRing

type KeyRing []KeyPair

func NewKeyRing

func NewKeyRing() KeyRing

func (KeyRing) FindPair

func (r KeyRing) FindPair(pubKey string) (KeyPair, error)

func (KeyRing) GetPublicKeys

func (r KeyRing) GetPublicKeys() []PublicKey

func (*KeyRing) Upsert

func (r *KeyRing) Upsert(pair KeyPair)

type Meta

type Meta struct {
	Key   string `json:"key"`
	Value string `json:"value"`
}

type PublicKey

type PublicKey struct {
	Key       string                    `json:"pub"`
	Algorithm crypto.SignatureAlgorithm `json:"algo"`
	Tainted   bool                      `json:"tainted"`
	Meta      []Meta                    `json:"meta"`
}

type RSAKeys

type RSAKeys struct {
	Pub  []byte
	Priv []byte
}

func GenerateRSAKeys

func GenerateRSAKeys() (*RSAKeys, error)

type Signature

type Signature struct {
	Sig     []byte `json:"sig"`
	Algo    string `json:"algo"`
	Version uint32 `json:"version"`
}

type SignedBundle

type SignedBundle struct {
	Tx  []byte    `json:"tx"`
	Sig Signature `json:"sig"`
}

func (*SignedBundle) IntoProto

func (s *SignedBundle) IntoProto() *typespb.SignedBundle

func (SignedBundle) MarshalJSON

func (s SignedBundle) MarshalJSON() ([]byte, error)

type Store

type Store interface {
	WalletExists(name string) bool
	SaveWallet(w Wallet, passphrase string) error
	GetWallet(name, passphrase string) (Wallet, error)
	GetWalletPath(name string) string
}

Store abstracts the underlying storage for wallet data.

type Wallet

type Wallet struct {
	Owner   string
	KeyRing KeyRing `json:"Keypairs"`
}

func New

func New(owner string) Wallet

func NewWallet

func NewWallet(name string) *Wallet