Documentation, particularly for FSM Module #8
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add a readme to fsm module outlining usage
hannahhoward
force-pushed
the
feat/add-readme-fsm
branch
from
f821f0b
to
10a7c9d
Compare
add general readme information and a few corrections to fsm docs
hannahhoward
changed the title
laser
approved these changes
Mar 11, 2020
README.md
Outdated
| It has the following signature: | ||
|
|
||
| ```golang | ||
| type Planner func(events []Event, user interface{}) (interface{}, uint64, error) |
There was a problem hiding this comment.
Suggestion: Give names to the return parameters.
README.md
Outdated
| type Planner func(events []Event, user interface{}) (interface{}, uint64, error) | ||
| ``` | ||
|
|
||
| A planner receives a series of events and a point to the current state (represented by user) |
There was a problem hiding this comment.
and a point to the current state
Suggestion: "and a pointer to the current state"
fsm/README.md
Outdated
|
|
||
| A state machine is defined in terms of | ||
|
|
||
| - StateType -- the type of data structure we are tracking (should be a struct) |
There was a problem hiding this comment.
Note: Some things in this list, e.g. Events, are backtick'ed - and others (like StateKeyField) are not.
fsm/README.md
Outdated
| Let's pretend our ideal deal flow looks like: | ||
|
|
||
| ``` | ||
| Receive new deal proposal -> Validate proposal-> For All Data Requested, Send a chunk, then request payment, then wait for payment before sending more -> Complete deal |
There was a problem hiding this comment.
Suggestion:
Change
Validate proposal->
to
Validate proposal ->
ingar
approved these changes
Mar 11, 2020
README.md
Outdated
| type Planner func(events []Event, user interface{}) (interface{}, uint64, error) | ||
| ``` | ||
|
|
||
| A planner receives a series of events and a point to the current state (represented by user) |
README.md
Outdated
| You can now dispatch events to a state machine with: | ||
|
|
||
| ```golang | ||
| var id interface{} // some identifier of a deal |
There was a problem hiding this comment.
Should be identifier of a "tracked state" or something like that.
fsm/README.md
Outdated
|
|
||
| ## Usage | ||
|
|
||
| Let's consider a hypothetical deal we want to track in Filecoin. Each deal will have a series of states it can be in, and various things that can happen to change its state. We will track multiple deals at the same time. In this example, we will model the actions of the receiving party (i.e. the person who accepted the deal and responding) |
There was a problem hiding this comment.
the person who accepted the deal and is responding
fsm/README.md
Outdated
| ReceivedNewDeal | ||
| AcceptedDeal | ||
| RejectedDeal | ||
| SentBlocks |
There was a problem hiding this comment.
Should be SentData to be consistent with below...
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Goals
Provide basic module documentation since that is a source of confusion
Provide guidance on using FSM module beyond examples in test
Implementation
go-storage-miner