indexer

type Asset struct {
	// asset id
	ID uint64 `json:"id" db:"id,omitempty"`
	// collection id associated to this asset
	CollectionID uint64 `json:"collectionId" db:"collection_id"`
	// token id associated to this collection
	TokenID *prototyp.BigInt `json:"tokenId" db:"token_id,omitempty"`
	// url where we can view the asset contents
	// ie. https://metadata.sequence.app/projects/1/collections/1/tokens/1/image
	URL string `json:"url" db:"-"`
	// metadata field related to TokenMetadata, some field names:
	// ['image', 'video', 'audio', 'animation_url', ...]
	MetadataField string `json:"metadataField,omitempty" db:"metadata_field"`
	// asset details
	Filename  string    `json:"filename,omitempty" db:"filename"`
	Filesize  uint32    `json:"filesize,omitempty" db:"filesize"`
	MimeType  string    `json:"mimeType,omitempty" db:"mime_type"`
	Width     *uint16   `json:"width,omitempty" db:"width"`
	Height    *uint16   `json:"height,omitempty" db:"height"`
	UpdatedAt time.Time `json:"updatedAt" db:"updated_at"`
}

type BloomStatus struct {
	Enabled              bool   `json:"enabled"`
	Initialized          bool   `json:"initialized"`
	BloomInitElapsedTime string `json:"bloomInitElapsedTime"`
}

type Bond struct {
	Pebble                     *PebbleMetrics `json:"pebble"`
	EstimatedDiskUsagePerTable interface{}    `json:"estimatedDiskUsagePerTable"`
	EstimatedDiskUsageTotal    string         `json:"estimatedDiskUsageTotal"`
}

type ContractInfo struct {
	ChainID      uint64                  `json:"chainId" cbor:"-"`
	Address      string                  `json:"address" cbor:"-"`
	Name         string                  `json:"name" cbor:"-"`
	Type         string                  `json:"type" cbor:"-"`
	Symbol       string                  `json:"symbol" cbor:"-"`
	Decimals     *uint64                 `json:"decimals,omitempty" cbor:"-"`
	LogoURI      string                  `json:"logoURI,omitempty" cbor:"-"`
	Deployed     bool                    `json:"deployed" cbor:"-"`
	BytecodeHash prototyp.Hash           `json:"bytecodeHash" cbor:"-"`
	Extensions   *ContractInfoExtensions `json:"extensions" cbor:"-"`
	ContentHash  uint64                  `json:"-" cbor:"-"`
	UpdatedAt    time.Time               `json:"updatedAt" cbor:"-"`
}

type ContractInfoExtensions struct {
	Link          string `json:"link" cbor:"-"`
	Description   string `json:"description" cbor:"-"`
	OgImage       string `json:"ogImage" cbor:"-"`
	OriginChainID uint64 `json:"originChainId" cbor:"-"`
	OriginAddress string `json:"originAddress" cbor:"-"`
	Blacklist     bool   `json:"blacklist,omitempty" cbor:"-"`
	Verified      bool   `json:"verified" cbor:"-"`
	VerifiedBy    string `json:"verifiedBy,omitempty" cbor:"-"`
	Featured      bool   `json:"featured,omitempty" cbor:"-"`
}

type ContractType uint8

type DiskUsage struct {
	HumanReadable string            `json:"humanReadable"`
	Used          uint64            `json:"used"`
	Size          uint64            `json:"size"`
	Percent       float32           `json:"percent"`
	Dirs          map[string]string `json:"dirs"`
}

type EtherBalance struct {
	AccountAddress prototyp.Hash `json:"accountAddress" cbor:"-"`
	// ETH balance in wei
	BalanceWei prototyp.BigInt `json:"balanceWei" cbor:"-"`
}

