wallet

type ICommon interface {
	// Auth
	AuthVerify(ctx context.Context, token string) ([]auth.Permission, error) //perm:read
	AuthNew(ctx context.Context, perms []auth.Permission) ([]byte, error)    //perm:admin

	// Version provides information about API provider
	Version(context.Context) (types.Version, error) //perm:read

	LogList(context.Context) ([]string, error)         //perm:read
	LogSetLevel(context.Context, string, string) error //perm:write
}

type ICommonStruct struct {
	Internal struct {
		AuthNew     func(ctx context.Context, perms []auth.Permission) ([]byte, error) `perm:"admin"`
		AuthVerify  func(ctx context.Context, token string) ([]auth.Permission, error) `perm:"read"`
		LogList     func(context.Context) ([]string, error)                            `perm:"read"`
		LogSetLevel func(context.Context, string, string) error                        `perm:"write"`
		Version     func(context.Context) (types.Version, error)                       `perm:"read"`
	}
}

type IFullAPI interface {
	ILocalStrategy
	ILocalWallet
	ICommon
	IWalletEvent
}

type IFullAPIStruct struct {
	ILocalStrategyStruct
	ILocalWalletStruct
	ICommonStruct
	IWalletEventStruct
}

type ILocalStrategy interface {
	IStrategyVerify
	IStrategy
}

type ILocalStrategyStruct struct {
	IStrategyVerifyStruct
	IStrategyStruct
}

type ILocalWallet interface {
	IWallet
	IWalletLock
}

type ILocalWalletStruct struct {
	IWalletStruct
	IWalletLockStruct
}

type IStrategy interface {
	// NewMsgTypeTemplate create a msgType template
	NewMsgTypeTemplate(ctx context.Context, name string, codes []int) error //perm:admin
	// NewMethodTemplate create a method template
	NewMethodTemplate(ctx context.Context, name string, methods []string) error //perm:admin
	// NewKeyBindCustom create a keyBind with custom msyTypes and methods
	NewKeyBindCustom(ctx context.Context, name string, address address.Address, codes []int, methods []wallet.MethodName) error //perm:admin
	// NewKeyBindFromTemplate create a keyBind form msgType template and method template
	NewKeyBindFromTemplate(ctx context.Context, name string, address address.Address, mttName, mtName string) error //perm:admin
	// NewGroup create a group to group multiple keyBinds together
	NewGroup(ctx context.Context, name string, keyBindNames []string) error //perm:admin
	// NewStToken generate a random token from group
	NewStToken(ctx context.Context, groupName string) (token string, err error) //perm:admin
	// GetMsgTypeTemplate get a msgType template by name
	GetMsgTypeTemplate(ctx context.Context, name string) (*wallet.MsgTypeTemplate, error) //perm:admin
	// GetMethodTemplateByName get a method template by name
	GetMethodTemplateByName(ctx context.Context, name string) (*wallet.MethodTemplate, error) //perm:admin
	// GetKeyBindByName get a keyBind by name
	GetKeyBindByName(ctx context.Context, name string) (*wallet.KeyBind, error) //perm:admin
	// GetKeyBinds list keyBinds by address
	GetKeyBinds(ctx context.Context, address address.Address) ([]*wallet.KeyBind, error) //perm:admin
	// GetGroupByName get a group by name
	GetGroupByName(ctx context.Context, name string) (*wallet.Group, error) //perm:admin
	// GetWalletTokensByGroup list strategy tokens under the group
	GetWalletTokensByGroup(ctx context.Context, groupName string) ([]string, error) //perm:admin
	// GetWalletTokenInfo get group details by token
	GetWalletTokenInfo(ctx context.Context, token string) (*wallet.GroupAuth, error) //perm:admin
	// ListGroups list groups' simple information
	ListGroups(ctx context.Context, fromIndex, toIndex int) ([]*wallet.Group, error) //perm:admin
	// ListKeyBinds list keyBinds' details
	ListKeyBinds(ctx context.Context, fromIndex, toIndex int) ([]*wallet.KeyBind, error) //perm:admin
	// ListMethodTemplates list method templates' details
	ListMethodTemplates(ctx context.Context, fromIndex, toIndex int) ([]*wallet.MethodTemplate, error) //perm:admin
	// ListMsgTypeTemplates list msgType templates' details
	ListMsgTypeTemplates(ctx context.Context, fromIndex, toIndex int) ([]*wallet.MsgTypeTemplate, error) //perm:admin

	// AddMsgTypeIntoKeyBind append msgTypes into keyBind
	AddMsgTypeIntoKeyBind(ctx context.Context, name string, codes []int) (*wallet.KeyBind, error) //perm:admin
	// AddMethodIntoKeyBind append methods into keyBind
	AddMethodIntoKeyBind(ctx context.Context, name string, methods []string) (*wallet.KeyBind, error) //perm:admin
	// RemoveMsgTypeFromKeyBind remove msgTypes form keyBind
	RemoveMsgTypeFromKeyBind(ctx context.Context, name string, codes []int) (*wallet.KeyBind, error) //perm:admin
	// RemoveMethodFromKeyBind remove methods from keyBind
	RemoveMethodFromKeyBind(ctx context.Context, name string, methods []string) (*wallet.KeyBind, error) //perm:admin

	// RemoveMsgTypeTemplate delete msgType template by name
	RemoveMsgTypeTemplate(ctx context.Context, name string) error //perm:admin
	// RemoveGroup delete group by name
	RemoveGroup(ctx context.Context, name string) error //perm:admin
	// RemoveMethodTemplate delete method template by name
	RemoveMethodTemplate(ctx context.Context, name string) error //perm:admin
	// RemoveKeyBind delete keyBind by name
	RemoveKeyBind(ctx context.Context, name string) error //perm:admin
	// RemoveKeyBindByAddress delete some keyBinds by address
	RemoveKeyBindByAddress(ctx context.Context, address address.Address) (int64, error) //perm:admin
	// RemoveStToken delete strategy token
	RemoveStToken(ctx context.Context, token string) error //perm:admin
}

