Add section for suave-std api #92
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
Nice! Perhaps adding it into the existing docs would be better than adding a whole new docs section 🤔 The formatting looks a bit plain, but we can improve that over time. |
I am expecting that section to grow over time with more examples or specific docs on Forge integration. We can put it into docs and move it out if it once it grows.
Agree, that is just the default format. |
There was a problem hiding this comment.
Most of my comments are notes to myself which will be useful when we get this merged.
The think I'd really like you to fix @ferranbt is the line refs in all the links - those all need to point at the actual functions, and I think they should point to the line where the function is defined, not where it ends, and not a random line within it. If you can do that, I will get the rest of the things in order an think about how this fits into my plans for the docs this week.
Really awesome work though, thank you so much 🙏
suavestd/api/Transactions.mdx
Outdated
|
|
||
| ## Functions | ||
|
|
||
| ### [encodeRLP](https://github.com/flashbots/suave-std/tree/main/src/Transactions.sol#L109) |
There was a problem hiding this comment.
These line numbers are all incorrect - can you fix them with the automatic tool?
I think that the Structs section should be moved to the top of this file so that it is clear what the difference between 155 and 1559, as well as transactions and "Request transactions" is.
I think that we should add at least one more line to the top of each file to explain why this library is useful/what often-used function it fulfills for suapp devs.
suavestd/api/Suapp.mdx
Outdated
|
|
||
| ## Functions | ||
|
|
||
| ### [emitOffchainLogs](https://github.com/flashbots/suave-std/tree/main/src/Suapp.sol#L9) |
There was a problem hiding this comment.
Better to reference the line where the function begins imo.
suavestd/api/Random.mdx
Outdated
|
|
||
| ## Functions | ||
|
|
||
| ### [randomUint8](https://github.com/flashbots/suave-std/tree/main/src/Random.sol#L10) |
There was a problem hiding this comment.
Line references seem to be incorrect.
suavestd/api/protocols/Bundle.mdx
Outdated
|
|
||
| ## Functions | ||
|
|
||
| ### [sendBundle](https://github.com/flashbots/suave-std/tree/main/src/protocols/Bundle.sol#L25) |
There was a problem hiding this comment.
Incorrect line refs again
suavestd/api/suavelib/Suave.mdx
Outdated
|
|
||
| ### [confidentialRetrieve](https://github.com/flashbots/suave-std/tree/main/src/suavelib/Suave.sol#L197) | ||
|
|
||
| Retrieves data from the confidential store. Also mandates the caller's presence in the `AllowedPeekers` list. |
There was a problem hiding this comment.
strange character here? '
suavestd/api/suavelib/Suave.mdx
Outdated
|
|
||
| Output: | ||
|
|
||
| - "b": Whether execution is off- or on-chain |
There was a problem hiding this comment.
unclear - is this a boolean. Better to be explicit in our public docs.
suavestd/index.md
Outdated
|
|
||
| # Suave-std | ||
|
|
||
| Suave-std is a set of utility libraries to build Suapps. |
There was a problem hiding this comment.
Probably needs more detail here if we merge this.
This PR does two things:
docusaurus/plugin-content-docsto hostsuave-stddocumentation.suave-stddocs generator tool to create an API reference. Note that right now the content was moved manually. The idea is to have an automation tool to create sync up PRs as soon as the docs onsuave-stdchange.This PR is dependant on flashbots/suave-std#62 being merged first. This is a reference to see how the markdown files look like.