client

Feb 20, 2024

Changes in this version

+ type TransparentChannel struct

+ func NewTransparentChannel(c *Channel) *TransparentChannel

+ func (c *TransparentChannel) SignedState() channel.SignedState

Jul 15, 2022

Changes in this version

+ type ChannelFundingError struct

+ Err error

+ func (e ChannelFundingError) Error() string

Feb 25, 2022

Changes in this version

+ const ProposeeIdx

+ const ProposerIdx

+ type ChannelProposalRejMsg struct

+ ProposalID ProposalID

+ Reason string

+ func (ChannelProposalRejMsg) Type() wire.Type

+ func (rej *ChannelProposalRejMsg) Decode(r io.Reader) error

+ func (rej ChannelProposalRejMsg) Encode(w io.Writer) error

+ type ChannelSyncMsg struct

+ CurrentTX channel.Transaction

+ Phase channel.Phase

+ func (m *ChannelSyncMsg) Decode(r io.Reader) error

+ func (m *ChannelSyncMsg) Encode(w io.Writer) error

+ func (m *ChannelSyncMsg) ID() channel.ID

+ func (m *ChannelSyncMsg) Type() wire.Type

+ type ChannelUpdateAccMsg struct

+ ChannelID channel.ID

+ Sig wallet.Sig

+ Version uint64

+ func (*ChannelUpdateAccMsg) Type() wire.Type

+ func (c *ChannelUpdateAccMsg) Decode(r io.Reader) (err error)

+ func (c *ChannelUpdateAccMsg) ID() channel.ID

+ func (c *ChannelUpdateAccMsg) Ver() uint64

+ func (c ChannelUpdateAccMsg) Encode(w io.Writer) error

+ type ChannelUpdateMsg struct

+ Sig wallet.Sig

+ func (*ChannelUpdateMsg) Type() wire.Type

+ func (c *ChannelUpdateMsg) Base() *ChannelUpdateMsg

+ func (c *ChannelUpdateMsg) Decode(r io.Reader) (err error)

+ func (c *ChannelUpdateMsg) ID() channel.ID

+ func (c ChannelUpdateMsg) Encode(w io.Writer) error

+ type ChannelUpdateRejMsg struct

+ ChannelID channel.ID

+ Reason string

+ Version uint64

+ func (*ChannelUpdateRejMsg) Type() wire.Type

+ func (c *ChannelUpdateRejMsg) Decode(r io.Reader) (err error)

+ func (c *ChannelUpdateRejMsg) ID() channel.ID

+ func (c *ChannelUpdateRejMsg) Ver() uint64

+ func (c ChannelUpdateRejMsg) Encode(w io.Writer) error

+ type LedgerChannelProposalAccMsg struct

+ Participant wallet.Address

+ func (LedgerChannelProposalAccMsg) Type() wire.Type

+ func (acc *LedgerChannelProposalAccMsg) Base() *BaseChannelProposalAcc

+ func (acc *LedgerChannelProposalAccMsg) Decode(r io.Reader) error

+ func (acc LedgerChannelProposalAccMsg) Encode(w io.Writer) error

+ type LedgerChannelProposalMsg struct

+ Participant wallet.Address

+ Peers []wire.Address

+ func (LedgerChannelProposalMsg) Matches(acc ChannelProposalAccept) bool

+ func (LedgerChannelProposalMsg) Type() wire.Type

+ func (p *LedgerChannelProposalMsg) Decode(r io.Reader) error

+ func (p LedgerChannelProposalMsg) Accept(participant wallet.Address, nonceShare ProposalOpts) *LedgerChannelProposalAccMsg

+ func (p LedgerChannelProposalMsg) Encode(w io.Writer) error

+ func (p LedgerChannelProposalMsg) Valid() error

+ type SubChannelProposalAccMsg struct

+ func (SubChannelProposalAccMsg) Type() wire.Type

+ func (acc *SubChannelProposalAccMsg) Base() *BaseChannelProposalAcc

+ func (acc *SubChannelProposalAccMsg) Decode(r io.Reader) error

+ func (acc SubChannelProposalAccMsg) Encode(w io.Writer) error

+ type SubChannelProposalMsg struct

