ogmigo

package module
v1.2.7 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 17, 2024 License: Apache-2.0 Imports: 20 Imported by: 1

README

ogmigo

ogmigo is a go client for ogmios.

This library is under heavy development, use at your own risk.

Example

package example

import (
	"context"
	"github.com/thuannguyen2010/ogmigo"
)

func example(ctx context.Context) error {
	var callback ogmigo.ChainSyncFunc = func(ctx context.Context, data []byte) error {
		// do work
		return nil
	}

	client := ogmigo.New(ogmigo.WithEndpoint("ws://example.com:1337"))
	closer, err := client.ChainSync(ctx, callback)
	if err != nil {
		return err
	}
	if err := closer.Close(); err != nil {
		return err
	}

	return nil
}

Submodules

ogmigo imports ogmios as a submodule for testing purposes. To fetch the submodules,

git submodule update --init --recursive

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var DefaultLogger = defaultLogger{}

DefaultLogger logs via the log package

View Source 
var NopLogger = nopLogger{}

NopLogger logs nothing

Functions

func NewWrappedReadMessageError added in v0.3.5 

func NewWrappedReadMessageError(message string, originalErr error) error

Types

type ChainSync 

type ChainSync struct {
	// contains filtered or unexported fields
}

ChainSync provides control over a given ChainSync connection

func (*ChainSync) Close 

func (c *ChainSync) Close() error

Close the ChainSync connection

func (*ChainSync) Done 

func (c *ChainSync) Done() <-chan struct{}

Done indicates the ChainSync has terminated prematurely

type ChainSyncFunc 

type ChainSyncFunc func(ctx context.Context, data []byte) error

ChainSyncFunc callback containing json encoded chainsync.Response

type ChainSyncOption 

type ChainSyncOption func(opts *ChainSyncOptions)

ChainSyncOption provides functional options for ChainSync

func WithMinSlot 

func WithMinSlot(slot uint64) ChainSyncOption

WithMinSlot ignores any activity prior to the specified slot

func WithPoints 

func WithPoints(points ...chainsync.Point) ChainSyncOption

WithPoints allows starting from an optional point

func WithReconnect 

func WithReconnect(enabled bool) ChainSyncOption

WithReconnect attempt to reconnect to ogmios if connection drops

func WithStore 

func WithStore(store Store) ChainSyncOption

WithStore specifies store to persist points to; defaults to no persistence

func WithUseV6 added in v1.1.0 

func WithUseV6(useV6 bool) ChainSyncOption

WithUseV6 decides using ogmios v6 or v5 interface

type ChainSyncOptions 

type ChainSyncOptions struct {
	// contains filtered or unexported fields
}

ChainSyncOptions configuration parameters

type Client 

type Client struct {
	// contains filtered or unexported fields
}

Client provides a client for the chain sync protocol only

func New 

func New(opts ...Option) *Client

New returns a new Client

func (*Client) ChainSync 

func (c *Client) ChainSync(ctx context.Context, callback ChainSyncFunc, opts ...ChainSyncOption) (*ChainSync, error)

ChainSync replays the blockchain by invoking the callback for each block By default, ChainSync stores no checkpoints and always restarts from origin. These can be overridden via WithPoints and WithStore

func (*Client) ChainTip 

func (c *Client) ChainTip(ctx context.Context) (chainsync.Point, error)

func (*Client) CurrentEpoch 

func (c *Client) CurrentEpoch(ctx context.Context) (uint64, error)

func (*Client) CurrentProtocolParameters 

func (c *Client) CurrentProtocolParameters(ctx context.Context) (json.RawMessage, error)

func (*Client) EraStart 

func (c *Client) EraStart(ctx context.Context) (statequery.EraStart, error)

func (*Client) EvaluateTx added in v0.4.0 

func (c *Client) EvaluateTx(ctx context.Context, cborHex string) (redeemer chainsync.Redeemer, err error)

EvaluateTx evaluate the execution units of scripts present in a given transaction, without actually submitting the transaction https://ogmios.dev/mini-protocols/local-tx-submission/#evaluatetx

func (*Client) EvaluateTxV6 added in v1.0.3 

func (c *Client) EvaluateTxV6(ctx context.Context, cborHex string) (redeemer chainsync.Redeemer, err error)

EvaluateTxV6 evaluate the execution units of scripts present in a given transaction, without actually submitting the transaction https://ogmios.dev/mini-protocols/local-tx-submission/#evaluatetx

func (*Client) SubmitTx 

func (c *Client) SubmitTx(ctx context.Context, data []byte) (err error)

SubmitTx submits the transaction via ogmios https://ogmios.dev/mini-protocols/local-tx-submission/

func (*Client) SubmitTxV6 added in v1.2.5 

func (c *Client) SubmitTxV6(ctx context.Context, cborHex string) (txId string, err error)

EvaluateTxV6 evaluate the execution units of scripts present in a given transaction, without actually submitting the transaction https://ogmios.dev/mini-protocols/local-tx-submission/#evaluatetx

