Skip to content
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
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# Contributing to EOS Docs
# Contributing to Vaulta Docs

First, the fact you're even here right now means you're awesome. Thanks!

Contributing can be as easy or as hard as you want it to be.
We're happy to accept anything from small typo corrections to entirely new documents.
If you're looking for a place to start, consider [taking an item from our backlog](https://github.com/orgs/eosnetworkfoundation/projects/18/views/10)
If you're looking for a place to start, consider [taking an item from our backlog](https://github.com/orgs/vaultafoundation/projects/18/views/10)
that doesn't have a `🔥 crit` priority (we usually take those in our upcoming iteration)

Some ways you can contribute:
- [Reporting an issue](https://github.com/eosnetworkfoundation/docs/issues)
- [Reporting an issue](https://github.com/vaultafoundation/docs/issues)
- [Creating new documents](#creating-a-new-document)
- Updating existing documents (same process as creating a new document)

Expand All @@ -24,7 +24,7 @@ Some ways you can contribute:
## Creating a new document

Here is the process for creating a new document:
- [Fork the repository](https://github.com/eosnetworkfoundation/docs/fork)
- [Fork the repository](https://github.com/vaultafoundation/docs/fork)
- Switch to the `staging` branch (`git checkout staging`)
- Create a new branch (`git checkout -b doc/my-new-document`)
- Create your document in the `native` or `evm`
Expand Down
4 changes: 2 additions & 2 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License
eosnetworkfoundation/docs
Copyright (c) 2021-2022 EOS Network Foundation (ENF) and its contributors. All rights reserved.
vaultafoundation/docs
Copyright (c) 2021-2025 Vaulta Foundation (VF) and its contributors. All rights reserved.
This ENF software is based upon:

EOSIO/welcome
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Welcome

This repository contains the source of truth for the [EOS documentation site](http://docs.eosnetwork.com/welcome/latest/).
This repository contains the source of truth for the [Vaulta documentation site](http://docs.vaulta.com/).

Interested in contributing? That's awesome!
[Here are some guidelines to get started quickly and easily](CONTRIBUTING.md).
Expand Down
8 changes: 4 additions & 4 deletions evm/10_quick-start/01_introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@
title: Introduction
---

EOS EVM is a fully compatible Ethereum Virtual Machine (EVM) that runs on the EOS Network. This opens
up the EOS Network to the entire Ethereum developer community and tooling.
Vaulta EVM is a fully compatible Ethereum Virtual Machine (EVM) that runs on Vaulta. This opens
up Vaulta to the entire Ethereum developer community and tooling.

You can now take advantage of the EOS Network's high throughput and low latency by deploying and running
smart contracts written for the EVM on the EOS Network.
You can now take advantage of Vaulta's high throughput and low latency by deploying and running
smart contracts written for the EVM on Vaulta.

## Features

Expand Down
6 changes: 3 additions & 3 deletions evm/10_quick-start/02_setup-metamask.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Setup MetaMask
---

Click either of these buttons to instantly add EOS EVM to your MetaMask.
Click either of these buttons to instantly add Vaulta EVM to your MetaMask.

<!-- translation-ignore -->

Expand All @@ -21,7 +21,7 @@ manually with the information below.

### Mainnet

* `Network Name`: EOS EVM
* `Network Name`: Vaulta EVM
* `Chain ID`: 17777
* `New RPC URL`: https://api.evm.eosnetwork.com/
* `Currency Symbol`: EOS
Expand All @@ -30,7 +30,7 @@ manually with the information below.

### Testnet

* `Network Name`: EOS EVM Testnet
* `Network Name`: Vaulta EVM Testnet
* `Chain ID`: 15557
* `New RPC URL`: https://api.testnet.evm.eosnetwork.com/
* `Currency Symbol`: EOS
Expand Down
66 changes: 42 additions & 24 deletions evm/10_quick-start/03_evm-tokens.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,12 @@
title: EVM Tokens
---

The `EOS` tokens on the `EOS EVM` are the exact same tokens as the ones on the `EOS Network`.

This means that `EOS` tokens you see on exchanges are the same as the ones you use on `EOS EVM`. However, since most
exchanges only support the native version of those tokens, you must *bridge* your tokens to use them on the EVM.
The `Vaulta EVM` uses EOS tokens as the gas token.
You can bridge those tokens from Vaulta to EOS and back again by using the `Vaulta EVM Bridge`.

## Testnet faucet

Want some EOS tokens to play with? Click the button below to get some from the testnet faucet.
Want some Vaulta EVM tokens to play with? Click the button below to get some from the testnet faucet.

<!-- translation-ignore -->

Expand All @@ -19,59 +17,79 @@ import FaucetTokens from '@site/src/components/FaucetTokens/FaucetTokens';

<!-- end-translation-ignore -->

## Bridge from EOS to EOS EVM
## Bridge from Vaulta to Vaulta EVM

### Bridge tokens yourself

If you have **EOS** tokens on the `EOS Mainnet` or `Jungle Testnet`, you can send **EOS** directly to your EVM address.
Open your wallet and send **EOS** tokens to `eosio.evmin` with your EVM address as the `memo`.
If you have **Vaulta** tokens on Vaulta or Jungle Testnet, you will need to swap your Vaulta to EOS and then send
**EOS** directly to your EVM address.

> ⚠ **Disclaimer:**
>
> If you have Vaulta tokens and need EOS tokens you can send your Vaulta tokens to `core.vaulta` and it will be swapped and sent back to you.

Open your wallet and send **EOS** tokens to `eosio.evmin` with your EVM address as the `memo`.

### Bridge tokens from an exchange

Depending on whether the exchange supports Vaulta or EOS you might have to swap your tokens.

> ⚠ **Disclaimer:**
>
> Not all exchanges support sending tokens to a smart contract. Depending on the exchange you are using you might need
> to first send the tokens to your own wallet and then follow the directions in the previous section.

To withdraw EOS tokens from a centralized exchange (CEX) to an EOS EVM address:
To withdraw EOS tokens from a centralized exchange (CEX) to a Vaulta EVM address:

1. Visit the withdrawal screen of the Exchange's app
2. Select EOS as Coin
3. Select EOS as Network
4. Enter `eosio.evmin` as Wallet Address
5. Enter your EOS EVM public key as Memo
4. Open your wallet and transfer your EOS tokens
1. Enter `eosio.evmin` as Wallet Address
2. Enter your Vaulta EVM public key as Memo

![EOS EVM Token Flow](/images/EOS-EVM_withdraw_from_CEX_to_wallet.png)
![Vaulta EVM Token Flow](/images/EOS-EVM_withdraw_from_CEX_to_wallet.png)

To withdraw Vaulta tokens from a centralized exchange (CEX) to a Vaulta EVM address:
1. Visit the withdrawal screen of the Exchange's app
2. Select `A` as Coin
3. Select Vaulta as Network
4. Swap your Vaulta tokens to EOS
1. Send Vaulta tokens to `core.vaulta` to get EOS
5. Open your wallet and transfer your EOS tokens
1. Enter `eosio.evmin` as Wallet Address
2. Enter your Vaulta EVM public key as Memo



## Bridge from EOS EVM to EOS
## Bridge from Vaulta EVM to Vaulta

### Bridge tokens yourself

To transfer tokens from an EVM address to an EOS account you must use the [EOS EVM Mainnet Bridge](https://bridge.evm.eosnetwork.com/)
or the [EOS EVM Jungle Testnet Bridge](https://bridge.testnet.evm.eosnetwork.com/).
To transfer tokens from an EVM address to a Vaulta account you must use the [Vaulta EVM Mainnet Bridge](https://bridge.evm.eosnetwork.com/)
or the [Vaulta EVM Jungle Testnet Bridge](https://bridge.testnet.evm.eosnetwork.com/).

1. Select `Withdraw`
2. Connect your wallet
3. Enter an amount
4. Enter an EOS account to send to
1. Add an optional memo
5. Click `Transfer`
4. Enter a Vaulta account to send to
5. Add an optional memo
6. Click `Transfer`

At this point, if you need Vaulta you can swap back:
1. Send your EOS tokens to `core.vaulta`
2. This will send back the same amount of Vaulta tokens to your account

### Bridge tokens to an exchange

> ⚠ **Disclaimer:**
>
> Some exchanges do not yet support tracking inline transfers on EOS, which prevents them from seeing EOS EVM transfers.
> If you are in doubt whether your exchange supports this, first bridge tokens to the native EOS Network, and then send them
> to your exchange account.
> Some exchanges do not yet support tracking inline transfers on Vaulta, which prevents them from seeing Vaulta EVM transfers.
> If you are in doubt whether your exchange supports this, first bridge tokens to the native Vaulta network, and then send them to your exchange account.

You can follow the same process as above, but instead of entering an EOS account, enter your exchange account name.
You can follow the same process as above, but instead of entering an Vaulta account, enter your exchange account name.

Most EOS exchanges also require a `memo` field, so make sure you enter it there **or your tokens will be lost**.
Most exchanges also require a `memo` field, so make sure you enter it there **or your tokens will be lost**.



Expand All @@ -82,7 +100,7 @@ Most EOS exchanges also require a `memo` field, so make sure you enter it there

## Important ERC-20 tokens

There are a few ERC-20 tokens that are available on the `EOS EVM` which serve as core components of apps and defi.
There are a few ERC-20 tokens that are available on the `Vaulta EVM` which serve as core components of apps and defi.

### Wrapped EOS

Expand Down
7 changes: 1 addition & 6 deletions evm/10_quick-start/10_endpoints.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,13 @@
title: Endpoints
---

<head><title>EOS EVM Endpoints</title></head>
<head><title>Vaulta EVM Endpoints</title></head>

| Network | RPC URL | Chain ID |
| --- |--------------------|----------|
| Mainnet | [api.evm.eosnetwork.com](https://api.evm.eosnetwork.com) | 17777 |
| Testnet | [api.testnet.evm.eosnetwork.com](https://api.testnet.evm.eosnetwork.com) | 15557 |

> 💰 **Premium APIs:**
>
> If you're looking for premium API services you can join the
> [EOS Servers](https://t.me/eosservers) Telegram group where you can find premium API providers.

## Explorers

| Network | Explorer URL |
Expand Down
2 changes: 1 addition & 1 deletion evm/15_core-concepts/02_gas.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,5 @@ on [EVM Codes](https://www.evm.codes/).
If the transaction runs out of gas before it completes, then the transaction will fail and all changes will be reverted,
but the gas spent will not be refunded.

> **Note**: EOS EVM's gas price is fixed. It is currently set at `150000000000`.
> **Note**: Vaulta EVM's gas price is fixed. It is currently set at `150000000000`.
>
2 changes: 1 addition & 1 deletion evm/20_smart-contracts/01_contract-anatomy.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ contract MyContract {

> ⚠ **PUSH0 opcode**
>
> Currently the EOS EVM does not support the `PUSH0` opcode. This means you must use a version less than `0.8.20` for your Solidity compiler.
> Currently the Vaulta EVM does not support the `PUSH0` opcode. This means you must use a version less than `0.8.20` for your Solidity compiler.

### License identifier

Expand Down
2 changes: 1 addition & 1 deletion evm/20_smart-contracts/02_functions.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ function myFunction() public myModifier1 myModifier2 {}

Functions can accept the native currency of the blockchain as payment. This is done by declaring the function as `payable`.

In the case of the EOS EVM, this is EOS.
In the case of the Vaulta EVM, this is EOS.

```solidity
function myFunction() public payable {
Expand Down
27 changes: 15 additions & 12 deletions evm/20_smart-contracts/20_migrate-your-smart-contract.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@
title: Migrate your Smart Contract
---

This guide will teach you to deploy a smart contract to the EOS EVM using hardhat on both the EOS EVM mainnet and testnet.
This guide will teach you to deploy a smart contract to the Vaulta EVM using hardhat on both the Vaulta EVM mainnet and testnet.

## Set up your MetaMask

Click either of these buttons to instantly add EOS EVM to your MetaMask.
Click either of these buttons to instantly add Vaulta EVM to your MetaMask.

<!-- translation-ignore -->

Expand All @@ -32,9 +32,12 @@ import FaucetTokens from '@site/src/components/FaucetTokens/FaucetTokens';

If you're on the testnet, you can get some EOS tokens using the [**testnet faucet**](https://faucet.testnet.evm.eosnetwork.com/).

If you're on the EOS Mainnet, ]you can transfer your native EOS using a standard EOS transfer:
If you're on the Vaulta Mainnet, ]you can transfer your native EOS using a standard EOS transfer:
- Send tokens to: `eosio.evm`
- Set the `memo` to your EOS EVM address
- Set the `memo` to your Vaulta EVM address

> ⚠️ **Important**
> If you have only Vaulta, you will need to swap it to EOS. See the EVM tokens page below for more information.

For more ways to get EOS tokens, check out the [EVM Tokens](/evm/10_quick-start/03_evm-tokens.md) page.

Expand All @@ -52,11 +55,11 @@ const config: HardhatUserConfig = {
// ...

networks: {
eosevm: {
vaulta_evm: {
url: "https://api.evm.eosnetwork.com",
accounts:[process.env.PRIVATE_KEY],
},
eosevm_testnet: {
vaulta_evm_testnet: {
url: "https://api.testnet.evm.eosnetwork.com",
accounts:[process.env.PRIVATE_KEY],
}
Expand All @@ -75,13 +78,13 @@ const config: HardhatUserConfig = {

## Deploying your contract

Now you can deploy your contract to the EOS EVM testnet:
Now you can deploy your contract to the Vaulta EVM testnet:

```bash
npx hardhat run scripts/deploy.js --network eosevm
npx hardhat run scripts/deploy.js --network vaulta_evm

// or for testnet
npx hardhat run scripts/deploy.js --network eosevm_testnet
npx hardhat run scripts/deploy.js --network vaulta_evm_testnet
```

Once deployed, you will see the address of your new contract, and can view it an explorer by pasting it
Expand All @@ -94,10 +97,10 @@ into the search field.

## Congratulations!

You have successfully deployed your first smart contract to the EOS EVM! 🎉
You have successfully deployed your first smart contract to the Vaulta EVM! 🎉

If you already have a front-end application that interacts with your smart contract, you can now point it at the
[EOS EVM Endpoints](/evm/999_miscellaneous/10_endpoints.md), and it will work as expected.
[Vaulta EVM Endpoints](/evm/999_miscellaneous/10_endpoints.md), and it will work as expected.

Make sure you visit the [**Compatibility**](/evm/999_miscellaneous/20_evm-compatibility.md) section to learn about the differences between
the EOS EVM and Ethereum, and how to make sure your web3 application works on the EOS EVM as expected.
the Vaulta EVM and Ethereum, and how to make sure your web3 application works on the Vaulta EVM as expected.
12 changes: 6 additions & 6 deletions evm/20_smart-contracts/30_develop-with-remix.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Develop with Remix
---

Remix is a web-based IDE that allows you to write, compile, and deploy smart contracts to the EOS EVM.
Remix is a web-based IDE that allows you to write, compile, and deploy smart contracts to the Vaulta EVM.

## Learning the interface

Expand Down Expand Up @@ -127,7 +127,7 @@ In our contract, we defined two functions:

## Compiling your smart contract

Now that we have written our smart contract, we need to compile it so that we can deploy it to the EOS EVM.
Now that we have written our smart contract, we need to compile it so that we can deploy it to the Vaulta EVM.

Click on the `Solidity Compiler` icon in the sidebar.

Expand All @@ -145,15 +145,15 @@ If your contract has any errors, you will see a red box on the sidebar for each

## Deploying your smart contract

Now that we have compiled our smart contract, we can deploy it to the EOS EVM.
Now that we have compiled our smart contract, we can deploy it to the Vaulta EVM.

Click on the `Deploy & Run Transactions` icon in the sidebar.

Then click on the `ENVIROMENT` dropdown and select `Injected Provider - MetaMask`.

> ❕ **Set up your MetaMask first!**
>
> If you haven't already, make sure you have set up your MetaMask wallet and connected it to the EOS EVM.
> If you haven't already, make sure you have set up your MetaMask wallet and connected it to the Vaulta EVM.
>
> **You can follow [this guide](/evm/10_quick-start/02_setup-metamask.md) to learn how to do that.**

Expand All @@ -163,7 +163,7 @@ MetaMask will pop up and ask you to connect an account.

![Remix connect metamask](/images/eos-evm_using-remix_connect-metamask.png)

You can now click the `Deploy` button to deploy your smart contract to the EOS EVM.
You can now click the `Deploy` button to deploy your smart contract to the Vaulta EVM.

This will open up a MetaMask popup asking you to confirm the transaction.

Expand Down Expand Up @@ -239,7 +239,7 @@ in the `Solidity Compiler` tab.

**Congratulations!**

You have now successfully deployed and interacted with your first smart contract on the EOS EVM!
You have now successfully deployed and interacted with your first smart contract on the Vaulta EVM!

You learned about smart contract basics, setting up MetaMask, and using Remix to develop, deploy, and interact with
your smart contract.
2 changes: 1 addition & 1 deletion evm/23_advanced-guides/20_using-multicall3.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Using Multicall3
---

Multicall3 is a contract deployed to the EOS EVM that allows you to batch multiple calls into a single call. This means
Multicall3 is a contract deployed to the Vaulta EVM that allows you to batch multiple calls into a single call. This means
that you can make multiple calls to one or more contracts in a single transaction.

This is useful for reducing the number of transactions you need to make to either read or write data. For instance, if
Expand Down
Loading