icperun

Documentation

Overview

Package icperun contains functions to communicate to the Perun canister

Index

• type AdjRequest
• type Agent
  • func NewAgent(canisterId principal.Principal, config agent.Config) (*Agent, error)
  • func (a Agent) Conclude(arg0 AdjRequest) (Error, error)
  • func (a Agent) Deposit(arg0 Funding) (*Error, error)
  • func (a Agent) Dispute(arg0 AdjRequest) (Error, error)
  • func (a Agent) QueryEvents(arg0 ChannelTime) (EventTxt, error)
  • func (a Agent) QueryHoldings(arg0 Funding) (**Amount, error)
  • func (a Agent) QueryState(arg0 ChannelId) (*RegisteredState, error)
  • func (a Agent) RegisterEvent(arg0 FundMem) error
  • func (a Agent) TransactionNotification(arg0 uint64) (**Amount, error)
  • func (a Agent) Withdraw(arg0 WithdrawalRequest) (Error, error)
• type Amount
  • func NewBigNat(b *big.Int) Amount
• type ChannelId
• type ChannelTime
• type Duration
• type Error
• type Event
• type EventTxt
• type FullySignedState
• type FundMem
• type Funding
• type Hash
• type L2Account
• type Nonce
• type Params
• type RegisteredState
• type Signature
• type State
• type Timestamp
• type WithdrawalRequest

Types

type AdjRequest

type AdjRequest = struct {
	Nonce             Nonce       `ic:"nonce"`
	Participants      []L2Account `ic:"participants"`
	ChallengeDuration Duration    `ic:"challenge_duration"`
	Channel           ChannelId   `ic:"channel"`
	Version           uint64      `ic:"version"`
	Allocation        []Amount    `ic:"allocation"`
	Finalized         bool        `ic:"finalized"`
	Sigs              []Signature `ic:"sigs"`
}

type Agent

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

func NewAgent

func NewAgent(canisterId principal.Principal, config agent.Config) (*Agent, error)

func (Agent) Conclude

func (a Agent) Conclude(arg0 AdjRequest) (Error, error)

func (Agent) Deposit

func (a Agent) Deposit(arg0 Funding) (*Error, error)

func (Agent) Dispute

func (a Agent) Dispute(arg0 AdjRequest) (Error, error)

func (Agent) QueryEvents

func (a Agent) QueryEvents(arg0 ChannelTime) (EventTxt, error)

func (Agent) QueryHoldings

func (a Agent) QueryHoldings(arg0 Funding) (**Amount, error)

func (Agent) QueryState

func (a Agent) QueryState(arg0 ChannelId) (*RegisteredState, error)

func (Agent) RegisterEvent

func (a Agent) RegisterEvent(arg0 FundMem) error

func (Agent) TransactionNotification

func (a Agent) TransactionNotification(arg0 uint64) (**Amount, error)

func (Agent) Withdraw

func (a Agent) Withdraw(arg0 WithdrawalRequest) (Error, error)

type Amount

type Amount = idl.Nat

func NewBigNat

func NewBigNat(b *big.Int) Amount

type ChannelId

type ChannelId = [32]byte

type ChannelTime

type ChannelTime = struct {
	Channel   ChannelId `ic:"chanid"`
	Timestamp Timestamp `ic:"time"`
}

type Duration

type Duration = uint64

type Error

type Error = string

type Event

type Event = struct {
	// contains filtered or unexported fields
}

type EventTxt

type EventTxt = string

type FullySignedState

type FullySignedState = struct {
	State State    `ic:"state"`
	Sigs  [][]byte `ic:"sigs"`
}

type FundMem

type FundMem = struct {
	Channel     ChannelId `ic:"channel"`
	Participant L2Account `ic:"participant"`
	Memo        uint64    `ic:"memo"`
}

type Funding

type Funding = struct {
	Channel     ChannelId `ic:"channel"`
	Participant L2Account `ic:"participant"`
}

type Hash

type Hash = []uint8

type L2Account

type L2Account = []uint8

type Nonce

type Nonce = [32]byte

type Params

type Params = struct {
	Nonce             Nonce       `ic:"nonce"`
	Participants      []L2Account `ic:"participants"`
	ChallengeDuration Duration    `ic:"challenge_duration"`
}

type RegisteredState

type RegisteredState = struct {
	State   State     `ic:"state"`
	Timeout Timestamp `ic:"timeout"`
}

type Signature

type Signature = Hash

type State

type State = struct {
	Channel    ChannelId `ic:"channel"`
	Version    uint64    `ic:"version"`
	Allocation []Amount  `ic:"allocation"`
	Finalized  bool      `ic:"finalized"`
}

type Timestamp

type Timestamp = uint64

type WithdrawalRequest

type WithdrawalRequest = struct {
	Channel     ChannelId           `ic:"channel"`
	Participant L2Account           `ic:"participant"`
	Receiver    principal.Principal `ic:"receiver"`
	Sig         Signature           `ic:"signature"`
	Timestamp   Timestamp           `ic:"time"`
}