keeper

Documentation

Index

• func SudoersToPb(sudo Sudoers) sudotypes.Sudoers
• func SudoersValueEncoder(cdc codec.BinaryCodec) collections.ValueEncoder[sudotypes.Sudoers]
• type Keeper
  • func NewKeeper(cdc codec.BinaryCodec, storeKey types.StoreKey) Keeper
  • func (k Keeper) AddContracts(goCtx context.Context, msg *sudotypes.MsgEditSudoers) (msgResp *sudotypes.MsgEditSudoersResponse, err error)
  • func (k Keeper) CheckPermissions(contract sdk.AccAddress, ctx sdk.Context) error
  • func (k Keeper) EditSudoers(goCtx context.Context, msg *sudotypes.MsgEditSudoers) (*sudotypes.MsgEditSudoersResponse, error)
  • func (k Keeper) GetSudoContracts(ctx sdk.Context) (contracts []string, err error)
  • func (k Keeper) QuerySudoers(goCtx context.Context, req *types.QuerySudoersRequest) (resp *types.QuerySudoersResponse, err error)
  • func (k Keeper) RemoveContracts(goCtx context.Context, msg *sudotypes.MsgEditSudoers) (msgResp *sudotypes.MsgEditSudoersResponse, err error)
  • func (k Keeper) SenderHasPermission(sender string, root string) error
  • func (k Keeper) SetSudoContracts(contracts []string, ctx sdk.Context)
• type Sudoers
  • func SudoersFromPb(pbSudoers sudotypes.Sudoers) Sudoers
  • func (sudo *Sudoers) AddContracts(contracts []string) (out set.Set[string], err error)
  • func (sudo *Sudoers) RemoveContracts(contracts []string)
  • func (sudo Sudoers) String() string
  • func (sudo Sudoers) ToPb() sudotypes.Sudoers

Functions

func SudoersToPb

func SudoersToPb(sudo Sudoers) sudotypes.Sudoers

func SudoersValueEncoder

func SudoersValueEncoder(cdc codec.BinaryCodec) collections.ValueEncoder[sudotypes.Sudoers]

Types

type Keeper

type Keeper struct {
	Sudoers collections.Item[sudotypes.Sudoers]
}

func NewKeeper

func NewKeeper(
	cdc codec.BinaryCodec,
	storeKey types.StoreKey,
) Keeper

func (Keeper) AddContracts

func (k Keeper) AddContracts(
	goCtx context.Context, msg *sudotypes.MsgEditSudoers,
) (msgResp *sudotypes.MsgEditSudoersResponse, err error)

AddContracts executes a MsgEditSudoers message with action type "add_contracts". This adds contract addresses to the sudoer set.

func (Keeper) CheckPermissions

func (k Keeper) CheckPermissions(
	contract sdk.AccAddress, ctx sdk.Context,
) error

CheckPermissions Checks if a contract is contained within the set of sudo contracts defined in the x/sudo module. These smart contracts are able to execute certain permissioned functions.

func (Keeper) EditSudoers

func (k Keeper) EditSudoers(
	goCtx context.Context, msg *sudotypes.MsgEditSudoers,
) (*sudotypes.MsgEditSudoersResponse, error)

EditSudoers adds or removes sudo contracts from state.

func (Keeper) GetSudoContracts

func (k Keeper) GetSudoContracts(ctx sdk.Context) (contracts []string, err error)

func (Keeper) QuerySudoers

func (k Keeper) QuerySudoers(
	goCtx context.Context,
	req *types.QuerySudoersRequest,
) (resp *types.QuerySudoersResponse, err error)

func (Keeper) RemoveContracts

func (k Keeper) RemoveContracts(
	goCtx context.Context, msg *sudotypes.MsgEditSudoers,
) (msgResp *sudotypes.MsgEditSudoersResponse, err error)

func (Keeper) SenderHasPermission

func (k Keeper) SenderHasPermission(sender string, root string) error

func (Keeper) SetSudoContracts

func (k Keeper) SetSudoContracts(contracts []string, ctx sdk.Context)

SetSudoContracts overwrites the state. This function is a convenience function for testing with permissioned contracts in other modules..

type Sudoers

type Sudoers struct {
	Root      string          `json:"root"`
	Contracts set.Set[string] `json:"contracts"`
}

func SudoersFromPb

func SudoersFromPb(pbSudoers sudotypes.Sudoers) Sudoers

func (*Sudoers) AddContracts

func (sudo *Sudoers) AddContracts(
	contracts []string,
) (out set.Set[string], err error)

AddContracts adds contract addresses to the sudoer set.

func (*Sudoers) RemoveContracts

func (sudo *Sudoers) RemoveContracts(contracts []string)

func (Sudoers) String

func (sudo Sudoers) String() string

func (Sudoers) ToPb

func (sudo Sudoers) ToPb() sudotypes.Sudoers