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

Cards updates: WIP #465

Merged
merged 22 commits into from
Apr 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
5134554
first set of updates, some manual, some automated
mapachurro Mar 6, 2024
bf5769a
created index.mdx files; haven't done sidebar yet. Also, some fixes t…
mapachurro Mar 6, 2024
84e7aad
Updated several links and minor tweaks to developersSidebar; moved Ru…
mapachurro Mar 6, 2024
61e39e6
updated sidebars.js
mapachurro Mar 20, 2024
1f82686
correcting security link
mapachurro Mar 20, 2024
de98fab
Merge branch 'main' into cards-updates-2
mapachurro Mar 20, 2024
233eebe
removing scripts used to make index files
mapachurro Mar 20, 2024
e683b53
updating names of sections on index files
mapachurro Mar 20, 2024
f4a4787
minor copy edits to linea safe
mapachurro Mar 20, 2024
a668a31
updated npm, fixed vulns
mapachurro Mar 20, 2024
720c3e6
adding link for social login to sidebar
mapachurro Mar 20, 2024
97e9ed5
Merge branch 'main' into cards-updates-2
jlwllmr Mar 21, 2024
3b86669
correcting index path for overview page; correcting implementation of…
mapachurro Mar 27, 2024
c9d1c28
correcting overview index file
mapachurro Mar 27, 2024
2d61301
Run a Node in the top bar
mapachurro Mar 27, 2024
75cb02c
Update sidebars.js
jlwllmr Mar 28, 2024
f701b53
Merge branch 'main' into cards-updates-2
jlwllmr Apr 5, 2024
17ce3c1
Adjust sidebar
jlwllmr Apr 5, 2024
65bfe56
Merge branch 'main' into cards-updates-2
jlwllmr Apr 5, 2024
1eac369
Update
jlwllmr Apr 5, 2024
1f7fb34
Merge branch 'cards-updates-2' of https://github.com/ConsenSys/doc.zk…
jlwllmr Apr 5, 2024
0891b54
Add infura.io to prevent 403s blocking the link linter
jlwllmr Apr 5, 2024
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
7 changes: 0 additions & 7 deletions docs/build-on-linea/index.md

This file was deleted.

12 changes: 12 additions & 0 deletions docs/build-on-linea/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: "Build on Linea"
sidebar: developersSidebar
---

