package
0.0.0-20230307095339-03ee383c5cd9
Repository: https://github.com/gridiron-zone/huddle.git
Documentation: pkg.go.dev

# Functions

ArePermissionsValid checks whether the given value represents a valid permissions or not.
CheckPermission checks whether the given permissions contain the specified permissions.
No description provided by the author
CombinePermissions combines all the given permissions into a single Permission object using the OR operator.
DefaultGenesisState returns a default GenesisState.
DefaultSection returns the default section for the given subspace.
DefaultUserGroup returns the default user group for the given subspace.
GetAddressBytes returns the given user address as a byte array.
GetAddressFromBytes returns the sdk.AccAddress representation of the given user address.
GetGroupIDBytes returns the byte representation of the groupID.
GetGroupIDFromBytes returns groupID in uint32 format from a byte array.
GetSectionIDBytes returns the byte representation of the sectionID.
GetSectionIDFromBytes returns sectionID in uint32 format from a byte array.
GetSubspaceIDBytes returns the byte representation of the subspaceID.
GetSubspaceIDFromBytes returns subspaceID in uint64 format from a byte array.
GroupMembersPrefix returns the key used to store all the members of the given group inside the given subspace.
GroupMemberStoreKey returns the key used to store the membership of the given user to the specified group inside the provided subspace.
GroupStoreKey returns the key used to store the group having the given id inside the specified section.
NewGenesisState creates a new genesis state.
NewGroupUpdate builds a new SubspaceUpdate instance containing the given data.
NewMsgAddUserToUserGroup creates a new MsgAddUserToUserGroup instance.
No description provided by the author
NewMsgCreateSection returns a new MsgCreateSection instance.
NewMsgCreateSubspace creates a new MsgCreateSubspace instance.
NewMsgCreateUserGroup creates a new MsgCreateUserGroup instance.
NewMsgDeleteSection returns a new MsgDeleteSection instance.
NewMsgDeleteSubspace returns a new MsgDeleteSubspace instance.
NewMsgDeleteUserGroup creates a new MsgDeleteUserGroup instance.
NewMsgEditSection returns a new MsgEditSection instance.
NewMsgEditSubspace creates a new MsgEditSubspace instance.
NewMsgEditUserGroup returns a new NewMsgEditUserGroup instance.
NewMsgMoveSection returns a new MsgMoveSection instance.
NewMsgMoveUserGroup returns a new NewMsgMoveUserGroup instance.
NewMsgRemoveUserFromUserGroup creates a new MsgRemoveUserFromUserGroup instance.
NewMsgSetUserGroupPermissions returns a new MsgSetUserGroupPermissions instance.
NewMsgSetUserPermissions creates a new MsgSetUserPermissions instance.
No description provided by the author
NewPermissionDetailGroup returns a new PermissionDetail for the user with the given id and permission value.
NewPermissionDetailUser returns a new PermissionDetail for the user with the given address and permission value.
NewPermissions allows to build a new Permissions instance.
No description provided by the author
NewQuerySectionRequest returns a new QuerySectionRequest instance.
NewQuerySectionsRequest returns a new QuerySectionsRequest instance.
NewQuerySubspaceRequest returns a new QuerySubspaceRequest instance.
NewQuerySubspacesRequest returns a new QuerySubspacesRequest instance.
NewQueryUserGroupMembersRequest returns a new QueryUserGroupMembersRequest instance.
NewQueryUserGroupRequest returns a new QueryUserGroupRequest instance.
NewQueryUserGroupsRequest returns a new QueryUserGroupsRequest instance.
NewQueryUserPermissionsRequest returns a new QueryPermissionsRequest instance.
NewSection returns a new Section instance.
NewSectionUpdate returns a new SectionUpdate instance.
NewSubspace is a constructor for the Subspace type.
NewSubspaceData returns a new SubspaceData instance.
NewSubspaceUpdate builds a new SubspaceUpdate instance containing the given data.
NewUserGroup returns a new UserGroup instance.
NewUserGroupMemberEntry returns a new UserGroupMemberEntry instance.
NewUserPermission returns a new UserPermission instance.
NextGroupIDStoreKey returns the store key that is used to store the group id to be used next for the given subspace.
NextSectionIDStoreKey returns the key used to store the next section id for the given subspace.
ParseGroupID parses the given value as a group id, returning an error if it's invalid.
ParseSectionID parses the given value as a section id, returning an error if it's invalid.
ParseSubspaceID parses the given value as a subspace id, returning an error if it's invalid.
ParseSubspacesIDs parses the given value as a list of subspace ids separated by a comma.
No description provided by the author
No description provided by the author
No description provided by the author
RegisterPermission registers the permissions with the given name and returns its value.
RegisterQueryHandler registers the http handlers for service Query to "mux".
RegisterQueryHandlerClient registers the http handlers for service Query to "mux".
RegisterQueryHandlerFromEndpoint is same as RegisterQueryHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
RegisterQueryHandlerServer registers the http handlers for service Query to "mux".
No description provided by the author
SanitizePermissions sanitizes the given permissions to remove any duplicate.
SectionGroupsPrefix returns the prefix used to store all the groups for the given section.
SectionPermissionsPrefix returns the prefix used to store the permissions for the given section.
SectionStoreKey returns the key used to store the given section.
SerializePermission serializes the given permissions to a string value.
SplitGroupMemberStoreKey splits the given group member store key into the associated subspace id, group id and user address.
SplitUserAddressPermissionKey splits a UserPermissionStoreKey into the subspace id, section id and user address.
SubspaceGroupsMembersPrefix returns the prefix used to store groups members for the subspace having the given id.
SubspaceGroupsPrefix returns the store prefix used to store all the groups of a given subspace.
SubspacePermissionsPrefix returns the prefix used to store user permissions for the given subspace.
SubspaceSectionsPrefix returns the prefix used to store all the sections for the given subspace.
SubspaceStoreKey returns the key for a specific subspace.
UserPermissionStoreKey returns the key used to store the permission for the given user inside the given subspace.
ValidateGenesis validates the given genesis state and returns an error if something is invalid.

