CommitPool Single Player Smart Contract repository

CommitPool helps people meet their personal goals by holding themselves accountable. CommitPool users stake money to credibly commit to meeting their goals, and lose their stake when they don’t.

Our MVP focuses on a single goal type for individuals, hence the Single Player mode.

Getting started

Currently Ganache and Node 14 are not playing well together. To get started:

1. Use node 12 (using nvm is recommended)
2. npm install
3. npm run-script build
4. npm test (to verify the build)

Note: Hardhat guide on running test in VSCode

Deploying to local node

Buidler

1. Use node 12 (using nvm is recommended)
2. npx buidler node
3. In second terminalnpx buidler run --network localhost scripts/deploy.ts

Buidler & Ganache

1. Use node 12 (using nvm is recommended)
2. Start Ganache on port 8545
3. In second terminalnpx buidler run --network localhost scripts/deploy.ts

Truffle

1. Use node 12 (using nvm is recommended)
2. Start Ganache on port 8545
3. In terminaltruffle migrate

Deploying to Matic

Deployment to the Mumbai Testnet is configured in ./truffle-config.js

1. npm install truffle -g
2. Deploy to Mumbai testnet: truffle migrate --network matic
3. Find your contract based on the address reported by Truffle in the Matic Explorer.

Quite note on deploying to Matic:

• Test deployment using Truffle against a runnning Ganache instance: truffle migrate
• Configure Matic network in MetaMask
• Request funds at faucet
• Use this wallet's seed phrase in the .env file to pay the deployment

Interaction with the contract on Matic via Truffle:

1. truffle console --network matic
2. compile
3. var singlePlayerCommit = await SinglePlayerCommit.at('<ADDRESS FROM DEPLOYMENT>')
4. To test: await contractTest.activityKeyList(0)

Interacting with the contract using Buidler

After deploying to a local node

1. npx buidler console --network localhost
2. const CommitPool = await ethers.getContractFactory("SinglePlayerCommit")
3. const commitPool = await CommitPool.attach("<<CONTRACT ADDRESS FROM DEPLOYMENT>>")

Example for interacting: await commitPool.withdraw(1000)

Features

Technical documentation

Creation of Commitment

A commitment consists of an activity, a goalValue for given activity, a startTime, and stake. We will automagically set the endTime 7 days after the startdate.

Management of Activities

An activity consists of a name and the oracle address. Activities can be enabled by setting it to allowed.

Execution of commitment settlement

The contract can be called to process the commitment based on the address of the committer. A check on time and completion determines whether the stake is returned to the committer.

Architecture

Stack

This repository is a fork from Paul Berg's Solidity Template

Get in touch

commitpool.com

[email protected]

Subscribe to our Substack