How to create a simple smart contract to manage auctions ?

Paulina Lewandowska

07 Dec 2022
How to create a simple smart contract to manage auctions ?

In the previous tutorial you learned how to create a smart contract, which is a wallet. In this tutorial we will try to consolidate the knowledge from the previous tutorial, and expand it with new knowledge. 

So let's get to work. All the things you may not understand will be explained to you later in the text.

Defining variables

Let's start by defining the variables we'll need to make the smart contract work. We certainly need :

  • address of the person to whom the highest bid will be sent,
  • time when the auction in question will end,
  • address of the person who placed the highest bid,
  • why wei is the highest bid,
  • a table of addresses and the amount of money they transferred to the smart contract so that those who did not win the auction can withdraw their money,
  • variable whether the auction is completed or not.
pragma solidity 0.8.11;

contract Auction {

    address payable public beneficiary;

    uint public auctionEndTime;

    address public highestBidder;

    uint public highestBid;

    mapping(address => uint) pendingReturns;

    bool ended;

}

What can you not understand from the above code?

Mapping in solidity is a key-value array, equivalent to dictionary in other languages.

If you don't know why the auctionEndTime variable is given in plain uinta, it's because the time when the auction ends will be given in Unix time.

Let's create a constructor that will take the address to which the highest bid will be sent and how long the auction will last.

constructor(

        uint biddingTime,

        address payable beneficiaryAddress

    ) {

        beneficiary = beneficiaryAddress;

        auctionEndTime = block.timestamp + biddingTime;

    }

What is worth paying attention to ?

  • block.timestamp is a variable that simply means what time it is now given as Unix time of course ;)))

Function for making an offer

Now let's create a function that will be used to submit your bid. The function will return an error if :

  • The auction has ended
  • Our bid will be lower than the highest bid

At the end of the function execution, the function will emit an event that the highest bid has changed. The frontend application can listen to the emitted events on the smartcontest, so that as soon as the highest bid has changed, it can update it in the user interface.

event HighestBidIncreased(address bidder, uint amount);

    event AuctionEnded(address winner, uint amount);

    error AuctionAlreadyEnded();

    error BidNotHighEnough(uint highestBid);

    error AuctionNotYetEnded();

    error AuctionEndAlreadyCalled();

    function bid() external payable {

        if (block.timestamp > auctionEndTime)

            revert AuctionAlreadyEnded();

        if (msg.value <= highestBid)

            revert BidNotHighEnough(highestBid);

        if (highestBid != 0) {

            pendingReturns[highestBidder] += highestBid;

        }

        highestBidder = msg.sender;

        highestBid = msg.value;

        emit HighestBidIncreased(msg.sender, msg.value);

    }

As you can see in the code above, we define ourselves events with parameters that we can emit on the blockchain. To emit an event in solidity we type 

emit + event name and parameters

We have defined our own errors, which if we want to call them we type in revert + the name of our errror and parameters.

You have probably already guessed that instead of ifs and custom errors we could have used requier.

This function checks if the auction has already ended, if msg.value is higher than the highest bid, if so we update the mapping pendingReturns so that the person who placed the highest bid earlier can get his money back. We assign the highest bid to msg.value and the highestBidder to msg.sender, at the end of the function execution we emit an event that informs that the highest bid has been increased.

Function to end the auction, and transfer the highest bid to the benefactor

Now let's create a function so that after the auction ends, the beneficiary's address can send money to his wallet.

This function should:

  • Return an error if the auction has not yet ended,
  • return an error if this function has already been called,
  • change the ended variable to true,
  • emit an event indicating that the auction has ended,
  • transfer an amount of Ethereum equivalent to the highest bid to the benefactor.
function auctionEnd() external {

        if (block.timestamp < auctionEndTime)

            revert AuctionNotYetEnded();

        if (ended)

            revert AuctionEndAlreadyCalled();

        ended = true;

        emit AuctionEnded(highestBidder, highestBid);

        beneficiary.transfer(highestBid);

    }

Function for people who did not win the auction and want their money back

