channel

Feb 20, 2024

Changes in this version

+ type AppID interface

+ Equal func(AppID) bool

+ Key func() AppIDKey

+ func NewAppID() AppID

+ type AppIDKey string

+ type AppIDPredicate = func(AppID) bool

type Backend

+ NewAppID func() AppID

Feb 25, 2022

Changes in this version

+ const MinNumParts

+ func AssertAssetsEqual(a []Asset, b []Asset) error

type ActionApp

+ NewAction func() Action

type ActionMachine

+ func (m ActionMachine) ValidTransition(to *State) error

type App

+ NewData func() Data

type Asset

+ func NewAsset() Asset

+ Equal func(Asset) bool

type Backend

+ NewAsset func() Asset

type MockApp

+ func (a MockApp) NewAction() Action

+ func (a MockApp) NewData() Data

type MockOp

+ func (o *MockOp) UnmarshalBinary(data []byte) error

+ func (o MockOp) MarshalBinary() ([]byte, error)

+ type OptAppAndDataDec struct

+ App *App

+ Data *Data

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

+ type OptAppAndDataEnc struct

+ App App

+ Data Data

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

type StateMachine

+ func (m StateMachine) ValidTransition(to *State) error

Nov 9, 2021

Changes in this version

type Allocation

+ func NewAllocation(numParts int, assets ...Asset) *Allocation

+ func (a *Allocation) AddToBalance(part Index, asset Asset, val Bal)

+ func (a *Allocation) AssetIndex(asset Asset) (Index, bool)

+ func (a *Allocation) Balance(part Index, asset Asset) Bal

+ func (a *Allocation) SetAssetBalances(asset Asset, val []Bal)

+ func (a *Allocation) SetBalance(part Index, asset Asset, val Bal)

+ func (a *Allocation) SubFromBalance(part Index, asset Asset, val Bal)

+ func (a *Allocation) TransferBalance(from, to Index, asset Asset, val Bal)

type Balances

+ func MakeBalances(numAssets, numParticipants int) Balances

+ type EventSubscriber interface

+ Subscribe func(context.Context, ID) (AdjudicatorSubscription, error)

type Index

+ func (i *Index) Decode(r stdio.Reader) error

+ func (i Index) Encode(w stdio.Writer) error

+ type Progresser interface

+ Progress func(context.Context, ProgressReq) error

+ type RegisterSubscriber interface

+ type Registerer interface

+ Register func(context.Context, AdjudicatorReq, []SignedState) error

+ type Withdrawer interface

+ Withdraw func(context.Context, AdjudicatorReq, StateMap) error

Jul 14, 2021

Changes in this version

type ConcludedEvent

+ func NewConcludedEvent(id ID, timeout Timeout, version uint64) *ConcludedEvent

type Index

+ func CloneIndexMap(orig []Index) (clone []Index)

type Params

+ LedgerChannel bool

+ VirtualChannel bool

type RegisteredEvent

+ Sigs []wallet.Sig

+ State *State

+ type SignedState struct

+ Params *Params

+ Sigs []wallet.Sig

+ State *State

type StateMachine

+ func (m *StateMachine) ForceUpdate(stagingState *State, actor Index) error

type SubAlloc

+ IndexMap []Index

Dec 16, 2020

Changes in this version

type ActionMachine

+ func (m ActionMachine) IsRegistered() bool

+ func (m ActionMachine) SetProgressed(e *ProgressedEvent) error

+ func (m ActionMachine) SetProgressing(state *State) error

type Adjudicator

+ Progress func(context.Context, ProgressReq) error

+ Subscribe func(context.Context, *Params) (AdjudicatorSubscription, error)

+ type AdjudicatorEvent interface

+ ID func() ID

+ Timeout func() Timeout

+ Version func() uint64

+ type AdjudicatorEventBase struct

+ IDV ID

+ TimeoutV Timeout

+ VersionV uint64

+ func NewAdjudicatorEventBase(c ID, t Timeout, v uint64) *AdjudicatorEventBase

+ func (b AdjudicatorEventBase) ID() ID

+ func (b AdjudicatorEventBase) Timeout() Timeout

+ func (b AdjudicatorEventBase) Version() uint64

+ type AdjudicatorSubscription interface

+ Close func() error

+ Err func() error

+ Next func() AdjudicatorEvent

