keeper

Documentation

Index

• func AllInvariants(k Keeper) sdk.Invariant
• func NewMsgServerImpl(keeper Keeper) types.MsgServer
• func NewQuerier(k Keeper, legacyQuerierCdc *codec.LegacyAmino) sdk.Querier
• func RegisterInvariants(ir sdk.InvariantRegistry, k Keeper)
• func SupplyInvariant(k Keeper) sdk.Invariant
• type Keeper
  • func NewKeeper(cdc codec.Marshaler, storeKey sdk.StoreKey) Keeper
  • func (k Keeper) Authorize(ctx sdk.Context, denomID, tokenID string, owner sdk.AccAddress) (types.BaseNFT, error)
  • func (k Keeper) BurnNFT(ctx sdk.Context, denomID, tokenID string, owner sdk.AccAddress) error
  • func (k Keeper) Collection(c context.Context, request *types.QueryCollectionRequest) (*types.QueryCollectionResponse, error)
  • func (k Keeper) Denom(c context.Context, request *types.QueryDenomRequest) (*types.QueryDenomResponse, error)
  • func (k Keeper) Denoms(c context.Context, req *types.QueryDenomsRequest) (*types.QueryDenomsResponse, error)
  • func (k Keeper) EditNFT(ctx sdk.Context, denomID, tokenID, tokenNm, tokenURI, tokenData string, ...) error
  • func (k Keeper) GetCollection(ctx sdk.Context, denomID string) (types.Collection, error)
  • func (k Keeper) GetCollections(ctx sdk.Context) (cs []types.Collection)
  • func (k Keeper) GetDenom(ctx sdk.Context, id string) (denom types.Denom, err error)
  • func (k Keeper) GetDenoms(ctx sdk.Context) (denoms []types.Denom)
  • func (k Keeper) GetNFT(ctx sdk.Context, denomID, tokenID string) (nft exported.NFT, err error)
  • func (k Keeper) GetNFTs(ctx sdk.Context, denom string) (nfts []exported.NFT)
  • func (k Keeper) GetOwner(ctx sdk.Context, address sdk.AccAddress, denom string) types.Owner
  • func (k Keeper) GetOwners(ctx sdk.Context) (owners types.Owners)
  • func (k Keeper) GetPaginateCollection(ctx sdk.Context, request *types.QueryCollectionRequest, denomID string) (types.Collection, *query.PageResponse, error)
  • func (k Keeper) GetTotalSupply(ctx sdk.Context, denomID string) uint64
  • func (k Keeper) GetTotalSupplyOfOwner(ctx sdk.Context, id string, owner sdk.AccAddress) (supply uint64)
  • func (k Keeper) HasDenomID(ctx sdk.Context, id string) bool
  • func (k Keeper) HasDenomNm(ctx sdk.Context, name string) bool
  • func (k Keeper) HasNFT(ctx sdk.Context, denomID, tokenID string) bool
  • func (k Keeper) IssueDenom(ctx sdk.Context, id, name, schema string, creator sdk.AccAddress) error
  • func (k Keeper) Logger(ctx sdk.Context) log.Logger
  • func (k Keeper) MintNFT(ctx sdk.Context, denomID, tokenID, tokenNm, tokenURI, tokenData string, ...) error
  • func (k Keeper) NFT(c context.Context, request *types.QueryNFTRequest) (*types.QueryNFTResponse, error)
  • func (k Keeper) Owner(c context.Context, request *types.QueryOwnerRequest) (*types.QueryOwnerResponse, error)
  • func (k Keeper) SetCollection(ctx sdk.Context, collection types.Collection) error
  • func (k Keeper) SetDenom(ctx sdk.Context, denom types.Denom) error
  • func (k Keeper) Supply(c context.Context, request *types.QuerySupplyRequest) (*types.QuerySupplyResponse, error)
  • func (k Keeper) TransferOwner(ctx sdk.Context, denomID, tokenID, tokenNm, tokenURI, tokenData string, ...) error

Functions

func AllInvariants

func AllInvariants(k Keeper) sdk.Invariant

AllInvariants runs all invariants of the NFT module.

func NewMsgServerImpl

func NewMsgServerImpl(keeper Keeper) types.MsgServer

NewMsgServerImpl returns an implementation of the NFT MsgServer interface for the provided Keeper.

func NewQuerier

func NewQuerier(k Keeper, legacyQuerierCdc *codec.LegacyAmino) sdk.Querier

NewQuerier is the module level router for state queries

func RegisterInvariants

func RegisterInvariants(ir sdk.InvariantRegistry, k Keeper)

RegisterInvariants registers all supply invariants

func SupplyInvariant

func SupplyInvariant(k Keeper) sdk.Invariant

SupplyInvariant checks that the total amount of NFTs on collections matches the total amount owned by addresses

Types

type Keeper

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

Keeper maintains the link to data storage and exposes getter/setter methods for the various parts of the state machine

func NewKeeper

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

NewKeeper creates a new instance of the NFT Keeper

func (Keeper) Authorize

func (k Keeper) Authorize(ctx sdk.Context, denomID, tokenID string, owner sdk.AccAddress) (types.BaseNFT, error)

Authorize checks if the sender is the owner of the given NFT Return the NFT if true, an error otherwise

