perun

package module

Go to main page

Versions in this module

v0

v0.6.2

Dec 22, 2021

v0.6.1

Aug 13, 2021

v0.6.0

Jul 8, 2021

Changes in this version

+ func APIErrAsMap(method string, err APIError) map[string]interface

type APIError

+ func NewAPIErr(category ErrorCategory, code ErrorCode, err error, addInfo interface{}) APIError

+ func NewAPIErrChainNotReachable(err error, chainURL string) APIError

+ func NewAPIErrFailedPreCondition(err error) APIError

+ func NewAPIErrFailedPreConditionUnclosedChs(err error, chs []ChInfo) APIError

+ func NewAPIErrInvalidArgument(err error, name ArgumentName, value string) APIError

+ func NewAPIErrInvalidConfig(err error, name, value string) APIError

+ func NewAPIErrInvalidContracts(contractErrInfos ...ContractErrInfo) APIError

+ func NewAPIErrPeerNotFunded(err error, peerAlias string) APIError

+ func NewAPIErrPeerRejected(err error, peerAlias, reason string) APIError

+ func NewAPIErrPeerRequestTimedOut(err error, peerAlias, timeout string) APIError

+ func NewAPIErrResourceExists(resourceType ResourceType, resourceID string) APIError

+ func NewAPIErrResourceNotFound(resourceType ResourceType, resourceID string) APIError

+ func NewAPIErrTxTimedOut(err error, txType, txID, txTimeout string) APIError

+ func NewAPIErrUnknownInternal(err error) APIError

+ func NewAPIErrUserResponseTimedOut(expiry, receivedAt int64) APIError

+ AddInfo func() interface{}

+ Category func() ErrorCategory

+ Code func() ErrorCode

+ Message func() string

+ type ArgumentName string

type BalInfo

+ Currencies []string

type ChainBackend

+ DeployAssetERC20 func(adjudicator, tokenERC20, txSender pwallet.Address) (pwallet.Address, error)

+ DeployAssetETH func(adjudicator, txSender pwallet.Address) (pwallet.Address, error)

+ DeployPerunToken func(initAccs []pwallet.Address, initBal *big.Int, txSender pwallet.Address) (pwallet.Address, error)

+ type ContractErrInfo struct

+ Address string

+ Error string

+ Name string

+ type ContractRegistry interface

+ RegisterAssetERC20 func(token, asset pwallet.Address) (symbol string, maxDecimals uint8, _ error)

type Currency

+ Symbol func() string

+ type CurrencyRegistry interface

+ Register func(symbol string, maxDecimals uint8) (Currency, error)

+ type ErrInfoChainNotReachable struct

+ ChainURL string

+ type ErrInfoFailedPreCondUnclosedChs struct

+ ChInfos []ChInfo

+ type ErrInfoInvalidArgument struct

+ Name string

+ Requirement string

+ Value string

+ type ErrInfoInvalidConfig struct

+ Name string

+ Value string

+ type ErrInfoInvalidContracts struct

+ ContractErrInfos []ContractErrInfo

+ type ErrInfoPeerNotFunded struct

+ PeerAlias string

+ type ErrInfoPeerRejected struct

+ PeerAlias string

+ Reason string

+ type ErrInfoPeerRequestTimedOut struct

+ PeerAlias string

+ Timeout string

+ type ErrInfoResourceExists struct

+ ID string

+ Type string

+ type ErrInfoResourceNotFound struct

+ ID string

+ Type string

+ type ErrInfoTxTimedOut struct

+ TxID string

+ TxTimeout string

+ TxType string

+ type ErrInfoUserResponseTimedOut struct

+ Expiry int64

+ ReceivedAt int64

+ type ErrorCategory int

+ const ClientError

+ const InternalError

+ const ParticipantError

+ const ProtocolFatalError

+ func (c ErrorCategory) String() string

+ type ErrorCode int

+ const ErrChainNotReachable

+ const ErrFailedPreCondition

+ const ErrInvalidArgument

+ const ErrInvalidContracts

+ const ErrPeerNotFunded

+ const ErrPeerRequestTimedOut

+ const ErrResourceExists

+ const ErrResourceNotFound

+ const ErrTxTimedOut

