Skip to content

Latest commit

 

History

History
96 lines (66 loc) · 6.2 KB

ccip-001-citycoins-traits.md

File metadata and controls

96 lines (66 loc) · 6.2 KB
Raw

CCIP-001

Preamble

CCIP Number 001
Title CityCoins Traits
Author(s) Jason Schrader jason@joinfreehold.com
Consideration Technical
Type Standard
Status Ratified
Created 2022-03-16
License BSD-2-Clause

Introduction

The Stacks blockchain is a Layer 1 blockchain connected to Bitcoin, in which miners spend Bitcoin to bid for and win a fixed amount of Stacks tokens. Stackers have the option to lock up Stacks tokens for a specified amount of time, and in turn, receive a portion of the Bitcoin spent by miners proportionate to the amount Stacked in a cycle of 2,100 Bitcoin blocks.1

Taking this concept a level further, a new token (a "CityCoin") is created on the Stacks blockchain, following the SIP-010 fungible token standard2, such that CityCoins can be mined and Stacked per the methods stated above except a portion of the miner's bid would be redirected to the city's wallet overseen by a trusted third party custodian.

CityCoins leverage similar properties from the Proof of Transfer (PoX) consensus mechanism3 of the Stacks blockchain, programmed through a smart contract in Clarity.

This proposal describes the Clarity trait definitions for a CityCoin.

Specification

The trait system in Clarity is a mechanism that allows for simple definition and configuration of a common interface.4 Traits define a set of named functions, argument types, and the return type for a contract to be considered an implementation of the trait.

The CityCoins Protocol includes two custom trait definitions.

Core Contract Trait

The citycoin-core trait defines the core functionality of a CityCoin, including the following functions:

  • register-user: Allows a principal to register for the activation of a deployed CityCoin until the specified threshold is met. (see CCIP-002)
  • mine-tokens: Allows a principal to mine CityCoins at the current block height, and records the related mining data in the core contract. (see CCIP-003)
  • claim-mining-reward: Allows the winning principal to claim the mining reward for a CityCoin at the specified block height. (see CCIP-003)
  • stack-tokens: Allows a principal to stack CityCoins for a specified number of reward cycles. (see CCIP-004)
  • claim-stacking-reward: Allows a principal to claim eligible stacking rewards from a past stacking cycle. (see CCIP-004)
  • set-city-wallet: Allows the auth contract to set the city wallet variable in the core contract (see CCIP-007)
  • shutdown-contract: Allows the auth contract to shutdown the core contract, making mining unavailable and unlocking all stacked tokens. (see CCIP-007)

Token Contract Trait

The citycoin-token trait defines the token functionality of a CityCoin, including the following functions:

  • activate-token: Allows a core contract to set an activation block height and coinbase thresholds for the emissions schedule. (see CCIP-002)
  • set-token-uri: Allows the auth contract to set the token URI variable for a CityCoin. (see CCIP-007)
  • mint: Allows a core contract to mint new CityCoins. (see CCIP-005)
  • burn: Allows a principal to burn CityCoins they own.5 (see CCIP-005)
  • send-many: Allows a principal to send up to two hundred MiamiCoin transfers in a single transaction. (see CCIP-005)

Note: All CityCoin token contracts also follow the SIP-010 trait specification2.

Backwards Compatibility

None, this is the initial implementation.

Activation

None, this is the initial implementation.

Reference Implementations

General CityCoins Protocol Contracts:

  • citycoin-core-trait deployed on the Stacks mainnet6
  • citycoin-token-trait deployed on the Stacks mainnet7

MiamiCoin Contracts:

  • miamicoin-auth deployed on the Stacks mainnet, using the core contract trait on line 007, and using the token contract trait on line 0088
  • miamicoin-core-v1 deployed on the Stacks mainnet, implementing the core contract trait on line 0059
  • miamicoin-token deployed on the Stacks mainnet, implementing the token contract trait on line 009, and using the core contract trait on line 01010

NewYorkCityCoin Contracts:

  • newyorkcitycoin-auth deployed on the Stacks mainnet, using the core contract trait on line 008, and using the token contract trait on line 00911
  • newyorkcitycoin-core-v1 deployed on the Stacks mainnet, implementing the core contract trait on line 00612
  • newyorkcitycoin-token deployed on the Stacks mainnet, implementing the core contract trait on line 010, and using the core contract trait on line 01113

Footnotes

Footnotes

  1. https://stacking.club ↩

  2. https://github.com/stacksgov/sips/blob/main/sips/sip-010/sip-010-fungible-token-standard.md ↩ ↩2

  3. https://docs.stacks.co/understand-stacks/proof-of-transfer ↩

  4. https://www.hiro.so/blog/five-useful-clarity-keywords-functions ↩

  5. In the initial v1.0.0 implementation for MiamiCoin, the burn function was only allowed to be called by a core contract and not implemented in the core contract code, however this was updated in the v1.0.1 release starting with NewYorkCityCoin. ↩

  6. https://explorer.stacks.co/txid/SP466FNC0P7JWTNM2R9T199QRZN1MYEDTAR0KP27.citycoin-core-trait?chain=mainnet ↩

  7. https://explorer.stacks.co/txid/SP466FNC0P7JWTNM2R9T199QRZN1MYEDTAR0KP27.citycoin-token-trait?chain=mainnet ↩

  8. https://explorer.stacks.co/txid/SP466FNC0P7JWTNM2R9T199QRZN1MYEDTAR0KP27.miamicoin-auth?chain=mainnet ↩

  9. https://explorer.stacks.co/txid/SP466FNC0P7JWTNM2R9T199QRZN1MYEDTAR0KP27.miamicoin-core-v1?chain=mainnet ↩

  10. https://explorer.stacks.co/txid/SP466FNC0P7JWTNM2R9T199QRZN1MYEDTAR0KP27.miamicoin-token?chain=mainnet ↩

  11. https://explorer.stacks.co/txid/SP2H8PY27SEZ03MWRKS5XABZYQN17ETGQS3527SA5.newyorkcitycoin-auth?chain=mainnet ↩

  12. https://explorer.stacks.co/txid/SP2H8PY27SEZ03MWRKS5XABZYQN17ETGQS3527SA5.newyorkcitycoin-core-v1?chain=mainnet ↩

  13. https://explorer.stacks.co/txid/SP2H8PY27SEZ03MWRKS5XABZYQN17ETGQS3527SA5.newyorkcitycoin-token?chain=mainnet ↩