func (Keeper) BurnNFT

func (k Keeper) BurnNFT(ctx sdk.Context, denomID, tokenID string, owner sdk.AccAddress) error

BurnNFT deletes a specified NFT

func (Keeper) Collection

func (k Keeper) Collection(c context.Context, request *types.QueryCollectionRequest) (*types.QueryCollectionResponse, error)

func (Keeper) Denom

func (k Keeper) Denom(c context.Context, request *types.QueryDenomRequest) (*types.QueryDenomResponse, error)

func (Keeper) Denoms

func (k Keeper) Denoms(c context.Context, req *types.QueryDenomsRequest) (*types.QueryDenomsResponse, error)

func (Keeper) EditNFT

func (k Keeper) EditNFT(
	ctx sdk.Context, denomID, tokenID, tokenNm,
	tokenURI, tokenData string, owner sdk.AccAddress,
) error

EditNFT updates an already existing NFT

func (Keeper) GetCollection

func (k Keeper) GetCollection(ctx sdk.Context, denomID string) (types.Collection, error)

GetCollection returns the collection by the specified denom ID

func (Keeper) GetCollections

func (k Keeper) GetCollections(ctx sdk.Context) (cs []types.Collection)

GetCollections returns all the collections

func (Keeper) GetDenom

func (k Keeper) GetDenom(ctx sdk.Context, id string) (denom types.Denom, err error)

GetDenom returns the denom by id

func (Keeper) GetDenoms

func (k Keeper) GetDenoms(ctx sdk.Context) (denoms []types.Denom)

GetDenoms returns all the denoms

func (Keeper) GetNFT

func (k Keeper) GetNFT(ctx sdk.Context, denomID, tokenID string) (nft exported.NFT, err error)

GetNFT gets the the specified NFT

func (Keeper) GetNFTs

func (k Keeper) GetNFTs(ctx sdk.Context, denom string) (nfts []exported.NFT)

GetNFTs returns all NFTs by the specified denom ID

func (Keeper) GetOwner

func (k Keeper) GetOwner(ctx sdk.Context, address sdk.AccAddress, denom string) types.Owner

GetOwner gets all the ID collections owned by an address and denom ID

func (Keeper) GetOwners

func (k Keeper) GetOwners(ctx sdk.Context) (owners types.Owners)

GetOwners gets all the ID collections

func (Keeper) GetPaginateCollection

func (k Keeper) GetPaginateCollection(ctx sdk.Context, request *types.QueryCollectionRequest, denomID string) (types.Collection, *query.PageResponse, error)

GetPaginateCollection returns the collection by the specified denom ID

func (Keeper) GetTotalSupply

func (k Keeper) GetTotalSupply(ctx sdk.Context, denomID string) uint64

GetTotalSupply returns the number of NFTs by the specified denom ID

func (Keeper) GetTotalSupplyOfOwner

func (k Keeper) GetTotalSupplyOfOwner(ctx sdk.Context, id string, owner sdk.AccAddress) (supply uint64)

GetTotalSupplyOfOwner returns the amount of NFTs by the specified conditions

func (Keeper) HasDenomID

func (k Keeper) HasDenomID(ctx sdk.Context, id string) bool

HasDenomID returns whether the specified denom ID exists

func (Keeper) HasDenomNm

func (k Keeper) HasDenomNm(ctx sdk.Context, name string) bool

HasDenomNm returns whether the specified denom name exists

func (Keeper) HasNFT

func (k Keeper) HasNFT(ctx sdk.Context, denomID, tokenID string) bool

HasNFT checks if the specified NFT exists

func (Keeper) IssueDenom

func (k Keeper) IssueDenom(ctx sdk.Context,
	id, name, schema string,
	creator sdk.AccAddress) error

IssueDenom issues a denom according to the given params

func (Keeper) Logger

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

Logger returns a module-specific logger.

func (Keeper) MintNFT

func (k Keeper) MintNFT(
	ctx sdk.Context, denomID, tokenID, tokenNm,
	tokenURI, tokenData string, owner sdk.AccAddress,
) error

MintNFT mints an NFT and manages the NFT's existence within Collections and Owners

func (Keeper) NFT

func (k Keeper) NFT(c context.Context, request *types.QueryNFTRequest) (*types.QueryNFTResponse, error)

func (Keeper) Owner

func (k Keeper) Owner(c context.Context, request *types.QueryOwnerRequest) (*types.QueryOwnerResponse, error)

func (Keeper) SetCollection

func (k Keeper) SetCollection(ctx sdk.Context, collection types.Collection) error

SetCollection saves all NFTs and returns an error if there already exists

func (Keeper) SetDenom

func (k Keeper) SetDenom(ctx sdk.Context, denom types.Denom) error

SetDenom is responsible for saving the definition of denom

func (Keeper) Supply

func (k Keeper) Supply(c context.Context, request *types.QuerySupplyRequest) (*types.QuerySupplyResponse, error)

func (Keeper) TransferOwner

func (k Keeper) TransferOwner(
	ctx sdk.Context, denomID, tokenID, tokenNm, tokenURI,
	tokenData string, srcOwner, dstOwner sdk.AccAddress,
) error

TransferOwner transfers the ownership of the given NFT to the new owner