type EventFilter struct {
	// event is the event name to filter, for example
	// 'Transfer(address indexed from, address indexed to, uint256 value)'
	//
	// essentially the event is converted to a topic hash, and so
	// this filter option is a sugar to topicHashes
	Events []string `json:"events"`
	// explicit event topic hashes. See related `events` filter option.
	TopicHashes []prototyp.Hash `json:"topicHashes"`
	// contract addresses
	ContractAddresses []prototyp.Hash `json:"contractAddresses"`
	// token ids for events which have token ids
	TokenIDs []prototyp.BigInt `json:"tokenIDs"`
	// wallet addresses
	Accounts []prototyp.Hash `json:"accounts"`
}

type EventLog struct {
	ID              uint64           `json:"id" cbor:"id,omitempty"`
	Type            EventLogType     `json:"type" cbor:"type"`
	BlockNumber     uint64           `json:"blockNumber" cbor:"block_num"`
	BlockHash       prototyp.Hash    `json:"blockHash" cbor:"block_hash,extension"`
	ParentBlockHash prototyp.Hash    `json:"parentBlockHash" cbor:"parent_block_hash,extension" db:"parent_block_hash"`
	ContractAddress prototyp.Hash    `json:"contractAddress" cbor:"contract_address,extension"`
	ContractType    ContractType     `json:"contractType" cbor:"contract_type"`
	TxnHash         prototyp.Hash    `json:"txnHash" cbor:"txn_hash,extension"`
	TxnIndex        uint             `json:"txnIndex" cbor:"txn_index"`
	TxnData         TxnData          `json:"txnData" cbor:"txn_data"`
	TxnLogIndex     uint             `json:"txnLogIndex" cbor:"txn_log_index"`
	LogDataType     EventLogDataType `json:"logDataType" cbor:"log_data_type"`
	TS              time.Time        `json:"ts" cbor:"ts"`
	LogData         string           `json:"logData" cbor:"log_data"`
}

type EventLogDataType uint8

type EventLogType uint8

type HTTPClient interface {
	Do(req *http.Request) (*http.Response, error)
}

type IndexState struct {
	ChainID       prototyp.BigInt `json:"chainId" cbor:"chain_id,extension"`
	LastBlockNum  uint64          `json:"lastBlockNum" cbor:"last_block_num"`
	LastBlockHash prototyp.Hash   `json:"lastBlockHash" cbor:"last_block_hash,extension"`
}

type IndexedBlock struct {
	BlockNumber    uint64        `json:"blockNumber" cbor:"1"`
	BlockShortHash prototyp.Hash `json:"blockShortHash" cbor:"2,extension"`
}

