Skip to content

Commit

Permalink
Merge pull request #12 from PufferFinance/kynkong91-web3-patch-1
Browse files Browse the repository at this point in the history
Update index.md
  • Loading branch information
kynkong91-web3 authored Jan 13, 2025
2 parents 3803f77 + e406af0 commit d1e39cf
Show file tree
Hide file tree
Showing 12 changed files with 66 additions and 81 deletions.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Overview
slug: /protocol/overview
title: UniFi Architecture
slug: /developers/concepts/architecture
---

:::info
Expand Down
11 changes: 11 additions & 0 deletions docs/developers/concepts/deep-dive-based-rollups.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: How to use UniFi Faucet
slug: /developers/concepts/deep-dive-based-rollups
---

## Introduction to Based Rollups

:::info
Under developement
:::

Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Acquire Testnet Tokens
slug: /acquire-testnet-tokens
slug: /developers/getting-started/acquire-testnet-tokens
---

# Acquire Testnet Tokens
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: How to use UniFi Bridge
slug: /bridge-ui
slug: /developers/getting-started/bridge-ui
---

:::info
Bridging is currently paused as testnet access is being rolled out gradually. Bridging will be enabled in the next few weeks.
Bridging is currently paused as testnet access is being rolled out gradually. If you are keen to try out UniFi Testnet, feel free to express your interest [here.](https://forms.gle/ws4YxryeZbXHnfRdA)
:::

# Using the UniFi Bridge
Expand Down
42 changes: 38 additions & 4 deletions docs/developers/getting-started/index.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,48 @@
---
title: Getting Started
slug: /developers/getting-started/index
title: Introducing UniFi Rollup 🐡
slug: /
---

# Building on UniFi
# What is Puffer UniFi Rollup?

Puffer UniFi is an Ethereum Layer 2 (L2) based rollup designed to provide scalability to Ethereum while at the same time addressing the fragmentation problem faced by Ethereum.
Specifically, Puffer UniFi rollup will solve 4 big problems faced by Ethereum today:
- Realizing atomic composability allowing for instant transaction between L1 (Ethereum) and L2
- Liquidity fragmentation in L2s
- Enable decentralize sequencing in L2s
- Increase utility of Ethereum Token

### How is "Based Rollup" different from traditional rollups?

Based rollups derive their transaction sequencing directly from Ethereum validators on the L1 network.
This means that L1 validators determine the order of rollup transactions within the blocks they propose.
By shifting sequencing responsibilities to L1 validators, UniFi eliminates the need for a centralized sequencer,
giving users access to Ethereum's decentralized validator set for a more secure and neutral transaction layer.

### Key Features of UniFi Rollup

- **Credibly Neutral Sequencing**: Transactions are sequenced by Ethereum's L1 validators, ensuring reliability and neutrality.
- **Fast Transactions**: Users enjoy 100ms pre-confirmations, enhancing the overall experience.
- **Value Flow Back to Ethereum**: Sequencing fees flow back to block proposers on Ethereum, supporting the sustainability and value of the L1 network.
- **Fast Withdrawl from L2 to L1 (Ethereum)**: In the initial launch of UniFi, it will allow for fast withdrawal from UniFi to Ethereum L1 within 1 hours. As UniFi achieves true atomic composability, this withdrawal time is expected to reduce to as low as 8 seconds.

### Why Choose UniFi Rollup?

UniFi aims to drive long-term sustainability and value into Ethereum's base layer by allowing transaction
sequencing fees to benefit L1 validators. Users benefit from fast, seamless, and cost-efficient transactions,
making it an ideal solution for those seeking scalability without sacrificing decentralization.

### Get Started with UniFi Rollup

To begin using UniFi, start by [acquiring Testnet tokens](developers/getting-started/acquire-testnet-tokens.md).

By leveraging UniFi's Ethereum-based rollup, users can enjoy an efficient, decentralized, and unified experience while contributing to the long-term health of the Ethereum ecosystem.

# Building on UniFi
UniFi is mostly EVM equivalent, which means that developers can use familiar EVM tools and frameworks,
such as Hardhat, Truffle, and Remix, to interact with and develop on UniFi.
This compatibility significantly reduces the learning curve, allowing developers to leverage existing skills and knowledge.

:::info
For exact differences between UniFi and EVM behaviour, see the [Opcodes](../reference/opcodes.md) page.
For the specific differences between UniFi and EVM behaviour, see the [Opcodes](../reference/opcodes.md) page.
:::
3 changes: 1 addition & 2 deletions docs/developers/reference/opcodes.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
# Opcodes

Since UniFi is based on Taiko, it inherits the same opcode behaviour as Taiko. Unless listed below,
all opcodes are supported in UniFi and are EVM equivalent.
All opcodes are supported in UniFi and are EVM equivalent unless stated otherwise.
The execution of some Opcodes is not verified by the circuits, and not part of the validity proofs.

# Unsupported Opcodes
Expand Down
2 changes: 2 additions & 0 deletions docs/developers/reference/rpc-endpoints.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ slug: /developers/rollup/reference/rpc-endpoints

## UniFi Testnet

You can find access information to UniFi Testnet RPC below:

| Parameter | Value |
|--------------------|------------------------------------------|
| Network Name | `UniFi Testnet` |
Expand Down
2 changes: 1 addition & 1 deletion docs/developers/rollup/smart-contracts/deploy-foundry.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ slug: /developers/rollup/smart-contracts/foundry

Before you begin, ensure you've:

1. [Set up your wallet and have acquired Testnet tokens](../../../acquire-testnet-tokens.md).
1. [Set up your wallet and have acquired Testnet tokens](developers/getting-started/acquire-testnet-tokens.md).
2. Downloaded and installed Foundry:

```bash
Expand Down
2 changes: 1 addition & 1 deletion docs/developers/rollup/smart-contracts/deploy-hardhat.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ slug: /developers/rollup/smart-contracts/hardhat

Before you begin, ensure you:

1. [Set up your wallet and acquired Tesntet tokens](../../../acquire-testnet-tokens.md).
1. [Set up your wallet and acquired Tesntet tokens](developers/getting-started/acquire-testnet-tokens.md).
2. [Set up your Hardhat environment](https://hardhat.org/tutorial/setting-up-the-environment#2.-setting-up-the-environment).

## Create a Hardhat project
Expand Down
35 changes: 0 additions & 35 deletions docs/intro.md

This file was deleted.

6 changes: 0 additions & 6 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -66,12 +66,6 @@ module.exports = {
src: "img/Logo Mark.svg",
},
items: [
{
type: "doc",
docId: "intro",
label: "Users",
position: "left",
},
{
type: "doc",
docId: "developers/getting-started/index",
Expand Down
34 changes: 7 additions & 27 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -18,45 +18,25 @@ const sidebars = {

// But you can create a sidebar manually

docSidebar: [
"intro",
developersSidebar: [
"developers/getting-started/index",
{
type: "category",
label: "Protocol",
label: "Getting started",
link: {
type: "generated-index",
},
collapsed: false,
items: [
{
type: "doc",
label: "Overview",
id: "protocol/overview",
label: "Testnet Tokens",
id: "developers/getting-started/acquire-testnet-tokens",
},
]
},

"acquire-testnet-tokens",
"bridge-ui",
],
developersSidebar: [
{
type: "doc",
label: "Getting started",
id: "developers/getting-started/index",
},
{
type: "category",
label: "Concepts",
link: {
type: "generated-index",
},
collapsed: false,
items: [
{
type: "doc",
label: "TEE Multi Prover",
id: "developers/concepts/tee-multi-prover",
label: "UniFi Native Bridge",
id: "developers/getting-started/bridge-ui",
},
]
},
Expand Down

0 comments on commit d1e39cf

Please sign in to comment.