keeper

package
v4.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 5, 2022 License: Apache-2.0 Imports: 15 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func FormatOutputSubspaces

func FormatOutputSubspaces(subspaces []types.Subspace) (outputSubspaces string)

FormatOutputSubspaces concatenate the subspaces given into a unique string

func NewMsgServerImpl

func NewMsgServerImpl(keeper Keeper) types.MsgServer

NewMsgServerImpl returns an implementation of the stored MsgServer interface for the provided keeper

func RegisterInvariants

func RegisterInvariants(ir sdk.InvariantRegistry, keeper Keeper)

RegisterInvariants registers all subspaces invariants

func ValidSectionsInvariant

func ValidSectionsInvariant(k Keeper) sdk.Invariant

ValidSectionsInvariant checks that all the sections are valid

func ValidSubspacesInvariant

func ValidSubspacesInvariant(k Keeper) sdk.Invariant

ValidSubspacesInvariant checks that all the subspaces are valid

func ValidUserGroupMembersInvariant

func ValidUserGroupMembersInvariant(k Keeper) sdk.Invariant

ValidUserGroupMembersInvariant checks that all the user group members are valid

func ValidUserGroupsInvariant

func ValidUserGroupsInvariant(k Keeper) sdk.Invariant

ValidUserGroupsInvariant checks that all the subspaces are valid

func ValidUserPermissionsInvariant

func ValidUserPermissionsInvariant(k Keeper) sdk.Invariant

ValidUserPermissionsInvariant checks that all the user permission entries are valid

Types

type Keeper

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

func NewKeeper

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

NewKeeper creates new instances of the subspaces keeper

func (Keeper) AddUserToGroup

func (k Keeper) AddUserToGroup(ctx sdk.Context, subspaceID uint64, groupID uint32, user string)

AddUserToGroup adds the given user to the group having the provided id inside the specified subspace.

func (Keeper) AfterSubspaceDeleted

func (k Keeper) AfterSubspaceDeleted(ctx sdk.Context, subspaceID uint64)

AfterSubspaceDeleted - call if hook is registered

func (Keeper) AfterSubspaceGroupDeleted

func (k Keeper) AfterSubspaceGroupDeleted(ctx sdk.Context, subspaceID uint64, groupID uint32)

AfterSubspaceGroupDeleted - call if hook is registered

func (Keeper) AfterSubspaceGroupMemberAdded

func (k Keeper) AfterSubspaceGroupMemberAdded(ctx sdk.Context, subspaceID uint64, groupID uint32, user string)

AfterSubspaceGroupMemberAdded - call if hook is registered

func (Keeper) AfterSubspaceGroupMemberRemoved

func (k Keeper) AfterSubspaceGroupMemberRemoved(ctx sdk.Context, subspaceID uint64, groupID uint32, user string)

AfterSubspaceGroupMemberRemoved - call if hook is registered

func (Keeper) AfterSubspaceGroupSaved

func (k Keeper) AfterSubspaceGroupSaved(ctx sdk.Context, subspaceID uint64, groupID uint32)

AfterSubspaceGroupSaved - call if hook is registered

func (Keeper) AfterSubspaceSaved

func (k Keeper) AfterSubspaceSaved(ctx sdk.Context, subspaceID uint64)

AfterSubspaceSaved - call if hook is registered

func (Keeper) AfterSubspaceSectionDeleted

func (k Keeper) AfterSubspaceSectionDeleted(ctx sdk.Context, subspaceID uint64, sectionID uint32)

AfterSubspaceSectionDeleted - call if hook is registered

func (Keeper) AfterSubspaceSectionSaved

func (k Keeper) AfterSubspaceSectionSaved(ctx sdk.Context, subspaceID uint64, sectionID uint32)

AfterSubspaceSectionSaved - call if hook is registered

func (Keeper) AfterUserPermissionRemoved

func (k Keeper) AfterUserPermissionRemoved(ctx sdk.Context, subspaceID uint64, sectionID uint32, user string)

AfterUserPermissionRemoved - call if hook is registered

func (Keeper) AfterUserPermissionSet

func (k Keeper) AfterUserPermissionSet(ctx sdk.Context, subspaceID uint64, sectionID uint32, user string, permissions types.Permissions)

AfterUserPermissionSet - call if hook is registered

func (Keeper) DeleteNextGroupID

func (k Keeper) DeleteNextGroupID(ctx sdk.Context, subspaceID uint64)

DeleteNextGroupID deletes the next group id key for the given subspace

func (Keeper) DeleteNextSectionID

func (k Keeper) DeleteNextSectionID(ctx sdk.Context, subspaceID uint64)

DeleteNextSectionID deletes the next section id key for the given subspace from the store

func (Keeper) DeleteSection