type Indexer interface {
	// Ping the indexer
	Ping(ctx context.Context) (bool, error)
	// Get the current version of the indexer
	Version(ctx context.Context) (*Version, error)
	// Get the current runtime health status of the indexer
	RuntimeStatus(ctx context.Context) (*RuntimeStatus, error)
	// Get the chain ID of the indexer
	GetChainID(ctx context.Context) (uint64, error)
	// Queries an ethereum node for the latest and confirm ETH balances
	GetEtherBalance(ctx context.Context, accountAddress *string) (*EtherBalance, error)
	// GetTokenBalances returns a balance summary/details for a specific account. By default
	// if accountAddress is left empty, it will use the account from the jwt session.
	//
	// Also, if contractAddress is undefined, then it will list all current user coins/collectibles.
	// But, if contractAddress is provided, then it will return the token balances for the contract, this is
	// only useful for 1155, but for other tokens, it can act as a filter for the single balance.
	GetTokenBalances(ctx context.Context, accountAddress *string, contractAddress *string, tokenID *string, includeMetadata *bool, metadataOptions *MetadataOptions, includeCollectionTokens *bool, page *Page) (*Page, []*TokenBalance, error)
	// GetTokenSupplies returns the set of tokenIDs used by a contract address, supporting ERC-20, ERC-721, and ERC-1155
	// contracts, and their respective supply as well.
	GetTokenSupplies(ctx context.Context, contractAddress string, includeMetadata *bool, metadataOptions *MetadataOptions, page *Page) (*Page, ContractType, []*TokenSupply, error)
	// GetTokenSuppliesMap returns the token supplies of ERC-20 and ERC-1155 tokens as requested in the `tokenMap`
	// represented as a map of contractAddress :: []tokenIDs.
	//
	// For an ERC-20 specify tokenIDs as an empty array or [0], for example, { '0xdef': [] } or { '0xdef': [0] }
	// For ERC-1155 pass the array of tokens are strings, ie. { '0xabc': ['1', '2', '3'] }
	GetTokenSuppliesMap(ctx context.Context, tokenMap map[string][]string, includeMetadata *bool, metadataOptions *MetadataOptions) (map[string][]*TokenSupply, error)
	// Get balance update aggregate values -- useful for syncing balance details of a contract, ie. from Skyweaver
	GetBalanceUpdates(ctx context.Context, contractAddress string, lastBlockNumber uint64, lastBlockHash *string, page *Page) (*Page, []*TokenBalance, error)
	// History of mined transactions for the account which includes a list of token transfers (sent/recieved)
	// and sent transactions from a Sequence wallet
	GetTransactionHistory(ctx context.Context, filter *TransactionHistoryFilter, page *Page, includeMetadata *bool, metadataOptions *MetadataOptions) (*Page, []*Transaction, error)
	// Re-sync an incorrect token balance with the correct on-chain balance
	SyncBalance(ctx context.Context, accountAddress string, contractAddress string, tokenID *string) error
	// Fetches a single receipt and then will stop the subscription
	FetchTransactionReceipt(ctx context.Context, txnHash string, maxBlockWait *int) (*TransactionReceipt, error)
	// Fetch orderbook orders
	GetOrderbookOrders(ctx context.Context, page *Page, orderbookContractAddress string, collectionAddress string, currencyAddresses []string, filters []*OrderbookOrderFilter, orderStatuses []*OrderStatus, beforeExpiryTimestamp int64) (*Page, []*OrderbookOrder, error)
	GetTopOrders(ctx context.Context, orderbookContractAddress string, collectionAddress string, currencyAddresses []string, tokenIDs []string, isListing bool, priceSort SortOrder, excludeUser *string) ([]*OrderbookOrder, error)
	// Fetches a single receipt with filter and then will stop the subscription
	FetchTransactionReceiptWithFilter(ctx context.Context, filter *TransactionFilter, maxBlockWait *int) (*TransactionReceipt, error)
	GetAllWebhookListeners(ctx context.Context, projectId *uint64) ([]*WebhookListener, error)
	GetWebhookListener(ctx context.Context, id uint64, projectId *uint64) (*WebhookListener, error)
	AddWebhookListener(ctx context.Context, url string, filters *EventFilter, projectId *uint64) (bool, *WebhookListener, error)
	UpdateWebhookListener(ctx context.Context, listener *WebhookListener, projectId *uint64) (bool, error)
	RemoveWebhookListener(ctx context.Context, id uint64, projectId *uint64) (bool, error)
	ToggleWebhookListener(ctx context.Context, id uint64, projectId *uint64) (*WebhookListener, error)
	PauseAllWebhookListeners(ctx context.Context, projectId *uint64) (bool, error)
	ResumeAllWebhookListeners(ctx context.Context, projectId *uint64) (bool, error)
	SubscribeReceipts(ctx context.Context, filter *TransactionFilter, stream SubscribeReceiptsStreamWriter) error
	// TODO: pass optional block ...
	// can pass too, reorg true, etc. or stay behind, etc.
	SubscribeEvents(ctx context.Context, filter *EventFilter, stream SubscribeEventsStreamWriter) error
	SubscribeBalanceUpdates(ctx context.Context, contractAddress string, stream SubscribeBalanceUpdatesStreamWriter) error
}

