github.com/gnolang/gno@v0.0.0-20240520182011-228e9d0192ce/examples/gno.land/p/demo/grc/grc777/igrc777.gno

package grc777

import (
	"std"

	"gno.land/p/demo/grc/exts"
)

// TODO: use big.Int or a custom uint64 instead of uint64

type IGRC777 interface {
	exts.TokenMetadata

	// Returns the smallest part of the token that is not divisible. This
	// means all token operations (creation, movement and destruction) must
	// have amounts that are a multiple of this number.
	//
	// For most token contracts, this value will equal 1.
	Granularity() (granularity uint64)

	// Returns the amount of tokens in existence.
	TotalSupply() (supply uint64)

	// Returns the amount of tokens owned by an account (`owner`).
	BalanceOf(address std.Address) uint64

	// Moves `amount` tokens from the caller's account to `recipient`.
	//
	// If send or receive hooks are registered for the caller and `recipient`,
	// the corresponding functions will be called with `data` and empty
	// `operatorData`. See {IERC777Sender} and {IERC777Recipient}.
	//
	// Emits a {Sent} event.
	//
	// Requirements
	//
	// - the caller must have at least `amount` tokens.
	// - `recipient` cannot be the zero address.
	// - if `recipient` is a contract, it must implement the {IERC777Recipient}
	// interface.
	Send(recipient std.Address, amount uint64, data []byte)

	// Destroys `amount` tokens from the caller's account, reducing the
	// total supply.
	//
	// If a send hook is registered for the caller, the corresponding function
	// will be called with `data` and empty `operatorData`. See {IERC777Sender}.
	//
	// Emits a {Burned} event.
	//
	// Requirements
	//
	// - the caller must have at least `amount` tokens.
	Burn(amount uint64, data []byte)

	// Returns true if an account is an operator of `tokenHolder`.
	// Operators can send and burn tokens on behalf of their owners. All
	// accounts are their own operator.
	//
	// See {operatorSend} and {operatorBurn}.
	IsOperatorFor(operator, tokenHolder std.Address) bool

	// Make an account an operator of the caller.
	//
	// See {isOperatorFor}.
	//
	// Emits an {AuthorizedOperator} event.
	//
	// Requirements
	//
	// - `operator` cannot be calling address.
	AuthorizeOperator(operator std.Address)

	// Revoke an account's operator status for the caller.
	//
	// See {isOperatorFor} and {defaultOperators}.
	//
	// Emits a {RevokedOperator} event.
	//
	// Requirements
	//
	// - `operator` cannot be calling address.
	RevokeOperator(operators std.Address)

	// Returns the list of default operators. These accounts are operators
	// for all token holders, even if {authorizeOperator} was never called on
	// them.
	//
	// This list is immutable, but individual holders may revoke these via
	// {revokeOperator}, in which case {isOperatorFor} will return false.
	DefaultOperators() []std.Address

	// Moves `amount` tokens from `sender` to `recipient`. The caller must
	// be an operator of `sender`.
	//
	// If send or receive hooks are registered for `sender` and `recipient`,
	// the corresponding functions will be called with `data` and
	// `operatorData`. See {IERC777Sender} and {IERC777Recipient}.
	//
	// Emits a {Sent} event.
	//
	// Requirements
	//
	// - `sender` cannot be the zero address.
	// - `sender` must have at least `amount` tokens.
	// - the caller must be an operator for `sender`.
	// - `recipient` cannot be the zero address.
	// - if `recipient` is a contract, it must implement the {IERC777Recipient}
	// interface.
	OperatorSend(sender, recipient std.Address, amount uint64, data, operatorData []byte)

	// Destroys `amount` tokens from `account`, reducing the total supply.
	// The caller must be an operator of `account`.
	//
	// If a send hook is registered for `account`, the corresponding function
	// will be called with `data` and `operatorData`. See {IERC777Sender}.
	//
	// Emits a {Burned} event.
	//
	// Requirements
	//
	// - `account` cannot be the zero address.
	// - `account` must have at least `amount` tokens.
	// - the caller must be an operator for `account`.
	OperatorBurn(account std.Address, amount uint64, data, operatorData []byte)
}

// Emitted when `amount` tokens are created by `operator` and assigned to `to`.
//
// Note that some additional user `data` and `operatorData` can be logged in the event.
type MintedEvent struct {
	Operator     std.Address
	To           std.Address
	Amount       uint64
	Data         []byte
	OperatorData []byte
}

// Emitted when `operator` destroys `amount` tokens from `account`.
//
// Note that some additional user `data` and `operatorData` can be logged in the event.
type BurnedEvent struct {
	Operator     std.Address
	From         std.Address
	Amount       uint64
	Data         []byte
	OperatorData []byte
}

// Emitted when `operator` is made operator for `tokenHolder`
type AuthorizedOperatorEvent struct {
	Operator    std.Address
	TokenHolder std.Address
}

// Emitted when `operator` is revoked its operator status for `tokenHolder`.
type RevokedOperatorEvent struct {
	Operator    std.Address
	TokenHolder std.Address
}

type SentEvent struct {
	Operator     std.Address
	From         std.Address
	To           std.Address
	Amount       uint64
	Data         []byte
	OperatorData []byte
}