Skip to content

Latest commit

 

History

History
32 lines (21 loc) · 1.29 KB

README.md

File metadata and controls

32 lines (21 loc) · 1.29 KB

Ticker registry

A proof-of-concept public on-chain registry for token tickers with admin override functionality.

It allows any user to register a token address, provided that address has not already been registered, and that there is not already a token registered with that ticker.

It allows an admin to override the provided value for a token ticker, for example, when old DAI was renamed SAI, yet the original SAI contract still shows the ticker as DAI.

See the quick_tests.ts for assertions over the basic functionality.

Important note

Currently in development, this contract has not been audited and is not intended for use on the Ethereum main-network yet.

Development

See package.json for all scripts.

  1. Clone
  2. Install dependencies (yarn)
  3. Build (yarn build)
    1. Compile contracts (yarn compile:solidity)
    2. Compile typescript (yarn copmile:typescript)
    3. Generate contract wrappers (yarn generate:contract_wrappers)
  4. Build test artifacts (yarn build:test)
    1. Generate solidity test artifacts (yarn compile:test:solidity)
    2. Generate TS test artifacts (yarn generate:test:contract_wrappers)
  5. Run tests (yarn test)

License

MIT