metadata

type AdminClient interface {
	// ContractInfo
	RefreshContractInfoUpdatedBefore(ctx context.Context, before string, maxContractNumber int) ([]uint64, error)
	// TokenMetadata
	RefreshTokenMetadataUpdatedBefore(ctx context.Context, before string, maxTokenNumber int) ([]uint64, error)
	// Contract Info Overrides
	GetContractInfoOverride(ctx context.Context, chainID string, contractAddress string) (*ContractInfoOverride, error)
	GetContractInfoOverrides(ctx context.Context, chainID *string, page *Page) ([]*ContractInfoOverride, *Page, error)
	AddContractInfoOverride(ctx context.Context, chainID string, contractAddress string, contractInfoOverride *ContractInfoOverride) (bool, error)
	UpdateContractInfoOverride(ctx context.Context, chainID string, contractAddress string, contractInfoOverride *ContractInfoOverride) (bool, error)
	RemoveContractInfoOverride(ctx context.Context, chainID string, contractAddress string) (bool, error)
	// Token Directory
	IsInTokenDirectory(ctx context.Context, chainID string, contractAddress string) (bool, uint8, error)
	SetTokenDirectoryFeatureIndex(ctx context.Context, chainID string, contractAddress string, featureIndex uint8) (bool, error)
	AddContractToTokenDirectory(ctx context.Context, chainID string, contractAddress string) (bool, error)
	RemoveContractFromTokenDirectory(ctx context.Context, chainID string, contractAddress string) (bool, error)
	RefreshTokenDirectory(ctx context.Context) (uint64, error)
	// Deprecated: use new admin api
	AddContractsToTokenDirectory(ctx context.Context, contracts []*ContractInfo, featureIndexes []uint8) (bool, error)
	// Deprecated: use new admin api
	RemoveContractsFromTokenDirectory(ctx context.Context, chainHandle string, contracts []string) (bool, error)
	// Deprecated: use new admin api
	ModifyFeatureIndex(ctx context.Context, chainHandle string, contractAddress string, featured uint8) (bool, error)
	// Deprecated: use new admin api
	GetFeatureIndex(ctx context.Context, chainHandle string, contractAddress string) (uint8, error)
	// Deprecated: use new admin api
	ListTokenDirectory(ctx context.Context, chainID *uint64, includeTestnets *bool, onlyFeatured *bool, page *Page) (*Page, []*ContractInfo, error)
}

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:"url"`
	// 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 Collection struct {
	ID         uint64              `json:"id,omitempty" db:"id,omitempty"`
	ProjectID  uint64              `json:"projectId,omitempty" db:"project_id"`
	Metadata   *CollectionMetadata `json:"metadata,omitempty" db:"metadata"`
	Private    bool                `json:"private" db:"private"`
	RevealKey  string              `json:"revealKey,omitempty" db:"reveal_key"`
	TokenCount *uint64             `json:"tokenCount,omitempty" db:"-"`
	CreatedAt  time.Time           `json:"createdAt,omitempty" db:"created_at,omitempty"`
	UpdatedAt  time.Time           `json:"updatedAt,omitempty" db:"updated_at,omitempty"`
	DeletedAt  *time.Time          `json:"deletedAt,omitempty" db:"deleted_at"`
	BaseURIs   *CollectionBaseURIs `json:"baseURIs,omitempty" db:"-"`
	// Assets associated to this collection metadata
	Assets []*Asset `json:"assets,omitempty" cbor:"-"`
}

type CollectionBaseURIs struct {
	// contractMetadataURI is the URI to the contract-level metadata for the collection,
	// which is the value to set on a contract. Note, we do not store this in the db, but we
	// do return it as part of the response.
	//
	// aka, `contractURI()` on a contract
	ContractMetadataURI string `json:"contractMetadataURI"`
	// tokenMetadataURI is the URI to the token-level metadata for the collection,
	// which is the value to set on a contract's token baseURI. Note, we do not store this
	// in the db, but we do return it as part of the response.
	//
	// aka `uri(uint256 tokenId)` on 721 and 1155
	//
	// This base URI which satisfy 721 and 1155
	//
	// https://eips.ethereum.org/EIPS/eip-721
	// uri ending with '/ without placeholder for tokenID
	//
	// also use for 1155
	// https://eips.ethereum.org/EIPS/eip-1155#metadata
	TokenMetadataURI string `json:"tokenMetadataURI"`
}

type CollectionMetadata struct {
	Name        string `json:"name"`
	Description string `json:"description"`
	Image       string `json:"image,omitempty"`
	// NOTE: we use `external_link` for the field name because of OpenSea's
	// contract-level metadata https://docs.opensea.io/docs/contract-level-metadata
	ExternalLink string                   `json:"external_link,omitempty"`
	Properties   map[string]interface{}   `json:"properties,omitempty"`
	Attributes   []map[string]interface{} `json:"attributes,omitempty"`
}

type Collections struct {
	CollectionsClient
	// contains filtered or unexported fields
}

type CollectionsClient interface {
	CreateCollection(ctx context.Context, projectId *uint64, collection *Collection) (*Collection, error)
	GetCollection(ctx context.Context, projectId *uint64, collectionId uint64) (*Collection, error)
	ListCollections(ctx context.Context, projectId *uint64, page *Page) (*Page, []*Collection, error)
	UpdateCollection(ctx context.Context, projectId *uint64, collection *Collection) (*Collection, error)
	DeleteCollection(ctx context.Context, projectId *uint64, collectionId uint64) (bool, error)
	PublishCollection(ctx context.Context, projectId *uint64, collectionId uint64, recursive *bool) (*Collection, error)
	UnpublishCollection(ctx context.Context, projectId *uint64, collectionId uint64) (*Collection, error)
	CreateContractCollection(ctx context.Context, projectId uint64, contractCollection *ContractCollection) (*ContractCollection, error)
	GetContractCollection(ctx context.Context, projectId uint64, chainId uint64, contractAddress string) (*ContractCollection, error)
	ListContractCollections(ctx context.Context, projectId uint64, collectionId *uint64, page *Page) ([]*ContractCollection, []*Collection, *Page, error)
	UpdateContractCollection(ctx context.Context, projectId uint64, contractCollection *ContractCollection) (bool, error)
	DeleteContractCollection(ctx context.Context, projectId uint64, chainId uint64, contractAddress string) (bool, error)
	CreateToken(ctx context.Context, projectId *uint64, collectionId uint64, token *TokenMetadata, private *bool) (*TokenMetadata, []*Asset, error)
	GetToken(ctx context.Context, projectId *uint64, collectionId uint64, tokenId string) (*TokenMetadata, []*Asset, error)
	ListTokens(ctx context.Context, projectId *uint64, collectionId uint64, page *Page) (*Page, []*TokenMetadata, error)
	UpdateToken(ctx context.Context, projectId *uint64, collectionId uint64, tokenId string, token *TokenMetadata, private *bool) (*TokenMetadata, error)
	DeleteToken(ctx context.Context, projectId *uint64, collectionId uint64, tokenId string) (bool, error)
	CreateAsset(ctx context.Context, projectId *uint64, asset *Asset) (*Asset, error)
	GetAsset(ctx context.Context, projectId *uint64, assetId uint64) (*Asset, error)
	UpdateAsset(ctx context.Context, projectId *uint64, asset *Asset) (*Asset, error)
	DeleteAsset(ctx context.Context, projectId *uint64, assetId uint64) (bool, error)
}

type ContractCollection struct {
	ID              uint64        `json:"id,omitempty" db:"id,omitempty"`
	ChainID         uint64        `json:"chainId" db:"chain_id"`
	ContractAddress prototyp.Hash `json:"contractAddress" db:"contract_address"`
	CollectionID    uint64        `json:"collectionId" db:"collection_id"`
}

type ContractIndex struct {
	ChainID      uint64                 `json:"chainId" db:"chain_id"`
	Address      prototyp.Hash          `json:"address" db:"contract_address"`
	Type         ContractType           `json:"type" db:"type"`
	Source       Source                 `json:"source" db:"source"`
	Metadata     map[string]interface{} `json:"metadata" db:"metadata"`
	ContentHash  uint64                 `json:"contentHash,omitempty" db:"content_hash,omitempty"`
	Deployed     bool                   `json:"deployed" db:"deployed"`
	BytecodeHash prototyp.Hash          `json:"bytecodeHash" db:"bytecode_hash"`
	NotFound     bool                   `json:"notFound,omitempty" db:"not_found"`
	UpdatedAt    time.Time              `json:"updatedAt" db:"updated_at"`
	QueuedAt     *time.Time             `json:"queuedAt" db:"queued_at"`
	Status       ResourceStatus         `json:"status"`
}

type ContractInfo struct {
	ChainID      uint64                  `json:"chainId" cbor:"-"`
	Address      string                  `json:"address" cbor:"-"`
	Source       string                  `json:"source" 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:"-"`
	QueuedAt     *time.Time              `json:"queuedAt"`
	Status       ResourceStatus          `json:"status"`
}

type ContractInfoExtensionBridgeInfo struct {
	TokenAddress string `json:"tokenAddress" cbor:"-"`
}

type ContractInfoExtensions struct {
	Link          string                                     `json:"link,omitempty" cbor:"-"`
	Description   string                                     `json:"description,omitempty" cbor:"-"`
	Categories    []string                                   `json:"categories,omitempty" cbor:"-"`
	BridgeInfo    map[string]ContractInfoExtensionBridgeInfo `json:"bridgeInfo,omitempty" cbor:"-"`
	OgImage       string                                     `json:"ogImage,omitempty" cbor:"-"`
	OgName        string                                     `json:"ogName,omitempty" cbor:"-"`
	OriginChainID uint64                                     `json:"originChainId,omitempty" cbor:"-"`
	OriginAddress string                                     `json:"originAddress,omitempty" cbor:"-"`
	Blacklist     bool                                       `json:"blacklist,omitempty" cbor:"-"`
	Verified      bool                                       `json:"verified,omitempty" cbor:"-"`
	VerifiedBy    string                                     `json:"verifiedBy,omitempty" cbor:"-"`
	Featured      bool                                       `json:"featured,omitempty" cbor:"-"`
	FeatureIndex  uint8                                      `json:"featureIndex,omitempty" cbor:"-"`
}

type ContractInfoExtensionsOverride struct {
	Link          *string  `json:"link" cbor:"-"`
	Description   *string  `json:"description" cbor:"-"`
	Categories    []string `json:"categories,omitempty" cbor:"-"`
	OgImage       *string  `json:"ogImage" cbor:"-"`
	OgName        *string  `json:"ogName" 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:"-"`
	FeatureIndex  *uint8   `json:"featureIndex,omitempty"`
}

type ContractInfoOverride struct {
	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:"-"`
	Extensions *ContractInfoExtensionsOverride `json:"extensions" cbor:"-"`
}

type ContractType uint16

type Filter struct {
	Text       *string           `json:"text"`
	Properties []*PropertyFilter `json:"properties"`
}

type GetNiftyswapUnitPricesRequest struct {
	SwapType SwapType          `json:"swapType"`
	Ids      []prototyp.BigInt `json:"ids"`
	Amounts  []prototyp.BigInt `json:"amounts"`
}

type GetNiftyswapUnitPricesResponse struct {
	UnitPrice       prototyp.BigInt `json:"unitPrice"`
	UnitAmount      prototyp.BigInt `json:"unitAmount"`
	AvailableAmount prototyp.BigInt `json:"availableAmount"`
}

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

type MetadataClient interface {
	Ping(ctx context.Context) (bool, error)
	Version(ctx context.Context) (*Version, error)
	RuntimeStatus(ctx context.Context) (*RuntimeStatus, error)
	GetTask(ctx context.Context, taskId uint64) (*Task, error)
	GetTaskStatus(ctx context.Context, taskId uint64) (*TaskStatus, error)
	// Contract Info -- returns contract meta-info for contracts found in registered chain's token-lists
	GetContractInfo(ctx context.Context, chainID string, contractAddress string) (*ContractInfo, *uint64, error)
	GetContractInfoBatch(ctx context.Context, chainID string, contractAddresses []string) (map[string]*ContractInfo, *uint64, error)
	// Find Contract Info across all chains token-lists. Similar to GetContractInfo above,
	// but it will traverse all chains and results from all.
	FindContractInfo(ctx context.Context, contractAddress string) ([]*ContractInfo, error)
	// map of contractAddress :: []ContractInfo
	FindContractInfoBatch(ctx context.Context, contractAddresses []string) (map[string][]*ContractInfo, error)
	// Refresh Contract Info -- refresh contract meta-info
	RefreshContractInfo(ctx context.Context, chainID string, contractAddress string) (*uint64, error)
	RefreshContractInfoBatch(ctx context.Context, chainID string, contractAddresses []string) (*uint64, error)
	// Search for contract infos using a query string
	SearchContractsByQuery(ctx context.Context, q string, chainID *string, chainIDs []string, types []ContractType, page *Page) ([]*ContractInfo, *Page, error)
	// Deprecated: UseFindContractInfo instead. (renamed).
	SearchContractInfo(ctx context.Context, contractAddress string) ([]*ContractInfo, error)
	// Deprecated: Use FindContractInfoBatch instead. (renamed)
	SearchContractInfoBatch(ctx context.Context, contractAddresses []string) (map[string][]*ContractInfo, error)
	// Deprecated: Use SearchContractsByQuery instead. (renamed)
	SearchContracts(ctx context.Context, q string, chainID *string, chainIDs []string, types []ContractType, page *Page) ([]*ContractInfo, *Page, error)
	// Deprecated: Use SearchContractsByQuery() and SearchTokenMetadataByQuery() instead.
	SearchMetadata(ctx context.Context, filter string, chainID *string, types []ContractType, excludeTokenMetadata *bool) ([]*TokenMetadata, []*ContractInfo, error)
	// GetTokenMetadata - fetch token metadata for a particular contract and respective tokenIDs
	GetTokenMetadata(ctx context.Context, chainID string, contractAddress string, tokenIDs []string) ([]*TokenMetadata, *uint64, error)
	// GetTokenMetadataBatch allows you to query the token metadata of a batch of contracts and respective tokenIDs
	// where map is contractAddress::[]tokenID => contractAddress::[]TokenMetadata
	//
	// Note, we limit each request to 50 contracts max and 50 tokens max per contract.
	GetTokenMetadataBatch(ctx context.Context, chainID string, contractTokenMap map[string][]string) (map[string][]*TokenMetadata, *uint64, error)
	// RefreshTokenMetadata allows you to refresh a contract metadata for contract-level and token-level metadata.
	RefreshTokenMetadata(ctx context.Context, chainID string, contractAddress string, tokenIDs []string, newMints *bool) (uint64, error)
	// Search ERC721 & ERC1155 token metadata by query string 'q'
	SearchTokenMetadataByQuery(ctx context.Context, q string, chainID *string, contractAddress *string, page *Page) ([]*TokenMetadata, *Page, error)
	// Search ERC721 & ERC1155 token metadata by filter object 'filter'
	// which allows to search by text or properties.
	SearchTokenMetadata(ctx context.Context, chainID string, contractAddress string, filter *Filter, page *Page) (*Page, []*TokenMetadata, error)
	// Search ERC721 & ERC1155 for token IDs by filter object 'filter'
	// which allows to search by text or properties.
	SearchTokenMetadataTokenIDs(ctx context.Context, chainID string, contractAddress string, filter *Filter, page *Page) (*Page, []string, error)
	// Get token metadata property filters for a contract address
	GetTokenMetadataPropertyFilters(ctx context.Context, chainID string, contractAddress string, excludeProperties []string, excludePropertyValues *bool) ([]*PropertyFilter, error)
	// Deprecated: Use RefreshTokenMetadata instead.
	RefreshAllContractTokens(ctx context.Context, chainHandle string, contractAddress string) (*uint64, uint64, error)
	// Deprecated: Use SearchTokenMetadataByQuery instead. (renamed)
	SearchTokens(ctx context.Context, q string, chainID *string, page *Page) ([]*TokenMetadata, *Page, error)
	// Deprecated: Use GetTokenMetadataPropertyFilters (renamed)
	TokenCollectionFilters(ctx context.Context, chainID string, contractAddress string) ([]*PropertyFilter, error)
	// Deprecated: Use GetTaskStatus instead. (its the same thing)
	GetTokenRefreshStatus(ctx context.Context, taskId uint64) (*TaskStatus, error)
	// Deprecated: Use SearchTokenMetadataTokenIDs instead. (renamed)
	SearchTokenIDs(ctx context.Context, chainID string, contractAddress string, filter *Filter, page *Page) (*Page, []string, error)
	// Gets Token Directory supported networks
	GetTokenDirectoryNetworks(ctx context.Context, includeTestnets *bool, onlyFeatured *bool) ([]uint64, []string, error)
	// Gets Token Directory entries
	GetTokenDirectory(ctx context.Context, chainID *string, includeTestnets *bool, onlyFeatured *bool, page *Page) ([]*ContractInfo, *Page, error)
	// Search in Token Directory
	SearchTokenDirectory(ctx context.Context, query string, chainID *uint64, includeTestnets *bool, onlyFeatured *bool, page *Page) ([]*ContractInfo, *Page, error)
	// Deprecated: Use GetTokenDirectoryNetworks instead.
	DirectoryGetNetworks(ctx context.Context, includeTestnets *bool, onlyFeatured *bool) ([]uint64, error)
	// Deprecated: Use GetTokenDirectory instead.
	DirectoryGetCollections(ctx context.Context, chainId *uint64, includeTestnets *bool, onlyFeatured *bool, page *Page) ([]*ContractInfo, *Page, error)
	// Deprecated: Use SearchTokenDirectory instead.
	DirectorySearchCollections(ctx context.Context, query string, chainId *uint64, includeTestnets *bool, onlyFeatured *bool, page *Page) ([]*ContractInfo, *Page, error)
	// Niftyswap querying data
	GetNiftyswapTokenQuantity(ctx context.Context, chainID string, contractAddress string, tokenIDs []string) (map[string]string, error)
	// map of tokenID :: quantity
	GetNiftyswapUnitPrices(ctx context.Context, chainID string, contractAddress string, req *GetNiftyswapUnitPricesRequest, fresh bool) (map[string]string, error)
	// map of tokenID :: price
	GetNiftyswapUnitPricesWithQuantities(ctx context.Context, chainID string, contractAddress string, req *GetNiftyswapUnitPricesRequest, fresh bool) (map[string]*GetNiftyswapUnitPricesResponse, error)
}

