Documentation ¶
Index ¶
- func MembershipVerifiedInvariant(k Keeper) sdk.Invariant
- func NewHandler(keeper Keeper, governmentKeeper government.Keeper) sdk.Handler
- func NewQuerier(keeper Keeper) sdk.Querier
- func RegisterInvariants(ir sdk.InvariantRegistry, k Keeper)
- type InviteResponse
- type Keeper
- func (k Keeper) AddTrustedServiceProvider(ctx sdk.Context, tsp sdk.AccAddress)
- func (k Keeper) AssignMembership(ctx sdk.Context, user sdk.AccAddress, membershipType string) sdk.Error
- func (k Keeper) BuyMembership(ctx sdk.Context, buyer sdk.AccAddress, membershipType string) sdk.Error
- func (k Keeper) DepositIntoPool(ctx sdk.Context, depositor sdk.AccAddress, amount sdk.Coins) sdk.Error
- func (k Keeper) DistributeReward(ctx sdk.Context, invite types.Invite) sdk.Error
- func (k Keeper) ExtractMembership(key []byte, value []byte) types.Membership
- func (k Keeper) GetCredentials(ctx sdk.Context) (credentials types.Credentials)
- func (k Keeper) GetInvite(ctx sdk.Context, user sdk.AccAddress) (invite types.Invite, found bool)
- func (k Keeper) GetInvites(ctx sdk.Context) types.Invites
- func (k Keeper) GetMembership(ctx sdk.Context, user sdk.AccAddress) (types.Membership, sdk.Error)
- func (k Keeper) GetMembershipModuleAccount(ctx sdk.Context) exported.ModuleAccountI
- func (k Keeper) GetPoolFunds(ctx sdk.Context) sdk.Coins
- func (k Keeper) GetStableCreditsDenom(ctx sdk.Context) (denom string)
- func (k Keeper) GetTrustedServiceProviders(ctx sdk.Context) (signers ctypes.Addresses)
- func (k Keeper) GetUserCredentials(ctx sdk.Context, user sdk.AccAddress) types.Credentials
- func (k Keeper) InviteUser(ctx sdk.Context, recipient, sender sdk.AccAddress) sdk.Error
- func (k Keeper) InvitesIterator(ctx sdk.Context) sdk.Iterator
- func (k Keeper) IsTrustedServiceProvider(ctx sdk.Context, signer sdk.Address) bool
- func (k Keeper) MembershipIterator(ctx sdk.Context) sdk.Iterator
- func (k Keeper) RemoveMembership(ctx sdk.Context, user sdk.AccAddress) sdk.Error
- func (k Keeper) SaveCredential(ctx sdk.Context, credential types.Credential)
- func (k Keeper) SaveInvite(ctx sdk.Context, invite types.Invite)
- func (k Keeper) SetStableCreditsDenom(ctx sdk.Context, denom string)
- type MembershipResult
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func MembershipVerifiedInvariant ¶ added in v1.4.0
MembershipVerifiedInvariant verifies that all the membership existing in the state have been authorized, and that the users associated with them have been invited by a TSP.
func NewHandler ¶ added in v1.3.0
func NewHandler(keeper Keeper, governmentKeeper government.Keeper) sdk.Handler
NewHandler is essentially a sub-router that directs messages coming into this module to the proper handler.
func NewQuerier ¶
NewQuerier is the module level router for state queries
func RegisterInvariants ¶ added in v1.4.0
func RegisterInvariants(ir sdk.InvariantRegistry, k Keeper)
RegisterInvariants registers all memberships invariants
Types ¶
type InviteResponse ¶ added in v1.3.0
type InviteResponse struct { Recipient sdk.AccAddress `json:"recipient"` Sender sdk.AccAddress `json:"sender"` }
type Keeper ¶
type Keeper struct { Cdc *codec.Codec StoreKey sdk.StoreKey SupplyKeeper supply.Keeper // contains filtered or unexported fields }
func NewKeeper ¶
func NewKeeper(cdc *codec.Codec, storeKey sdk.StoreKey, supplyKeeper supply.Keeper, governmentKeeper government.Keeper, accountKeeper auth.AccountKeeper) Keeper
NewKeeper creates new instances of the accreditation module Keeper
func (Keeper) AddTrustedServiceProvider ¶ added in v1.3.0
func (k Keeper) AddTrustedServiceProvider(ctx sdk.Context, tsp sdk.AccAddress)
AddTrustedServiceProvider allows to add the given signer as a trusted entity that can sign transactions setting an accrediter for a user.
func (Keeper) AssignMembership ¶
func (k Keeper) AssignMembership(ctx sdk.Context, user sdk.AccAddress, membershipType string) sdk.Error
AssignMembership allow to commerciomint and assign a membership of the given membershipType to the specified user. If the user already has a membership assigned, deletes the current one and assigns to it the new one. Returns the URI of the new minted token represented the assigned membership, or an error if something goes w
func (Keeper) BuyMembership ¶ added in v1.3.0
func (k Keeper) BuyMembership(ctx sdk.Context, buyer sdk.AccAddress, membershipType string) sdk.Error
BuyMembership allow to commerciomint and assign a membership of the given membershipType to the specified user. If the user already has a membership assigned, deletes the current one and assigns to it the new one.
func (Keeper) DepositIntoPool ¶ added in v1.3.0
func (k Keeper) DepositIntoPool(ctx sdk.Context, depositor sdk.AccAddress, amount sdk.Coins) sdk.Error
DepositIntoPool allows the depositor to deposit the specified amount inside the rewards pool
func (Keeper) DistributeReward ¶ added in v1.3.0
DistributeReward allows to distribute the rewards to the sender of the specified invite upon the receiver has properly bought a membership of the given membershipType
func (Keeper) ExtractMembership ¶ added in v1.4.0
func (k Keeper) ExtractMembership(key []byte, value []byte) types.Membership
ExtractMembership extracts a Membership struct from key and value retrieved from MembershipIterator
func (Keeper) GetCredentials ¶ added in v1.3.0
func (k Keeper) GetCredentials(ctx sdk.Context) (credentials types.Credentials)
GetCredentials returns the list of all the credentials that have been saved
func (Keeper) GetInvites ¶ added in v1.3.0
GetInvites returns all the invites ever made
func (Keeper) GetMembership ¶
func (k Keeper) GetMembership(ctx sdk.Context, user sdk.AccAddress) (types.Membership, sdk.Error)
GetMembership allows to retrieve any existent membership for the specified user. The second returned false (the boolean one) tells if the NFT token representing the membership was found or not
func (Keeper) GetMembershipModuleAccount ¶ added in v1.3.2
func (k Keeper) GetMembershipModuleAccount(ctx sdk.Context) exported.ModuleAccountI
GetMembershipModuleAccount returns the module account for the accreditations module
func (Keeper) GetPoolFunds ¶ added in v1.3.0
GetPoolFunds returns the funds currently present inside the rewards pool
func (Keeper) GetStableCreditsDenom ¶ added in v1.3.0
GetStableCreditsDenom returns the denom that must be used when referring to stable credits that can be used to purchase a membership
func (Keeper) GetTrustedServiceProviders ¶ added in v1.3.0
GetTrustedServiceProviders returns the list of signers that are allowed to sign transactions setting a specific accrediter for a user. NOTE. Any user which is not present inside the returned list SHOULD NOT be allowed to send a transaction setting an accrediter for another user.
func (Keeper) GetUserCredentials ¶ added in v1.3.0
func (k Keeper) GetUserCredentials(ctx sdk.Context, user sdk.AccAddress) types.Credentials
GetUserCredentials returns the credentials that have been associated to the given user
func (Keeper) InviteUser ¶ added in v1.3.0
InviteUser allows to set a given user as being invited by the given invite sender.
func (Keeper) InvitesIterator ¶ added in v1.5.0
InvitesIterator returns an Iterator which iterates over all the invites.
func (Keeper) IsTrustedServiceProvider ¶ added in v1.3.0
IsTrustedServiceProvider tells if the given signer is a trusted one or not
func (Keeper) MembershipIterator ¶ added in v1.4.0
GetMembershipIterator returns an Iterator for all the memberships stored.
func (Keeper) RemoveMembership ¶
RemoveMembership allows to remove any existing membership associated with the given user.
func (Keeper) SaveCredential ¶ added in v1.3.0
func (k Keeper) SaveCredential(ctx sdk.Context, credential types.Credential)
SaveCredential allows to save the given credential inside the store
func (Keeper) SaveInvite ¶ added in v1.3.0
SaveInvite allows to save the given invite inside the store
type MembershipResult ¶
type MembershipResult struct { User sdk.AccAddress `json:"user"` MembershipType string `json:"membership_type"` }
MembershipResult represents the data returned when a search is performed to know the membership of a given user