Package Info
Namespace: nt
Path: /p/nt/grc721/royalty/v0
Type: pure
Gno: 0.9
Creator: g1edq4…leuc8p
Block: 0
Code stats
Files: 4
.gno files: 3
Tests: 1
Funcs: 18 (1 exported)
Types: 3
Consts: 3
Vars: 1
Imports: 6

Metadata

published
public
Documented
Tests

Package Index

v0 source pure

Package royalty is a stackable GRC721 extension implementing EIP-2981 in basis points. Writes are issuer-only so a ho...

Package royalty is a stackable GRC721 extension implementing EIP-2981 in basis points. Writes are issuer-only so a holder cannot zero out a royalty on a token they just received.

1const FeeDenominator = 10000

source

FeeDenominator is the EIP-2981 basis-point denominator: bps/10000, 10000 == 100%.

1const Kind = "royalty"

source

1const RoyaltyUpdateEvent = "RoyaltyUpdate"

source

1var (
2	ErrInvalidReceiver  = errors.New("invalid royalty receiver")
3	ErrInvalidBps       = errors.New("royalty bps out of range")
4	ErrTokenNotMinted   = errors.New("token is not minted")
5	ErrMaxBpsRange      = errors.New("maxBps out of range (0..10000)")
6	ErrInvalidSalePrice = errors.New("invalid sale price (negative or would overflow)")
7)

source

1func NewRoyalty(coreLedger *grc721.PrivateLedger, maxBps int64) (*Royalty, *Ledger)

source

NewRoyalty attaches a royalty extension; maxBps caps every rate and must be 0..10000.

1type Ledger struct {
2	core *grc721.Token
3	st   *storage
4}

source

1func (led *Ledger) DeleteDefaultRoyalty()

source

1func (led *Ledger) DeleteTokenRoyalty(tid grc721.TokenID)

source

DeleteTokenRoyalty clears the per-token override, falling back to the default.

1func (led *Ledger) ExtensionKind() string

source

1func (led *Ledger) OnBurn(tid grc721.TokenID)

source

OnBurn clears the per-token override (cannot resurface on re-mint) but keeps the default, which is collection-level policy, not per-token state.

1func (led *Ledger) OnMint(to address, tid grc721.TokenID)

source

1func (led *Ledger) OnTransfer(from, to address, tid grc721.TokenID)

source

1func (led *Ledger) SetDefaultRoyalty(receiver address, bps int64) error

source

SetDefaultRoyalty sets the collection default for tokens without an override; issuer-only.

1func (led *Ledger) SetTokenRoyalty(tid grc721.TokenID, receiver address, bps int64) error

source

SetTokenRoyalty sets a per-token override for tid; issuer-only.

1type Royalty struct {
2	core *grc721.Token
3	st   *storage
4}

source

1func (r *Royalty) DefaultRoyalty() (RoyaltyInfo, bool)

source

1func (r *Royalty) ExtensionKind() string

source

1func (r *Royalty) MaxBps() int64

source

1func (r *Royalty) RoyaltyInfo(tid grc721.TokenID, salePrice int64) (address, int64, error)

source

RoyaltyInfo implements EIP-2981; per-token override takes precedence over the default, and no royalty returns (zeroAddress, 0) — the "no royalty" signal.

1func (r *Royalty) TokenID() string

source

1func (r *Royalty) TokenRoyalty(tid grc721.TokenID) (RoyaltyInfo, bool)

source

1type RoyaltyInfo struct {
2	Receiver address
3	Bps      int64
4}

source

RoyaltyInfo is a royalty policy: send Bps/10000 of a sale to Receiver.

chain stdlib
errors stdlib
gno.land/p/nt/avl/v0 package
gno.land/p/nt/grc721/v0 package
math stdlib
strconv stdlib

v0 source pure

Overview

Constants 3

const FeeDenominator

const Kind

const RoyaltyUpdateEvent

Variables 1

var ErrInvalidReceiver, ErrInvalidBps, ErrTokenNotMinted, ErrMaxBpsRange, ErrInvalidSalePrice

Functions 1

func NewRoyalty

Types 3

type Ledger

func DeleteDefaultRoyalty

func DeleteTokenRoyalty

func ExtensionKind

func OnBurn

func OnMint

func OnTransfer

func SetDefaultRoyalty

func SetTokenRoyalty

type Royalty

func DefaultRoyalty

func ExtensionKind

func MaxBps

func RoyaltyInfo

func TokenID

func TokenRoyalty

type RoyaltyInfo

Imports 6

Source Files 4

Overview

Constants 3

Variables 1

Functions 1

Types 3

Methods on Ledger

Methods on Royalty

Imports 6

Source Files 4