+ const ErrUnknownInternal

+ const ErrUserResponseTimedOut

+ type Funder interface

+ IsAssetRegistered func(asset pwallet.Address) bool

+ RegisterAssetERC20 func(asset, token, acc pwallet.Address) bool

type NodeAPI

+ RegisterCurrency func(tokenAddr, assetAddr string) (symbol string, _ APIError)

type NodeConfig

+ AssetERC20s map[string]string

+ AssetETH string

+ ChainID int

+ type ROChainBackend interface

+ ERC20Info func(token pwallet.Address) (symbol string, decimal uint8, _ error)

+ ValidateAdjudicator func(adjudicator pwallet.Address) error

+ ValidateAssetERC20 func(adjudicator, tokenERC20, assetERC20 pwallet.Address) (symbol string, maxDecimals uint8, _ error)

+ ValidateAssetETH func(adjudicator, assetETH pwallet.Address) error

+ type ROContractRegistry interface

+ Adjudicator func() pwallet.Address

+ Asset func(symbol string) (asset pwallet.Address, found bool)

+ AssetETH func() pwallet.Address

+ Assets func() map[string]string

+ Symbol func(asset pwallet.Address) (symbol string, found bool)

+ Token func(symbol string) (token pwallet.Address, found bool)

+ type ROCurrencyRegistry interface

+ Currency func(symbol string) Currency

+ IsRegistered func(symbol string) bool

+ Symbols func() []string

+ type ResourceType string

type SessionAPI

+ DeployAssetERC20 func(tokenERC20 string) (asset string, _ APIError)

v0.5.0

Dec 18, 2020

Changes in this version

+ var ErrUnsupportedIDProviderType = APIError("ID Provider type not supported by this node instance")

+ type Channel interface

+ Close func() error

+ ID func() pchannel.ID

+ Idx func() pchannel.Index

+ IsClosed func() bool

+ OnUpdate func(cb func(from, to *pchannel.State))

+ Params func() *pchannel.Params

+ Peers func() []pwire.Address

+ Phase func() pchannel.Phase

+ Settle func(ctx context.Context) error

+ SettleSecondary func(ctx context.Context) error

+ State func() *pchannel.State

+ UpdateBy func(ctx context.Context, update func(*pchannel.State)) error

+ Watch func() error

+ type IDProvider interface

+ Delete func(alias string) error

+ UpdateStorage func() error

+ Write func(alias string, p PeerID) error

+ type IDReader interface

+ ReadByAlias func(alias string) (p PeerID, contains bool)

+ ReadByOffChainAddr func(offChainAddr pwire.Address) (p PeerID, contains bool)

type NodeConfig

+ IDProviderTypes []string

+ type PeerID struct

+ Alias string

+ CommAddr string

+ CommType string

+ OffChainAddr pwire.Address

+ OffChainAddrString string

type SessionAPI

+ AddPeerID func(PeerID) error

+ GetPeerID func(alias string) (PeerID, error)

v0.4.0

Oct 16, 2020

Changes in this version

+ var ErrOpenCh = APIError("Session cannot be closed (without force option) as there are open channels")

+ var ErrSessionClosed = APIError("Session is closed")

+ var ErrUnknownChID = APIError("No channel corresponding to the specified ID")

type BalInfo

+ Bal []string

+ Parts []string

+ type ChAPI interface

+ ChallengeDurSecs func() uint64

+ Close func(context.Context) (ChInfo, error)

+ Currency func() string

+ GetChInfo func() ChInfo

+ ID func() string

+ Parts func() []string

+ RespondChUpdate func(context.Context, string, bool) (ChInfo, error)

+ SendChUpdate func(context.Context, StateUpdater) (ChInfo, error)

+ SubChUpdates func(ChUpdateNotifier) error

+ UnsubChUpdates func() error

+ type ChClient interface

+ Channel func(pchannel.ID) (*pclient.Channel, error)

+ Close func() error

+ EnablePersistence func(ppersistence.PersistRestorer)

+ Handle func(pclient.ProposalHandler, pclient.UpdateHandler)

+ Log func() pLog.Logger

+ OnNewChannel func(handler func(*pclient.Channel))