type IndexerClient interface {
	// Ping the indexer
	Ping(ctx context.Context) (bool, error)
	// Get the current version of the indexer
	Version(ctx context.Context) (*Version, error)
	// Get the current runtime health status of the indexer
	RuntimeStatus(ctx context.Context) (*RuntimeStatus, error)
	// Get the chain ID of the indexer
	GetChainID(ctx context.Context) (uint64, error)
	// Queries an ethereum node for the latest and confirm ETH balances
	GetEtherBalance(ctx context.Context, accountAddress *string) (*EtherBalance, error)
	// GetTokenBalances returns a balance summary/details for a specific account. By default
	// if accountAddress is left empty, it will use the account from the jwt session.
	//
	// Also, if contractAddress is undefined, then it will list all current user coins/collectibles.
	// But, if contractAddress is provided, then it will return the token balances for the contract, this is
	// only useful for 1155, but for other tokens, it can act as a filter for the single balance.
	GetTokenBalances(ctx context.Context, accountAddress *string, contractAddress *string, tokenID *string, includeMetadata *bool, metadataOptions *MetadataOptions, includeCollectionTokens *bool, page *Page) (*Page, []*TokenBalance, error)
	// GetTokenSupplies returns the set of tokenIDs used by a contract address, supporting ERC-20, ERC-721, and ERC-1155
	// contracts, and their respective supply as well.
	GetTokenSupplies(ctx context.Context, contractAddress string, includeMetadata *bool, metadataOptions *MetadataOptions, page *Page) (*Page, ContractType, []*TokenSupply, error)
	// GetTokenSuppliesMap returns the token supplies of ERC-20 and ERC-1155 tokens as requested in the `tokenMap`
	// represented as a map of contractAddress :: []tokenIDs.
	//
	// For an ERC-20 specify tokenIDs as an empty array or [0], for example, { '0xdef': [] } or { '0xdef': [0] }
	// For ERC-1155 pass the array of tokens are strings, ie. { '0xabc': ['1', '2', '3'] }
	GetTokenSuppliesMap(ctx context.Context, tokenMap map[string][]string, includeMetadata *bool, metadataOptions *MetadataOptions) (map[string][]*TokenSupply, error)
	// Get balance update aggregate values -- useful for syncing balance details of a contract, ie. from Skyweaver
	GetBalanceUpdates(ctx context.Context, contractAddress string, lastBlockNumber uint64, lastBlockHash *string, page *Page) (*Page, []*TokenBalance, error)
	// History of mined transactions for the account which includes a list of token transfers (sent/recieved)
	// and sent transactions from a Sequence wallet
	GetTransactionHistory(ctx context.Context, filter *TransactionHistoryFilter, page *Page, includeMetadata *bool, metadataOptions *MetadataOptions) (*Page, []*Transaction, error)
	// Re-sync an incorrect token balance with the correct on-chain balance
	SyncBalance(ctx context.Context, accountAddress string, contractAddress string, tokenID *string) error
	// Fetches a single receipt and then will stop the subscription
	FetchTransactionReceipt(ctx context.Context, txnHash string, maxBlockWait *int) (*TransactionReceipt, error)
	// Fetch orderbook orders
	GetOrderbookOrders(ctx context.Context, page *Page, orderbookContractAddress string, collectionAddress string, currencyAddresses []string, filters []*OrderbookOrderFilter, orderStatuses []*OrderStatus, beforeExpiryTimestamp int64) (*Page, []*OrderbookOrder, error)
	GetTopOrders(ctx context.Context, orderbookContractAddress string, collectionAddress string, currencyAddresses []string, tokenIDs []string, isListing bool, priceSort SortOrder, excludeUser *string) ([]*OrderbookOrder, error)
	// Fetches a single receipt with filter and then will stop the subscription
	FetchTransactionReceiptWithFilter(ctx context.Context, filter *TransactionFilter, maxBlockWait *int) (*TransactionReceipt, error)
	GetAllWebhookListeners(ctx context.Context, projectId *uint64) ([]*WebhookListener, error)
	GetWebhookListener(ctx context.Context, id uint64, projectId *uint64) (*WebhookListener, error)
	AddWebhookListener(ctx context.Context, url string, filters *EventFilter, projectId *uint64) (bool, *WebhookListener, error)
	UpdateWebhookListener(ctx context.Context, listener *WebhookListener, projectId *uint64) (bool, error)
	RemoveWebhookListener(ctx context.Context, id uint64, projectId *uint64) (bool, error)
	ToggleWebhookListener(ctx context.Context, id uint64, projectId *uint64) (*WebhookListener, error)
	PauseAllWebhookListeners(ctx context.Context, projectId *uint64) (bool, error)
	ResumeAllWebhookListeners(ctx context.Context, projectId *uint64) (bool, error)
	SubscribeReceipts(ctx context.Context, filter *TransactionFilter) (SubscribeReceiptsStreamReader, error)
	// TODO: pass optional block ...
	// can pass too, reorg true, etc. or stay behind, etc.
	SubscribeEvents(ctx context.Context, filter *EventFilter) (SubscribeEventsStreamReader, error)
	SubscribeBalanceUpdates(ctx context.Context, contractAddress string) (SubscribeBalanceUpdatesStreamReader, error)
}