type IStrategyStruct struct {
	Internal struct {
		AddMethodIntoKeyBind     func(ctx context.Context, name string, methods []string) (*wallet.KeyBind, error)                               `perm:"admin"`
		AddMsgTypeIntoKeyBind    func(ctx context.Context, name string, codes []int) (*wallet.KeyBind, error)                                    `perm:"admin"`
		GetGroupByName           func(ctx context.Context, name string) (*wallet.Group, error)                                                   `perm:"admin"`
		GetKeyBindByName         func(ctx context.Context, name string) (*wallet.KeyBind, error)                                                 `perm:"admin"`
		GetKeyBinds              func(ctx context.Context, address address.Address) ([]*wallet.KeyBind, error)                                   `perm:"admin"`
		GetMethodTemplateByName  func(ctx context.Context, name string) (*wallet.MethodTemplate, error)                                          `perm:"admin"`
		GetMsgTypeTemplate       func(ctx context.Context, name string) (*wallet.MsgTypeTemplate, error)                                         `perm:"admin"`
		GetWalletTokenInfo       func(ctx context.Context, token string) (*wallet.GroupAuth, error)                                              `perm:"admin"`
		GetWalletTokensByGroup   func(ctx context.Context, groupName string) ([]string, error)                                                   `perm:"admin"`
		ListGroups               func(ctx context.Context, fromIndex, toIndex int) ([]*wallet.Group, error)                                      `perm:"admin"`
		ListKeyBinds             func(ctx context.Context, fromIndex, toIndex int) ([]*wallet.KeyBind, error)                                    `perm:"admin"`
		ListMethodTemplates      func(ctx context.Context, fromIndex, toIndex int) ([]*wallet.MethodTemplate, error)                             `perm:"admin"`
		ListMsgTypeTemplates     func(ctx context.Context, fromIndex, toIndex int) ([]*wallet.MsgTypeTemplate, error)                            `perm:"admin"`
		NewGroup                 func(ctx context.Context, name string, keyBindNames []string) error                                             `perm:"admin"`
		NewKeyBindCustom         func(ctx context.Context, name string, address address.Address, codes []int, methods []wallet.MethodName) error `perm:"admin"`
		NewKeyBindFromTemplate   func(ctx context.Context, name string, address address.Address, mttName, mtName string) error                   `perm:"admin"`
		NewMethodTemplate        func(ctx context.Context, name string, methods []string) error                                                  `perm:"admin"`
		NewMsgTypeTemplate       func(ctx context.Context, name string, codes []int) error                                                       `perm:"admin"`
		NewStToken               func(ctx context.Context, groupName string) (token string, err error)                                           `perm:"admin"`
		RemoveGroup              func(ctx context.Context, name string) error                                                                    `perm:"admin"`
		RemoveKeyBind            func(ctx context.Context, name string) error                                                                    `perm:"admin"`
		RemoveKeyBindByAddress   func(ctx context.Context, address address.Address) (int64, error)                                               `perm:"admin"`
		RemoveMethodFromKeyBind  func(ctx context.Context, name string, methods []string) (*wallet.KeyBind, error)                               `perm:"admin"`
		RemoveMethodTemplate     func(ctx context.Context, name string) error                                                                    `perm:"admin"`
		RemoveMsgTypeFromKeyBind func(ctx context.Context, name string, codes []int) (*wallet.KeyBind, error)                                    `perm:"admin"`
		RemoveMsgTypeTemplate    func(ctx context.Context, name string) error                                                                    `perm:"admin"`
		RemoveStToken            func(ctx context.Context, token string) error                                                                   `perm:"admin"`
	}
}