Now, the last function we need to make our contract ready! It will be for addresses that did not win the auction and want to get their money back. Let's consider what such a function should have in it :

  • it should check how much Ethereum you owe in the mapping pendingReturns and assign this value to a variable,
  • it should change how much you owe to 0,
  • it should send as much Ethereum as you have stored in the variable.

Well, let's get to work !

  function withdraw() external{

        uint amount = pendingReturns[msg.sender];

        pendingReturns[msg.sender] = 0;

        payable(msg.sender).transfer(amount);

    }

That's the end of today's tutorial ! Our smart contract is ready. In order to practice and consolidate your knowledge, as a task you can try to replace custom errors with requirs. However, if this is not enough for you, you can also improve this contract so that it can be used to conduct several auctions at once.

Tagi

Most viewed


Never miss a story

Stay updated about Nextrope news as it happens.

You are subscribed

Token Engineering Process

Kajetan Olas

13 Apr 2024
Token Engineering Process

Token Engineering is an emerging field that addresses the systematic design and engineering of blockchain-based tokens. It applies rigorous mathematical methods from the Complex Systems Engineering discipline to tokenomics design.

In this article, we will walk through the Token Engineering Process and break it down into three key stages. Discovery Phase, Design Phase, and Deployment Phase.

Discovery Phase of Token Engineering Process

The first stage of the token engineering process is the Discovery Phase. It focuses on constructing high-level business plans, defining objectives, and identifying problems to be solved. That phase is also the time when token engineers first define key stakeholders in the project.

Defining the Problem

This may seem counterintuitive. Why would we start with the problem when designing tokenomics? Shouldn’t we start with more down-to-earth matters like token supply? The answer is No. Tokens are a medium for creating and exchanging value within a project’s ecosystem. Since crypto projects draw their value from solving problems that can’t be solved through TradFi mechanisms, their tokenomics should reflect that. 

The industry standard, developed by McKinsey & Co. and adapted to token engineering purposes by Outlier Ventures, is structuring the problem through a logic tree, following MECE.
MECE stands for Mutually Exclusive, Collectively Exhaustive. Mutually Exclusive means that problems in the tree should not overlap. Collectively Exhaustive means that the tree should cover all issues.

In practice, the “Problem” should be replaced by a whole problem statement worksheet. The same will hold for some of the boxes.
A commonly used tool for designing these kinds of diagrams is the Miro whiteboard.

Identifying Stakeholders and Value Flows in Token Engineering

This part is about identifying all relevant actors in the ecosystem and how value flows between them. To illustrate what we mean let’s consider an example of NFT marketplace. In its case, relevant actors might be sellers, buyers, NFT creators, and a marketplace owner. Possible value flow when conducting a transaction might be: buyer gets rid of his tokens, seller gets some of them, marketplace owner gets some of them as fees, and NFT creators get some of them as royalties.

Incentive Mechanisms Canvas

The last part of what we consider to be in the Discovery Phase is filling the Incentive Mechanisms Canvas. After successfully identifying value flows in the previous stage, token engineers search for frictions to desired behaviors and point out the undesired behaviors. For example, friction to activity on an NFT marketplace might be respecting royalty fees by marketplace owners since it reduces value flowing to the seller.

source: https://www.canva.com/design/DAFDTNKsIJs/8Ky9EoJJI7p98qKLIu2XNw/view#7

Design Phase of Token Engineering Process

The second stage of the Token Engineering Process is the Design Phase in which you make use of high-level descriptions from the previous step to come up with a specific design of the project. This will include everything that can be usually found in crypto whitepapers (e.g. governance mechanisms, incentive mechanisms, token supply, etc). After finishing the design, token engineers should represent the whole value flow and transactional logic on detailed visual diagrams. These diagrams will be a basis for creating mathematical models in the Deployment Phase. 

Token Engineering Artonomous Design Diagram
Artonomous design diagram, source: Artonomous GitHub

Objective Function

Every crypto project has some objective. The objective can consist of many goals, such as decentralization or token price. The objective function is a mathematical function assigning weights to different factors that influence the main objective in the order of their importance. This function will be a reference for machine learning algorithms in the next steps. They will try to find quantitative parameters (e.g. network fees) that maximize the output of this function.
Modified Metcalfe’s Law can serve as an inspiration during that step. It’s a framework for valuing crypto projects, but we believe that after adjustments it can also be used in this context.