type MetadataOptions struct {
	VerifiedOnly     bool            `json:"verifiedOnly"`
	UnverifiedOnly   bool            `json:"unverifiedOnly"`
	IncludeContracts []prototyp.Hash `json:"includeContracts"`
}

type Options struct {
	HTTPClient   HTTPClient
	JWTAuthToken string
}

type OrderStatus uint32

type OrderbookOrder struct {
	OrderID                  prototyp.BigInt `json:"orderId" cbor:"1,extension"`
	TokenContract            prototyp.Hash   `json:"tokenContract" cbor:"2,extension"`
	TokenID                  prototyp.BigInt `json:"tokenId" cbor:"3,extension"`
	IsListing                bool            `json:"isListing" cbor:"4,extension"`
	Quantity                 prototyp.BigInt `json:"quantity" cbor:"5,extension"`
	QuantityRemaining        prototyp.BigInt `json:"quantityRemaining" cbor:"6,extension"`
	CurrencyAddress          prototyp.Hash   `json:"currencyAddress" cbor:"7,extension"`
	PricePerToken            prototyp.BigInt `json:"pricePerToken" cbor:"8,extension"`
	Expiry                   prototyp.BigInt `json:"expiry" cbor:"9,extension"`
	OrderStatus              OrderStatus     `json:"orderStatus" cbor:"10,extension"`
	CreatedBy                prototyp.Hash   `json:"createdBy" cbor:"11,extension"`
	CreatedAt                uint64          `json:"createdAt" cbor:"12,extension"`
	OrderbookContractAddress prototyp.Hash   `json:"orderbookContractAddress" cbor:"13,extension"`
}

type OrderbookOrderFilter struct {
	IsListing          *bool    `json:"isListing" cbor:"1,extension"`
	UserAddress        *string  `json:"userAddress" cbor:"2,extension"`
	TokenIDs           []string `json:"tokenIds" cbor:"3,extension"`
	ExcludeUserAddress *string  `json:"excludeUserAddress" cbor:"4,extension"`
}

type Page struct {
	// Numbered pages: Page number, this is multiplied by the value of the <pageSize> parameter.
	Page *uint32 `json:"page,omitempty"`
	// Cursor: column to compare before/after to
	Column *string `json:"column,omitempty"`
	// Cursor: return column < before - include to get previous page
	Before *interface{} `json:"before,omitempty"`
	// Cursor: return column > after - include to get next page
	After *interface{} `json:"after,omitempty"`
	// Sorting filter
	Sort []*SortBy `json:"sort,omitempty"`
	// Number of items per page
	PageSize *uint32 `json:"pageSize,omitempty"`
	// Indicates if there are more results available
	More *bool `json:"more,omitempty"`
}

type PebbleMetrics struct {
	CompactionCount           int64  `json:"compactionCount"`
	CompactionEstimatedDebt   uint64 `json:"compactionEstimatedDebt"`
	CompactionInProgressBytes int64  `json:"compactionInProgressBytes"`
	CompactionNumInProgress   int64  `json:"compactionNumInProgress"`
	CompactionMarkedFiles     int    `json:"compactionMarkedFiles"`
}

