Skip to content

Commit

Permalink
Add bridging explanation (#2410)
Browse files Browse the repository at this point in the history
* Add bridging explanation

* spag comment
  • Loading branch information
bob0005 authored Dec 11, 2024
1 parent 2bdb72f commit 239a550
Show file tree
Hide file tree
Showing 2 changed files with 67 additions and 31 deletions.
58 changes: 33 additions & 25 deletions docs/pages/overview/bridging.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,20 +3,26 @@ import { Callout } from "vocs/components";
# Bridge Closure

<Callout type="danger">
Important information – Game Bridge **permanently** closes **48 hours** after victory has been claimed. <br />

# Critical End-Game Information
The Game Bridge **permanently** closes **48 hours** after after victory has been claimed.

[Read the full End Season Disclaimer](/overview/disclaimer) to understand all risks and limitations.
</Callout>

## Bridging in Eternum

Eternum is a fully onchain game with immutable smart contracts, meaning the game rules cannot be altered after
deployment. Bridging tokens in and out of the game is a core mechanic, but you must carefully manage this process. The
game bridge closes **forever** 48 hours after the game ends (victory claimed). Any tokens left in the game at that time
are **permanently locked** in the contract (effectively **burned**).

Bridging out of the game is done by sending resources to a bank. This process takes **time and requires donkeys** as
part of the gameplay mechanics. Since the contracts are immutable, "code is law." Players must plan accordingly, as the
developers cannot modify the system after deployment.
Eternum is a fully onchain game with immutable smart contracts, meaning the game rules cannot be altered. Bridging tokens in and out of the game is a core mechanic, but you must carefully manage this process.

<Callout type="warning">
### End Game Bridge Closure
- The game bridge closes **permanently** 48 hours after "End Season" is triggered
- Only resources in your Realm's direct balance can be bridged out
- Resources in the following locations are NOT part of your bridgeable balance:
- AMM Liquidity Pool positions
- Open market orders
- Resources in transit
- Any resources not bridged out by the deadline are **permanently locked** in the contract
</Callout>

## Bridging in

Expand Down Expand Up @@ -49,22 +55,24 @@ You can bridge out resources from the game, which will be converted to the ERC20

### Game End

When the game ends, players will have **48 hours** to withdraw all in-game assets including:
When "End Season" is triggered:

> - All **$LORDS** tokens
> - Resources in storage
> - Market orders
> - Liquidity pool positions
> - Any other in-game assets
1. A **48-hour countdown** begins immediately
2. During this window, you can only:
- Bridge out **$LORDS** and resources from your Realm's direct balance
- Register your score (within 4 days)

To preserve your assets, you **must**:

> 1. Remove liquidity from AMM pools before the game ends.
> 2. Cancel open orders on the Order Book.
> 3. Bridge out **$LORDS** and **Resources** through the Central Bank before the game ends.
### ⚠️ Key Reminders ⚠️

- The 48 hour window after the game ends is your **final** opportunity to secure your in-game assets.
- Developers **cannot** intervene or make exceptions after the bridge closes.
- Plan ahead to ensure a smooth and timely withdrawal of your assets.
> 1. Remove all liquidity from AMM pools **before** the season ends
> 2. Cancel all open orders on the Order Book **before** the season ends
> 3. Ensure all resource transfers to your Realm are completed **before** the season ends
> 4. Bridge out **$LORDS** and **Resources** from your Realm's balance within the 48-hour window
<Callout type="error">
### ⚠️ Permanent Loss Warning ⚠️
- The 48-hour countdown is **final** and **cannot be extended**
- Developers **cannot** recover any assets after the bridge closes
- Any resources not in your Realm's direct balance **cannot** be bridged out
- Plan ahead to ensure all your assets are in your Realm's balance before the season ends
</Callout>
40 changes: 34 additions & 6 deletions docs/pages/overview/disclaimer.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,41 @@ A season of Eternum concludes when a single player achieves the required
**{formatNumberWithSpaces(HYPERSTRUCTURE_POINTS_FOR_WIN)}** Victory Points and clicks the "End Season" button. At this
point:

- A **48 hour** period begins where you **must** bridge out **ALL $LORDS** tokens and in-game resources.
- After this period, **ALL $LORDS** tokens and **Resources** are **permanently** locked within the game.
- Individual rewards are claimed by **registering** scores. Players will have **4 days** to register their scores and
**must** register to be eligible. There is **no** time limit to claim prizes.

Players are encouraged to review the documentation for instructions on how to bridge tokens out during the active
gameplay phase.

### ⚠️ SEASON END CRITICAL INFORMATION

When the season ends, **ALL in-game actions are DISABLED.**

#### ⛔️ Disabled Actions
- You **cannot** retrieve LP positions from the AMM
- You **cannot** cancel market orders to retrieve locked resources
- You **cannot** conclude ongoing battles

1. **48-Hour Withdrawal Window (starts immediately when "End Season" is clicked)**
- Starting from the exact moment the season ends, you have **48 hours** to bridge out **ALL $LORDS** tokens and resources from your Realms' balance
- **IMPORTANT:** Your Realm's balance withdrawal:
- Can be BLOCKED if your Realm is in an active battle
- Does NOT include resources that are:
- Locked in AMM LP positions
- Locked in market orders
- In transit to your Realm (not yet deposited)
- These locked/in-transit resources CANNOT be recovered after the season ends

2. **After 48 Hours**
- Any remaining **$LORDS** tokens and **Resources** will be **permanently locked**
- These assets **CANNOT** be recovered under any circumstances

3. **Score Registration**
- Players have **4 days** to register their scores
- Registration is **MANDATORY** to be eligible for prizes
- While registration has a deadline, prize claiming does not

<Callout type="warning">
**PRO TIP:** Don't wait for the season to end! You can and should start bridging out tokens during active gameplay to minimize risk.
</Callout>

Please refer to the documentation for detailed instructions on the bridging process during active gameplay.

## No Recourse

Expand Down

0 comments on commit 239a550

Please sign in to comment.