func (k Keeper) DeleteSection(ctx sdk.Context, subspaceID uint64, sectionID uint32)

DeleteSection deletes the section having the given id from the subspace with the provided id

func (Keeper) DeleteSubspace

func (k Keeper) DeleteSubspace(ctx sdk.Context, subspaceID uint64)

DeleteSubspace allows to delete the subspace with the given id

func (Keeper) DeleteUserGroup

func (k Keeper) DeleteUserGroup(ctx sdk.Context, subspaceID uint64, groupID uint32)

DeleteUserGroup deletes the group with the given id from the subspace with the provided id

func (Keeper) ExportGenesis

func (k Keeper) ExportGenesis(ctx sdk.Context) *types.GenesisState

ExportGenesis returns the GenesisState associated with the given context

func (Keeper) GetAllPermissions

func (k Keeper) GetAllPermissions(ctx sdk.Context) []types.UserPermission

GetAllPermissions returns all the stored permissions for all subspaces

func (Keeper) GetAllSections

func (k Keeper) GetAllSections(ctx sdk.Context) []types.Section

GetAllSections returns all the stored sections

func (Keeper) GetAllSubspaces

func (k Keeper) GetAllSubspaces(ctx sdk.Context) []types.Subspace

GetAllSubspaces returns a list of all the subspaces that have been store inside the given context

func (Keeper) GetAllUserGroups

func (k Keeper) GetAllUserGroups(ctx sdk.Context) []types.UserGroup

GetAllUserGroups returns the information (name and members) for all the groups of all the subspaces

func (Keeper) GetGroupsInheritedPermissions

func (k Keeper) GetGroupsInheritedPermissions(ctx sdk.Context, subspaceID uint64, sectionID uint32, user string) types.Permissions

GetGroupsInheritedPermissions returns the permissions that the specified user has inherited from all the groups that they are part of.

func (Keeper) GetNextGroupID

func (k Keeper) GetNextGroupID(ctx sdk.Context, subspaceID uint64) (groupID uint32, err error)

GetNextGroupID gets the highest group id for the subspace with the given id

func (Keeper) GetNextSectionID

func (k Keeper) GetNextSectionID(ctx sdk.Context, subspaceID uint64) (sectionID uint32, err error)

GetNextSectionID gets the next section id for the subspace having the given id

func (Keeper) GetSection

func (k Keeper) GetSection(ctx sdk.Context, subspaceID uint64, sectionID uint32) (section types.Section, found bool)

GetSection returns the section having the given id from the subspace with the provided id. If there is no section associated with the given id the function will return an empty section and false.

func (Keeper) GetSectionUserGroups

func (k Keeper) GetSectionUserGroups(ctx sdk.Context, subspaceID uint64, sectionID uint32) []types.UserGroup

GetSectionUserGroups returns all the user groups present inside the given section

func (Keeper) GetSectionUserPermissions

func (k Keeper) GetSectionUserPermissions(ctx sdk.Context, subspaceID uint64, sectionID uint32) []types.UserPermission

GetSectionUserPermissions returns all the user permissions set inside the specific section

func (Keeper) GetSubspace

func (k Keeper) GetSubspace(ctx sdk.Context, subspaceID uint64) (subspace types.Subspace, found bool)

GetSubspace returns the subspace associated with the given id. If there is no subspace associated with the given id the function will return an empty subspace and false.

func (Keeper) GetSubspaceID

func (k Keeper) GetSubspaceID(ctx sdk.Context) (subspaceID uint64, err error)

GetSubspaceID gets the highest subspace id

func (Keeper) GetSubspaceSections

func (k Keeper) GetSubspaceSections(ctx sdk.Context, subspaceID uint64) []types.Section

GetSubspaceSections returns all the sections for the given subspace

func (Keeper) GetSubspaceUserGroups

func (k Keeper) GetSubspaceUserGroups(ctx sdk.Context, subspaceID uint64) []types.UserGroup

GetSubspaceUserGroups returns the list of all groups present inside a given subspace

func (Keeper) GetSubspaceUserPermissions

func (k Keeper) GetSubspaceUserPermissions(ctx sdk.Context, subspaceID uint64) []types.UserPermission

GetSubspaceUserPermissions returns all the user permissions set for the given subspace

func (Keeper) GetUserGroup

func (k Keeper) GetUserGroup(ctx sdk.Context, subspaceID uint64, groupID uint32) (group types.UserGroup, found bool)

GetUserGroup returns the group associated with the given id inside the subspace with the provided id. If there is no group associated with the given id the function will return an empty group and false.

func (Keeper) GetUserGroupMembers

func (k Keeper) GetUserGroupMembers(ctx sdk.Context, subspaceID uint64, groupID uint32) []string

