v0 source pure

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

1const (
2	// NewToken announces every token creation; see NewToken for why it is a
3	// complete provenance signal.
4	NewTokenEvent = "NewToken"
5	// Mint emits from empty addr; burn emits to empty addr (EIP-721).
6	TransferEvent       = "Transfer"
7	ApprovalEvent       = "Approval"
8	ApprovalForAllEvent = "ApprovalForAll"
9)

 1var (
 2	ErrInvalidTokenId             = errors.New("invalid token id")
 3	ErrInvalidAddress             = errors.New("invalid address")
 4	ErrTokenIdNotApproved         = 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	ErrCannotTransferToSelf       = errors.New("cannot send transfer to self")
 8	ErrTransferFromIncorrectOwner = errors.New("transfer from incorrect owner")
 9	ErrCallerIsNotOwnerOrApproved = errors.New("caller is not token owner or approved")
10	ErrTokenIdAlreadyExists       = errors.New("token id already exists")
11	ErrReadonly                   = errors.New("teller is readonly")
12	ErrSpoofedRealm               = errors.New("rlm does not match the current crossing frame")
13	ErrForeignCallerTeller        = errors.New("frame-relative teller used outside the token's realm")
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 IsCanonicalTeller(t Teller) bool

1func NewToken(name, symbol string, id seqid.ID, rlm realm) (*Token, *PrivateLedger)

1type Extension interface {
2	ExtensionKind() string // unique; duplicates rejected at register
3	OnMint(to address, tid TokenID)
4	OnTransfer(from, to address, tid TokenID)
5	OnBurn(tid TokenID)
6}

1type ExtensionView interface {
2	ExtensionKind() string
3	TokenID() string // core Token.ID
4}

1type PrivateLedger struct {
2	token             *Token
3	totalSupply       int64
4	owners            avl.Tree // TokenID -> owner address
5	balances          avl.Tree // owner address -> int64
6	tokenApprovals    avl.Tree // TokenID -> approved address
7	operatorApprovals avl.Tree // "owner:operator" -> bool
8	extensions        []Extension
9}

 1type Teller interface {
 2	GetName() string
 3	GetSymbol() string
 4	ID() string
 5	TotalSupply() int64
 6	BalanceOf(owner address) (int64, error)
 7	OwnerOf(tid TokenID) (address, error)
 8	GetApproved(tid TokenID) (address, error)
 9	IsApprovedForAll(owner, operator address) bool
10
11	Approve(_ int, rlm realm, to address, tid TokenID) error
12	SetApprovalForAll(_ int, rlm realm, operator address, approved bool) error
13	TransferFrom(_ int, rlm realm, from, to address, tid TokenID) error
14}

1type Token struct {
2	id     string // origRealm + "." + symbol + "." + id
3	name   string
4	symbol string
5	ledger *PrivateLedger
6	// origRealm is the PkgPath of the realm that created the token, captured
7	// unforgeably in NewToken. A frame-relative teller only works there.
8	origRealm string
9}

1type TokenID string