client

Documentation

Index

• type Connection
  • func NewConnection(id ucan.Principal, channel transport.Channel, options ...Option) (Connection, error)
• type ExecutionResponse
  • func Execute(invocations []invocation.Invocation, conn Connection) (ExecutionResponse, error)
• type Option
  • func WithHasher(hasher func() hash.Hash) Option
  • func WithOutboundCodec(codec transport.OutboundCodec) Option

Types

type Connection

type Connection interface {
	ID() ucan.Principal
	Channel() transport.Channel
	Codec() transport.OutboundCodec
	Hasher() hash.Hash
}

func NewConnection

func NewConnection(id ucan.Principal, channel transport.Channel, options ...Option) (Connection, error)

type ExecutionResponse

type ExecutionResponse interface {
	// Blocks returns an iterator of all the IPLD blocks that are included in
	// the response.
	Blocks() iter.Seq2[block.Block, error]
	// Get returns a link to a receipt, given an invocation link.
	Get(inv ucan.Link) (ucan.Link, bool)
}

func Execute

func Execute(invocations []invocation.Invocation, conn Connection) (ExecutionResponse, error)

type Option

type Option func(cfg *connConfig) error

Option is an option configuring a ucanto connection.

func WithHasher

func WithHasher(hasher func() hash.Hash) Option

WithHasher configures the hasher factory.

func WithOutboundCodec

func WithOutboundCodec(codec transport.OutboundCodec) Option

WithOutboundCodec configures the codec used to encode requests and decode responses.