# Constants

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Subspaces module event types.
Subspaces module event types.
Subspaces module event types.
Subspaces module event types.
Subspaces module event types.
Subspaces module event types.
Subspaces module event types.
Subspaces module event types.
No description provided by the author
Subspaces module event types.
Subspaces module event types.
Subspaces module event types.
Subspaces module event types.
Subspaces module event types.
Subspaces module event types.
Subspaces module event types.
Subspaces module event types.
Subspaces module event types.
Subspaces module event types.
Subspaces module event types.
Subspaces module event types.
Subspaces module event types.
Subspaces module event types.
Subspaces module event types.
No description provided by the author
No description provided by the author
RootSectionID represents the id of the root section of each subspace.
No description provided by the author
No description provided by the author

# Variables

AminoCodec references the global x/subspaces module codec.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ErrPermissionDenied is returned if a user cannot perform a specific action inside a subspace.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
PermissionDeleteSubspace allows users to delete the subspace.
PermissionEditSubspace allows to change the information of the subspace.
PermissionEverything allows to do everything.
PermissionManageGroups allows users to manage user groups and members.
PermissionManageSections allows users to manage a subspace sections.
PermissionSetPermissions allows users to set other users' permissions (except PermissionSetPermissions).
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Structs

GenesisState contains the data of the genesis state for the subspaces module.
GroupUpdate contains all the data that can be updated about a group.
MsgAddUserToUserGroup represents the message used to add a user to a user group.
MsgAddUserToUserGroupResponse defines the Msg/AddUserToUserGroupResponse response type.
MsgCreateSection represents the message to be used when creating a subspace section.
MsgCreateSectionResponse represents the Msg/CreateSection response type.
MsgCreateSubspace represents the message used to create a subspace.
MsgCreateSubspaceResponse defines the Msg/CreateSubspace response type.
MsgCreateUserGroup represents the message used to create a user group.
MsgCreateUserGroupResponse defines the Msg/CreateUserGroup response type.
MsgDeleteSection represents the message to be used when deleting a section.
MsgDeleteSectionResponse represents the Msg/DeleteSection response type.
MsgDeleteSubspace represents the message used to delete a subspace.
MsgDeleteSubspaceResponse defines the Msg/DeleteSubspace response type.
MsgDeleteUserGroup represents the message used to delete a user group.
MsgDeleteUserGroupResponse defines the Msg/DeleteUserGroup response type.
MsgEditSection represents the message to be used when editing a subspace section.
MsgEditSectionResponse represents the Msg/EditSection response type.
MsgEditSubspace represents the message used to edit a subspace fields.
MsgEditSubspaceResponse defines the Msg/EditSubspace response type.
MsgEditUserGroup represents the message used to edit a user group.
MsgEditUserGroupResponse defines the Msg/EditUserGroup response type.
MsgMoveSection represents the message to be used when moving a section to another parent.
MsgMoveSectionResponse.
MsgMoveUserGroup represents the message used to move one user group from a section to anoter.
MsgMoveUserGroupResponse defines the Msg/MoveUserGroup response type.
MsgRemoveUserFromUserGroup represents the message used to remove a user from a user group.
MsgRemoveUserFromUserGroupResponse defines the Msg/RemoveUserFromUserGroupResponse response type.
MsgSetUserGroupPermissions represents the message used to set the permissions of a user group.
MsgSetUserGroupPermissionsResponse defines the Msg/SetUserGroupPermissionsResponse response type.
MsgSetUserPermissions represents the message used to set the permissions of a specific user.
MsgSetUserPermissionsResponse defines the Msg/SetPermissionsResponse response type.
PermissionDetail contains the details data of a permission.
Group is a permission that has been set to a user group.
No description provided by the author
User is a permission that has been set to a specific user.
No description provided by the author
QuerySectionRequest is the request type for Query/Section RPC method.
QuerySectionResponse is the response type for Query/Section RPC method.
QuerySectionsRequest is the request type for Query/Sections RPC method.
QuerySectionsResponse is the response type for Query/Sections RPC method.
QuerySubspace is the request type for the Query/Subspace RPC method.
QuerySubspaceResponse is the response type for the Query/Subspace method.
QuerySubspacesRequest is the request type for the Query/Subspaces RPC method.
QuerySubspacesResponse is the response type for the Query/Subspaces RPC method.
QueryUserGroupMembersRequest is the request type for the Query/UserGroupMembers RPC method.
QueryUserGroupMembersResponse is the response type for the Query/UserGroupMembers RPC method.
QueryUserGroupRequest is the request type for the Query/UserGroup RPC method.
QueryUserGroupResponse is the response type for the Query/UserGroup RPC method.
QueryUserGroupsRequest is the request type for the Query/UserGroups RPC method.
QueryUserGroupsResponse is the response type for the Query/UserGroups RPC method.
QueryUserPermissionsRequest is the request type for the Query/UserPermissions RPC method.
QueryUserPermissionsRequest is the response type for the Query/UserPermissions method.
Section contains the data of a single subspace section.
SectionUpdate contains all the data that can be updated about a section.
Subspace contains all the data of a Huddle subspace.
SubspaceData contains the genesis data for a single subspace.
No description provided by the author
No description provided by the author
SubspaceUpdate contains all the data that can be updated about a subspace.
UnimplementedMsgServer can be embedded to have forward compatible implementations.
UnimplementedQueryServer can be embedded to have forward compatible implementations.
UserGroup represents a group of users.
UserGroupMemberEntry contains the details of a user group member.
UserPermission represents a single Access Control List entry.

# Interfaces

MsgClient is the client API for Msg service.
MsgServer is the server API for Msg service.
QueryClient is the client API for Query service.
QueryServer is the server API for Query service.
SubspaceMsg represents a generic message that is related to a subspace.
SubspacesHooks event hooks for subspaces objects (noalias).

# Type aliases

MultiSubspacesHooks combines multiple subspaces hooks, all hook functions are run in array sequence.
Permission represents a permission that can be set to a user or user group.
No description provided by the author