type IStrategyVerify interface {
	// Verify verify the address strategy permissions
	Verify(ctx context.Context, address address.Address, msgType types.MsgType, msg *types.Message) error //perm:admin
	// ScopeWallet get the wallet scope
	ScopeWallet(ctx context.Context) (*wallet.AddressScope, error) //perm:admin
	// ContainWallet Check if it is visible to the wallet
	ContainWallet(ctx context.Context, address address.Address) bool //perm:admin
}

type IStrategyVerifyStruct struct {
	Internal struct {
		ContainWallet func(ctx context.Context, address address.Address) bool                                             `perm:"admin"`
		ScopeWallet   func(ctx context.Context) (*wallet.AddressScope, error)                                             `perm:"admin"`
		Verify        func(ctx context.Context, address address.Address, msgType types.MsgType, msg *types.Message) error `perm:"admin"`
	}
}

type IWallet interface {
	WalletNew(ctx context.Context, kt types.KeyType) (address.Address, error)                                             //perm:admin
	WalletHas(ctx context.Context, address address.Address) (bool, error)                                                 //perm:read
	WalletList(ctx context.Context) ([]address.Address, error)                                                            //perm:read
	WalletSign(ctx context.Context, signer address.Address, toSign []byte, meta types.MsgMeta) (*crypto.Signature, error) //perm:sign
	WalletExport(ctx context.Context, addr address.Address) (*types.KeyInfo, error)                                       //perm:admin
	WalletImport(ctx context.Context, ki *types.KeyInfo) (address.Address, error)                                         //perm:admin
	WalletDelete(ctx context.Context, addr address.Address) error                                                         //perm:admin
}

type IWalletEvent interface {
	AddSupportAccount(ctx context.Context, supportAccount string) error  //perm:admin
	AddNewAddress(ctx context.Context, newAddrs []address.Address) error //perm:admin
}

type IWalletEventStruct struct {
	Internal struct {
		AddNewAddress     func(ctx context.Context, newAddrs []address.Address) error `perm:"admin"`
		AddSupportAccount func(ctx context.Context, supportAccount string) error      `perm:"admin"`
	}
}

type IWalletLock interface {
	// SetPassword do it first after program setup
	SetPassword(ctx context.Context, password string) error //perm:admin
	// unlock the wallet and enable IWallet logic
	Unlock(ctx context.Context, password string) error //perm:admin
	// lock the wallet and disable IWallet logic
	Lock(ctx context.Context, password string) error //perm:admin
	// show lock state
	LockState(ctx context.Context) bool //perm:admin
	// VerifyPassword verify that the passwords are consistent
	VerifyPassword(ctx context.Context, password string) error //perm:admin
}

type IWalletLockStruct struct {
	Internal struct {
		Lock           func(ctx context.Context, password string) error `perm:"admin"`
		LockState      func(ctx context.Context) bool                   `perm:"admin"`
		SetPassword    func(ctx context.Context, password string) error `perm:"admin"`
		Unlock         func(ctx context.Context, password string) error `perm:"admin"`
		VerifyPassword func(ctx context.Context, password string) error `perm:"admin"`
	}
}

type IWalletStruct struct {
	Internal struct {
		WalletDelete func(ctx context.Context, addr address.Address) error                                                           `perm:"admin"`
		WalletExport func(ctx context.Context, addr address.Address) (*types.KeyInfo, error)                                         `perm:"admin"`
		WalletHas    func(ctx context.Context, address address.Address) (bool, error)                                                `perm:"read"`
		WalletImport func(ctx context.Context, ki *types.KeyInfo) (address.Address, error)                                           `perm:"admin"`
		WalletList   func(ctx context.Context) ([]address.Address, error)                                                            `perm:"read"`
		WalletNew    func(ctx context.Context, kt types.KeyType) (address.Address, error)                                            `perm:"admin"`
		WalletSign   func(ctx context.Context, signer address.Address, toSign []byte, meta types.MsgMeta) (*crypto.Signature, error) `perm:"sign"`
	}
}