+ Parent channel.ID

+ func (SubChannelProposalMsg) Matches(acc ChannelProposalAccept) bool

+ func (SubChannelProposalMsg) Type() wire.Type

+ func (p *SubChannelProposalMsg) Decode(r io.Reader) error

+ func (p SubChannelProposalMsg) Accept(nonceShare ProposalOpts) *SubChannelProposalAccMsg

+ func (p SubChannelProposalMsg) Encode(w io.Writer) error

+ type VirtualChannelFundingProposalMsg struct

+ IndexMap []channel.Index

+ Initial channel.SignedState

+ func (*VirtualChannelFundingProposalMsg) Type() wire.Type

+ func (m *VirtualChannelFundingProposalMsg) Decode(r io.Reader) (err error)

+ func (m VirtualChannelFundingProposalMsg) Encode(w io.Writer) (err error)

+ type VirtualChannelProposalAccMsg struct

+ Responder wallet.Address

+ func (VirtualChannelProposalAccMsg) Type() wire.Type

+ func (acc *VirtualChannelProposalAccMsg) Base() *BaseChannelProposalAcc

+ func (acc *VirtualChannelProposalAccMsg) Decode(r io.Reader) error

+ func (acc VirtualChannelProposalAccMsg) Encode(w io.Writer) error

+ type VirtualChannelProposalMsg struct

+ IndexMaps [][]channel.Index

+ Parents []channel.ID

+ Peers []wire.Address

+ Proposer wallet.Address

+ func (VirtualChannelProposalMsg) Matches(acc ChannelProposalAccept) bool

+ func (VirtualChannelProposalMsg) Type() wire.Type

+ func (p *VirtualChannelProposalMsg) Decode(r io.Reader) error

+ func (p VirtualChannelProposalMsg) Accept(responder wallet.Address, opts ...ProposalOpts) *VirtualChannelProposalAccMsg

+ func (p VirtualChannelProposalMsg) Encode(w io.Writer) error

+ type VirtualChannelSettlementProposalMsg struct

+ Final channel.SignedState

+ func (*VirtualChannelSettlementProposalMsg) Type() wire.Type

+ func (m *VirtualChannelSettlementProposalMsg) Decode(r io.Reader) (err error)

+ func (m VirtualChannelSettlementProposalMsg) Encode(w io.Writer) (err error)

Nov 9, 2021

Changes in this version

type Channel

+ func (c *Channel) ForceUpdate(ctx context.Context, update func(*channel.State)) error

type TestChannel

+ func (c *TestChannel) Register(ctx context.Context) error

Jul 14, 2021

Changes in this version

+ func NewChainNotReachableError(actualErr error) error

+ func NewTxTimedoutError(txType, txID, actualErrMsg string) error

+ type ChainNotReachableError struct

+ func (e ChainNotReachableError) Error() string

type Channel

+ func (c *Channel) IsVirtualChannel() bool

+ type ChannelUpdateProposal interface

+ Base func() *msgChannelUpdate

+ type PeerRejectedError struct

+ ItemType string

+ Reason string

+ func (e PeerRejectedError) Error() string

+ type RequestTimedOutError string

+ func (e RequestTimedOutError) Error() string

+ type TxTimedoutError struct

+ TxID string

+ TxType string

+ func (e TxTimedoutError) Error() string

+ type VirtualChannelProposal struct

+ IndexMaps [][]channel.Index

+ Parents []channel.ID

+ Peers []wire.Address

+ Proposer wallet.Address

+ func NewVirtualChannelProposal(challengeDuration uint64, participant wallet.Address, ...) (prop *VirtualChannelProposal, err error)

+ func (VirtualChannelProposal) Matches(acc ChannelProposalAccept) bool

+ func (VirtualChannelProposal) Type() wire.Type

+ func (p *VirtualChannelProposal) Decode(r io.Reader) error

+ func (p VirtualChannelProposal) Accept(responder wallet.Address, opts ...ProposalOpts) *VirtualChannelProposalAcc

+ func (p VirtualChannelProposal) Encode(w io.Writer) error

+ type VirtualChannelProposalAcc struct

+ Responder wallet.Address

