Skip to content

Commit

Permalink
Add Substreams matching diagram
Browse files Browse the repository at this point in the history
  • Loading branch information
cristian-recoseanu committed Oct 24, 2023
1 parent 27407c3 commit 9216f90
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/Receiver Capabilities.md
Original file line number Diff line number Diff line change
Expand Up @@ -180,6 +180,12 @@ Each substream object includes the following attributes:
A Constraint Set using the `substreams` attribute is satisfied if **all of** its Substream Parameter Constraints are satisfied in the quantities specified by each `count` attribute.
This implies that if **any of** the Substream Parameter Constraints are _not_ satisfied in the quantities specified by each `count` attribute, the Constraint Set as a whole is not satisfied.

Substream Parameter Constraints are matched against parent Flow and source attributes. Each parent Flow can only be used to satisfy one Substream Parameter Constraints. The following diagram shows this matching workflow.

| ![Substreams](images/substreams.png) |
|:--:|
| _**Substreams**_ |

### Listing Constraint Sets

The Receiver advertises a list of Constraint Sets as a JSON array of these objects, using the key `constraint_sets` in the `caps` object.
Expand Down
Binary file added docs/images/substreams.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 9216f90

Please sign in to comment.