type RuntimeChecks struct {
	Running               bool         `json:"running"`
	Runnables             interface{}  `json:"runnables"`
	CgoEnabled            bool         `json:"cgoEnabled"`
	QuotaControlEnabled   bool         `json:"quotaControlEnabled"`
	SyncMode              string       `json:"syncMode"`
	PercentIndexed        float64      `json:"percentIndexed"`
	LastBlockNum          uint64       `json:"lastBlockNum"`
	LastBlockNumWithState uint64       `json:"lastBlockNumWithState"`
	BloomStatus           *BloomStatus `json:"bloomStatus"`
	Bond                  *Bond        `json:"bond"`
	DiskUsage             *DiskUsage   `json:"diskUsage"`
}

type RuntimeStatus struct {
	// overall status, true/false
	HealthOK       bool           `json:"healthOK"`
	IndexerEnabled bool           `json:"indexerEnabled"`
	StartTime      time.Time      `json:"startTime"`
	Uptime         uint64         `json:"uptime"`
	Ver            string         `json:"ver"`
	Branch         string         `json:"branch"`
	CommitHash     string         `json:"commitHash"`
	ChainID        uint64         `json:"chainID"`
	Checks         *RuntimeChecks `json:"checks"`
}

type SortBy struct {
	Column string    `json:"column"`
	Order  SortOrder `json:"order"`
}

type SortOrder uint32

type SubscribeBalanceUpdatesStreamReader interface {
	Read() (balance *TokenBalance, err error)
}

type SubscribeBalanceUpdatesStreamWriter interface {
	Write(balance *TokenBalance) error
}

type SubscribeEventsStreamReader interface {
	Read() (log *EventLog, err error)
}

type SubscribeEventsStreamWriter interface {
	Write(log *EventLog) error
}

type SubscribeReceiptsStreamReader interface {
	Read() (receipt *TransactionReceipt, err error)
}

type SubscribeReceiptsStreamWriter interface {
	Write(receipt *TransactionReceipt) error
}

type TokenBalance struct {
	ContractType    ContractType       `json:"contractType" cbor:"2,omitempty"`
	ContractAddress prototyp.Hash      `json:"contractAddress" cbor:"1,extension"`
	AccountAddress  prototyp.HashMaybe `json:"accountAddress,omitempty" cbor:"3,extension,omitempty"`
	TokenID         *prototyp.BigInt   `json:"tokenID,omitempty" cbor:"4,extension"`
	Balance         prototyp.BigInt    `json:"balance" cbor:"5,extension"`
	BlockHash       prototyp.Hash      `json:"blockHash,omitempty" cbor:"6,extension"`
	BlockNumber     uint64             `json:"blockNumber,omitempty" cbor:"7"`
	// included to remind the receiver of network source
	ChainID       uint64         `json:"chainId" cbor:"-"`
	IsNFTSummary  bool           `json:"-" cbor:"9"`
	ContractInfo  *ContractInfo  `json:"contractInfo,omitempty" cbor:"-"`
	TokenMetadata *TokenMetadata `json:"tokenMetadata,omitempty" cbor:"-"`
}

type TokenBalanceFilter struct {
	ContractAddress  prototyp.Hash `json:"contractAddress"`
	SinceBlockNumber uint64        `json:"sinceBlockNumber"`
}

type TokenHistory struct {
	BlockNumber     uint64        `json:"blockNumber" cbor:"1"`
	BlockHash       prototyp.Hash `json:"blockHash" cbor:"2,extension"`
	AccountAddress  prototyp.Hash `json:"accountAddress" cbor:"3,extension"`
	ContractAddress prototyp.Hash `json:"contractAddress" cbor:"4,extension"`
	ContractType    ContractType  `json:"contractType" cbor:"5"`
	FromAddress     prototyp.Hash `json:"fromAddress" cbor:"6,extension"`
	ToAddress       prototyp.Hash `json:"toAddress" cbor:"7,extension"`
	TxnHash         prototyp.Hash `json:"txnHash" cbor:"8,extension"`
	TxnIndex        uint          `json:"txnIndex" cbor:"9"`
	TxnLogIndex     uint          `json:"txnLogIndex" cbor:"a"`
	// deprecated in favour of TokenIDs and Amounts
	LogData  string            `json:"logData" cbor:"b"`
	TokenIDs []prototyp.BigInt `json:"tokenIDs" cbor:"d,extension"`
	Amounts  []prototyp.BigInt `json:"Amounts" cbor:"e,extension"`
	TS       time.Time         `json:"ts" cbor:"c"`
}