+ func (VirtualChannelProposalAcc) Type() wire.Type

+ func (acc *VirtualChannelProposalAcc) Base() *BaseChannelProposalAcc

+ func (acc *VirtualChannelProposalAcc) Decode(r io.Reader) error

+ func (acc VirtualChannelProposalAcc) Encode(w io.Writer) error

Dec 16, 2020

Changes in this version

+ type AdjudicatorEventHandler interface

+ HandleAdjudicatorEvent func(channel.AdjudicatorEvent)

type Channel

+ func (c *Channel) HasApp() bool

+ func (c *Channel) IsLedgerChannel() bool

+ func (c *Channel) ProgressBy(ctx context.Context, update func(*channel.State)) error

+ func (c *Channel) Register(ctx context.Context) error

+ func (c *Channel) SettleWithSubchannels(ctx context.Context, subStates channel.StateMap, secondary bool) error

Nov 5, 2020

Changes in this version

type BaseChannelProposal

+ FundingAgreement channel.Balances

+ func (p BaseChannelProposal) NumPeers() int

+ type BaseChannelProposalAcc struct

+ NonceShare NonceShare

+ ProposalID ProposalID

+ func (acc *BaseChannelProposalAcc) Decode(r io.Reader) error

+ func (acc BaseChannelProposalAcc) Encode(w io.Writer) error

type ChannelProposal

+ Matches func(ChannelProposalAccept) bool

+ ProposalID func() ProposalID

+ type ChannelProposalAccept interface

+ Base func() *BaseChannelProposalAcc

type LedgerChannelProposal

+ Participant wallet.Address

+ Peers []wire.Address

+ func (LedgerChannelProposal) Matches(acc ChannelProposalAccept) bool

+ func (p *LedgerChannelProposal) Decode(r io.Reader) error

+ func (p LedgerChannelProposal) Accept(participant wallet.Address, nonceShare ProposalOpts) *LedgerChannelProposalAcc

+ func (p LedgerChannelProposal) Encode(w io.Writer) error

+ func (p LedgerChannelProposal) ProposalID() (propID ProposalID)

+ func (p LedgerChannelProposal) Valid() error

+ type LedgerChannelProposalAcc struct

+ Participant wallet.Address

+ func (LedgerChannelProposalAcc) Type() wire.Type

+ func (acc *LedgerChannelProposalAcc) Base() *BaseChannelProposalAcc

+ func (acc *LedgerChannelProposalAcc) Decode(r io.Reader) error

+ func (acc LedgerChannelProposalAcc) Encode(w io.Writer) error

type ProposalOpts

+ func WithFundingAgreement(alloc channel.Balances) ProposalOpts

type SubChannelProposal

+ func (SubChannelProposal) Matches(acc ChannelProposalAccept) bool

+ func (p SubChannelProposal) Accept(nonceShare ProposalOpts) *SubChannelProposalAcc

+ func (p SubChannelProposal) ProposalID() (propID ProposalID)

+ type SubChannelProposalAcc struct

+ func (SubChannelProposalAcc) Type() wire.Type

+ func (acc *SubChannelProposalAcc) Base() *BaseChannelProposalAcc

+ func (acc *SubChannelProposalAcc) Decode(r io.Reader) error

+ func (acc SubChannelProposalAcc) Encode(w io.Writer) error

Oct 17, 2020

Changes in this version

type BaseChannelProposal

+ func (p *BaseChannelProposal) Base() *BaseChannelProposal

type Channel

+ func (c *Channel) IsSubChannel() bool

+ func (c *Channel) Parent() *Channel

type ChannelProposal

+ Base func() *BaseChannelProposal

+ type SubChannelProposal struct

+ Parent channel.ID

+ func NewSubChannelProposal(parent channel.ID, challengeDuration uint64, participantAddr wallet.Address, ...) *SubChannelProposal

+ func (SubChannelProposal) Type() wire.Type

+ func (p *SubChannelProposal) Decode(r io.Reader) (err error)

+ func (p *SubChannelProposal) Encode(w io.Writer) error

Sep 22, 2020

Changes in this version

+ type BaseChannelProposal struct

+ App channel.App

+ ChallengeDuration uint64

+ InitBals *channel.Allocation

