fat1

Documentation

Index

• Constants
• Variables
• type AddressNFTokensMap
  • func (m AddressNFTokensMap) AllNFTokens() (NFTokens, error)
  • func (m AddressNFTokensMap) MarshalJSON() ([]byte, error)
  • func (m AddressNFTokensMap) Owner(tknID NFTokenID) factom.FAAddress
  • func (m AddressNFTokensMap) Sum() uint64
  • func (m *AddressNFTokensMap) UnmarshalJSON(data []byte) error
• type NFTokenID
• type NFTokenIDMetadataMap
  • func (m NFTokenIDMetadataMap) MarshalJSON() ([]byte, error)
  • func (m *NFTokenIDMetadataMap) UnmarshalJSON(data []byte) error
• type NFTokens
  • func (tkns NFTokens) ContainsAll(tknsSub NFTokens) error
  • func (tkns NFTokens) MarshalJSON() ([]byte, error)
  • func (tkns NFTokens) Slice() []NFTokenID
  • func (tkns NFTokens) String() string
  • func (tkns *NFTokens) UnmarshalJSON(data []byte) error
  • func (tkns *NFTokens) UnmarshalText(text []byte) error
• type Transaction
  • func NewTransaction(e factom.Entry, idKey *factom.Bytes32) (Transaction, error)
  • func (t Transaction) IsCoinbase() bool
  • func (t Transaction) Sign(signingSet ...factom.RCDSigner) (factom.Entry, error)
  • func (t Transaction) String() string
  • func (t *Transaction) UnmarshalJSON(data []byte) error

Constants

const MaxCapacity = 4e5

const Type = fat.TypeFAT1

Variables

var ErrorCapacity = fmt.Errorf("NFTokenID max capacity (%v) exceeded", maxCapacity)

Types

type AddressNFTokensMap

type AddressNFTokensMap map[factom.FAAddress]NFTokens

AddressTokenMap relates the RCDHash of an address to its NFTokenIDs.

func (AddressNFTokensMap) AllNFTokens

func (m AddressNFTokensMap) AllNFTokens() (NFTokens, error)

func (AddressNFTokensMap) MarshalJSON

func (m AddressNFTokensMap) MarshalJSON() ([]byte, error)

func (AddressNFTokensMap) Owner

func (m AddressNFTokensMap) Owner(tknID NFTokenID) factom.FAAddress

func (AddressNFTokensMap) Sum

func (m AddressNFTokensMap) Sum() uint64

func (*AddressNFTokensMap) UnmarshalJSON

func (m *AddressNFTokensMap) UnmarshalJSON(data []byte) error

type NFTokenID

type NFTokenID uint64

NFTokenID is a Non-Fungible Token ID.

type NFTokenIDMetadataMap

type NFTokenIDMetadataMap map[NFTokenID]json.RawMessage

func (NFTokenIDMetadataMap) MarshalJSON

func (m NFTokenIDMetadataMap) MarshalJSON() ([]byte, error)

func (*NFTokenIDMetadataMap) UnmarshalJSON

func (m *NFTokenIDMetadataMap) UnmarshalJSON(data []byte) error

type NFTokens

type NFTokens map[NFTokenID]struct{}

NFTokens are a set of unique NFTokenIDs. A map[NFTokenID]struct{} is used to guarantee uniqueness of NFTokenIDs.

func (NFTokens) ContainsAll

func (tkns NFTokens) ContainsAll(tknsSub NFTokens) error

func (NFTokens) MarshalJSON

func (tkns NFTokens) MarshalJSON() ([]byte, error)

func (NFTokens) Slice

func (tkns NFTokens) Slice() []NFTokenID

Slice returns a sorted slice of tkns' NFTokenIDs.

func (NFTokens) String

func (tkns NFTokens) String() string

func (*NFTokens) UnmarshalJSON

func (tkns *NFTokens) UnmarshalJSON(data []byte) error

func (*NFTokens) UnmarshalText

func (tkns *NFTokens) UnmarshalText(text []byte) error

type Transaction

type Transaction struct {
	Inputs  AddressNFTokensMap `json:"inputs"`
	Outputs AddressNFTokensMap `json:"outputs"`

	TokenMetadata NFTokenIDMetadataMap `json:"tokenmetadata,omitempty"`
	Metadata      json.RawMessage      `json:"metadata,omitempty"`

	Entry factom.Entry `json:"-"`
}

Transaction represents a fat1 transaction, which can be a normal account transaction or a coinbase transaction depending on the Inputs and the RCD/signature pair.

func NewTransaction

func NewTransaction(e factom.Entry, idKey *factom.Bytes32) (Transaction, error)

func (Transaction) IsCoinbase

func (t Transaction) IsCoinbase() bool

func (Transaction) Sign

func (t Transaction) Sign(signingSet ...factom.RCDSigner) (factom.Entry, error)

func (Transaction) String

func (t Transaction) String() string

func (*Transaction) UnmarshalJSON

func (t *Transaction) UnmarshalJSON(data []byte) error