keeper

package
v1.9.9 Latest Latest
Warning

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

 Go to latest Published: Oct 1, 2024 License: GPL-3.0 Imports: 15 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

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 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,
	memKey sdk.StoreKey,

) *Keeper

NewKeeper creates a new instance of the NFT Keeper

func (Keeper) AddApproval 

func (k Keeper) AddApproval(ctx sdk.Context, denomID, tokenID string, sender sdk.AccAddress, approvedAddress sdk.AccAddress) error

func (Keeper) AddApprovalForAll 

func (k Keeper) AddApprovalForAll(ctx sdk.Context, sender sdk.AccAddress, operatorAddressToBeAdded sdk.AccAddress, approved bool) error

func (Keeper) ApproveNFT 

func (k Keeper) ApproveNFT(ctx sdk.Context, nft types.BaseNFT, approvedAddress sdk.AccAddress, denomID string)

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) CollectionsByDenomIds added in v1.1.1 

func (k Keeper) CollectionsByDenomIds(c context.Context, request *types.QueryCollectionsByIdsRequest) (*types.QueryCollectionByIdsResponse, error)

func (Keeper) Denom 

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

func (Keeper) DenomByName 

func (k Keeper) DenomByName(c context.Context, request *types.QueryDenomByNameRequest) (*types.QueryDenomByNameResponse, error)

func (Keeper) DenomBySymbol 

func (k Keeper) DenomBySymbol(c context.Context, request *types.QueryDenomBySymbolRequest) (*types.QueryDenomBySymbolResponse, 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, sender sdk.AccAddress,
) error

EditNFT updates an already existing NFT

func (Keeper) GetApprovalsNFT 

func (k Keeper) GetApprovalsNFT(c context.Context, request *types.QueryApprovalsNFTRequest) (*types.QueryApprovalsNFTResponse, error)

func (Keeper) GetApprovedAddresses 

func (k Keeper) GetApprovedAddresses(ctx sdk.Context, sender sdk.AccAddress) (*types.ApprovedAddressesData, error)

func (Keeper) GetBaseNFT 

func (k Keeper) GetBaseNFT(ctx sdk.Context, denomID, tokenID string) (nft types.BaseNFT, err error)

GetNFT set a specific NFT in the store from its index

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) GetDenomByName 

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

GetDenom returns the denom by name

func (Keeper) GetDenomBySymbol 

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

GetDenomBySymbol returns the denom by symbol

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 set a specific NFT in the store from its index

func (Keeper) GetNFTApprovedAddresses 

func (k Keeper) GetNFTApprovedAddresses(ctx sdk.Context, denomID, tokenID string) (approvedAddresses []string, err error)

GetNFTApprovedAddresses returns the approved addresses for the 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) GetNftTotalCountForCollection 

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

GetNftTotalCountForCollection returns the count of all minted nfts ( including burned )

func (Keeper) GetOwner 

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

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, err error)

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) HasDenomSymbol 

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

HasDenomSymbol returns whether the specified denom symbol exists

func (Keeper) HasNFT 

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

HasNFT checks if the specified NFT exists

func (Keeper) IncrementTotalCounterForCollection 

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

IncrementTotalCounterForCollection increments the count of all minted nfts for a collection

func (Keeper) IsApprovedAddress added in v0.5.0 

func (k Keeper) IsApprovedAddress(nft *types.BaseNFT, sender string) bool

func (Keeper) IsApprovedOperator 

func (k Keeper) IsApprovedOperator(ctx sdk.Context, owner, operator sdk.AccAddress) bool

func (Keeper) IsDenomCreator 

func (k Keeper) IsDenomCreator(ctx sdk.Context, denomID string, address sdk.AccAddress) (types.Denom, error)

IsDenomCreator checks if address is the creator of Denom Return the Denom if true, an error otherwise

func (Keeper) IsDenomMinter added in v1.1.1 

func (k Keeper) IsDenomMinter(denom types.Denom, address sdk.AccAddress) error

func (Keeper) IsEditable added in v1.1.1 

func (k Keeper) IsEditable(ctx sdk.Context, denomID string) error

func (Keeper) IsOwner 

func (k Keeper) IsOwner(nft types.BaseNFT, owner sdk.AccAddress) bool

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

func (Keeper) IsSoftLocked added in v1.1.1 

func (k Keeper) IsSoftLocked(ctx sdk.Context, denomID, tokenID string) error

func (Keeper) IssueDenom 

func (k Keeper) IssueDenom(ctx sdk.Context, id, name, schema, symbol, traits, minter, description, data 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 string, tokenNm,
	tokenURI, tokenData string, sender, owner sdk.AccAddress,
) (string, error)

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

func (Keeper) MintNFTUnverified 

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

MintNFTUnverified mints an NFT without verifying if the owner is the creator of denom Needed during genesis initialization

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) QueryApprovalsIsApprovedForAll 

func (k Keeper) QueryApprovalsIsApprovedForAll(c context.Context, request *types.QueryApprovalsIsApprovedForAllRequest) (*types.QueryApprovalsIsApprovedForAllResponse, error)

func (Keeper) RevokeApproval 

func (k Keeper) RevokeApproval(ctx sdk.Context, denomID, tokenID string, sender, addressToRevoke sdk.AccAddress) error

func (Keeper) RevokeApprovalNFT 

func (k Keeper) RevokeApprovalNFT(ctx sdk.Context, nft types.BaseNFT, addressToRevoke sdk.AccAddress, denomID string) error

func (Keeper) SetApprovedAddress 

func (k Keeper) SetApprovedAddress(ctx sdk.Context, sender, operator sdk.AccAddress, approved bool)

func (Keeper) SetCollection 

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

SetCollection saves all NFTs and returns an error if there already exists or any one of the owner's bech32 account address is invalid or any NFT's owner is not the creator of denomination

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) SetGenesisCollection 

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

SetGenesisCollection saves all NFTs and returns an error if there already exists or any one of the owner's bech32 account address is invalid

func (Keeper) SoftLockNFT added in v1.1.1 

func (k Keeper) SoftLockNFT(ctx sdk.Context, lockOwner, denomID, tokenID string) error

func (Keeper) SoftUnlockNFT added in v1.1.1 

func (k Keeper) SoftUnlockNFT(ctx sdk.Context, lockOwner, denomID, tokenID string) error

func (Keeper) Supply 

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

func (Keeper) TransferDenomOwner added in v1.1.0 

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) TransferNftInternal added in v1.1.1 

func (k Keeper) TransferNftInternal(ctx sdk.Context, denomID string, tokenID string, from sdk.AccAddress, to sdk.AccAddress, nft types.BaseNFT)

func (Keeper) TransferOwner 

func (k Keeper) TransferOwner(ctx sdk.Context, denomID, tokenID string, from, to, sender sdk.AccAddress) error

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

func (Keeper) UpdateDenom added in v1.1.0 

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

UpdateDenom is responsible for updating the definition of denom

type Migrator added in v1.1.1 

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

func NewMigrator added in v1.1.1 

func NewMigrator(keeper Keeper) Migrator

func (Migrator) Migrate1to2 added in v1.1.1 

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.