+ InitData channel.Data

+ NonceShare NonceShare

+ ParticipantAddr wallet.Address

+ PeerAddrs []wire.Address

+ func (p *BaseChannelProposal) Decode(r io.Reader) (err error)

+ func (p *BaseChannelProposal) Encode(w io.Writer) error

+ func (p *BaseChannelProposal) NewChannelProposalAcc(participantAddr wallet.Address, nonceShare ProposalOpts) *ChannelProposalAcc

+ func (p *BaseChannelProposal) Proposal() *BaseChannelProposal

+ func (p *BaseChannelProposal) ProposalID() (propID ProposalID)

+ func (p *BaseChannelProposal) Valid() error

type Channel

+ func (c *Channel) OnUpdate(cb func(from, to *channel.State))

+ func (c *Channel) SettleSecondary(ctx context.Context) error

type ChannelProposal

+ Proposal func() *BaseChannelProposal

type ChannelProposalAcc

+ NonceShare NonceShare

+ ProposalID ProposalID

type ChannelProposalRej

+ ProposalID ProposalID

+ type LedgerChannelProposal struct

+ func NewLedgerChannelProposal(challengeDuration uint64, participantAddr wallet.Address, ...) *LedgerChannelProposal

+ func (LedgerChannelProposal) Type() wire.Type

+ type NonceShare = [32]byte

+ type OptAppAndDataDec struct

+ App *channel.App

+ Data *channel.Data

+ func (o OptAppAndDataDec) Decode(r io.Reader) (err error)

+ type OptAppAndDataEnc struct

+ func (o OptAppAndDataEnc) Encode(w io.Writer) error

+ type ProposalID = [32]byte

+ type ProposalOpts map[string]interface

+ func (o ProposalOpts) App() channel.App

+ func (o ProposalOpts) AppData() channel.Data

+ func (o ProposalOpts) SetsApp() bool

+ func WithApp(app channel.App, initData channel.Data) ProposalOpts

+ func WithNonce(share NonceShare) ProposalOpts

+ func WithNonceFrom(r io.Reader) ProposalOpts

+ func WithRandomNonce() ProposalOpts

+ func WithoutApp() ProposalOpts

Jul 23, 2020

Changes in this version

type Channel

+ func (c *Channel) Peers() []wire.Address

type Client

+ func (c *Client) Restore(ctx context.Context) error

+ func (c *Client) SetLog(l log.Logger)

type ProposalHandler

+ HandleProposal func(*ChannelProposal, *ProposalResponder)

type ProposalHandlerFunc

+ func (f ProposalHandlerFunc) HandleProposal(p *ChannelProposal, r *ProposalResponder)

type UpdateHandler

+ HandleUpdate func(ChannelUpdate, *UpdateResponder)

type UpdateHandlerFunc

+ func (f UpdateHandlerFunc) HandleUpdate(u ChannelUpdate, r *UpdateResponder)

May 29, 2020

Changes in this version

type Channel

+ func (c *Channel) Ctx() context.Context

+ func (c *Channel) IsClosed() bool

+ func (c *Channel) UpdateBy(ctx context.Context, update func(*channel.State)) (err error)

type Client

+ func (c *Client) EnablePersistence(pr persistence.PersistRestorer)

+ func (c *Client) Handle(ph ProposalHandler, uh UpdateHandler)

+ func (c *Client) OnNewChannel(handler func(*Channel))

+ func (c *Client) Reconnect(ctx context.Context) error

+ type ProposalHandlerFunc func(*ChannelProposal, *ProposalResponder)

+ func (f ProposalHandlerFunc) Handle(p *ChannelProposal, r *ProposalResponder)

+ type UpdateHandlerFunc func(ChannelUpdate, *UpdateResponder)

+ func (f UpdateHandlerFunc) Handle(u ChannelUpdate, r *UpdateResponder)

May 4, 2020

Changes in this version

type ChannelProposal

+ ParticipantAddr wallet.Address

+ func (ChannelProposal) Type() msg.Type

+ func (c *ChannelProposal) Decode(r io.Reader) (err error)

+ func (c ChannelProposal) Encode(w io.Writer) error

