This repository has been archived by the owner on Nov 24, 2022. It is now read-only.
README: enhance explanation #10
Merged
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
Signed-off-by: Ignacio Hagopian <jsign.uy@gmail.com>
Signed-off-by: Ignacio Hagopian <jsign.uy@gmail.com>
jsign
commented
Jul 7, 2021
|
I added a deprecated message in the original Notion doc, so every new improvement should be done in this README. |
merlinran
reviewed
Jul 7, 2021
Signed-off-by: Ignacio Hagopian <jsign.uy@gmail.com>
Signed-off-by: Ignacio Hagopian <jsign.uy@gmail.com>
jsign
commented
Jul 7, 2021
Comment on lines
+92
to
+98
| 0. [Install Go 1.15 or newer](https://golang.org/doc/install) | ||
| 1. Make sure `$GOPATH/bin` is in your `$PATH`, i.e., `export PATH=$GOPATH/bin:$PATH`. | ||
| 1. `bidbot init`. | ||
| 1. The output will ask you to sign a token with the owner address of your miner. | ||
| 1. Configure your _ask price_, other bid settings, and auction filters. See `bidbot help daemon` for details. You can edit the configuration file generated by `bidbot init` or use the equivalent flag for any given option. | ||
| 1. Use the signature you generated above to start the daemon: `bidbot daemon --miner-addr [address] --wallet-addr-sig [signature]` | ||
| 1. Good luck! Your `bidbot` will automatically bid in open deal auctions. If it wins an auction, the broker will automatically start making a deal with the Lotus wallet address used in step 3. | ||
| 2. `bidbot init`. | ||
| 3. The output will ask you to sign a token with the owner address of your miner. | ||
| 4. Configure your _ask price_, other bid settings, and auction filters. See `bidbot help daemon` for details. You can edit the configuration file generated by `bidbot init` or use the equivalent flag for any given option. | ||
| 5. Use the signature you generated above to start the daemon: `bidbot daemon --miner-addr [address] --wallet-addr-sig [signature]` | ||
| 6. Good luck! Your `bidbot` will automatically bid in open deal auctions. If it wins an auction, the broker will automatically start making a deal with the Lotus miner address used in step 4. |
There was a problem hiding this comment.
Same as the previous Getting started (with fixed bullet numbers).
Signed-off-by: Ignacio Hagopian <jsign.uy@gmail.com>
jsign
commented
Jul 7, 2021
Comment on lines
+33
to
+34
| First, we must understand that `bidbot` is a piece that's part of a bigger picture: the storage broker. | ||
| The storage broker (SB) is a system that receives data from multiple clients, aggregates them, and makes it available for miners to store. The SB has several unique properties that make it different than your typical Filecoin client. |
|
Thanks @merlinran for the detailed review, rushed a bit in moving things from the doc. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Moved from Notion doc to README.
Had to fix the links and some other formatting stuff, but the content is the same.