network

Documentation

Overview

Package network contains useful functions for ip address formatting.

Index

• Constants
• func ExternalIP() (string, error)
• func ExternalIPv4() (string, error)
• func IPAddr() net.IP
• func Method(auth string) authorization.AuthorizationMethod
• func NewHttpClientWithSecret(secret string) *http.Client
• func SortAddresses(ipAddrs []net.IP) []net.IP
• func WriteError(w http.ResponseWriter, errJson *DefaultErrorJson)
• func WriteJson(w http.ResponseWriter, v any)
• type AuthorizationData
  • func (d AuthorizationData) Equals(other AuthorizationData) bool
  • func (d *AuthorizationData) ToHeaderValue() (string, error)
• type DefaultErrorJson
• type Endpoint
  • func (e Endpoint) Equals(other Endpoint) bool
  • func (e Endpoint) HttpClient() *http.Client

Constants

const DefaultRPCHTTPTimeout = time.Second * 30

DefaultRPCHTTPTimeout for HTTP requests via an RPC connection to an execution node.

Functions

func ExternalIP

func ExternalIP() (string, error)

ExternalIP returns the first IPv4/IPv6 available.

func ExternalIPv4

func ExternalIPv4() (string, error)

ExternalIPv4 returns the first IPv4 available.

func IPAddr

func IPAddr() net.IP

IPAddr gets the external ipv4 address and converts into a libp2p formatted value.

func Method

func Method(auth string) authorization.AuthorizationMethod

Method returns the authorizationmethod.AuthorizationMethod corresponding with the parameter value.

func NewHttpClientWithSecret

func NewHttpClientWithSecret(secret string) *http.Client

NewHttpClientWithSecret returns a http client that utilizes jwt authentication.

func SortAddresses

func SortAddresses(ipAddrs []net.IP) []net.IP

SortAddresses sorts a set of addresses in the order of ipv4 -> ipv6.

func WriteError

func WriteError(w http.ResponseWriter, errJson *DefaultErrorJson)

WriteError writes the error by manipulating headers and the body of the final response.

func WriteJson

func WriteJson(w http.ResponseWriter, v any)

WriteJson writes the response message in JSON format.

Types

type AuthorizationData

type AuthorizationData struct {
	Method authorization.AuthorizationMethod
	Value  string
}

AuthorizationData holds all information necessary to authorize with HTTP.

func (AuthorizationData) Equals

func (d AuthorizationData) Equals(other AuthorizationData) bool

Equals compares two authorization data objects for equality.

func (*AuthorizationData) ToHeaderValue

func (d *AuthorizationData) ToHeaderValue() (string, error)

ToHeaderValue retrieves the value of the authorization header from AuthorizationData.

type DefaultErrorJson

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

DefaultErrorJson is a JSON representation of a simple error value, containing only a message and an error code.

type Endpoint

type Endpoint struct {
	Url  string
	Auth AuthorizationData
}

Endpoint is an endpoint with authorization data.

func (Endpoint) Equals

func (e Endpoint) Equals(other Endpoint) bool

Equals compares two endpoints for equality.

func (Endpoint) HttpClient

func (e Endpoint) HttpClient() *http.Client

HttpClient creates a http client object dependant on the properties of the network endpoint.