GetUserGroupMembers returns all the members of a group inside a specific subspace

func (Keeper) GetUserPermissions

func (k Keeper) GetUserPermissions(ctx sdk.Context, subspaceID uint64, sectionID uint32, user string) types.Permissions

GetUserPermissions returns the permissions that are currently set inside the subspace with the given id for the given user

func (Keeper) GetUsersWithRootPermissions

func (k Keeper) GetUsersWithRootPermissions(ctx sdk.Context, subspaceID uint64, permission types.Permissions) []string

GetUsersWithRootPermissions returns all the users that have a given permission inside the specified subspace

func (Keeper) HasNextGroupID

func (k Keeper) HasNextGroupID(ctx sdk.Context, subspaceID uint64) bool

HasNextGroupID tells whether the next group id key exists for the given subspace

func (Keeper) HasNextSectionID

func (k Keeper) HasNextSectionID(ctx sdk.Context, subspaceID uint64) bool

HasNextSectionID tells whether the next section id key exists for the given subspace

func (Keeper) HasPermission

func (k Keeper) HasPermission(ctx sdk.Context, subspaceID uint64, sectionID uint32, user string, permission types.Permission) bool

HasPermission checks whether the specific user has the given permission inside a specific subspace

func (Keeper) HasSection

func (k Keeper) HasSection(ctx sdk.Context, subspaceID uint64, sectionID uint32) bool

HasSection tells whether the section having the given id exists inside the provided subspace

func (Keeper) HasSubspace

func (k Keeper) HasSubspace(ctx sdk.Context, subspaceID uint64) bool

HasSubspace tells whether the given subspace exists or not

func (Keeper) HasUserGroup

func (k Keeper) HasUserGroup(ctx sdk.Context, subspaceID uint64, groupID uint32) bool

HasUserGroup tells whether the given subspace has a group with the specified id or not

func (Keeper) InitGenesis

func (k Keeper) InitGenesis(ctx sdk.Context, data types.GenesisState)

InitGenesis initializes the chain state based on the given GenesisState

func (Keeper) IsMemberOfGroup

func (k Keeper) IsMemberOfGroup(ctx sdk.Context, subspaceID uint64, groupID uint32, user string) bool

IsMemberOfGroup returns whether the given user is part of the group with the specified id inside the provided subspace

func (Keeper) IsSectionPathValid

func (k Keeper) IsSectionPathValid(ctx sdk.Context, subspaceID uint64, sectionID uint32) bool

IsSectionPathValid tells whether the given path of the given section is valid or not. A path is considered to be valid if it's possible to reach the RootSection starting from a section.

func (Keeper) IterateSectionChildren

func (k Keeper) IterateSectionChildren(ctx sdk.Context, subspaceID uint64, sectionID uint32, fn func(section types.Section) (stop bool))

IterateSectionChildren iterates over all the children of the given section and performs the provided function

func (Keeper) IterateSectionPath

func (k Keeper) IterateSectionPath(ctx sdk.Context, subspaceID uint64, sectionID uint32, fn func(section types.Section) (stop bool))

IterateSectionPath iterates the path that leads from the section having the given id up towards the root section and performs the provided function on all the sections that are encountered over the path (including the initial section having the specified id).

func (Keeper) IterateSectionUserGroups

func (k Keeper) IterateSectionUserGroups(ctx sdk.Context, subspaceID uint64, sectionID uint32, fn func(group types.UserGroup) (stop bool))

IterateSectionUserGroups iterates over all the user groups for the given section and performs the provided function

func (Keeper) IterateSectionUserPermissions

func (k Keeper) IterateSectionUserPermissions(ctx sdk.Context, subspaceID uint64, sectionID uint32, fn func(entry types.UserPermission) (stop bool))

IterateSectionUserPermissions iterates over all the permissions set for the given section and performs the provided function

func (Keeper) IterateSections

func (k Keeper) IterateSections(ctx sdk.Context, fn func(section types.Section) (stop bool))

IterateSections iterates over all the sections stored and performs the provided function

func (Keeper) IterateSubspaceSections

func (k Keeper) IterateSubspaceSections(ctx sdk.Context, subspaceID uint64, fn func(section types.Section) (stop bool))

IterateSubspaceSections iterates over all the sections for the given subspace and performs the provided function

func (Keeper) IterateSubspaceUserGroups

func (k Keeper) IterateSubspaceUserGroups(ctx sdk.Context, subspaceID uint64, fn func(group types.UserGroup) (stop bool))

IterateSubspaceUserGroups allows iterating over all the groups that are part of the subspace having the given id

func (Keeper) IterateSubspaceUserPermissions

func (k Keeper) IterateSubspaceUserPermissions(ctx sdk.Context, subspaceID uint64, fn func(entry types.UserPermission) (stop bool))