To get started building on Linea, check out our [quickstart](./quickstart/index.mdx). Otherwise, find workshops, tutorials, and walkthroughs on our [YouTube page](https://www.youtube.com/channel/UCVOIfxxbSHfCbX6-qHsowqQ).

## Resources

import DocCardList from '@theme/DocCardList';

<DocCardList />
2 changes: 1 addition & 1 deletion docs/build-on-linea/linea-version/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ their claiming outside of the Bridge UI, then we recommend looking at the update
- After migration to the new finalization mechanism, the rollup contract will no longer emit finalization events per block, but will instead emit events for data submission as well as an event indicating the current point of finalization.
- The calldata will contain only the final block state root hash and final block number.

:::info[Note]
:::info[Note]

This is a breaking change for consumers listening to the existing events. The `BlockFinalized` event will be replaced by the `DataFinalized` event.

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
title: "Deploy a smart contract"
sidebar: developersSidebar
description: Deploy a contract to Linea using a variety of libraries.
---

import DocCardList from '@theme/DocCardList';

<DocCardList />
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ Before you begin, ensure you've:
1. [Set up your wallet](../../use-mainnet/set-up-your-wallet.mdx)
2. [Funded your wallet with Linea ETH](../../use-mainnet/fund.mdx) on either the testnet or mainnet

## Resources

import DocCardList from '@theme/DocCardList';

<DocCardList />
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
title: "Verify a smart contract"
sidebar: developersSidebar
description: Verify a contract on Linea using a variety of libraries.
---

import DocCardList from '@theme/DocCardList';

<DocCardList />
8 changes: 8 additions & 0 deletions docs/build-on-linea/tooling/automation/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: Automation
---


import DocCardList from '@theme/DocCardList';

<DocCardList />
8 changes: 8 additions & 0 deletions docs/build-on-linea/tooling/cloud-infra/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: Cloud Infrastructure
---


import DocCardList from '@theme/DocCardList';

<DocCardList />
8 changes: 8 additions & 0 deletions docs/build-on-linea/tooling/contracts-templates/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: Contract Templates
---


import DocCardList from '@theme/DocCardList';

<DocCardList />
8 changes: 8 additions & 0 deletions docs/build-on-linea/tooling/cross-chain/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: Cross-chain tooling
---


import DocCardList from '@theme/DocCardList';

<DocCardList />
8 changes: 8 additions & 0 deletions docs/build-on-linea/tooling/data-indexers/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: Data indexers
---


import DocCardList from '@theme/DocCardList';

<DocCardList />
8 changes: 8 additions & 0 deletions docs/build-on-linea/tooling/libraries/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: Libraries
---


import DocCardList from '@theme/DocCardList';

<DocCardList />
7 changes: 5 additions & 2 deletions docs/build-on-linea/tooling/linea-safe.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,12 @@ image: /img/socialCards/create-a-multi-signature-smart-contract-wallet.jpg

Linea Safe is a fork managed by the Linea team in collaboration with Protofire, an official partner of the Safe team. It is a multi-signature smart contract wallet, which means it requires a minimum number of signatures to approve a transaction before it can occur. For example, if your business has three main stakeholders, you can configure the wallet to require approval from either two out of three or all three individuals before a transaction can proceed. This security measure ensures that no single person can compromise the funds.

On top of that, Linea Safe gives complete self custody over funds and the smart contract that is deployed is completely trustless and in control.
On top of that, Linea Safe gives complete self-custody over funds. In other words, the smart
contract deployed for the wallet has complete control over the wallet's contents, and does not
rely on any trusted external party for execution.

To create your Linea Safe wallet click [here](https://safe.linea.build).

<!--
to check the status of the linea safe and entry points https://status.safe.linea.build/ not sure if we want to include this. right now it is password protected -->
to check the status of the linea safe and entry points https://status.safe.linea.build/ not
sure if we want to include this. right now it is password protected -->
2 changes: 1 addition & 1 deletion docs/build-on-linea/tooling/node-providers.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ image: /img/socialCards/node-providers.jpg

## Run your own node

- [Set it up yourself](../run-a-node/index.md)
- [Set it up yourself](../run-a-node/index.mdx)
- [One-click deploy with EasyNode](https://app.easy-node.xyz/)
- [One-click deploy with RapidNode](https://rapidnode.xyz/dashboard)

Expand Down
8 changes: 8 additions & 0 deletions docs/build-on-linea/tooling/oracles/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: Oracles
---


import DocCardList from '@theme/DocCardList';

<DocCardList />
8 changes: 8 additions & 0 deletions docs/build-on-linea/tooling/security/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: Security
---


import DocCardList from '@theme/DocCardList';

<DocCardList />
8 changes: 8 additions & 0 deletions docs/build-on-linea/tooling/social-login/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: Social login
---


import DocCardList from '@theme/DocCardList';

<DocCardList />
File renamed without changes.
36 changes: 28 additions & 8 deletions docs/use-mainnet/bridges-of-linea/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,34 +4,54 @@ sidebar_position: 3
image: /img/socialCards/bridge-your-tokens.jpg
---

Any L2 is going to have a lot of connections to other networks. Some of these bridges will be made by Consensys and
Linea, some by projects collaborating with us; some may be made without our knowledge—that's what 'permissionless' means.

import DocCardList from '@theme/DocCardList';

Any L2 is going to have a lot of connections to other networks. Some of these bridges will be made
by Consensys and
Linea, some by projects collaborating with us; some may be made without our knowledge—that's what
'permissionless' means.

> **What's going on here?**
>
> Linea, like any other rollup network, is designed to offer its own experience, while 'reporting back' to another network (usually Ethereum Mainnet) on all the activity that happens on it (at least, at the level of transactions); this means that the 'Layer 1' network is tracking all the activity on the 'Layer 2'. In this way, L2s are said to 'inherit the security of the L1'.
> Linea, like any other rollup network, is designed to offer its own experience, while 'reporting
back' to another network (usually Ethereum Mainnet) on all the activity that happens on it (at
least, at the level of transactions); this means that the 'Layer 1' network is tracking all the
activity on the 'Layer 2'. In this way, L2s are said to 'inherit the security of the L1'.
>
> One of the main reasons you would want a rollup network is for it to be totally interoperable with the L1, and one of the main things you need to make networks interoperable is enable people to move things back and forth between them. The class of tools used to do this, broadly, are called **bridges**.
> One of the main reasons you would want a rollup network is for it to be totally interoperable
with the L1, and one of the main things you need to make networks interoperable is enable people to
move things back and forth between them. The class of tools used to do this, broadly, are called
**bridges**.
>
> Ok, now you're up to speed 🚀


## How to: Bridge ERC-20 Tokens vs. ETH
<DocCardList />

## Options for moving large liquidity

### 1. Use the canonical token bridge with the default `BridgedToken` implementation

This is suited for all protocols that just need their token on L2 for DeFi and other uses without any special requirement for custom features (Vanilla ERC20).
This is suited for all protocols that just need their token on L2 for DeFi and other uses without
any special requirement for custom features (Vanilla ERC20).

**Bridge ETH**

We recommend you use the [official Linea token bridge](./how-to-bridge-eth.md) for bridging between Linea and Ethereum.
We recommend you use the [official Linea token bridge](./how-to-bridge-eth.md) for bridging between
Linea and Ethereum.

**Bridge ERC-20 tokens**

Again, we recommend the official bridge; ERC-20-specific instructions are [here](./how-to-bridge-erc20-tokens.mdx).
Again, we recommend the official bridge; ERC-20-specific instructions are
[here](./how-to-bridge-erc20-tokens.mdx).

### 2. Use the canonical token bridge with a custom `BridgedToken` implementation

This is suited for protocols that want to implement special features for the bridged ERC20 on L2. **This is only possible if the token has not yet been bridged from L1 to L2 in order to avoid unexpected changes for end-users.**
This is suited for protocols that want to implement special features for the bridged ERC20 on L2.
**This is only possible if the token has not yet been bridged from L1 to L2 in order to avoid
unexpected changes for end-users.**

Protocols that want to use a custom BridgedToken will be able to incorporate arbitrary logic on the L2 ERC20, while still relying on the Token Bridge lock and mint logic and cross-chain communication. **For this to work, protocols need to keep compatibility with the Token Bridge by enabling it to call the ERC20 mint and burn functions.**

Expand Down
2 changes: 2 additions & 0 deletions docs/use-mainnet/index.md → docs/use-mainnet/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,5 @@ This section should walk you through everything you need to get started:
1. [Deploy your first contract](./../build-on-linea/quickstart/)

If you run into a problem, step on over to the [Linea Support page](https://support.linea.build/hc/en-us) and let us know.

import DocCardList from '@theme/DocCardList';
7 changes: 6 additions & 1 deletion docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ const config = {
},
{
type: "doc",
docId: "build-on-linea/quickstart/index",
docId: "build-on-linea/index",
position: "left",
label: "Developers",
},
Expand Down Expand Up @@ -141,6 +141,11 @@ const config = {
position: "left",
label: "Support",
},
{
to: "/build-on-linea/run-a-node/",
position: "left",
label: "Run a node",
},
{
to: "https://linea.build/",
position: "left",
Expand Down
3 changes: 3 additions & 0 deletions mlc_config.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@
{
"pattern": "https://www.infura.io/faucet/linea"
},
{
"pattern": "https://infura.io"
}
{
"pattern": "https://rpc.sepolia.linea.build"
}
Expand Down
Loading
Loading