Home / JavaScript / Miscellaneous

Repository containing the CowSwap Governance Token smart contract

CowSwap Token This repository contains the Solidity smart contract code for the CowSwap token. Overview This repo contains all code related to the dep
Information
Category: JavaScript / Miscellaneous
Watchers: 4
Star: 4
Fork: 0
Last update: Dec 29, 2021
Resource links
https://github.com/gnosis/cow-token

CowSwap Token

This repository contains the Solidity smart contract code for the CowSwap token.

Overview

This repo contains all code related to the deployment of the CowSwap token contract and the tools that manage how the token will be distributed.

Two contracts will be deployed onchain: the CowSwap token contract (COW) and a "virtual" CowSwap token (vCOW). The Cowswap token is a standard ERC20 token that can optionally be minted by the CowDao, up to 3% of the total supply each year. The virtual token manages how the real token is distributed and cannot be transferred.

In the deployment transaction, all existing COW tokens are minted and sent to the CowSwap DAO. Shares of virtual tokens will be assigned to the users in advance based on a Merkle tree that is determined at deployment time. Some claims will be paid (with different currencies), some will be vesting in time, and some will be cancellable. All claims have a deadline, the latest is six weeks after deployment; no claim can be redeemed after its deadline has passed. Claims can be exercised by anyone, but only the claim owner can partially redeem them.

After all shares of virtual token have been distributed, they may be made convertible to COW tokens by the CowDao. To do this, the DAO would have to send to the virtual token contract the exact amount of COW tokens needed to cover all exercised virtual token claims. Then, the claim owner will be able to swap virtual tokens to real tokens, effectively converting virtual tokens to real tokens one to one.

Getting Started

Building the Project

yarn
yarn build

Running Tests

yarn test

Test coverage

The contracts code in this repo is fully covered by unit tests. Test coverage can be checked by running the following command:

yarn coverage

A summary of coverage results are printed out to console. More detailed information is presented in the generated file coverage/index.html.

Contracts that are either vendored from other repositories or only used in tests are not included in coverage.

Gas Reporter

Gas consumption can be estimated from the tests. Setting the REPORT_GAS flag when running tests shows details on the gas consumption of each method.

REPORT_GAS=1 yarn test

Contract Code Size

Contract code size can be benched by running:

yarn bench:code-size

Deploying Contracts

The contracts are expected to be deployed by the Gnosis DAO using the Zodiac module. A script to create this transaction will be included in this repo.

1 Open More issues
Closed

Allow reading claims from CSV for test deployment

Instead of always generating random claims, allows to specify a CSV claim file that will be used as the list of all claims available in the test deployment.

Note that the plan is to isolate the random claim generation to its own script and use the csv file mode as the only mode of operation of this script. This means that in a future PR all the ifs introduced in this PR will be removed.

This change requires the csv npm package. To my understanding it's a well-known package to manage CSV files.

Test Plan

New unit tests. Also manual script testing.

First create a file ./claims.csv with the following content:

Account,Airdrop
0x4242424242424242424242424242424242424242,1337

Then execute the test deployment script pointing to this file:

$ npx hardhat test-deployment --network rinkeby --mnemonic "claim all milk together toward moon swap coin become rich quick guitar" ./claims.csv 
Using deployer 0xe90C3A883c386636192B0199BbDC933a66BDf43c
Reading user claims from file...
Generating Merkle proofs...
Setting up administration addresses...
Generating deploy transactions...
Clearing old files...
Saving generated data to file...
Deploying real token...
Deploying virtual token...

Look for example at output/claims.json and notice that there is only a single claim, as expected:

[{"account":"0x4242424242424242424242424242424242424242","type":0,"claimableAmount":{"type":"BigNumber","hex":"0x0539"},"index":0,"proof":[]}]
opened Jan 19, 2022 by fedgiac 7
Closed

Make vCOW swappable

Creates a script that generates the DAO proposal for making vCOW swappable.

