api

package

v1.15.2 Latest Latest Go to latest Published: Apr 23, 2024 License: Apache-2.0, MIT Imports: 12 Imported by: 26

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/filecoin-project/venus

Links

Open Source Insights

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
type Version

Constants ¶

View Source

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

View Source

const ProtoVersion = multiaddr.P_WSS + 1

Variables ¶

View Source

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

Functions ¶

func DialArgs ¶ added in v1.2.2

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 ¶ added in v1.13.0

func ParseAddr(addr string) (string, error)

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

func VerString ¶ added in v1.2.2

func VerString(ver uint32) string

Types ¶

type APIInfo ¶ added in v1.2.2

type APIInfo struct {
	Addr  string
	Token []byte
}

func NewAPIInfo ¶ added in v1.2.2

func NewAPIInfo(addr, token string) APIInfo

func ParseApiInfo ¶ added in v1.2.2

func ParseApiInfo(s string) APIInfo

func (APIInfo) AuthHeader ¶ added in v1.2.2

func (a APIInfo) AuthHeader() http.Header

func (APIInfo) DialArgs ¶ added in v1.2.2

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 ¶ added in v1.2.2

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

func (APIInfo) SetAuthHeader ¶ added in v1.2.2

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
}

Source Files ¶

View all Source files

Directories ¶

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

Path	Synopsis
chain
v0 Code generated by github.com/filecoin-project/venus/venus-devtool/api-gen.	Code generated by github.com/filecoin-project/venus/venus-devtool/api-gen.
v0/mock Package mock is a generated GoMock package.	Package mock is a generated GoMock package.
v1 Code generated by github.com/filecoin-project/venus/venus-devtool/api-gen.	Code generated by github.com/filecoin-project/venus/venus-devtool/api-gen.
v1/mock Package mock is a generated GoMock package.	Package mock is a generated GoMock package.
gateway
v0 Code generated by github.com/filecoin-project/venus/venus-devtool/api-gen.	Code generated by github.com/filecoin-project/venus/venus-devtool/api-gen.
v0/mock Package mock is a generated GoMock package.	Package mock is a generated GoMock package.
v1 Code generated by github.com/filecoin-project/venus/venus-devtool/api-gen.	Code generated by github.com/filecoin-project/venus/venus-devtool/api-gen.
v1/mock Package mock is a generated GoMock package.	Package mock is a generated GoMock package.
v2 Code generated by github.com/filecoin-project/venus/venus-devtool/api-gen.	Code generated by github.com/filecoin-project/venus/venus-devtool/api-gen.
v2/mock Package mock is a generated GoMock package.	Package mock is a generated GoMock package.
market
client Code generated by github.com/filecoin-project/venus/venus-devtool/api-gen.	Code generated by github.com/filecoin-project/venus/venus-devtool/api-gen.
client/mock Package mock is a generated GoMock package.	Package mock is a generated GoMock package.
v0 Code generated by github.com/filecoin-project/venus/venus-devtool/api-gen.	Code generated by github.com/filecoin-project/venus/venus-devtool/api-gen.
v0/mock Package mock is a generated GoMock package.	Package mock is a generated GoMock package.
v1 Code generated by github.com/filecoin-project/venus/venus-devtool/api-gen.	Code generated by github.com/filecoin-project/venus/venus-devtool/api-gen.
v1/mock Package mock is a generated GoMock package.	Package mock is a generated GoMock package.
messager Code generated by github.com/filecoin-project/venus/venus-devtool/api-gen.	Code generated by github.com/filecoin-project/venus/venus-devtool/api-gen.
mock Package mock is a generated GoMock package.	Package mock is a generated GoMock package.
permission
wallet Code generated by github.com/filecoin-project/venus/venus-devtool/api-gen.	Code generated by github.com/filecoin-project/venus/venus-devtool/api-gen.
mock Package mock is a generated GoMock package.	Package mock is a generated GoMock package.