+ type ConcludedEvent struct

type Phase

+ const LastPhase

+ const Progressed

+ const Progressing

+ type ProgressReq struct

+ NewState *State

+ Sig wallet.Sig

+ func NewProgressReq(ar AdjudicatorReq, newState *State, sig wallet.Sig) *ProgressReq

+ type ProgressedEvent struct

+ Idx Index

+ State *State

+ func NewProgressedEvent(id ID, timeout Timeout, state *State, idx Index) *ProgressedEvent

type RegisteredEvent

+ func NewRegisteredEvent(id ID, timeout Timeout, version uint64) *RegisteredEvent

type State

+ func (s *State) ToSubAlloc() *SubAlloc

type StateMachine

+ func (m StateMachine) IsRegistered() bool

+ func (m StateMachine) SetProgressed(e *ProgressedEvent) error

+ func (m StateMachine) SetProgressing(state *State) error

+ type StateMap map[ID]*State

+ func MakeStateMap() StateMap

+ func (m StateMap) Add(states ...*State)

Nov 5, 2020

Changes in this version

type Balances

+ func (b *Balances) Decode(r io.Reader) error

type FundingReq

+ Agreement Balances

+ func NewFundingReq(params *Params, state *State, idx Index, agreement Balances) *FundingReq

Oct 17, 2020

Changes in this version

+ var MaxBalance = new(big.Int).Sub(new(big.Int).Lsh(big.NewInt(1), 256), big.NewInt(1))

+ func AppShouldEqual(expected, actual App) error

+ func AssetsAssertEqual(a []Asset, b []Asset) error

+ func RegisterApp(app App)

+ func RegisterAppResolver(pred wallet.AddressPredicate, appRes AppResolver)

+ func RegisterDefaultApp(appRes AppResolver)

+ func SubAllocsAssertEqual(a []SubAlloc, b []SubAlloc) error

+ func SubAllocsEqual(a []SubAlloc, b []SubAlloc) bool

type Allocation

+ func (a *Allocation) AddSubAlloc(subAlloc SubAlloc)

+ func (a *Allocation) RemoveSubAlloc(subAlloc SubAlloc) error

+ func (a Allocation) SubAlloc(subchannel ID) (subAlloc SubAlloc, ok bool)

type App

+ func Resolve(def wallet.Address) (App, error)

+ type AppResolver interface

+ Resolve func(wallet.Address) (App, error)

+ type Balances [][]Bal

+ func (b *Balances) Decoder(numAssets, numParts Index) perunio.Decoder

+ func (b Balances) Add(a Balances) Balances

+ func (b Balances) AssertEqual(bals Balances) error

+ func (b Balances) AssertGreaterOrEqual(bals Balances) error

+ func (b Balances) Clone() Balances

+ func (b Balances) Encode(w io.Writer) error

+ func (b Balances) Equal(bals Balances) bool

+ func (b Balances) Sub(a Balances) Balances

+ func (b Balances) Sum() []Bal

+ type MockAppResolver struct

+ func (m *MockAppResolver) Resolve(addr wallet.Address) (App, error)

type SubAlloc

+ func NewSubAlloc(id ID, bals []Bal) *SubAlloc

+ func (s *SubAlloc) BalancesEqual(b []Bal) bool

Sep 22, 2020

Changes in this version

+ const MaxNonceLen

+ func IsNoApp(a App) bool

+ func IsNoData(d Data) bool

+ func ValidateProposalParameters(challengeDuration uint64, numParts int, app App) error

type AdjudicatorReq

+ Secondary bool

type App

+ func NoApp() App

type Data

+ func NoData() Data

+ type Nonce = *big.Int

+ func NonceFromBytes(b []byte) Nonce

+ type OptAppDec struct

+ App *App

+ func (d OptAppDec) Decode(r io.Reader) (err error)

+ type OptAppEnc struct

+ func (e OptAppEnc) Encode(w io.Writer) error

Jul 23, 2020

Changes in this version

type FundingReq

+ State *State

May 29, 2020

Changes in this version

type Allocation

+ func (a *Allocation) Equal(b *Allocation) error

type Params

+ func (p *Params) Decode(r stdio.Reader) error

+ func (p *Params) Encode(w stdio.Writer) error

type Phase

+ func (p *Phase) Decode(r stdio.Reader) error

+ func (p Phase) Encode(w stdio.Writer) error

+ type Source interface

+ CurrentTX func() Transaction

+ ID func() ID

+ Idx func() Index

+ Params func() *Params

+ Phase func() Phase

+ StagingTX func() Transaction

type State

+ func (s *State) Equal(t *State) error

type StateMachine

+ func RestoreStateMachine(acc wallet.Account, source Source) (*StateMachine, error)

type SubAlloc

+ func (s *SubAlloc) Equal(t *SubAlloc) error

May 4, 2020

Changes in this version

type ActionMachine

+ func (m *ActionMachine) Clone() *ActionMachine

+ func (m ActionMachine) CurrentTX() Transaction

+ func (m ActionMachine) StagingTX() Transaction

type Allocation

+ Balances [][]Bal

+ func (a *Allocation) NumParts() int

type Params

+ func (p *Params) Clone() *Params

type StateMachine

+ func (m *StateMachine) Clone() *StateMachine

+ func (m StateMachine) CurrentTX() Transaction

+ func (m StateMachine) StagingTX() Transaction

type Transaction

+ func (t *Transaction) Decode(r io.Reader) error

+ func (t Transaction) Clone() Transaction

+ func (t Transaction) Encode(w io.Writer) error

Mar 23, 2020

Changes in this version

+ func IsAssetFundingError(err error) bool

+ func IsFundingTimeoutError(err error) bool

+ func NewFundingTimeoutError(fundingErrs []*AssetFundingError) error

type ActionMachine

+ func (m ActionMachine) AdjudicatorReq() AdjudicatorReq

+ func (m ActionMachine) Registered() *RegisteredEvent

+ func (m ActionMachine) SetRegistered(reg *RegisteredEvent) error

+ func (m ActionMachine) SetRegistering() error

+ func (m ActionMachine) SetWithdrawing() error

+ func (m ActionMachine) SetWithdrawn() error

+ type Adjudicator interface

+ Register func(context.Context, AdjudicatorReq) (*RegisteredEvent, error)

+ SubscribeRegistered func(context.Context, *Params) (RegisteredSubscription, error)

+ Withdraw func(context.Context, AdjudicatorReq) error

+ type AdjudicatorReq struct

+ Acc wallet.Account

+ Idx Index

+ Params *Params

+ Tx Transaction

+ type AssetFundingError struct

+ Asset int

+ TimedOutPeers []Index

+ func (e AssetFundingError) Error() string

type Backend

+ CalcID func(*Params) ID

+ type ElapsedTimeout struct

+ func (t *ElapsedTimeout) IsElapsed() bool

+ func (t *ElapsedTimeout) String() string

+ func (t *ElapsedTimeout) Wait(context.Context) error

+ type FundingTimeoutError struct

+ Errors []*AssetFundingError

+ func (e FundingTimeoutError) Error() string

type ID

+ func CalcID(p *Params) ID

type Phase

+ const Registered

+ const Registering

+ const Withdrawing

+ const Withdrawn

+ type RegisteredEvent struct

+ ID ID

+ Timeout Timeout

+ Version uint64

+ type RegisteredSubscription interface

+ Close func() error

+ Err func() error

+ Next func() *RegisteredEvent

type StateMachine

+ func (m StateMachine) AdjudicatorReq() AdjudicatorReq

+ func (m StateMachine) Registered() *RegisteredEvent

+ func (m StateMachine) SetRegistered(reg *RegisteredEvent) error

+ func (m StateMachine) SetRegistering() error

+ func (m StateMachine) SetWithdrawing() error

+ func (m StateMachine) SetWithdrawn() error

+ type TimeTimeout struct

+ func (t *TimeTimeout) IsElapsed() bool

+ func (t *TimeTimeout) String() string

+ func (t *TimeTimeout) Wait(ctx context.Context) error

+ type Timeout interface

+ IsElapsed func() bool

+ Wait func(context.Context) error

Dec 20, 2019

Changes in this version

+ const IDLen

+ const MaxNumAssets

+ const MaxNumParts

+ const MaxNumSubAllocations

+ func IsActionApp(app App) bool

+ func IsActionError(err error) bool

+ func IsAlreadySettledError(err error) bool

+ func IsPeerTimedOutFundingError(err error) bool

+ func IsPhaseTransitionError(err error) bool

+ func IsStateApp(app App) bool

+ func IsStateTransitionError(err error) bool

+ func NewActionError(id ID, msg string) error

+ func NewAlreadySettledError(idx Index, version uint64) error

+ func NewPeerTimedOutFundingError(idx Index) error

+ func NewStateTransitionError(id ID, msg string) error

+ func SetAppBackend(b AppBackend)

+ func SetBackend(b Backend)

+ func SetBackendTest(t *testing.T)

+ func Sign(a wallet.Account, p *Params, s *State) (wallet.Sig, error)

+ func ValidateParameters(challengeDuration uint64, numParts int, appDef wallet.Address, nonce *big.Int) error

+ func Verify(addr wallet.Address, params *Params, state *State, sig wallet.Sig) (bool, error)

+ type Action = perunio.Encoder

+ type ActionApp interface

+ ApplyActions func(*Params, *State, []Action) (*State, error)

+ DecodeAction func(io.Reader) (Action, error)

+ InitState func(*Params, []Action) (Allocation, Data, error)

+ ValidAction func(*Params, *State, Index, Action) error

+ type ActionError struct

+ ID ID

+ func (e *ActionError) Error() string

+ type ActionMachine struct

+ func NewActionMachine(acc wallet.Account, params Params) (*ActionMachine, error)

+ func (m *ActionMachine) AddAction(idx Index, a Action) error

+ func (m *ActionMachine) Init() error

+ func (m *ActionMachine) Update() error

+ func (m ActionMachine) Account() wallet.Account

+ func (m ActionMachine) AddSig(idx Index, sig wallet.Sig) error

+ func (m ActionMachine) DiscardUpdate() error

+ func (m ActionMachine) EnableFinal() error

+ func (m ActionMachine) EnableInit() error

+ func (m ActionMachine) EnableUpdate() error

+ func (m ActionMachine) ID() ID

+ func (m ActionMachine) Idx() Index

+ func (m ActionMachine) N() Index

+ func (m ActionMachine) Params() *Params

+ func (m ActionMachine) Phase() Phase

+ func (m ActionMachine) SetFunded() error

+ func (m ActionMachine) SetSettled() error

+ func (m ActionMachine) SettleReq() SettleReq

+ func (m ActionMachine) Sig() (sig wallet.Sig, err error)

+ func (m ActionMachine) StagingState() *State

+ func (m ActionMachine) State() *State

+ func (m ActionMachine) Subscribe(phase Phase, who string, sub chan<- PhaseTransition)

+ type Allocation struct

+ Assets []Asset

+ Locked []SubAlloc

+ OfParts [][]Bal

+ func (a *Allocation) Decode(r io.Reader) error

+ func (a Allocation) Clone() (clone Allocation)

+ func (a Allocation) Encode(w io.Writer) error

+ func (a Allocation) Sum() []Bal

+ func (a Allocation) Valid() error

+ type AlreadySettledError struct

+ PeerIdx Index

+ Version uint64

+ func (e AlreadySettledError) Error() string

+ type App interface

+ DecodeData func(io.Reader) (Data, error)

+ Def func() wallet.Address

+ func AppFromDefinition(def wallet.Address) (App, error)

+ type AppBackend interface

+ AppFromDefinition func(wallet.Address) (App, error)

+ type Asset = perunio.Encoder

+ func DecodeAsset(r io.Reader) (Asset, error)

+ type Backend interface

+ ChannelID func(*Params) ID

+ DecodeAsset func(io.Reader) (Asset, error)

+ Sign func(wallet.Account, *Params, *State) (wallet.Sig, error)

+ Verify func(addr wallet.Address, params *Params, state *State, sig wallet.Sig) (bool, error)

+ type Bal = *big.Int

+ func CloneBals(orig []Bal) []Bal

+ type Data interface

+ Clone func() Data

+ type Funder interface

+ Fund func(context.Context, FundingReq) error

+ type FundingReq struct

+ Allocation *Allocation

+ Idx Index

+ Params *Params

+ type ID = [IDLen]byte

+ var Zero ID = ID{}

+ func ChannelID(p *Params) ID

+ type Index = uint16

+ type MockApp struct

+ func NewMockApp(definition perun.Address) *MockApp

+ func (a MockApp) ApplyActions(params *Params, state *State, acts []Action) (*State, error)

+ func (a MockApp) DecodeAction(r io.Reader) (Action, error)

+ func (a MockApp) DecodeData(r io.Reader) (Data, error)

+ func (a MockApp) Def() perun.Address

+ func (a MockApp) InitState(params *Params, rawActs []Action) (Allocation, Data, error)

+ func (a MockApp) ValidAction(params *Params, state *State, part Index, act Action) error

+ func (a MockApp) ValidInit(params *Params, state *State) error

+ func (a MockApp) ValidTransition(params *Params, from, to *State, actor Index) error

+ type MockAppBackend struct

+ func (MockAppBackend) AppFromDefinition(addr wallet.Address) (App, error)

+ type MockOp uint64

+ const OpActionErr

+ const OpErr

+ const OpPanic

+ const OpTransitionErr

+ const OpValid

+ func NewMockOp(op MockOp) *MockOp

+ func (o *MockOp) Decode(r io.Reader) error

+ func (o MockOp) Clone() Data

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

+ type Params struct

+ App App

+ ChallengeDuration uint64

+ Nonce *big.Int

+ Parts []wallet.Address

+ func NewParams(challengeDuration uint64, parts []wallet.Address, appDef wallet.Address, ...) (*Params, error)

+ func NewParamsUnsafe(challengeDuration uint64, parts []wallet.Address, appDef wallet.Address, ...) *Params

+ func (p *Params) ID() ID

+ type PeerTimedOutFundingError struct

+ TimedOutPeerIdx Index

+ func (e PeerTimedOutFundingError) Error() string

+ type Phase uint8

+ const Acting

+ const Final

+ const Funding

+ const InitActing

+ const InitSigning

+ const Settled

+ const Signing

+ func (p Phase) String() string

+ type PhaseTransition struct

+ From Phase

+ To Phase

+ func (t PhaseTransition) String() string

+ type PhaseTransitionError struct

+ ID ID

+ func (e *PhaseTransitionError) Error() string

+ type SettleReq struct

+ Idx Index

+ Params *Params

+ Tx Transaction

+ type Settler interface

+ Settle func(context.Context, SettleReq, wallet.Account) error

+ type State struct

+ App App

+ Data Data

+ ID ID

+ IsFinal bool

+ Version uint64

+ func (s *State) Clone() *State

+ func (s *State) Decode(r io.Reader) error

+ func (s State) Encode(w io.Writer) error

+ type StateApp interface

+ ValidInit func(*Params, *State) error

+ ValidTransition func(parameters *Params, from, to *State, actor Index) error

+ type StateMachine struct

+ func NewStateMachine(acc wallet.Account, params Params) (*StateMachine, error)

+ func (m *StateMachine) CheckUpdate(state *State, actor Index, sig wallet.Sig, sigIdx Index) error

+ func (m *StateMachine) Init(initBals Allocation, initData Data) error

+ func (m *StateMachine) Update(stagingState *State, actor Index) error

+ func (m StateMachine) Account() wallet.Account

+ func (m StateMachine) AddSig(idx Index, sig wallet.Sig) error

+ func (m StateMachine) DiscardUpdate() error

+ func (m StateMachine) EnableFinal() error

+ func (m StateMachine) EnableInit() error

+ func (m StateMachine) EnableUpdate() error

+ func (m StateMachine) ID() ID

+ func (m StateMachine) Idx() Index

+ func (m StateMachine) N() Index

+ func (m StateMachine) Params() *Params

+ func (m StateMachine) Phase() Phase

+ func (m StateMachine) SetFunded() error

+ func (m StateMachine) SetSettled() error

+ func (m StateMachine) SettleReq() SettleReq

+ func (m StateMachine) Sig() (sig wallet.Sig, err error)

+ func (m StateMachine) StagingState() *State

+ func (m StateMachine) State() *State

+ func (m StateMachine) Subscribe(phase Phase, who string, sub chan<- PhaseTransition)

+ type StateTransitionError struct

+ ID ID

+ func (e *StateTransitionError) Error() string

+ type SubAlloc struct

+ Bals []Bal

+ ID ID

+ func (s *SubAlloc) Decode(r io.Reader) error

+ func (s SubAlloc) Encode(w io.Writer) error

+ func (s SubAlloc) Valid() error

+ type Transaction struct

+ Sigs []wallet.Sig