Deployment Phase of Token Engineering Process

The Deployment Phase is final, but also the most demanding step in the process. It involves the implementation of machine learning algorithms that test our assumptions and optimize quantitative parameters. Token Engineering draws from Nassim Taleb’s concept of Antifragility and extensively uses feedback loops to make a system that gains from arising shocks.

Agent-based Modelling 

In agent-based modeling, we describe a set of behaviors and goals displayed by each agent participating in the system (this is why previous steps focused so much on describing stakeholders). Each agent is controlled by an autonomous AI and continuously optimizes his strategy. He learns from his experience and can mimic the behavior of other agents if he finds it effective (Reinforced Learning). This approach allows for mimicking real users, who adapt their strategies with time. An example adaptive agent would be a cryptocurrency trader, who changes his trading strategy in response to experiencing a loss of money.

Monte Carlo Simulations

Token Engineers use the Monte Carlo method to simulate the consequences of various possible interactions while taking into account the probability of their occurrence. By running a large number of simulations it’s possible to stress-test the project in multiple scenarios and identify emergent risks.

Testnet Deployment

If possible, it's highly beneficial for projects to extend the testing phase even further by letting real users use the network. Idea is the same as in agent-based testing - continuous optimization based on provided metrics. Furthermore, in case the project considers airdropping its tokens, giving them to early users is a great strategy. Even though part of the activity will be disingenuine and airdrop-oriented, such strategy still works better than most.

Time Duration

Token engineering process may take from as little as 2 weeks to as much as 5 months. It depends on the project category (Layer 1 protocol will require more time, than a simple DApp), and security requirements. For example, a bank issuing its digital token will have a very low risk tolerance.

Required Skills for Token Engineering

Token engineering is a multidisciplinary field and requires a great amount of specialized knowledge. Key knowledge areas are:

  • Systems Engineering
  • Machine Learning
  • Market Research
  • Capital Markets
  • Current trends in Web3
  • Blockchain Engineering
  • Statistics

Summary

The token engineering process consists of 3 steps: Discovery Phase, Design Phase, and Deployment Phase. It’s utilized mostly by established blockchain projects, and financial institutions like the International Monetary Fund. Even though it’s a very resource-consuming process, we believe it’s worth it. Projects that went through scrupulous design and testing before launch are much more likely to receive VC funding and be in the 10% of crypto projects that survive the bear market. Going through that process also has a symbolic meaning - it shows that the project is long-term oriented.

If you're looking to create a robust tokenomics model and go through institutional-grade testing please reach out to contact@nextrope.com. Our team is ready to help you with the token engineering process and ensure your project’s resilience in the long term.

FAQ

What does token engineering process look like?

  • Token engineering process is conducted in a 3-step methodical fashion. This includes Discovery Phase, Design Phase, and Deployment Phase. Each of these stages should be tailored to the specific needs of a project.

Is token engineering meant only for big projects?

  • We recommend that even small projects go through a simplified design and optimization process. This increases community's trust and makes sure that the tokenomics doesn't have any obvious flaws.

How long does the token engineering process take?

  • It depends on the project and may range from 2 weeks to 5 months.

What is Berachain? 🐻 ⛓️ + Proof-of-Liquidity Explained

Karolina

18 Mar 2024
What is Berachain? 🐻 ⛓️ + Proof-of-Liquidity Explained

Enter Berachain: a high-performance, EVM-compatible blockchain that is set to redefine the landscape of decentralized applications (dApps) and blockchain services. Built on the innovative Proof-of-Liquidity consensus and leveraging the robust Polaris framework alongside the CometBFT consensus engine, Berachain is poised to offer an unprecedented blend of efficiency, security, and user-centric benefits. Let's dive into what makes it a groundbreaking development in the blockchain ecosystem.

What is Berachain?

Overview