+ func (c ChannelProposal) SessID() (sid SessionID)

+ func (c ChannelProposal) Valid() error

type Client

+ func (c *Client) HandleChannelProposals(handler ProposalHandler)

+ func (c *Client) SetPersister(pr persistence.Persister)

Mar 23, 2020

Changes in this version

type Channel

+ func (c *Channel) Watch() error

type Client

+ func (c *Client) Channel(id channel.ID) (*Channel, error)

+ type TestChannel struct

+ func NewTestChannel(c *Channel) *TestChannel

+ func (c *TestChannel) AdjudicatorReq() channel.AdjudicatorReq

Dec 20, 2019

Changes in this version

+ type Channel struct

+ func (c *Channel) Close() error

+ func (c *Channel) ID() channel.ID

+ func (c *Channel) Idx() channel.Index

+ func (c *Channel) ListenUpdates(uh UpdateHandler)

+ func (c *Channel) Params() *channel.Params

+ func (c *Channel) Phase() channel.Phase

+ func (c *Channel) Settle(ctx context.Context) error

+ func (c *Channel) State() *channel.State

+ func (c *Channel) SubUpdates(updateSub chan<- *channel.State)

+ func (c *Channel) Update(ctx context.Context, up ChannelUpdate) (err error)

+ type ChannelMsg interface

+ ID func() channel.ID

+ type ChannelProposal struct

+ Account wallet.Account

+ AppDef wallet.Address

+ ChallengeDuration uint64

+ InitBals *channel.Allocation

+ InitData channel.Data

+ Nonce *big.Int

+ PeerAddrs []wallet.Address

+ func (c *ChannelProposal) AsReq() *ChannelProposalReq

+ type ChannelProposalAcc struct

+ ParticipantAddr wallet.Address

+ SessID SessionID

+ func (ChannelProposalAcc) Type() msg.Type

+ func (acc *ChannelProposalAcc) Decode(r io.Reader) (err error)

+ func (acc ChannelProposalAcc) Encode(w io.Writer) error

+ type ChannelProposalRej struct

+ Reason string

+ SessID SessionID

+ func (ChannelProposalRej) Type() msg.Type

+ func (rej *ChannelProposalRej) Decode(r io.Reader) error

+ func (rej ChannelProposalRej) Encode(w io.Writer) error

+ type ChannelProposalReq struct

+ AppDef wallet.Address

+ ChallengeDuration uint64

+ InitBals *channel.Allocation

+ InitData channel.Data

+ Nonce *big.Int

+ ParticipantAddr wallet.Address

+ PeerAddrs []wallet.Address

+ func (ChannelProposalReq) Type() msg.Type

+ func (c *ChannelProposalReq) AsProp(acc wallet.Account) *ChannelProposal

+ func (c *ChannelProposalReq) Decode(r io.Reader) (err error)

+ func (c ChannelProposalReq) Encode(w io.Writer) error

+ func (c ChannelProposalReq) SessID() (sid SessionID)

+ func (c ChannelProposalReq) Valid() error

+ type ChannelUpdate struct

+ ActorIdx uint16

+ State *channel.State

+ type Client struct

+ func New(id peer.Identity, dialer peer.Dialer, propHandler ProposalHandler, ...) *Client

+ func (c *Client) Close() error

+ func (c *Client) Listen(listener peer.Listener)

+ func (c *Client) Log() log.Logger

+ func (c *Client) ProposeChannel(ctx context.Context, prop *ChannelProposal) (*Channel, error)

+ type ProposalAcc struct

+ Participant wallet.Account

+ type ProposalHandler interface

+ Handle func(*ChannelProposalReq, *ProposalResponder)

+ type ProposalResponder struct

+ func (r *ProposalResponder) Accept(ctx context.Context, acc ProposalAcc) (*Channel, error)

+ func (r *ProposalResponder) Reject(ctx context.Context, reason string) error

+ type SessionID = [32]byte

+ type UpdateHandler interface

+ Handle func(ChannelUpdate, *UpdateResponder)

+ type UpdateResponder struct

+ func (r *UpdateResponder) Accept(ctx context.Context) error

+ func (r *UpdateResponder) Reject(ctx context.Context, reason string) error