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

Docs edit #2

Open
wants to merge 12 commits into
base: main
Choose a base branch
from
10 changes: 4 additions & 6 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,12 @@
sidebar_position: 1
---


# Overview

![](./assets/logoFull.png)

Tholgar is a DeFi protocol that builds products on top of other DeFi protocols, enabling users to achieve higher yields than they could achieve individually.

We foster synergy with Paladin Vote stakeholders to build products that will benefit the entire ecosystem.

Tholgar is a DeFi protocol that build products on top of other DeFi protocol enabling users to gain higher yield than alone.

We empower synergy with Paladin Vote stakeholders to build products that will benefit the whole ecosystem.

Our first product is an auto-compounder built on top of Warlord. It will let anyone join a vault and gain higher and more optimized yield in a non custodial manner.
Our first product is an auto-compounder built on top of Warlord, allowing anyone to participate in a vault and attain higher, more optimized yields in a non-custodial manner.
74 changes: 0 additions & 74 deletions docs/warlord-vault/deposit.md

This file was deleted.

70 changes: 70 additions & 0 deletions docs/warlord-vault/depositing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
---
order: 3
---

# Depositing

Currently, two set of tokens can be deposited: $WAR and $AURA/$CVX. The process is nearly the same for both sets.

## Depositing $WAR

### Accessing the $WAR deposit

The $WAR deposit is the default option when the app is loaded. However, you can still access it by clicking on the deposit tab and choosing the $WAR token in the bottom-left dropdown menu.

![](../assets/WarDeposit.png)

### Depositing

#### Amount to deposit

Input the desired amount of $WAR you intend to deposit and click the "Deposit" button.

#### Approval

A dialog will open, initially asking you to approve the spending of $WAR (in accordance with ERC-20 standards). You have the option to either approve only the deposit amount or approve the maximum spending to bypass this step in future deposits.

![](../assets/WarDeposit-Approve.png)

#### Deposit

You will then be prompted to sign the transaction to complete the deposit. This marks the final step in the process.

![](../assets/WarDeposit-Deposit.png)

#### Verify

The "Circulating Supply" and "WAR Locked" statistics should reflect an increase by the amount of your deposit. If this change is not immediate, please try refreshing your page.

![](../assets/WarDeposit-Deposited.png)

## Depositing $AURA/$CVX
### Accessing the $AURA/$CVX deposit

To access the $AURA/$CVX deposit, you need to switch the deposit token(s) by using the dropdown menu located in the bottom-left corner of the deposit tab.

![](../assets/AuraCvxDeposit.png)

### Depositing

#### Amount to deposit

Enter the desired amount of $AURA and/or $CVX you want to deposit, and then click the "Deposit" button.

#### Approval

A dialog will open, initially asking you to approve the spending of $AURA and/or $CVX (in accordance with ERC-20 standards). You have the option to either approve only the deposit amount or approve the maximum spending to bypass this step in future deposits.
![](../assets/AuraCvxDeposit-ApproveAura.png)
![](../assets/AuraCvxDeposit-ApproveCvx.png)

#### Deposit

You will then be prompted to sign the transaction to complete the deposit. This marks the final step in the process.

![](../assets/AuraCvxDeposit-Deposit.png)

#### Verify

The "Circulating Supply" and "WAR Locked" statistics should reflect an increase by the amount of your deposit. If this change is not immediate, please try refreshing your page.

![](../assets/AuraCvxDeposit-Deposited.png)
18 changes: 9 additions & 9 deletions docs/warlord-vault/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,20 +6,20 @@ order: 5

## What is Warlord ?

Warlord is an index of governance tokens which gains yield and that will auto compound some rewards into WAR + optimize the overall yield with an auto voter on most rewarding vote incentives. You can read more about it [here](https://doc.paladin.vote/warlord/overview).
Warlord is an index of governance tokens that generates yield and automatically compounds some ot the rewards into $WAR, optimizing the overall yield through an auto-voter for the most rewarding vote incentives. You can read more about it [!ref target="blank" text="here"](https://doc.paladin.vote/warlord/overview).

## What is the Warlord Vault ?

It is a product built by Tholgar team. This is an auto-compounder built on top of Warlord. It will let anyone join a vault and gain higher and more optimized yield in a non custodial manner.
All vote incentives will be claimed every week and auto-compounded into the vault gaining even more yield.
It uses the ERC4626 standard to follow the industry standart developped by yearn to enable more composability with other protocols.
The Warlord Vault is a product built by the Tholgar team. It is an auto-compounder built on top of Warlord, enabling anyone to participate in a Vault and achieve higher, more optimized yields in a non-custodial manner.

All vote incentives will be claimed on a weekly basis and automatically compounded into the Vault, resulting in even higher yields.

It follows the ERC-4626 standard, aligning with the industry standard developed by Yearn to enhance composability with other protocols.

![](../assets/schema.png)

## Addresses

- Vault: [0x188cA46Aa2c7ae10C14A931512B62991D5901453](https://etherscan.io/address/0x188ca46aa2c7ae10c14a931512b62991d5901453)
- Zap: [0x0598c652eEB0F95137Af02f32022005139453744](https://etherscan.io/address/0x0598c652eeb0f95137af02f32022005139453744)
- Swapper: [0x4247d145049B426d39f19F41555137D9cB154B99](https://etherscan.io/address/0x4247d145049b426d39f19f41555137d9cb154b99)
- Vault: [!ref target="blank" text="0x188cA46Aa2c7ae10C14A931512B62991D5901453"](https://etherscan.io/address/0x188ca46aa2c7ae10c14a931512b62991d5901453)
- Zap: [!ref target="blank" text="0x0598c652eEB0F95137Af02f32022005139453744"](https://etherscan.io/address/0x0598c652eeb0f95137af02f32022005139453744)
- Swapper: [!ref target="blank" text="0x4247d145049B426d39f19F41555137D9cB154B99"](https://etherscan.io/address/0x4247d145049b426d39f19f41555137d9cb154b99)
11 changes: 0 additions & 11 deletions docs/warlord-vault/redeem.md

This file was deleted.

11 changes: 11 additions & 0 deletions docs/warlord-vault/redeeming.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
order: 1
---

# Redeeming

To redeem in $AURA/$CVX, you will need to first withdraw your $tWAR into $WAR tokens ([see how](withdraw.md)).

Once you have $WAR tokens in your wallet, you will need to go to Paladin's Warlord app to initiate the redemption process.

The instructions can be found here <https://doc.paladin.vote/warlord/redeeming-war>
Loading