func (*Client) UtxosByAddress 

func (c *Client) UtxosByAddress(ctx context.Context, addresses ...string) ([]statequery.Utxo, error)

func (*Client) UtxosByTxIn 

func (c *Client) UtxosByTxIn(ctx context.Context, txIns ...chainsync.TxIn) ([]statequery.Utxo, error)

type Error 

type Error struct {
	Type        string `json:"type,omitempty"`
	Version     string `json:"version,omitempty"`
	ServiceName string `json:"servicename,omitempty"`
	Fault       Fault  `json:"fault,omitempty"`
}

Error encapsulates errors from ogmios

func (Error) Error 

func (e Error) Error() string

Error implements error interface

type EvaluateTxError added in v0.4.0 

type EvaluateTxError struct {
	// contains filtered or unexported fields
}

EvaluateTxError encapsulates the EvaluateTx errors and allows the results to be parsed

func (EvaluateTxError) Error added in v0.4.0 

func (s EvaluateTxError) Error() string

Error implements the error interface

func (EvaluateTxError) Messages added in v0.4.0 

func (s EvaluateTxError) Messages() json.RawMessage

Messages returns the raw messages from EvaluateTxError

type EvaluationResponse added in v0.4.0 

type EvaluationResponse struct {
	Type        string
	Version     string
	ServiceName string `json:"servicename"`
	MethodName  string `json:"methodname"`
	Reflection  interface{}
	Result      json.RawMessage
}

type Fault 

type Fault struct {
	Code   string `json:"code,omitempty"`   // Code identifies error
	String string `json:"string,omitempty"` // String provides human readable description
}

Fault provides additional context for ogmios errors

type KeyValue 

type KeyValue struct {
	Key   string
	Value string
}

func KV 

func KV(key, value string) KeyValue

type Logger 

type Logger interface {
	Debug(message string, kvs ...KeyValue)
	Info(message string, kvs ...KeyValue)
	Error(error error, message string, kvs ...KeyValue)
	With(kvs ...KeyValue) Logger
}

type Map 

type Map map[string]interface{}

Map provides a simple type alias

type Option 

type Option func(*Options)

Option to cardano client

func WithEndpoint 

func WithEndpoint(endpoint string) Option

WithEndpoint allows ogmios endpoint to set; defaults to ws://127.0.0.1:1337

func WithInterval 

func WithInterval(n int) Option

WithInterval specifies how frequently to save checkpoints when reading

func WithLogger 

func WithLogger(logger Logger) Option

WithLogger allows custom logger to be specified

func WithPipeline 

func WithPipeline(n int) Option

WithPipeline allows number of pipelined ogmios requests to be provided

func WithTimeout added in v0.5.0 

func WithTimeout(timeout time.Duration) Option

WithTimeout allows set timeout for handshaking

type Options 

type Options struct {
	// contains filtered or unexported fields
}

Options available to ogmios client

type Response 

type Response struct {
	Type        string
	Version     string
	ServiceName string `json:"servicename"`
	MethodName  string `json:"methodname"`
	Reflection  interface{}
	Result      json.RawMessage
}

type Store 

type Store interface {
	// Save the point; save will be called multiple times and should only
	// keep track of the most recent points
	Save(ctx context.Context, point chainsync.Point) error
	// Load saved points
	Load(ctx context.Context) (chainsync.Points, error)
}

Store allows points to be saved and retrieved to allow graceful recovery after shutdown

func NewLoggingStore 

func NewLoggingStore(logger Logger) Store

NewLoggingStore logs Save requests, but does not actually save points

type SubmitTxError 

type SubmitTxError struct {
	// contains filtered or unexported fields
}

SubmitTxError encapsulates the SubmitTx errors and allows the results to be parsed

func (SubmitTxError) Error 

func (s SubmitTxError) Error() string

Error implements the error interface

func (SubmitTxError) ErrorCodes 

func (s SubmitTxError) ErrorCodes() (keys []string, err error)

ErrorCodes the list of errors codes

func (SubmitTxError) HasErrorCode 

func (s SubmitTxError) HasErrorCode(errorCode string) bool

HasErrorCode returns true if the error contains the provided code

func (SubmitTxError) Messages 

func (s SubmitTxError) Messages() []json.RawMessage

Messages returns the raw messages from SubmitTxError

type WrappedReadMessageError added in v0.3.5 

type WrappedReadMessageError struct {
	// contains filtered or unexported fields
}

func (*WrappedReadMessageError) Error added in v0.3.5 

func (e *WrappedReadMessageError) Error() string

func (*WrappedReadMessageError) Temporary added in v0.3.5 

func (e *WrappedReadMessageError) Temporary() bool

Source Files

View all Source files

Directories

Path Synopsis
logger
zaplogger Module
ouroboros
chainsync
chainsync/num
statequery
store
badgerstore Module

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.