# README
Virtual fund off-chain protocol
Single hop case
Take three actors Alice, Bob and Irene. Given a ledger channel L between Alice and Irene and a ledger channel L' between Bob and Irene, the clients send and wait on messages as shown in the below sequence diagram in order to create and fund a virtual channel V:
The diagram is generated at https://sequencediagram.org/. The source code for this diagram is co-located in this folder, and should be updated in concert with changing the diagram.
See ADR 9 for greater detail.
# Functions
ConstructObjectiveFromPayload takes in a message and constructs an objective from it.
IsVirtualFundObjective inspects a objective id and returns true if the objective id is for a virtual fund objective.
NewObjective creates a new virtual funding objective from a given request.
NewObjectiveRequest creates a new ObjectiveRequest.
# Constants
No description provided by the author
No description provided by the author
Round 2.
Round 3.
Round 1.
Finished.
# Structs
No description provided by the author
GuaranteeInfo contains the information used to generate the expected guarantees.
Objective is a cache of data computed by reading from the store.
ObjectiveRequest represents a request to create a new virtual funding objective.
ObjectiveResponse is the type returned across the API in response to the ObjectiveRequest.
# Type aliases
GetTwoPartyConsensusLedgerFuncion describes functions which return a ConsensusChannel ledger channel between the calling client and the given counterparty, if such a channel exists.