token

README

Token Metadata for Go

Usage

Import this repo directly into your own go repo

Maintain

To add a new token's metadata:

1. add a new token_name: {address:token_address, coinGeckoId:token_coingecko_id, denom:token_denom, metaSource: [Alchemy/custom]} kv pair in token_meta.json
2. run make gen

To add some new util functions

1. develop your new util functions
2. don't forget to run make build to make sure no error in compiling at least

Documentation

Index

• func SetDenomToMetadataMap(metadataMap map[string]*Token)
• type AlchemyRequest
• type Dict
• type EthereumAddress
• type Meta
• type MetaSource
• type MetadataResponse
• type RPCError
• type Token
  • func GetTokenByAddress(address string) *Token
  • func GetTokenByDenom(denom string) *Token
  • func GetTokenBySymbol(symbol string) *Token

Functions

func SetDenomToMetadataMap

func SetDenomToMetadataMap(metadataMap map[string]*Token)

Types

type AlchemyRequest

type AlchemyRequest struct {
	JsonRPC string `json:"jsonrpc"`
	ID      int    `json:"id"`

	Method string   `json:"method"`
	Params []string `json:"params"`
}

type Dict

type Dict map[string]*Token

type EthereumAddress

type EthereumAddress struct {
	common.Address
}

type Meta

type Meta struct {
	Name     string `json:"name"`
	Symbol   string `json:"symbol"`
	Decimals int    `json:"decimals"`
	Logo     string `json:"logo"`
}

Meta this struct is the same as the metadata in the resp of Alchemy

type MetaSource

type MetaSource string

const (
	MetaSourceAlchemy MetaSource = "alchemy" // query from Alchemy API
	MetaSourceCustom  MetaSource = "custom"  // defined in Customizers
)

type MetadataResponse

type MetadataResponse struct {
	JsonRPC string `json:"jsonrpc"`
	ID      int    `json:"id"`

	Error  *RPCError `json:"error"`
	Result *Meta     `json:"result"`
}

type RPCError

type RPCError struct {
	Code    int    `json:"code"`
	Message string `json:"message"`
}

type Token

type Token struct {
	Address        string     `json:"address"`
	CoingeckoID    string     `json:"coinGeckoId"`
	Denom          string     `json:"denom,omitempty"`
	MetaSource     MetaSource `json:"metaSource"`
	Meta           *Meta      `json:"meta"`
	LastAccessTime time.Time  `json:"-"`
}

func GetTokenByAddress

func GetTokenByAddress(address string) *Token

GetTokenByAddress no case sensitivity, and it's safe to pass address with prefix "peggy" for unknown address, request metadata from alchemy This method rely on an internal cache, so it's safe to call it frequently

func GetTokenByDenom

func GetTokenByDenom(denom string) *Token

GetTokenByDenom no case sensitivity

func GetTokenBySymbol

func GetTokenBySymbol(symbol string) *Token

GetTokenBySymbol no case sensitivity, USD/usd/Usd are all fine