/charged-particles-universe

Solidity Contracts for the Charged Particles Universe

Primary LanguageSolidityOtherNOASSERTION

Charged Particles Universe - Solidity Contracts v2.0.0

Discord Twitter Follow built-with openzeppelin

Coverage Status GitHub last commit GitHub package.json version GitHub code size in bytes GitHub repo size

Charged Particles are Non-Fungible Tokens (NFTs) that are minted with an Underlying Asset (ex: DAI) and accrue interest via an Interest-bearing token (ex: Aave's aDAI) giving the Token a "Charge".

Coming Soon:

  • Compound - cTokens
  • mStable - mTokens
  • yEarn - yTokens

Production Site (Beta, Ropsten Only)

Documentation

Value

Particle Value
  =
Intrinsic Value (underlying asset, DAI)
  +
Speculative Value (non-fungible rarity)
  +
Interest value (accrued in aDAI)

Value Appreciation

Imagine a Babe Ruth rookie card that was stuffed with $1 and earning interest since 1916! The same might be true of a Charged Particle NFT in 100 years!

Ownership

Charged Particles are non-custodial NFTs that can be "discharged" at any time by the owner, collecting the interest from the token. And just like any NFT, they are yours trade, transfer, sell, etc.

They can also be burned (melted) to reclaim the underlying DAI + interest in full, destroying the token. Charged Particles, therefore, always have an underlying value in DAI.

Custom Mechanics

Based on the amount of "charge" a token has, Smart Contracts and/or Dapps can decide how to handle the token - custom mechanics can be designed around the level of "Charge" a token has.

Imagine an NFT that represents a Sword - the power of that sword could be dependant on the amount of "Charge" the token has. Or perhaps certain items can only be used once they reach a certain level of charge.

Other possibilities include battling over the "charge" of a particle - the winner earns the interest from their competitor's particles. (Still trying to work this part out, ideas are welcome!)

Particle Accelerator

  • Fully-decentralized Public Particle Minting & Energizing Station

Feedback & Contributions

Feel free to fork and/or use in your own projects!

And, of course, contributions are always welcome!

Community

Join our community, share ideas and help support the project in anyway you want!

Discord: https://discord.gg/Cdv6zZMKEa

Frameworks/Software used:

  • Main Repo:
    • OpenZeppelin CLI v2.8.0
    • OpenZeppelin Upgrades v2.8.0
    • OpenZeppelin Ethereum Contracts v3.3.0
    • Solidity v0.6.12 (solc-js)
    • NodeJS v12.16.3
    • hardhat v2.0.3
    • EthersJS v5.0.8

Prepare environment:

Create a local .env file with the following (replace ... with your keys):

    INFURA_APIKEY="__api_key_only_no_url__"
    ALCHEMY_APIKEY="__api_key_only_no_url__"
    ETHERSCAN_APIKEY="__api_key_only_no_url__"
    TESTNET_MNEMONIC="wallet_mnemonic_separated_by_underscores"
    MAINNET_MNEMONIC="wallet_mnemonic_separated_by_underscores"
    OPTIMIZER_DISABLED="true|false"

Deploy:

Deploy (all): yarn deploy Deploy (only protocol): yarn deploy --tags protocol Deploy (only protocol and aave): yarn deploy --tags protocol,aave Deploy (only protocol and aave on network kovan): yarn deploy --network kovan --tags protocol,generic,aave,tokens

Deployed contract details go in deployments/{networkName}/{contractName}.json

####Examples yarn deploy-only community-incentives --network kovan

Test:

yarn test

Watching tests: npx hardhat watch test

See package.json for more scripts

MIT License

Copyright (c) 2021 Firma Lux, Inc. https://charged.fi