keeper

Documentation

Index

• func NewMsgServerImpl(keeper Keeper) types.MsgServer
• func RegisterInvariants(ir sdk.InvariantRegistry, k Keeper)
• func SupplyInvariant(k Keeper) sdk.Invariant
• type Keeper
  • func NewKeeper(cdc codec.Codec, storeKey storetypes.StoreKey, ak nft.AccountKeeper, ...) Keeper
  • func (k Keeper) Authorize(ctx sdk.Context, denomID, tokenID string, owner sdk.AccAddress) 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, err error)
  • func (k Keeper) GetDenomInfo(ctx sdk.Context, denomID string) (*types.Denom, error)
  • 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, err 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) HasNFT(ctx sdk.Context, denomID, tokenID string) bool
  • func (k Keeper) IssueDenom(ctx sdk.Context, id, name, schema, symbol string, creator sdk.AccAddress, ...) error
  • func (k Keeper) MintNFT(ctx sdk.Context, denomID string, tokenID string, tokenNm string, ...) error
  • func (k Keeper) NFT(c context.Context, request *types.QueryNFTRequest) (*types.QueryNFTResponse, error)
  • func (k Keeper) NFTsOfOwner(c context.Context, request *types.QueryNFTsOfOwnerRequest) (*types.QueryNFTsOfOwnerResponse, error)
  • func (k Keeper) SetCollection(ctx sdk.Context, collection types.Collection) error
  • func (k Keeper) Supply(c context.Context, request *types.QuerySupplyRequest) (*types.QuerySupplyResponse, error)
  • func (k Keeper) TransferDenomOwner(ctx sdk.Context, denomID string, srcOwner, dstOwner sdk.AccAddress) error
  • func (k Keeper) TransferOwnership(ctx sdk.Context, denomID, tokenID, tokenNm, tokenURI, tokenData string, ...) error

Functions

func NewMsgServerImpl

func NewMsgServerImpl(keeper Keeper) types.MsgServer

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

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.Codec,
	storeKey storetypes.StoreKey,
	ak nft.AccountKeeper,
	bk nft.BankKeeper,
) 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) 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, err error)

GetCollections returns all the collections

func (Keeper) GetDenomInfo

func (k Keeper) GetDenomInfo(ctx sdk.Context, denomID string) (*types.Denom, error)

func (Keeper) GetNFT

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

GetNFT gets the specified NFT

func (Keeper) GetNFTs

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

GetNFTs returns all NFTs 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) 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, symbol string,
	creator sdk.AccAddress,
	mintRestricted, updateRestricted bool,
) error

IssueDenom issues a denom according to the given params

func (Keeper) MintNFT

func (k Keeper) MintNFT(
	ctx sdk.Context,
	denomID string,
	tokenID string,
	tokenNm string,
	tokenURI string,
	tokenData string,
	sender sdk.AccAddress,
	receiver 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) NFTsOfOwner

func (k Keeper) NFTsOfOwner(c context.Context, request *types.QueryNFTsOfOwnerRequest) (*types.QueryNFTsOfOwnerResponse, 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) Supply

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

func (Keeper) TransferDenomOwner

func (k Keeper) TransferDenomOwner(
	ctx sdk.Context, denomID string, srcOwner, dstOwner sdk.AccAddress,
) error

TransferDenomOwner transfers the ownership of the given denom to the new owner

func (Keeper) TransferOwnership

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

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