For now, it only handles mainnet, but it will be extended to handle Gnosis Chain.

Test Plan

New unit tests. Also, try out the script as in the readme. I simulated the resulting transaction on Tenderly and it does execute the transfer, but I'm not able to get a link I can use to share, so you'd have to try yourself.

opened Feb 23, 2022 by fedgiac 5
Closed

Add script to generate Rinkeby deployment

Note: the first commit of this PR has code that was already read (and in part approved) by the people I'm requesting a review from. The logic doesn't need to be checked again except for the (few) new changes that were discussed in the previous reviews, which appear in separate commits.

when developing the smart contract, so the reviews in there still apply to this PR. That PR was ready to merge except for two comments that I will discuss here.

Description

Creates a script that generates pseudorandom claims and deploys the token contracts on the chosen network. It tries to make a realistic deployment, so all address parameters of the deployment (like the DAO or the fund targets) are Gnosis Safes, owned by the deployer.

It can be used to generate a test deployment on Rinkeby that the frontend can use to test that the website works.

This is how the script can be used:

$ npx hardhat test-deployment --help
Hardhat version 2.7.1

Usage: hardhat [GLOBAL OPTIONS] test-deployment --gno-token <STRING> --mnemonic <STRING> [--total-supply <STRING>] [--usdc-per-cow <STRING>] [--usdc-per-gno <STRING>] [--usdc-per-weth <STRING>] --usdc-token <STRING> [--user-count <INT>] --weth-token <STRING>

OPTIONS:

  --gno-token           Address of token GNO. 
  --mnemonic            The mnemonic used to generate user addresses. 
  --total-supply        The total supply of real token minted on deployment. (default: "1000000000000")
  --usdc-per-cow        How many USDC a COW is worth. (default: "0.15")
  --usdc-per-gno        How many USDC a GNO is worth. (default: "400")
  --usdc-per-weth       How many USDC a WETH is worth. (default: "4000")
  --usdc-token          Address of token USDC. 
  --user-count          Random claims will be generated for this amount of users. Their secret key will be generated from the mnemonic. (default: 1000)
  --weth-token          Address of token WETH. 

test-deployment: Generate a list of pseudorandom claims for each signer and deploy test contracts on the current network.

For global options help run: hardhat help

Test Plan

Run the script on Rinkeby and see that the deployment work. For example:

$ npx hardhat test-deployment --network rinkeby --user-count 100 --mnemonic "candy maple cake sugar pudding cream honey rich smooth crumble sweet treat"
Using deployer 0x627306090abaB3A6e1400e9345bC60c78a8BEf57
Generating user PKs...
Generating user claims...
Gemerating Merkle proofs...
Deploying administration safes...
Generating deploy transactions...
Saving generated data to file...
Deploying real token...
Deploying virtual token...

The frontend is currently using deployments generated with this script.

The final output can be sanity-checked with the following script:

script.ts 
import { promises as fs } from "fs";

const OUTPUT_FOLDER = "output/";

async function main() {
  const mapping: Record<string, string> = JSON.parse(
    (await fs.readFile(`${OUTPUT_FOLDER}/mapping.json`)).toString(),
  );
  const allAddresses: string[] = [];
  for (const [key, value] of Object.entries(mapping)) {
    const chunk: Record<string, unknown> = await JSON.parse(
      (await fs.readFile(`${OUTPUT_FOLDER}/chunks/${key}.json`)).toString(),
    );
    const addressesInChunk = Object.keys(chunk).sort((lhs, rhs) =>
      lhs.toLowerCase() < rhs.toLowerCase() ? -1 : 1,
    );
    const repeatingAddreses = addressesInChunk.filter((address) =>
      allAddresses.includes(address),
    );
    if (repeatingAddreses.length !== 0) {
      throw new Error(
        `Address(es) ${repeatingAddreses.join(
          ", ",
        )} also appear in a chunk before ${key}`,
      );
    } else {
      allAddresses.push(...addressesInChunk);
    }
    const firstAddress = addressesInChunk[0];
    if (firstAddress !== key) {
      throw new Error(
        `Invalid start of chunk ${key}: found ${firstAddress} instead of ${key}}`,
      );
    }
    const lastAddress = addressesInChunk[addressesInChunk.length - 1];
    if (lastAddress !== value) {
      throw new Error(
        `Invalid end of chunk ${key}: found ${lastAddress} instead of ${value}`,
      );
    }
  }
  console.log(`Found ${allAddresses.length} distinct addresses in chunks.`);
}

