Evmos Burn Auction Instant dApp

The instant dapp for the Burn Auction module of Evmos.

https://store.evmos.org/dapps/defi/burn-auction

Documentation

Pre-requisites:

• Node.js (v20.16.0 or higher)
• Pnpm

Installation

pnpm install

pnpm prisma:db:push

cp .env.example .env
# edit the .env file with your own values

Development

pnpm dev # to run all the services (next, dappstore, indexer)

# or run each service separately
pnpm dev:next # to run only the next.js app
pnpm dev:dappstore # to run the dappstore sdk preview that handles the wallet connection
pnpm dev:indexer # to run the indexer that indexes the blockchain events into the database

Build

pnpm build

Test with a local node

Follow the instructions described in this issue in order to run a local node with the Burn Auction module enabled check this file.

Indexing Endpoints

To index blockchain events into the database, you can use the following endpoints:

• /api/v1/indexer/bid-events: Indexes bid events from the blockchain to the database.
• /api/v1/indexer/auction-end-events: Indexes auction end events from the blockchain to the database.

These endpoints will index events from the block number specified in process.env.FIRST_AUCTION_BLOCK to the latest block number in batches of 10000 blocks.

In order to have the dApp work properly you will need a cron job to call these indexing endpoints ideally at every block, in practice every 30 seconds should be enough.

Community

The following chat channels and forums are a great spot to ask questions about Evmos:

• Evmos Twitter
• Evmos Discord
• Evmos Forum

Contributing

Looking for a good place to start contributing? Check out some good first issues.

For additional instructions, standards and style guides, please refer to the Contributing document.

Careers

See our open positions on Greenhouse.

Disclaimer

The software is provided “as is”, without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose and noninfringement. In no event shall the authors or copyright holders be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with the software or the use or other dealings in the software.

Licensing

Starting from April 21th, 2023, this repository will update its license to Evmos Non-Commercial License 1.0 (ENCL-1.0). For more information see LICENSE.

SPDX Identifier

The following header including a license identifier in SPDX short form has been added in all ENCL-1.0 files:

// Copyright Tharsis Labs Ltd.(Evmos)
// SPDX-License-Identifier:ENCL-1.0(https://github.com/evmos/burn-auction-dapp/blob/main/LICENSE)

License FAQ

Find below an overview of Permissions and Limitations of the Evmos Non-Commercial License 1.0. For more information, check out the full ENCL-1.0 FAQ here.