Skip to content

FundingRequirement

Funding requirements and source request types.

Functions

NameDescription
FundingRequirement.assertValidates a funding requirement's signed fields.
FundingRequirement.fromCreates and validates a funding requirement, preserving inferred literal types.
FundingRequirement.fromRpcConverts RPC quantities to a funding requirement.
FundingRequirement.fromRpcRequestDecodes unsigned funding intent, preserving omitted fields for inference.
FundingRequirement.fromTupleDecodes a funding requirement from its RLP tuple.
FundingRequirement.toRpcConverts a funding requirement to RPC quantities.
FundingRequirement.toRpcRequestEncodes unsigned funding intent without filling omitted fields.
FundingRequirement.toTupleConverts a funding requirement to its RLP tuple.

Errors

NameDescription
FundingRequirement.InvalidRequirementErrorThrown when funding fields violate the protocol encoding.

Types

NameDescription
FundingRequirement.FundingRequirementTarget balance to satisfy before application calls.
FundingRequirement.RequestUnsigned funding fields to resolve before signing.
FundingRequirement.RequestRpcRPC funding intent with optional token, amount, and sources.
FundingRequirement.RpcRPC funding requirement.
FundingRequirement.TupleRLP funding requirement tuple.