type TokenMetadata struct {
	TokenID     string `json:"tokenId" cbor:"-"`
	Name        string `json:"name" cbor:"-"`
	Description string `json:"description" cbor:"-"`
	// url
	Image string `json:"image" cbor:"-"`
	// non-standard fields we've added for Sequence. Others should adopt
	// these too and we should prompt, similar to how `image` field works.
	// url
	Video string `json:"video,omitempty" cbor:"-"`
	// url
	Audio      string                 `json:"audio,omitempty" cbor:"-"`
	Properties map[string]interface{} `json:"properties" cbor:"-"`
	// OpenSea fields
	// see https://docs.opensea.io/docs/metadata-standards
	//
	// NOTE: its a bit unfortunate OpenSea didn't use camelCase, and
	// also introduces 'attributes' when 'properties' is actually the correct property name.
	// TODO: we could smooth this out / normalize it, but we can leave it for now.
	Attributes      []map[string]interface{} `json:"attributes" cbor:"-"`
	ImageData       string                   `json:"image_data,omitempty" cbor:"-"`
	ExternalUrl     string                   `json:"external_url,omitempty" cbor:"-"`
	BackgroundColor string                   `json:"background_color,omitempty" cbor:"-"`
	AnimationUrl    string                   `json:"animation_url,omitempty" cbor:"-"`
	//
	// Misc
	//
	// decimals is deprecated, but still used by some
	Decimals  *uint64   `json:"decimals,omitempty" cbor:"-"`
	UpdatedAt time.Time `json:"updatedAt" cbor:"-"`
	// Assets associated to this token metadata
	Assets []*Asset `json:"assets,omitempty" cbor:"-"`
}

type TokenSupply struct {
	TokenID prototyp.BigInt `json:"tokenID,omitempty" cbor:"token_id,extension"`
	Supply  prototyp.BigInt `json:"supply" cbor:"supply,extension"`
	// included to remind the receiver of network source
	ChainID       uint64         `json:"chainId" cbor:"-"`
	ContractInfo  *ContractInfo  `json:"contractInfo,omitempty" cbor:"-"`
	TokenMetadata *TokenMetadata `json:"tokenMetadata,omitempty" cbor:"-"`
}

type Transaction struct {
	TxnHash     prototyp.Hash  `json:"txnHash" cbor:"1,extension"`
	BlockNumber uint64         `json:"blockNumber" cbor:"2"`
	BlockHash   prototyp.Hash  `json:"blockHash" cbor:"3,extension"`
	ChainID     uint64         `json:"chainId" cbor:"4"`
	MetaTxnID   *string        `json:"metaTxnID" cbor:"5"`
	Transfers   []*TxnTransfer `json:"transfers" cbor:"6"`
	Timestamp   *time.Time     `json:"timestamp" cbor:"7" db:"ts,omitempty"`
}

type TransactionFilter struct {
	TxnHash         *prototyp.Hash `json:"txnHash"`
	From            *prototyp.Hash `json:"from"`
	To              *prototyp.Hash `json:"to"`
	ContractAddress *prototyp.Hash `json:"contractAddress"`
	// NOTE: event will convert to topicHash, its a sugar
	Event     *string        `json:"event"`
	TopicHash *prototyp.Hash `json:"topicHash"`
}

type TransactionHistoryFilter struct {
	// short-hand for accountAddresses[]
	AccountAddress *string `json:"accountAddress"`
	// short-hand for contractAddresses[]
	ContractAddress   *string  `json:"contractAddress"`
	AccountAddresses  []string `json:"accountAddresses"`
	ContractAddresses []string `json:"contractAddresses"`
	// TODO: rename to txnHashes
	TransactionHashes []string `json:"transactionHashes"`
	// TODO: rename to metaTxnIds
	MetaTransactionIDs []string         `json:"metaTransactionIDs"`
	FromBlock          *uint64          `json:"fromBlock"`
	ToBlock            *uint64          `json:"toBlock"`
	TokenID            *prototyp.BigInt `json:"tokenID"`
}

