accounts

type AXIAwallet interface {
	// URL retrieves the canonical path under which this axiawallet is reachable. It is
	// used by upper layers to define a sorting order over all axiawallets from multiple
	// backends.
	URL() URL

	// Status returns a textual status to aid the user in the current state of the
	// axiawallet. It also returns an error indicating any failure the axiawallet might have
	// encountered.
	Status() (string, error)

	// Open initializes access to a axiawallet instance. It is not meant to unlock or
	// decrypt account keys, rather simply to establish a connection to hardware
	// axiawallets and/or to access derivation seeds.
	//
	// The passphrase parameter may or may not be used by the implementation of a
	// particular axiawallet instance. The reason there is no passwordless open method
	// is to strive towards a uniform axiawallet handling, oblivious to the different
	// backend providers.
	//
	// Please note, if you open a axiawallet, you must close it to release any allocated
	// resources (especially important when working with hardware axiawallets).
	Open(passphrase string) error

	// Close releases any resources held by an open axiawallet instance.
	Close() error

	// Accounts retrieves the list of signing accounts the axiawallet is currently aware
	// of. For hierarchical deterministic axiawallets, the list will not be exhaustive,
	// rather only contain the accounts explicitly pinned during account derivation.
	Accounts() []Account

	// Contains returns whether an account is part of this particular axiawallet or not.
	Contains(account Account) bool

	// Derive attempts to explicitly derive a hierarchical deterministic account at
	// the specified derivation path. If requested, the derived account will be added
	// to the axiawallet's tracked account list.
	Derive(path DerivationPath, pin bool) (Account, error)

	// SelfDerive sets a base account derivation path from which the axiawallet attempts
	// to discover non zero accounts and automatically add them to list of tracked
	// accounts.
	//
	// Note, self derivation will increment the last component of the specified path
	// opposed to descending into a child path to allow discovering accounts starting
	// from non zero components.
	//
	// Some hardware axiawallets switched derivation paths through their evolution, so
	// this method supports providing multiple bases to discover old user accounts
	// too. Only the last base will be used to derive the next empty account.
	//
	// You can disable automatic account discovery by calling SelfDerive with a nil
	// chain state reader.
	SelfDerive(bases []DerivationPath, chain interfaces.ChainStateReader)

	// SignData requests the axiawallet to sign the hash of the given data
	// It looks up the account specified either solely via its address contained within,
	// or optionally with the aid of any location metadata from the embedded URL field.
	//
	// If the axiawallet requires additional authentication to sign the request (e.g.
	// a password to decrypt the account, or a PIN code to verify the transaction),
	// an AuthNeededError instance will be returned, containing infos for the user
	// about which fields or actions are needed. The user may retry by providing
	// the needed details via SignDataWithPassphrase, or by other means (e.g. unlock
	// the account in a keystore).
	SignData(account Account, mimeType string, data []byte) ([]byte, error)

	// SignDataWithPassphrase is identical to SignData, but also takes a password
	// NOTE: there's a chance that an erroneous call might mistake the two strings, and
	// supply password in the mimetype field, or vice versa. Thus, an implementation
	// should never echo the mimetype or return the mimetype in the error-response
	SignDataWithPassphrase(account Account, passphrase, mimeType string, data []byte) ([]byte, error)

	// SignText requests the axiawallet to sign the hash of a given piece of data, prefixed
	// by the Ethereum prefix scheme
	// It looks up the account specified either solely via its address contained within,
	// or optionally with the aid of any location metadata from the embedded URL field.
	//
	// If the axiawallet requires additional authentication to sign the request (e.g.
	// a password to decrypt the account, or a PIN code to verify the transaction),
	// an AuthNeededError instance will be returned, containing infos for the user
	// about which fields or actions are needed. The user may retry by providing
	// the needed details via SignTextWithPassphrase, or by other means (e.g. unlock
	// the account in a keystore).
	//
	// This method should return the signature in 'canonical' format, with v 0 or 1.
	SignText(account Account, text []byte) ([]byte, error)

	// SignTextWithPassphrase is identical to Signtext, but also takes a password
	SignTextWithPassphrase(account Account, passphrase string, hash []byte) ([]byte, error)

	// SignTx requests the axiawallet to sign the given transaction.
	//
	// It looks up the account specified either solely via its address contained within,
	// or optionally with the aid of any location metadata from the embedded URL field.
	//
	// If the axiawallet requires additional authentication to sign the request (e.g.
	// a password to decrypt the account, or a PIN code to verify the transaction),
	// an AuthNeededError instance will be returned, containing infos for the user
	// about which fields or actions are needed. The user may retry by providing
	// the needed details via SignTxWithPassphrase, or by other means (e.g. unlock
	// the account in a keystore).
	SignTx(account Account, tx *types.Transaction, chainID *big.Int) (*types.Transaction, error)

	// SignTxWithPassphrase is identical to SignTx, but also takes a password
	SignTxWithPassphrase(account Account, passphrase string, tx *types.Transaction, chainID *big.Int) (*types.Transaction, error)
}

type AXIAwalletEvent struct {
	AXIAwallet AXIAwallet          // AXIAwallet instance arrived or departed
	Kind       AXIAwalletEventType // Event type that happened in the system
}

type AXIAwalletEventType int

type AXIAwalletsByURL []AXIAwallet

type Account struct {
	Address common.Address `json:"address"` // Ethereum account address derived from the key
	URL     URL            `json:"url"`     // Optional resource locator within a backend
}

type AccountsByURL []Account

type AuthNeededError struct {
	Needed string // Extra authentication the user needs to provide
}

type Backend interface {
	// AXIAwallets retrieves the list of axiawallets the backend is currently aware of.
	//
	// The returned axiawallets are not opened by default. For software HD axiawallets this
	// means that no base seeds are decrypted, and for hardware axiawallets that no actual
	// connection is established.
	//
	// The resulting axiawallet list will be sorted alphabetically based on its internal
	// URL assigned by the backend. Since axiawallets (especially hardware) may come and
	// go, the same axiawallet might appear at a different positions in the list during
	// subsequent retrievals.
	AXIAwallets() []AXIAwallet

	// Subscribe creates an async subscription to receive notifications when the
	// backend detects the arrival or departure of a axiawallet.
	Subscribe(sink chan<- AXIAwalletEvent) event.Subscription
}

type Config struct {
	InsecureUnlockAllowed bool // Whether account unlocking in insecure environment is allowed
}

type DerivationPath []uint32

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

type URL struct {
	Scheme string // Protocol scheme to identify a capable account backend
	Path   string // Path for the backend to identify a unique entity
}