alchemy

Documentation

Overview

nolint: misspell

Index

• Constants
• type Asset
• type Attribute
• type AttributeValue
  • func (st *AttributeValue) UnmarshalJSON(b []byte) error
• type BatchContractAddresses
• type BatchTokenIDs
• type Client
  • func NewClient(apiKeys map[uint64]string) *Client
  • func (o *Client) FetchAllAssetsByOwner(ctx context.Context, chainID walletCommon.ChainID, owner common.Address, ...) (*thirdparty.FullCollectibleDataContainer, error)
  • func (o *Client) FetchAllAssetsByOwnerAndContractAddress(ctx context.Context, chainID walletCommon.ChainID, owner common.Address, ...) (*thirdparty.FullCollectibleDataContainer, error)
  • func (o *Client) FetchAssetsByCollectibleUniqueID(ctx context.Context, uniqueIDs []thirdparty.CollectibleUniqueID) ([]thirdparty.FullCollectibleData, error)
  • func (o *Client) FetchCollectibleOwnersByContractAddress(ctx context.Context, chainID walletCommon.ChainID, ...) (*thirdparty.CollectibleContractOwnership, error)
  • func (o *Client) FetchCollectionSocials(ctx context.Context, contractID thirdparty.ContractID) (*thirdparty.CollectionSocials, error)
  • func (o *Client) FetchCollectionsDataByContractID(ctx context.Context, contractIDs []thirdparty.ContractID) ([]thirdparty.CollectionData, error)
  • func (o *Client) ID() string
  • func (o *Client) IsChainSupported(chainID walletCommon.ChainID) bool
  • func (o *Client) IsConnected() bool
• type CollectibleContractOwnership
• type CollectibleOwner
• type Contract
• type ContractList
• type Image
• type NFTList
• type OpenSeaMetadata
• type OwnedNFTList
• type Raw
  • func (r *Raw) UnmarshalJSON(b []byte) error
• type RawFull
• type RawMetadata
• type TokenBalance
• type TokenID

Constants

const AlchemyID = "alchemy"

Types

type Asset

type Asset struct {
	Contract    Contract       `json:"contract"`
	TokenID     *bigint.BigInt `json:"tokenId"`
	Name        string         `json:"name"`
	Description string         `json:"description"`
	Image       Image          `json:"image"`
	Raw         Raw            `json:"raw"`
	TokenURI    string         `json:"tokenUri"`
	Balance     *bigint.BigInt `json:"balance,omitempty"`
}

type Attribute

type Attribute struct {
	TraitType string         `json:"trait_type"`
	Value     AttributeValue `json:"value"`
}

type AttributeValue

type AttributeValue string

func (*AttributeValue) UnmarshalJSON

func (st *AttributeValue) UnmarshalJSON(b []byte) error

type BatchContractAddresses

type BatchContractAddresses struct {
	Addresses []common.Address `json:"contractAddresses"`
}

type BatchTokenIDs

type BatchTokenIDs struct {
	IDs []TokenID `json:"tokens"`
}

type Client

type Client struct {
	thirdparty.CollectibleContractOwnershipProvider
	// contains filtered or unexported fields
}

func NewClient

func NewClient(apiKeys map[uint64]string) *Client

func (*Client) FetchAllAssetsByOwner

func (o *Client) FetchAllAssetsByOwner(ctx context.Context, chainID walletCommon.ChainID, owner common.Address, cursor string, limit int) (*thirdparty.FullCollectibleDataContainer, error)

func (*Client) FetchAllAssetsByOwnerAndContractAddress

func (o *Client) FetchAllAssetsByOwnerAndContractAddress(ctx context.Context, chainID walletCommon.ChainID, owner common.Address, contractAddresses []common.Address, cursor string, limit int) (*thirdparty.FullCollectibleDataContainer, error)

func (*Client) FetchAssetsByCollectibleUniqueID

func (o *Client) FetchAssetsByCollectibleUniqueID(ctx context.Context, uniqueIDs []thirdparty.CollectibleUniqueID) ([]thirdparty.FullCollectibleData, error)

func (*Client) FetchCollectibleOwnersByContractAddress

func (o *Client) FetchCollectibleOwnersByContractAddress(ctx context.Context, chainID walletCommon.ChainID, contractAddress common.Address) (*thirdparty.CollectibleContractOwnership, error)

func (*Client) FetchCollectionSocials

func (o *Client) FetchCollectionSocials(ctx context.Context, contractID thirdparty.ContractID) (*thirdparty.CollectionSocials, error)

func (*Client) FetchCollectionsDataByContractID

func (o *Client) FetchCollectionsDataByContractID(ctx context.Context, contractIDs []thirdparty.ContractID) ([]thirdparty.CollectionData, error)

func (*Client) ID

func (o *Client) ID() string

func (*Client) IsChainSupported

func (o *Client) IsChainSupported(chainID walletCommon.ChainID) bool

func (*Client) IsConnected

func (o *Client) IsConnected() bool

type CollectibleContractOwnership

type CollectibleContractOwnership struct {
	Owners  []CollectibleOwner `json:"owners"`
	PageKey string             `json:"pageKey"`
}

type CollectibleOwner

type CollectibleOwner struct {
	OwnerAddress  common.Address `json:"ownerAddress"`
	TokenBalances []TokenBalance `json:"tokenBalances"`
}

type Contract

type Contract struct {
	Address         common.Address  `json:"address"`
	Name            string          `json:"name"`
	Symbol          string          `json:"symbol"`
	TokenType       string          `json:"tokenType"`
	OpenSeaMetadata OpenSeaMetadata `json:"openseaMetadata"`
}

type ContractList

type ContractList struct {
	Contracts []Contract `json:"contracts"`
}

type Image

type Image struct {
	ImageURL             string `json:"pngUrl"`
	CachedAnimationURL   string `json:"cachedUrl"`
	OriginalAnimationURL string `json:"originalUrl"`
}

type NFTList

type NFTList struct {
	NFTs []Asset `json:"nfts"`
}

type OpenSeaMetadata

type OpenSeaMetadata struct {
	ImageURL        string `json:"imageUrl"`
	TwitterUsername string `json:"twitterUsername"`
	ExternalURL     string `json:"externalUrl"`
}

type OwnedNFTList

type OwnedNFTList struct {
	OwnedNFTs  []Asset        `json:"ownedNfts"`
	TotalCount *bigint.BigInt `json:"totalCount"`
	PageKey    string         `json:"pageKey"`
}

type Raw

type Raw struct {
	RawMetadata interface{} `json:"metadata"`
}

func (*Raw) UnmarshalJSON

func (r *Raw) UnmarshalJSON(b []byte) error

type RawFull

type RawFull struct {
	RawMetadata RawMetadata `json:"metadata"`
}

type RawMetadata

type RawMetadata struct {
	Attributes []Attribute `json:"attributes"`
}

type TokenBalance

type TokenBalance struct {
	TokenID *bigint.BigInt `json:"tokenId"`
	Balance *bigint.BigInt `json:"balance"`
}

type TokenID

type TokenID struct {
	ContractAddress common.Address `json:"contractAddress"`
	TokenID         *bigint.BigInt `json:"tokenId"`
}