main().catch((e) => console.error(e));

Verify that the final output is correct by running the script and verifying that the number of unique addresses is the same as the number of addresses used in --user-count. For example, for the latest deployment we use:

$ npx ts-node script.ts 
Found 10000 distinct addresses in chunks.
opened Jan 13, 2022 by fedgiac 4
Closed

Add forwarder contract

Both the Gnosis Safe Proxy Factory and the deterministic deployer used in this repo revert if they deploy a contract at an address that already has a contract. This could happen if for example someone deployed the same contract at that address in a previous transaction. Since our DAO proposal depends on deploying many contracts deterministically and permissionlessly, this could be an issue as somebody else could deploy one of the deterministic contract as soon as the DAO proposal is public and make any subsequent transaction unexecutable.

This PR is the first step in resolving this issue. It acts as a barrier before a transaction is executed. If at the target address there already is code, then the transaction succeeds without any further effects. Otherwise, it executes the original transaction (in our current issue, it will be a deterministic deployment).

This PR only introduces the new contract.

In terms of costs, this extra call adds about 10k extra gas. Surprisingly, I didn't notice any difference between using addressToTest.code compared to addressToTest.codehash, which makes me think that the optimizer already takes care of using the best opcode for this comparison.

Test Plan

New unit tests.

opened Jan 25, 2022 by fedgiac 3
Closed

adding e2e user option test

Finishes the PR for the e2e test.

Initially, we said that we want to use exactly the same deployment strategy as we have in the final deployment. But I think this only makes the tests more complicated, and does not add value for these integration testing purposes.

We will do a separate testing of the deployment and one simple claim with a mainnet hardhat-fork for testing the real deployment.

I address the comments from Federico in the original PR.

The PR is still in draft, as I don't know how to set best the USDC token. The new openzepplin libraries only support tokens with 18 decimal places. I see two options:

  • Either depend on older openzepplin versions
  • Code an own, better TestERC20 with configurable decimals.

Maybe @fedgiac has a suggestion?

Test Plan

REPORT_GAS=1 yarn test test/e2eUserOption.test.ts

and observe the gas estimations from the e2e test.

·----------------------------------------|---------------------------|-----------------|-----------------------------·
|          Solc version: 0.8.10          ·  Optimizer enabled: true  ·  Runs: 1000000  ·  Block limit: 12500000 gas  │
·········································|···························|·················|······························
|  Methods                                                                                                           │
····························|············|·············|·············|·················|···············|··············
|  Contract                 ·  Method    ·  Min        ·  Max        ·  Avg            ·  # calls      ·  usd (avg)  │
····························|············|·············|·············|·················|···············|··············
|  CowProtocolToken         ·  transfer  ·      51504  ·      51516  ·          51510  ·            2  ·          -  │
····························|············|·············|·············|·················|···············|··············
|  CowProtocolVirtualToken  ·  claim     ·          -  ·          -  ·         134722  ·            2  ·          -  │
····························|············|·············|·············|·················|···············|··············
|  CowProtocolVirtualToken  ·  swapAll   ·          -  ·          -  ·          88285  ·            2  ·          -  │
····························|············|·············|·············|·················|···············|··············
|  TestERC20                ·  approve   ·      46248  ·      46260  ·          46254  ·            2  ·          -  │
····························|············|·············|·············|·················|···············|··············
|  TestERC20                ·  mint      ·      72858  ·      72870  ·          72864  ·            2  ·          -  │
····························|············|·············|·············|·················|···············|··············
|  Deployments                           ·                                             ·  % of limit   ·             │
·········································|·············|·············|·················|···············|··············
|  CowProtocolToken                      ·          -  ·          -  ·        1756557  ·       14.1 %  ·          -  │
·········································|·············|·············|·················|···············|··············
|  CowProtocolVirtualToken               ·          -  ·          -  ·        2473807  ·       19.8 %  ·          -  │
·········································|·············|·············|·················|···············|··············
|  TestERC20                             ·    2233495  ·    2233507  ·        2233505  ·       17.9 %  ·          -  │
·----------------------------------------|-------------|-------------|-----------------|---------------|-------------·
opened Jan 14, 2022 by josojo 3
Closed