type Options struct {
	// JWTAuthToken is an optional JWT token to authenticate with the metadata service.
	JWTAuthToken string

	// MetadataServiceURL is an optional custom URL for the Sequence Metadata service.
	// If not provided, the default URL in `DefaultMetadataServiceURL` will be used.
	MetadataServiceURL string

	// HTTPClient is an optional custom HTTP client to use for communicating with the
	// metadata service.
	HTTPClient HTTPClient

	// ProjectAccessKey is the access key for the project. (optional)
	ProjectAccessKey string
}

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"`
	// Number of items per page
	PageSize *uint32 `json:"pageSize,omitempty"`
	// Indicates if there are more results available
	More *bool `json:"more,omitempty"`
}

type PropertyFilter struct {
	Name   string        `json:"name"`
	Type   PropertyType  `json:"type"`
	Min    *int64        `json:"min"`
	Max    *int64        `json:"max"`
	Values []interface{} `json:"values"`
}

type PropertyType uint32

type ResourceStatus uint32

type RunnableStatus struct {
	Running   bool        `json:"running"`
	Restarts  int         `json:"restarts"`
	StartTime time.Time   `json:"startTime"`
	EndTime   *time.Time  `json:"endTime"`
	LastError interface{} `json:"lastError"`
}

type RuntimeStatus struct {
	HealthOK     bool                       `json:"healthOK"`
	StartTime    time.Time                  `json:"startTime"`
	Uptime       uint64                     `json:"uptime"`
	UptimeString string                     `json:"uptimeString"`
	Ver          string                     `json:"ver"`
	Branch       string                     `json:"branch"`
	CommitHash   string                     `json:"commitHash"`
	Runnable     map[string]*RunnableStatus `json:"runnable,omitempty"`
}

type Source uint8

type SwapType uint32

type Task struct {
	ID        uint64          `json:"id" db:"id,omitempty"`
	Queue     string          `json:"queue" db:"queue"`
	Status    TaskStatus      `json:"status" db:"status"`
	Try       uint32          `json:"try" db:"try"`
	RunAt     *time.Time      `json:"runAt" db:"run_at,omitempty"`
	LastRanAt *time.Time      `json:"lastRanAt" db:"last_ran_at,omitempty"`
	CreatedAt *time.Time      `json:"createdAt" db:"created_at,omitempty"`
	Payload   json.RawMessage `json:"payload" db:"payload"`
	Result    json.RawMessage `json:"result"`
}

type TaskStatus uint8

type Token struct {
	CollectionID uint64          `json:"collectionId" db:"collection_id"`
	TokenID      prototyp.BigInt `json:"tokenId" db:"token_id"`
	Metadata     *TokenMetadata  `json:"metadata" db:"metadata"`
	Private      bool            `json:"private" db:"private"`
	SearchColumn string          `json:"-" db:"search_col"`
	UpdatedAt    time.Time       `json:"updatedAt" db:"updated_at"`
}

type TokenIndex struct {
	ChainID         uint64                 `json:"chainId" db:"chain_id"`
	ContractAddress prototyp.Hash          `json:"contractAddress,omitempty" db:"contract_address"`
	TokenID         prototyp.BigInt        `json:"tokenId" db:"token_id"`
	Source          Source                 `json:"source" db:"source"`
	Metadata        map[string]interface{} `json:"metadata" db:"metadata"`
	NotFound        bool                   `json:"notFound,omitempty" db:"not_found"`
	LastFetched     *time.Time             `json:"lastFetched,omitempty" db:"last_fetched"`
	FetchCount      *uint8                 `json:"fetchCount,omitempty" db:"fetch_count"`
	UpdatedAt       time.Time              `json:"updatedAt" db:"updated_at"`
	QueuedAt        *time.Time             `json:"queuedAt"`
}