+ ProposeChannel func(context.Context, pclient.ChannelProposal) (*pclient.Channel, error)

+ Restore func(context.Context) error

+ RestoreChs func(func(*pclient.Channel)) error

type ChCloseNotif

+ ClosedChInfo ChInfo

+ type ChInfo struct

+ App App

+ BalInfo BalInfo

+ ChID string

+ Version string

type ChProposalNotif

+ App App

+ ChallengeDurSecs uint64

+ OpeningBalInfo BalInfo

type ChUpdateNotif

+ CurrChInfo ChInfo

+ Error string

+ ProposedChInfo ChInfo

+ Type ChUpdateType

+ type ChUpdateType uint8

+ const ChUpdateTypeClosed

+ const ChUpdateTypeFinal

+ const ChUpdateTypeOpen

type NodeConfig

+ CurrencyInterpreters []string

type Session

+ ChClient ChClient

type SessionAPI

+ Close func(force bool) ([]ChInfo, error)

+ GetChsInfo func() []ChInfo

v0.3.0

Aug 26, 2020

Changes in this version

+ const OwnAlias

+ var ErrChClosed = APIError("Channel is closed.")

+ var ErrChFinalized = APIError("Channel is finalized.")

+ var ErrInsufficientBal = APIError("Insufficient balance in sender account.")

+ var ErrInternalServer = APIError("Internal Server Error")

+ var ErrInvalidAmount = APIError("Invalid amount string")

+ var ErrInvalidConfig = APIError("Invalid configuration detected.")

+ var ErrInvalidOffChainAddr = APIError("Invalid off-chain address string.")

+ var ErrInvalidPayee = APIError("Invalid payee, no such participant in the channel.")

+ var ErrMissingBalance = APIError("Missing balance")

+ var ErrNoActiveSub = APIError("No active subscription was found.")

+ var ErrPeerAliasInUse = APIError("Alias already used by another peer in the contacts.")

+ var ErrPeerExists = APIError("Peer already available in the contacts provider.")

+ var ErrPeerRejected = APIError("The request was rejected by the peer.")

+ var ErrRespTimeoutExpired = APIError("Response to the notification was sent after the timeout has expired.")

+ var ErrSubAlreadyExists = APIError("A subscription for this context already exists.")

+ var ErrUnclosedCh = APIError(...)

+ var ErrUnknownAlias = APIError("No peer corresponding to the specified ID was found in contacts.")

+ var ErrUnknownChannelID = APIError("No channel corresponding to the specified ID.")

+ var ErrUnknownProposalID = APIError("No channel proposal corresponding to the specified ID.")

+ var ErrUnknownSessionID = APIError("No session corresponding to the specified ID.")

+ var ErrUnknownUpdateID = APIError("No response was expected for the given channel update ID")

+ var ErrUnsupportedCommType = APIError("Communication protocol not supported by this node instance.")

+ var ErrUnsupportedContactsType = APIError("Contacts type not supported by this node instance.")

+ var ErrUnsupportedCurrency = APIError("Currency not supported by this node instance.")

+ func GetAPIError(err error) error

+ type APIError string

+ func (e APIError) Error() string

+ type App struct

+ Data pchannel.Data

+ Def pwallet.Address

+ type BalInfo struct

+ Bals map[string]string

+ Currency string

+ type ChCloseNotif struct

+ ChState *pchannel.State

+ ChannelID string

+ Currency string

+ Error string

+ Parts []string

+ type ChCloseNotifier func(ChCloseNotif)

+ type ChProposalNotif struct

+ Currency string

+ Expiry int64

+ Parts []string

+ Proposal *pclient.ChannelProposal

+ ProposalID string

+ type ChProposalNotifier func(ChProposalNotif)

+ type ChUpdateNotif struct

+ CurrState *pchannel.State

+ Currency string

+ Expiry int64

+ Parts []string

+ Update *pclient.ChannelUpdate

+ UpdateID string

+ type ChUpdateNotifier func(ChUpdateNotif)

+ type ChainBackend interface

+ DeployAdjudicator func() (adjAddr pwallet.Address, _ error)

+ DeployAsset func(adjAddr pwallet.Address) (assetAddr pwallet.Address, _ error)

