Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

suave-std index page #101

Merged
merged 3 commits into from
Mar 14, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,10 @@ Use this command to update to the latest version of suave-specs:
git submodule update --remote
```

## SUAVE-STD

The SUAVE standard library is automatically updated by [this CI workflow](.github/workflows/suave-std-sync.yml) and used with https://docusaurus.io/docs/sidebar/autogenerated

## Deployment

The docs use Vercel for hosting, and deployment is done by Vercel on any merge into the main branch.
Expand Down
4 changes: 0 additions & 4 deletions docs/concepts/mev-supplychain-interface.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,3 @@ The Private OFA examples also illustrates how the confidential store, and the va
The below visualization demonstrate the generalized form such Suapps can take as SUAVE matures, illustrating how the OFA contract could key values into the confidential store such that a block building contract could fetch them and use them to create and emit valid blocks (this would require, among other things, extending the **allowedPeekers** we set in [the previous page](/concepts/confidential-data-storage#practical-example)):

![OFA to Block Flow](/assets/OFA_And_Block_Flow.svg)

---

For practical examples of what it looks like to develop on SUAVE, please consult the [`suave-std` tutorial](/tutorials/suave-standard-library#mevshare).
1 change: 1 addition & 0 deletions docs/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ module.exports = {
type: 'category',
label: 'SUAVE-STD',
collapsed: true,
link: { type: 'doc', id: 'tools/suave-std-index' },
items: [
{
type: 'autogenerated',
Expand Down
2 changes: 1 addition & 1 deletion docs/tools/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Here is an up-to-date list of software and repositories to help you build on [SU

**SDKs and Tools:**

- [`suave-std` Solidity Libraries](/tutorials/suave-standard-library)
- [`suave-std` Solidity Libraries](/tools/suave-std/)
- [Forge](/tools/forge)
- [Golang SDK](/tools/golang-sdk)
- [`suave-viem` TypeScript SDK](/tools/typescript-sdk)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,18 +1,19 @@
---
title: SUAVE Standard Library
description: A collection of contracts and libraries to empower SUAPP developers and make life easier for builders.
slug: /tools/suave-std
description: Contracts and libraries to supercharge SUAPP development.
keywords:
- application
- build
- suave
- solidity
---

[suave-std](https://github.com/flashbots/suave-std) is a collection of Solidity contracts and libraries to help you create Suapps. It is included as a submodule in the [SUAPP Examples](https://github.com/flashbots/suapp-examples/) repo, which we used in the previous tutorial.
[SUAVE-STD](https://github.com/flashbots/suave-std) is a collection of Solidity contracts and libraries to help you create Suapps. It is included as a submodule in the [SUAPP Examples](https://github.com/flashbots/suapp-examples/) repo, which we used in the previous tutorial.

In this tutorial, we will be diving deeper into the different capabilities offered by `suave-std`.

:::info
:::info

`suave-std` is the main entrypoint for developers who are interacting with SUAVE. It is a place to create building blocks, sdks, and common patterns that are useful to SUAVE developers.

Expand Down
2 changes: 1 addition & 1 deletion docs/tutorials/confidential-compute-requests.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ There are a number of different ways to work with SUAVE and to craft Confidentia
:::

<div className="intro-grid">
<a href="#typsescipt" className="intro-link">
<a href="#typescript" className="intro-link">
<div className="intro-block">
<div className="intro-image">
<svg xmlns="http://www.w3.org/2000/svg" width="40" height="40" viewBox="0 0 24 24"><path d="M6.993 12c0 2.761 2.246 5.007 5.007 5.007s5.007-2.246 5.007-5.007S14.761 6.993 12 6.993 6.993 9.239 6.993 12zM12 8.993c1.658 0 3.007 1.349 3.007 3.007S13.658 15.007 12 15.007 8.993 13.658 8.993 12 10.342 8.993 12 8.993zM10.998 19h2v3h-2zm0-17h2v3h-2zm-9 9h3v2h-3zm17 0h3v2h-3zM4.219 18.363l2.12-2.122 1.415 1.414-2.12 2.122zM16.24 6.344l2.122-2.122 1.414 1.414-2.122 2.122zM6.342 7.759 4.22 5.637l1.415-1.414 2.12 2.122zm13.434 10.605-1.414 1.414-2.122-2.122 1.414-1.414z"></path></svg>
Expand Down
Loading