type TokenMetadata struct {
	ChainID         *uint64       `json:"chainId,omitempty" cbor:"-"`
	ContractAddress prototyp.Hash `json:"contractAddress,omitempty" cbor:"-"`
	TokenID         string        `json:"tokenId" cbor:"-"`
	Source          string        `json:"source" 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.
	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:"-"`
	Status      ResourceStatus `json:"status"`
	QueuedAt    *time.Time     `json:"queuedAt"`
	LastFetched *time.Time     `json:"lastFetched,omitempty"`
}

type TokenMetadataClient interface {
	Ping(ctx context.Context) (bool, error)

	GetContractInfo(ctx context.Context, chainID string, contractAddress string) (*ContractInfo, *uint64, error)

	GetContractInfoBatch(ctx context.Context, chainID string, contractAddresses []string) (map[string]*ContractInfo, *uint64, error)

	GetTokenMetadata(ctx context.Context, chainID string, contractAddress string, tokenIDs []string) ([]*TokenMetadata, *uint64, error)

	// GetTokenMetadataBatch allows you to query the token metadata of a batch of contracts and respective tokenIDs
	// where map is contractAddress::[]tokenID => contractAddress::[]TokenMetadata
	//
	// Note, we limit each request to 50 contracts max and 50 tokens max per contract.
	GetTokenMetadataBatch(ctx context.Context, chainID string, contractTokenMap map[string][]string) (map[string][]*TokenMetadata, *uint64, error)
}

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

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 WebrpcGenVersions struct {
	WebrpcGenVersion string
	CodeGenName      string
	CodeGenVersion   string
	SchemaName       string
	SchemaVersion    string
}