type TransactionLog struct {
	ContractAddress prototyp.Hash   `json:"contractAddress"`
	Topics          []prototyp.Hash `json:"topics"`
	Data            string          `json:"data"`
	Index           uint64          `json:"index"`
}

type TransactionReceipt struct {
	TxnHash     prototyp.Hash     `json:"txnHash"`
	TxnStatus   TransactionStatus `json:"txnStatus"`
	TxnIndex    uint64            `json:"txnIndex"`
	TxnType     TransactionType   `json:"txnType"`
	BlockHash   prototyp.Hash     `json:"blockHash"`
	BlockNumber uint64            `json:"blockNumber"`
	GasUsed     uint64            `json:"gasUsed"`
	// number as string, since its BigInt ..
	EffectiveGasPrice prototyp.BigInt   `json:"effectiveGasPrice"`
	From              prototyp.Hash     `json:"from"`
	To                prototyp.Hash     `json:"to"`
	Logs              []*TransactionLog `json:"logs"`
	Final             bool              `json:"final"`
	Reorged           bool              `json:"reorged"`
}

type TransactionStatus uint32

type TransactionType uint32

type TxnData struct {
	From  prototyp.Hash   `json:"from" cbor:"from"`
	To    prototyp.Hash   `json:"to" cbor:"to"`
	Value prototyp.BigInt `json:"value" cbor:"value"`
}

type TxnTransfer struct {
	TransferType    TxnTransferType           `json:"transferType" cbor:"1"`
	ContractAddress prototyp.Hash             `json:"contractAddress" cbor:"2,extension"`
	ContractType    ContractType              `json:"contractType" cbor:"3"`
	From            prototyp.Hash             `json:"from" cbor:"4,extension"`
	To              prototyp.Hash             `json:"to" cbor:"5,extension"`
	TokenIds        []prototyp.BigInt         `json:"tokenIds,omitempty" cbor:"6,extension"`
	Amounts         []prototyp.BigInt         `json:"amounts" cbor:"7,extension"`
	LogIndex        uint                      `json:"logIndex" cbor:"8"`
	ContractInfo    *ContractInfo             `json:"contractInfo,omitempty" cbor:"-"`
	TokenMetadata   map[string]*TokenMetadata `json:"tokenMetadata,omitempty" cbor:"-"`
}

type TxnTransferType uint32

type Version struct {
	WebrpcVersion string `json:"webrpcVersion"`
	SchemaVersion string `json:"schemaVersion"`
	SchemaHash    string `json:"schemaHash"`
	AppVersion    string `json:"appVersion"`
}

type WALWriterRuntimeStatus struct {
	HealthOK          bool      `json:"healthOK"`
	StartTime         time.Time `json:"startTime"`
	Uptime            uint64    `json:"uptime"`
	Ver               string    `json:"ver"`
	Branch            string    `json:"branch"`
	CommitHash        string    `json:"commitHash"`
	ChainID           uint64    `json:"chainID"`
	PercentWALWritten float64   `json:"percentWALWritten"`
}

type WebRPCError struct {
	Name       string `json:"error"`
	Code       int    `json:"code"`
	Message    string `json:"msg"`
	Cause      string `json:"cause,omitempty"`
	HTTPStatus int    `json:"status"`
	// contains filtered or unexported fields
}

type WebhookListener struct {
	Id        uint64       `json:"id" db:"id"`
	ProjectID uint64       `json:"projectID" db:"project_id"`
	Url       string       `json:"url" db:"url"`
	Filters   *EventFilter `json:"filters" db:"filters"`
	Name      string       `json:"name" db:"name"`
	UpdatedAt time.Time    `json:"updatedAt" db:"updated_at"`
	Active    bool         `json:"active" db:"active"`
}