IterateSubspaceUserPermissions iterates over all the user permissions set for the subspace with the given id

func (Keeper) IterateSubspaces

func (k Keeper) IterateSubspaces(ctx sdk.Context, fn func(subspace types.Subspace) (stop bool))

IterateSubspaces iterates through the subspaces set and performs the given function

func (Keeper) IterateUserGroupMembers

func (k Keeper) IterateUserGroupMembers(ctx sdk.Context, subspaceID uint64, groupID uint32, fn func(member string) (stop bool))

IterateUserGroupMembers iterates over all the members of the group with the given id present inside the given subspace

func (Keeper) IterateUserGroups

func (k Keeper) IterateUserGroups(ctx sdk.Context, fn func(group types.UserGroup) (stop bool))

IterateUserGroups iterates over all the users groups stored

func (Keeper) IterateUserGroupsMembers

func (k Keeper) IterateUserGroupsMembers(ctx sdk.Context, fn func(entry types.UserGroupMemberEntry) (stop bool))

IterateUserGroupsMembers iterates over all the group member entries and performs the provided function

func (Keeper) IterateUserPermissions

func (k Keeper) IterateUserPermissions(ctx sdk.Context, fn func(entry types.UserPermission) (stop bool))

IterateUserPermissions iterates over all the stored user permissions

func (Keeper) Logger

func (k Keeper) Logger(ctx sdk.Context) log.Logger

Logger returns a module-specific logger

func (Keeper) RemoveUserFromGroup

func (k Keeper) RemoveUserFromGroup(ctx sdk.Context, subspaceID uint64, groupID uint32, user string)

RemoveUserFromGroup removes the specified user from the subspace group having the given id.

func (Keeper) RemoveUserPermissions

func (k Keeper) RemoveUserPermissions(ctx sdk.Context, subspaceID uint64, sectionID uint32, user string)

RemoveUserPermissions removes the permission for the given user inside the provided subspace

func (Keeper) SaveSection

func (k Keeper) SaveSection(ctx sdk.Context, section types.Section)

SaveSection saves the given section inside the current context

func (Keeper) SaveSubspace

func (k Keeper) SaveSubspace(ctx sdk.Context, subspace types.Subspace)

SaveSubspace saves the given subspace inside the current context.

func (Keeper) SaveUserGroup

func (k Keeper) SaveUserGroup(ctx sdk.Context, group types.UserGroup)

SaveUserGroup saves the given user group

func (Keeper) Section

Section implements the Query/Section gRPC method

func (Keeper) Sections

Sections implements the Query/Sections gRPC method

func (*Keeper) SetHooks

func (k *Keeper) SetHooks(sh types.SubspacesHooks) *Keeper

SetHooks allows to set the subspaces hooks

func (Keeper) SetNextGroupID

func (k Keeper) SetNextGroupID(ctx sdk.Context, subspaceID uint64, groupID uint32)

SetNextGroupID sets the new group id for the specific subspace to the store

func (Keeper) SetNextSectionID

func (k Keeper) SetNextSectionID(ctx sdk.Context, subspaceID uint64, sectionID uint32)

SetNextSectionID sets the next section id for the specific subspace

func (Keeper) SetSubspaceID

func (k Keeper) SetSubspaceID(ctx sdk.Context, subspaceID uint64)

SetSubspaceID sets the new subspace id to the store

func (Keeper) SetUserPermissions

func (k Keeper) SetUserPermissions(ctx sdk.Context, subspaceID uint64, sectionID uint32, user string, permissions types.Permissions)

SetUserPermissions sets the given permission for the specific user inside a single subspace

func (Keeper) Subspace

Subspace implements the Query/Subspace gRPC method

func (Keeper) Subspaces

Subspaces implements the Query/Subspaces gRPC method

func (Keeper) UserGroup

UserGroup implements the Query/UserGroup gRPC method

func (Keeper) UserGroupMembers

UserGroupMembers implements the Query/UserGroupMembers gRPC method

func (Keeper) UserGroups

UserGroups implements the Query/UserGroups gRPC method

func (Keeper) UserPermissions

UserPermissions implements the Query/UserPermissions gRPC method

type Migrator

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

Migrator is a struct for handling in-place store migrations.

func NewMigrator

func NewMigrator(keeper Keeper) Migrator

NewMigrator returns a new Migrator

func (Migrator) Migrate1to2

func (m Migrator) Migrate1to2(ctx sdk.Context) error

Migrate1to2 migrates from version 1 to 2.

func (Migrator) Migrate2to3

func (m Migrator) Migrate2to3(ctx sdk.Context) error

Migrate2to3 migrates from version 2 to 3.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL