npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@cartesi/token

v1.9.0

Published

Cartesi ERC-20 Token - CTSI

Downloads

252

Readme

:warning: The Cartesi team keeps working internally on the next version of this repository, following its regular development roadmap. Whenever there's a new version ready or important fix, these are published to the public source tree as new releases.

Token

Cartesi Token is an ERC20, with the following attributes:

  • NAME = "CartesiToken";
  • SYMBOL = "CTSI";
  • DECIMALS = 18;
  • INITIAL_SUPPLY = 1000000000 * (10 ** 18) (1 Billion)

The code imports two Open Zeppelin libraries: ERC20Detailed v2.5 and ERC20Mintable v2.5

The ERC20Mintable code implements the basic ERC20 standard, following the same definitions of the Open Zeppeling ERC20 code - including Safe Math, for sound mathematical operations. Being a mintable token means that the total supply of CTSIs can increase - as opposed to the capped version of ERC20. This minting behavior is implemented using the MinterRole library, also provided by OpenZeppelin. The minter is defined, initially, as the deployer of the token contract - and it has the power to create new tokens, add a new minter or renounce it's privileges.

The ability to create new Cartesi Tokens will be paramount to the network, it is a relevant part of the incentive layer/macroeconomics planned. The minting of new tokens will be entirely managed, in a decentralized way, by the macroeconomics smart contracts. In the beggining, while these smart contracts are not yet available, the Cartesi Token contract will have its minting blocked - by an override in its mint function. The amount of time that the minting privilege will be blocked for can be extended by calling the extendMintLockTime function - which will emit an mint locktime extended event (only the minter can call this function).

The decentralized minting process will be implemented and audited before the mintng locktime mechanism is released.

Vesting

The Cartesi vesting will use the design available in the TokenTimelock v2.5 contract, also provided by OpenZeppelin. This contract implements a simple token timelock, in which a certain amount of token is transferred to a deployed version of this contract and becomes available to a beneficiary after an amount of time - both of which are defined in the deployment. This version of vesting differs from the TokenVesting v2.5 in the way tokens are released. The TokenVesting contract offers a continuous and linear vesting procedure which was not a desired feature. In Cartesi we opted for a vesting design in which the tokens are vested following a step function - the total amount of tokens will be divided into a number of time periods and will be paid in full as these time periods expire. For instance, with vesting duration of one year, with a time period of 6 months, half the tokens would be vested at the same time after the first 6 months and then the other half when the 12 months finish. As opposed to having a tiny amount of tokens being released linearly every second. Part of Cartesi's tokens (CTSI) will be reserved for the so-called mine, which defines a decentralized incentive structure that pays workers for performing certain tasks on Cartesi network. The specifics of the mine contract are still being defined, so we created a special TokenTimelock version for it. It is very similar to the timelock mechanism defined above, differing in the sense that this version allows for a change in the beneficiary address - only callable by the owner. The idea is that the tokens will be locked from the beggining but the real beneficiary , the decentralized mine contract, will be set when its ready.

We chose OpenZeppelin v2.5 for both the token and vesting because it is the last stable release (v3 is still beta) and it includes specific purpose contracts - like MinterRole, which will be substituted by more general purpose ones (i.e AccessControl) in the next version release.

Faucet

For test purposes we created a SimpleFaucet contract that transfers 100,000 CTSI to any address, once every 4 weeks. This faucet is deployed to all supported testnets.

Bridges

We deployed bridges of the Cartesi Token to some L2 networks:

Polygon Mainnet

We manually requested the creation of a bridged token following the Mapping Request procedure documented in the Polygon Documentation website.

The token was deployed to 0x2727Ab1c2D22170ABc9b595177B2D5C6E1Ab7B7B

Polygon Mumbai

We manually requested the creation of a bridged token following the Mapping Request procedure documented in the Polygon Documentation website.

The token was deployed to 0x8B3ae9F9E61Ed278c17d45517fEFb52191ab2683

Optimism Goerli

The Optimism documentation provides instructions on how to deploy a token. As of today, it's outdated because it refers to the Optimism Kovan network, which will be deprecated in the near future.

However the procedure still partially applies to the Optimism Goerli network, which is already running, but doesn't have an Etherscan service available yet.

For that reason we used an Ethereum command line tool to communicate with the L2StandardTokenFactory smart contract.

First we installed eth-cli.

Then we imported the L2StandardTokenFactory ABI by creating a json file extracted from the Optimism GitHub project and executing the following command:

eth abi:add L2StandardTokenFactory ./L2StandardTokenFactory.json

Then we sent a transaction to the createStandardL2Token of the L2StandardTokenFactory contract, by specifying the command below:

eth contract:send L2StandardTokenFactory@0x4200000000000000000000000000000000000012 'createStandardL2Token("0x9d2133302B0beB040d2E86D1fbC78Da1Dea9Fa3e","Cartesi","CTSI")' --network=https://goerli.optimism.io --pk=<PRIVATE_KEY_REDACTED>

The transaction was executed.

To get the address of the bridged token we queried the events by sending the following command, and searching for the Cartesi Token goerli address:

eth event:get --network=https://goerli.optimism.io L2StandardTokenFactory@0x4200000000000000000000000000000000000012 StandardL2TokenCreated

The briged token was deployed to 0x3bB4445D30AC020a84c1b5A8A2C6248ebC9779D0

Arbitrum Goerli

We manually deployed the bridged token by using the official UI for Arbitrum Bridge.

The token was deployed to 0x0905a95fa1ce6A11bf399c8958fd782BbeCe8a4D