References

Class Summary

Static Public Class Summary
public	CollectingVisitor CollectingVisitor extends Visitor by providing default functionality of collecting all leaf nodes.
public	Currency Currency class describes supported currencies as well as operations on them, such as mapping from and to a Currency index as well as exchanging a list of interval in different currencies to a single base for evaluation.
public	Deployer Deployer allows for deployment of Fincontract to the blockchain in a series of transaction.
public	DescriptionDeployer Deploys a Fincontract description to the blockchain by traversing the FincNode tree in preorder fashion to ensure topological ordering.
public	DotGenerator DotGenerator class allows for generation Fincontract DOT graphs.
public	DotGeneratorVisitor DotGeneratorVisitor performs collection of links and labels in order to later generate a DOT description of the Fincontract graph from FincNode description tree by extending Visitor.
public	EmptyVisitor EmptyVisitor extends Visitor.
public	Evaluator Evaluator class is used for performing different evaluation methods on a Fincontracts' descriptions.
public	EvaluatorVisitor Performs the actual evaluation of a Fincontract by analysing its description tree (See FincNode).
public	Examples Examples class is meant to deploy some of the tests defined in FincontractMarketplace as well as assign Gateways to global values.
public	Executor Executor class is used for executing deployed contracts in FincontractMarketplace.
public	Fetcher Fetcher class is used for fetching blockchain deployed Fincontracts, by calling appropriate functions (see `getFincontractInfo` and `getDescriptionInfo` from FincontractMarketplace).
public	FincAndNode FincAndNode extends FincNode and implements `And` primitive, which takes two sub-fincontracts and makes them both valid.
public	FincGiveNode FincGiveNode extends FincNode and implements `Give` primitive, which upon execution flips the payer with the payee
public	FincIfNode FincIfNode extends FincNode and implements `If` primitive, which takes two sub-fincontracts and a Gateway address.
public abstract	FincNode FincNode is the superclass for all primitives.
public	FincOneNode FincOneNode extends FincNode and implements `One` primitive, which takes a currency index (see CurrenciesType) and always requires payer to pay `1` of that currency upon execution.
public	FincOrNode FincOrNode extends FincNode and implements `Or` primitive, which takes two sub-fincontracts and allows the owner to choose only one of them.
public	FincScaleNode FincScaleNode extends FincNode and implements `Scale` primitive, which takes a sub-fincontract and a Number.
public	FincScaleObsNode FincScaleObsNode extends FincNode and implements `ScaleObs` primitive, which takes a sub-fincontract and a Gateway address.
public	FincTimeboundNode FincTimeboundNode extends FincNode and implements `Timebound` primitive, which takes a sub-fincontract and makes it valid only if the current timestamp is between FincTimeboundNode.lowerBound and FincTimeboundNode.upperBound.
public	FincZeroNode FincZeroNode extends FincNode and implements `Zero` primitive, which upon execution does nothing.
public	Fincontract Fincontract describes an instance of a Fincontract in memory.
public	GatewayUpdater GatewayUpdater updates Gateways contained inside Fincontract instance (see Fincontract.rootDescription).
public	GatewayVisitor GatewayVisitor performs the actual Gateway update by traversing the FincNode description tree.
public	OrNodeChecker OrNodeChecker checks if there exist path from root node to the nearest Or node (see FincOrNode), while only passing through FincTimeboundNode and FincScaleNode.
public	Parser Parser class allows for parsing Fincontract descriptions, using `math.js` as its back-end.
public	Sender Sender class allows for sending Ethereum transactions and returns Transaction objects that can be then watched for events (see Transaction#watch).
public	Serializer Serializer class allows for serialization of Fincontracts.
public	SerializerVisitor SerializerVisitor performs the actual serialization of a FincNode description tree into String by extending Visitor.
public	Transaction A sent transaction, which can be watched for events.
public	Visitor Visitor implements pre-order tree traversal for Fincontract description trees (see FincNode).

Function Summary

Static Public Function Summary
public	makeDirectEvaluators(web3: Web3, gateway: Gateway): NodeEvaluators Returns NodeEvaluators object for evaluating using `direct` (See makeEstimationEvaluators) method.
public	makeEstimationEvaluators(): NodeEvaluators Returns NodeEvaluators object for evaluating using `estimate` method.
public	makeRandomIDFunc(randomFunc: Function): Function Creates a random ID generator given a PRNG

Typedef Summary

Static Public Typedef Summary
public	CurrenciesType: Object Currencies as defined in: https://github.com/cryptolu/findel
public	ExecutionResult: Object Result of executing a Fincontract
public	NodeEvaluators: Object NodeEvaluators is an Object that contains evaluator functions for all types of nodes (See classes that inherit from FincNode).
public	TransactionFilter: Object Object passed to Transaction#watch as filter argument that specifies type of event or blockchain change to watch for.

External Summary

Static Public External Summary
public	FincontractMarketplace
public	Gateway
public	Web3