+ NewAdjudicator func(adjAddr, receiverAddr pwallet.Address) pchannel.Adjudicator

+ NewFunder func(assetAddr pwallet.Address) pchannel.Funder

+ ValidateContracts func(adjAddr, assetAddr pwallet.Address) error

+ type ChannelAPI interface

+ Close func(context.Context) (ChannelInfo, error)

+ GetInfo func() ChannelInfo

+ ID func() string

+ RespondChUpdate func(context.Context, string, bool) error

+ SendChUpdate func(context.Context, StateUpdater) error

+ SubChUpdates func(ChUpdateNotifier) error

+ UnsubChUpdates func() error

+ type ChannelClient interface

+ Channel func(pchannel.ID) (*pclient.Channel, error)

+ Close func() error

+ EnablePersistence func(ppersistence.PersistRestorer)

+ Handle func(pclient.ProposalHandler, pclient.UpdateHandler)

+ Log func() pLog.Logger

+ OnNewChannel func(handler func(*pclient.Channel))

+ ProposeChannel func(context.Context, *pclient.ChannelProposal) (*pclient.Channel, error)

+ Restore func(context.Context) error

+ type ChannelInfo struct

+ ChannelID string

+ Currency string

+ Parts []string

+ State *pchannel.State

+ type CommBackend interface

+ NewDialer func() Dialer

+ NewListener func(address string) (pnet.Listener, error)

+ type Contacts interface

+ Delete func(alias string) error

+ UpdateStorage func() error

+ Write func(alias string, p Peer) error

+ type ContactsReader interface

+ ReadByAlias func(alias string) (p Peer, contains bool)

+ ReadByOffChainAddr func(offChainAddr pwire.Address) (p Peer, contains bool)

+ type Credential struct

+ Addr pwallet.Address

+ Keystore string

+ Password string

+ Wallet pwallet.Wallet

+ type Currency interface

+ Parse func(string) (*big.Int, error)

+ Print func(*big.Int) string

+ type Dialer interface

+ type NodeAPI interface

+ GetConfig func() NodeConfig

+ GetSession func(string) (SessionAPI, error)

+ Help func() []string

+ OpenSession func(configFile string) (string, error)

+ Time func() int64

+ type NodeConfig struct

+ Adjudicator string

+ Asset string

+ ChainConnTimeout time.Duration

+ ChainURL string

+ CommTypes []string

+ ContactTypes []string

+ Currencies []string

+ LogFile string

+ LogLevel string

+ OnChainTxTimeout time.Duration

+ ResponseTimeout time.Duration

+ type Peer struct

+ Alias string

+ CommAddr string

+ CommType string

+ OffChainAddr pwire.Address

+ OffChainAddrString string

+ type Registerer interface

+ Register func(offChainAddr pwire.Address, commAddr string)

+ type Session struct

+ ChannelClient ChannelClient

+ ID string

+ User User

+ type SessionAPI interface

+ AddContact func(Peer) error

+ GetCh func(string) (ChannelAPI, error)

+ GetChInfos func() []ChannelInfo

+ GetContact func(alias string) (Peer, error)

+ HandleClose func(string, error)

+ HandleProposal func(*pclient.ChannelProposal, *pclient.ProposalResponder)

+ HandleUpdate func(pclient.ChannelUpdate, *pclient.UpdateResponder)

+ ID func() string

+ OpenCh func(context.Context, string, BalInfo, App, uint64) (ChannelInfo, error)

+ RespondChProposal func(context.Context, string, bool) error

+ SubChCloses func(ChCloseNotifier) error

+ SubChProposals func(ChProposalNotifier) error

+ UnsubChCloses func() error

+ UnsubChProposals func() error

+ type StateUpdater func(*pchannel.State)

+ type User struct

+ OffChain Credential

+ OnChain Credential

+ PartAddrs []pwallet.Address

+ type WalletBackend interface

+ NewWallet func(keystore string, password string) (pwallet.Wallet, error)

+ ParseAddr func(string) (pwallet.Address, error)

+ UnlockAccount func(pwallet.Wallet, pwallet.Address) (pwallet.Account, error)

+ type WireBus interface

+ Close func() error

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL