grc721v2 source pure

1const (
2	MintEvent           = "Mint"
3	BurnEvent           = "Burn"
4	TransferEvent       = "Transfer"
5	ApprovalEvent       = "Approval"
6	ApprovalForAllEvent = "ApprovalForAll"
7	TokenURIUpdateEvent = "TokenUriUpdate"
8	MetadataUpdateEvent = "MetadataUpdate"
9)

1const (
2	MaxNameLen   = 64
3	MaxSymbolLen = 11
4)

 1var (
 2	ErrInvalidTokenId              = errors.New("invalid token id")
 3	ErrInvalidAddress              = errors.New("invalid address")
 4	ErrTokenIdNotHasApproved       = errors.New("token id not approved for anyone")
 5	ErrApprovalToCurrentOwner      = errors.New("approval to current owner")
 6	ErrCallerIsNotOwner            = errors.New("caller is not token owner")
 7	ErrCallerNotApprovedForAll     = errors.New("caller is not approved for all")
 8	ErrCannotTransferToSelf        = errors.New("cannot send transfer to self")
 9	ErrTransferFromIncorrectOwner  = errors.New("transfer from incorrect owner")
10	ErrTransferToNonGRC721Receiver = errors.New("transfer to non GRC721Receiver implementer")
11	ErrCallerIsNotOwnerOrApproved  = errors.New("caller is not token owner or approved")
12	ErrTokenIdAlreadyExists        = errors.New("token id already exists")
13
14	ErrNotRealm      = errors.New("rlm must be a realm (got EOA/origin)")
15	ErrInvalidName   = errors.New("invalid token name (empty, too long, or contains control chars)")
16	ErrInvalidSymbol = errors.New("invalid token symbol (empty, too long, or contains chars outside [A-Za-z0-9_-])")
17)

1func NewBasicNFT(_ int, _ realm, name, symbol string) *BasicNFT

1func NewNFTWithMetadata(_ int, rlm realm, name, symbol string) *MetadataNFT

 1type BasicNFT struct {
 2	name              string
 3	symbol            string
 4	origRealm         string   // owning realm's package path
 5	owners            avl.Tree // tokenId -> OwnerAddress
 6	balances          avl.Tree // OwnerAddress -> TokenCount
 7	tokenApprovals    avl.Tree // TokenId -> ApprovedAddress
 8	tokenURIs         avl.Tree // TokenId -> URIs
 9	operatorApprovals avl.Tree // "OwnerAddress:OperatorAddress" -> bool
10}

1type IGRC721CollectionMetadata interface {
2	Name() string   // Name returns the name of the collection.
3	Symbol() string // Symbol returns the symbol of the collection.
4}

1type IGRC721Metadata interface {
2	IGRC721CollectionMetadata
3	TokenURI(tid TokenID) (string, error) // TokenURI returns the URI of a specific token.
4}

1type IGRC721MetadataOnchain interface {
2	IGRC721CollectionMetadata
3	TokenMetadata(tid TokenID) (Metadata, error)
4}

1type IGRC721Reader interface {
2	Name() string
3	Symbol() string
4	TokenCount() int64
5	BalanceOf(owner address) (int64, error)
6	OwnerOf(tid TokenID) (address, error)
7	GetApproved(tid TokenID) (address, error)
8	IsApprovedForAll(owner, operator address) bool
9}

 1type Metadata struct {
 2	Image           string  // URL, IPFS/Arweave path, or (commonly here) a data: URI holding the image itself.
 3	ImageData       string  // Raw SVG image data, if generating images on the fly. Only used if Image is empty.
 4	ExternalURL     string  // URL shown alongside the asset on marketplaces, linking back to the collection's own site.
 5	Description     string  // Human-readable description of the item. Markdown is supported.
 6	Name            string  // Name of the item.
 7	Attributes      []Trait // Attributes for the item, shown on marketplace pages for the item.
 8	BackgroundColor string  // Background color of the item on marketplaces. Six-character hex, no leading #.
 9	AnimationURL    string  // URL/data URI to a multimedia attachment for the item.
10	YoutubeURL      string  // URL to a YouTube video (only used if AnimationURL is not provided).
11}

1type MetadataNFT struct {
2	*BasicNFT
3	extensions *avl.Tree // AVL tree for storing metadata extensions
4}

1type NFTGetter func() IGRC721Reader

1type TokenID string

1type TokenURI string

1type Trait struct {
2	DisplayType string
3	TraitType   string
4	Value       string
5}