Giter Site home page Giter Site logo

constitution's Introduction

The Urbit Constitution

The Urbit PKI on the Ethereum blockchain.

This is a work in progress nearing completion. Feel free to poke around and open issues or ask questions. The Urbit fora is also a good place for open-ended discussion related to this repo.

Overview

This is just a quick summary of the different contracts and their purposes. For more detailed descriptions, check out the contracts themselves.

  • Ships: contains all on-chain state for Urbit ships. Most notably, ownership and public keys. Can't be modified directly, you must use the Constitution.
  • Constitution: is used as an interface for interacting with your ships on-chain. Allows you to configure keys, transfer ownership, etc.
  • Polls: registers votes by the senate on proposals. These can be either static documents or Constitution upgrades.
  • Delegated Sending: allows stars to let their planets send brand new planets to their friends and family.
  • Linear Star Release: facilitates the release of blocks of stars to their owners over a period of time.
  • Conditional Star Release: facilitates the release of blocks of stars to their owners based on milestones.
  • Planet Sale: gives an example of a way in which stars could sell planets on-chain.
  • Pool: gives an example of a way in which stars could be temporarily tokenized.

Running

Install dependencies. Most notable inclusion is Zeppelin-Solidity.

npm install

Build, deploy and test using Truffle.

npm install -g truffle

Use any of the following commands.

truffle compile
truffle deploy
truffle test

When verifying deployed contracts on services like Etherscan, be sure to use truffle-flattener for flattening contracts into single files.

Tests

To successfully run the tests, make sure Ganache (or any other RPC enabled node) is running locally.

ganache-cli --gasLimit 6000000

The Planet Sale's test relating to withdrawing ETH from the contract are known to be finicky during tests, and may not always complete successfully.

This version of the contracts has been deployed to the Ethereum Ropsten testnet. Their addresses are:

Contract Address (Ropsten)
Constitution 0x3fADF877705878C6C06dEA3fF18c4045d71d22aB
Ships 0xc7946B45247A244bC60c31d0935C72fD87A0A9FC
Polls 0x56264DFB66a7eFFd1443D604863beA731e6eE35F
Claims 0xdE67eA5388A4b3c9Bc5DFE7d43218636c536F316
Censures 0x4a3c9d677797EFCCa77991eDB44FbF0a7769C01d
Pool 0xd873293d5aEA991E6b86A7AE91BCfaD5BA6830ef
DelegatedSending 0xfA7716930EA5184981Cc30926413864a98d4341A

Feel free to ask for a galaxy if you want to play around.

constitution's People

Contributors

fang- avatar cgyarvin avatar bencalder avatar galenwp avatar joemfb avatar gnidan avatar

Watchers

James Cloos avatar Bharath Meduri avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.