Berachain is an EVM-compatible Layer 1 (L1) blockchain that stands out through its adoption of the Proof-of-Liquidity (PoL) consensus mechanism. Designed to address the critical challenges faced by decentralized networks. It introduces a cutting-edge approach to blockchain governance and operations.

Key Features

  • High-performance Capabilities. Berachain is engineered for speed and scalability, catering to the growing demand for efficient blockchain solutions.
  • EVM Compatibility. It supports all Ethereum tooling, operations, and smart contract languages, making it a seamless transition for developers and projects from the Ethereum ecosystem.
  • Proof-of-Liquidity.This novel consensus mechanism focuses on building liquidity, decentralizing stake, and aligning the interests of validators and protocol developers.

MUST READ: Docs

EVM-Compatible vs EVM-Equivalent

EVM-Compatible

EVM compatibility means a blockchain can interact with Ethereum's ecosystem to some extent. It can interact supporting its smart contracts and tools but not replicating the entire EVM environment.

EVM-Equivalent

An EVM-equivalent blockchain, on the other hand, aims to fully replicate Ethereum's environment. It ensures complete compatibility and a smooth transition for developers and users alike.

Berachain's Position

Berachain can be considered an "EVM-equivalent-plus" blockchain. It supports all Ethereum operations, tooling, and additional functionalities that optimize for its unique Proof-of-Liquidity and abstracted use cases.

Berachain Modular First Approach

At the heart of Berachain's development philosophy is the Polaris EVM framework. It's a testament to the blockchain's commitment to modularity and flexibility. This approach allows for the easy separation of the EVM runtime layer, ensuring that Berachain can adapt and evolve without compromising on performance or security.

Proof Of Liquidity Overview

High-Level Model Objectives

  • Systemically Build Liquidity. By enhancing trading efficiency, price stability, and network growth, Berachain aims to foster a thriving ecosystem of decentralized applications.
  • Solve Stake Centralization. The PoL consensus works to distribute stake more evenly across the network, preventing monopolization and ensuring a decentralized, secure blockchain.
  • Align Protocols and Validators. Berachain encourages a symbiotic relationship between validators and the broader protocol ecosystem.

Proof-of-Liquidity vs Proof-of-Stake

Unlike traditional Proof of Stake (PoS), which often leads to stake centralization and reduced liquidity, Proof of Liquidity (PoL) introduces mechanisms to incentivize liquidity provision and ensure a fairer, more decentralized network. Berachain separates the governance token (BGT) from the chain's gas token (BERA) and incentives liquidity through BEX pools. Berachain's PoL aims to overcome the limitations of PoS, fostering a more secure and user-centric blockchain.

Berachain EVM and Modular Approach

Polaris EVM

Polaris EVM is the cornerstone of Berachain's EVM compatibility, offering developers an enhanced environment for smart contract execution that includes stateful precompiles and custom modules. This framework ensures that Berachain not only meets but exceeds the capabilities of the traditional Ethereum Virtual Machine.

CometBFT

The CometBFT consensus engine underpins Berachain's network, providing a secure and efficient mechanism for transaction verification and block production. By leveraging the principles of Byzantine fault tolerance (BFT), CometBFT ensures the integrity and resilience of the Berachain blockchain.

Conclusion

Berachain represents a significant leap forward in blockchain technology, combining the best of Ethereum's ecosystem with innovative consensus mechanisms and a modular development approach. As the blockchain landscape continues to evolve, Berachain stands out as a promising platform for developers, users, and validators alike, offering a scalable, efficient, and inclusive environment for decentralized applications and services.

Resources

For those interested in exploring further, a wealth of resources is available, including the Berachain documentation, GitHub repository, and community forums. It offers a compelling vision for the future of blockchain technology, marked by efficiency, security, and community-driven innovation.

FAQ

How is Berachain different?

  • It integrates Proof-of-Liquidity to address stake centralization and enhance liquidity, setting it apart from other blockchains.

Is Berachain EVM-compatible?

  • Yes, it supports Ethereum's tooling and smart contract languages, facilitating easy migration of dApps.

Can it handle high transaction volumes?

  • Yes, thanks to the Polaris framework and CometBFT consensus engine, it's built for scalability and high throughput.