pkg

Documentation

Overview

Copyright © 2021 Sebastien Leger

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• Constants
• func Fetch(bg context.Context, clioEndpoint string, magic int64, fetchMax int64, ...) ([]byte, error)
• func GetBlockHeight(url string) (*int64, error)
• func Push(config *server.ClientConfig, ch chan<- Producer)
• func PushBlockNo(bg context.Context, clioEndpoint string, magic int64, port int64, ...) ([]byte, error)
• func Serve(config *server.ServerConfig, ch chan Producer)
• type BlockHeightResponse
• type FetchRequest
• type PoolIdsResponse
• type PoolMetadata
• type PoolParameters
  • func VetPools(url string) ([]*PoolParameters, error)
• type PoolParametersResponse
• type PoolRelay
• type Producer
• type PullPayload
• type PushPayload
• type Query
• type QueryArgs

Constants

const (
	MaxMetadataLen       = 1024 // https://cips.cardano.org/cips/cip6/
	RequestMaxWaitTime   = 1 * time.Second
	MaxWorkers           = 16
	WebsocketMethodName  = "Query"
	WebsocketServiceName = "p2p"
	WebsocketQueryType   = "jsonwsp/request"
	WebsocketVersion     = "1.0"
)

Functions

func Fetch

func Fetch(bg context.Context, clioEndpoint string, magic int64, fetchMax int64, ipVersion int64) ([]byte, error)

func GetBlockHeight

func GetBlockHeight(url string) (*int64, error)

func Push

func Push(config *server.ClientConfig, ch chan<- Producer)

func PushBlockNo

func PushBlockNo(bg context.Context, clioEndpoint string, magic int64, port int64, blockNo int64) ([]byte, error)

func Serve

func Serve(config *server.ServerConfig, ch chan Producer)

Types

type BlockHeightResponse

type BlockHeightResponse struct {
	Result *int64 `json:"result"`
}

type FetchRequest

type FetchRequest struct {
	Magic     uint64 `validate:"min=0"`
	Max       int    `validate:"min=1,max=20"`
	IpVersion int    `validate:"min=4"`
}

type PoolIdsResponse

type PoolIdsResponse struct {
	Result []string `json:"result"`
}

type PoolMetadata

type PoolMetadata struct {
	Url  string `json:"url"`
	Hash string `json:"hash"`
}

type PoolParameters

type PoolParameters struct {
	Id            string       `json:"id"`
	Vrf           string       `json:"vrf"`
	Pledge        uint64       `json:"pledge"`
	Cost          uint64       `json:"cost"`
	Margin        string       `json:"margin"`
	RewardAccount string       `json:"rewardAccount"`
	Owners        []string     `json:"owners"`
	Relays        []PoolRelay  `json:"relays"`
	Metadata      PoolMetadata `json:"metadata"`
}

func VetPools

func VetPools(url string) ([]*PoolParameters, error)

type PoolParametersResponse

type PoolParametersResponse struct {
	Result map[string]PoolParameters `json:"result"`
}

type PoolRelay

type PoolRelay struct {
	Port     int     `json:"port"`
	Ip4      *string `json:"ipv4"`
	Ip6      *string `json:"ipv6"`
	HostName *string `json:"hostname"`
}

type Producer

type Producer struct {
	Addr    string `json:"addr"`
	Port    int    `json:"port"`
	Valency int    `json:"valency"`
}

type PullPayload

type PullPayload struct {
	ResultCode string     `json:"resultcode"`
	Date       string     `json:"datetime"`
	ClientIp   string     `json:"clientIp"`
	IpType     int        `json:"iptype"`
	Msg        string     `json:"msg"`
	Producers  []Producer `json:"Producers"`
}

type PushPayload

type PushPayload struct {
	ResultCode string `json:"resultcode"`
	Date       string `json:"datetime"`
	ClientIp   string `json:"clientIp"`
	IpType     int    `json:"iptype"`
	Msg        string `json:"msg"`
}

type Query

type Query struct {
	MethodName  string    `json:"methodname"`
	ServiceName string    `json:"servicename"`
	QueryType   string    `json:"type"`
	Version     string    `json:"version"`
	QueryArgs   QueryArgs `json:"args"`
}

type QueryArgs

type QueryArgs struct {
	Query interface{} `json:"query"`
}