Do not limit the amount of gas on ETH transfers

Remove gas limit when sending ETH. This is done to be able to redeem claims using native ETH with wallets that don't support creating transactions that use access lists.

Some discussion on reentrancy. There are currently 5 exernal functions that act on the state (and don't revert): claim, claimMany, swap, swapAll, and stopClaim (see here). Claims are set as claimed before actually performing the claim, so no claim can be executed twice. Calling any of the other functions, say f, in a reentrant transaction would be equivalent to calling f before the reentrant transaction, as the storage variables used by the reentrant claim transaction are not modified by f before the reentrant call is made.

This change does increase the cost of future changes to the code, as we should always keep into account the reentrancy risk when changing any of the mentioned functions.

Test Plan

Modified old unit tests.

opened Jan 13, 2022 by fedgiac 3
Closed

Rename ETH to native token

Replaces occurrences of ETH with "native token". Originally this contract was supposed to be deployed only on the ethereum chain, but it will also be deployed on xDai/Gnosis Chain.

No changes to the contract logic were introduced. However, the ABI of the contract will change, which means we will need to deploy a new version of the NPM package. The version bump will be done in another PR.

I left some occurrences of "ETH" in the tests because I thought it was easier to read.

Test Plan

Existing unit tests.

opened Jan 13, 2022 by fedgiac 3

Contents

    transmissions11 Delegate your governance tokens to this contract and never worry about those pesky governance proposals again.
    github MVG = Minimum Viable Governance
    iota-community This is a place to discuss and collect community feedback about all governance questions in the Shimmer network
    ZeframLou A simple contract for migrating from an old ERC20 token to a new ERC20 token.
    CodingMonkTech An utility smart contract to Airdrop ERC20 / BEP20 Tokens using node.js and web3.js
    visenger This repository provides a curated list of references about Machine Learning Model Governance, Ethics, and Responsible AI.
    restuwahyu13 Transform your real jwt token into fake jwt token.
    1mNebula This is a C# discord token grabber that sends the user token to your webhook.
    MetaplasiaTeam Smart Contract Viewer for VS Code
    smartcontractkit Ultimate Solidity, Blockchain, and Smart Contract - Beginner to Expert Full Course | Python Edition
    TBOT-Project TBOT Binance Smart Chain token
    marcelc63 Templates for Popular Smart Contracts
    bandprotocol Monolithic repository of everything Band Protocol
    fifikobayashi Smart contract that flash borrows from Aave and uses the flash liquidity for arbitrage between Sushiswap and UniswapV2 within the same transaction
    ChubbyDogeToken BSC Token with BNB reflection
    svanas NFT is a simple "Hello World" example project, demonstrating how to enumerate over the NFTs in a token contract and display the associated image for each and every one of them.
    m1guelpf A drop-in contract to airdrop all current holders of an NFT with an ERC20 token
    kadena-io The Pact Smart Contract Language
    corda Corda is an open source blockchain project, designed for business from the start. Only Corda allows you to build interoperable blockchain networks that transact in strict privacy. Corda's smart contract technology allows businesses to transact directly, with value.
    fxfactorial Flashbots is a research and development organization formed to mitigate the negative externalities and existential risks posed by miner-extractable value (MEV) to smart-contract blockchains.
    OpenZeppelin OpenZeppelin Contracts is a library for secure smart contract development.
    Share this repo

    Related Repos


    Miscellaneous
    5.5k
    Apache OpenWhisk is an open source serverless cloud platform
    apache OpenWhisk OpenWhisk is a serverless functions platform for building cloud applications. OpenWhisk offers a rich programming model for creating serverl
     
    Miscellaneous
    11
    Replaces twitter NFT idiocracy
    4ndv HexaGone HexaGone allows you to revert or customize twitter's new hexagonal avatars. It's a collection of a several userscripts, with different clip m
     
    Miscellaneous
    6
    replaces the nft avatars on twitter with subway jared
    virginteen replace-nft-avatars a chrome extension that replaces the nft avatars on twitter with subway jared to install Download this repo (Code > Download ZIP).
     
    Miscellaneous
    5
    Smart Contract Viewer for VS Code
    MetaplasiaTeam Contract Viewer English | 中文 Contract Viewer 是一个 VS Code 扩展，他可以帮你从区块链浏览器下载合约代码，只需要一个合约地址即可下载。 目前仅支持以太坊使用 Solidity 的智能合约，后续会支持更多类型。 快速开始 配置一个 API 在 Erh
     
    Miscellaneous
    5
    Video calling using WebRTC
    mehditeymorian webrtc-video-call This project is a video calling application using WebRTC technology. It contains minimum requirements to provide a group video call.
     
    Miscellaneous
    3
    A multipurpose bot, a clan bot, a all in one bot. The one bot u need for ur server origina...
    Tomato6966 Multipurpose-discord-bot A multipurpose bot, a clan bot, a all in one bot. The one bot u need for ur server originally made as Milrato discord Bot and
     
    Miscellaneous
    334
    A template for site builders and low-code tools.
    vercel Platforms Starter Kit The all-in-one starter kit for building platforms on Vercel. Introduction · Guide · Demo · Contributing Deploy Your Own Read the
     
    Miscellaneous
    152
    A Raycast/Alfred/Spotlight alternative
    ospfranco sol A Raycast/Alfred/Spotlight alternative Don't bother trying to run this, it's WIP, right now only the basic UI is there, no logic, there many bugs/
     
    Miscellaneous
    73
    Self hosted media tracker for movies, tv shows, video games, books and audiobooks
    bonukai MediaTracker · Self hosted platform for tracking movies, tv shows, video games, books and audiobooks, highly inspired by flox Demo https://mediatracke
     
    Miscellaneous
    52
    Everytime I come across good Github profiles I index them here
    championswimmer awesome-devs Everytime I come across good Github profiles I index them here NOTE: If you are on the github repo currently, go to the website 👇 to see
     
    Miscellaneous
    49
    Minimalist template for foundry projects
    ZeframLou Foundry template This is a template for a Foundry project. Installation To install with DappTools: dapp install [user]/[repo] To install with Foundry
     
    Miscellaneous
    45
    Log in the node terminal from the browser
    patak-dev vite-plugin-terminal Log in the node terminal from the browser Open a playground online in StackBlitz Install npm i -D vite-plugin-terminal Add plugin
     
    Miscellaneous
    43
    A simple web3 app for minting NFTs
    fireship-io Web3 - Full Tutorial The demo contains a basic web3 app and smart contract for minting NFTs. See it in action in the Web3 NFT Tutorial on YouTube. Fol
     
    Miscellaneous
    28
    A three.js component library for Svelte.
    grischaerbe A three.js component library for svelte. Index What is threlte? Getting started Concepts Interactivity Viewport Awareness Reactivity Conventions Refer
     
    Miscellaneous
    26
    Wordle Svelte Clone
    tayfunerbilen Wordle Svelte Clone Son zamanlarda popüler olan WORDLE uygulamasını svelte ile yapmaya çalıştım. Bu tarz acaba yapsam nasıl yapardım uygulamarı bana ç