api

Documentation

Index

• Constants
• Variables
• func DialArgs(addr, version string) (string, error)
• func Endpoint(raw string, ver uint32) (string, error)
• func GetInternalStructs(in interface{}) []interface{}
• func ParseAddr(addr string) (string, error)
• func VerString(ver uint32) string
• type APIInfo
  • func NewAPIInfo(addr, token string) APIInfo
  • func ParseApiInfo(s string) APIInfo
  • func (a APIInfo) AuthHeader() http.Header
  • func (a APIInfo) DialArgs(version string) (string, error)
  • func (a APIInfo) Host() (string, error)
  • func (a APIInfo) SetAuthHeader(h http.Header)
• type Version

Constants

const (
	VenusAPINamespaceHeader = "X-VENUS-API-NAMESPACE"
	AuthorizationHeader     = "Authorization"
)

const ProtoVersion = multiaddr.P_WSS + 1

Variables

var ErrNotSupported = errors.New("method not supported")

Functions

func DialArgs

func DialArgs(addr, version string) (string, error)

func Endpoint

func Endpoint(raw string, ver uint32) (string, error)

func GetInternalStructs

func GetInternalStructs(in interface{}) []interface{}

GetInternalStructs extracts all pointers to 'Internal' sub-structs from the provided pointer to a proxy struct

func ParseAddr

func ParseAddr(addr string) (string, error)

ParseAddr parse a multi addr to a traditional url ( with http scheme as default)

func VerString

func VerString(ver uint32) string

Types

type APIInfo

type APIInfo struct {
	Addr  string
	Token []byte
}

func NewAPIInfo

func NewAPIInfo(addr, token string) APIInfo

func ParseApiInfo

func ParseApiInfo(s string) APIInfo

func (APIInfo) AuthHeader

func (a APIInfo) AuthHeader() http.Header

func (APIInfo) DialArgs

func (a APIInfo) DialArgs(version string) (string, error)

DialArgs parser libp2p address to http/ws protocol, the version argument can be override by address in version

func (APIInfo) Host

func (a APIInfo) Host() (string, error)

func (APIInfo) SetAuthHeader

func (a APIInfo) SetAuthHeader(h http.Header)

type Version

type Version interface {
	// Version provides information about API provider
	Version(ctx context.Context) (types.Version, error) //perm:read
}