test(bdd): split features. Improved deployment, working on commitment management

Author: bitbeckers

README.md

@@ -54,7 +54,4 @@ This repository is a fork from [Paul Berg's Solidity Template](https://github.co
 
 <[email protected]>
 
-Subscribe to our [Substack](https://commit.substack.com/)
-
-
-
+Subscribe to our [Substack](https://commit.substack.com/)

contracts/SinglePlayerCommit.sol

@@ -24,6 +24,7 @@ contract SinglePlayerCommit is Ownable {
         bool allowed;
     }
 
+    //TODO Activity deployed in test now only has name/oracle/allowed initialized 
     struct Activity {
         string name; // e.g. "cycling"
         bytes32[] measures; // keys from allowedMeasures

test/SinglePlayerCommit.behavior.ts

@@ -0,0 +1,37 @@
+import { expect } from "chai";
+import { Wallet, utils } from "ethers";
+import { BytesLike } from "ethers/lib/utils";
+import { SinglePlayerCommit } from "../typechain/SinglePlayerCommit";
+
+export function shouldManageCommitments(wallet: Wallet, walletTo: Wallet): void {
+
+  it("allows the user to deposit for staking", async function () {
+    // const _activity = "biking";
+    // const _measureIndex = await this.singlePlayerCommit.measureList(0);
+    console.log(await walletTo.getBalance());
+    const _amount = utils.parseEther("1.0");
+    let contractWithSigner = await this.singlePlayerCommit.connect(walletTo);
+    console.log("Connected to contract")
+    let output = await contractWithSigner.deposit(_amount);
+    console.log(output)
+
+    expect(1).to.equal(1);
+  });
+
+  it.skip("allows users with sufficient staked funds to stake on a commitment of biking 50 kms", async function () {
+    // const _activity = "biking";
+    // const _measureIndex = await this.singlePlayerCommit.measureList(0);
+    console.log(await walletTo.getBalance());
+    const _activity = await this.singlePlayerCommit.activityList(0);
+    const _measureIndex = 0
+    const _goal = 50;
+    const _startTime = Date.now();
+    const _stake = 10;
+    let contractWithSigner = await this.singlePlayerCommit.connect(walletTo);
+    let output = await contractWithSigner.makeCommitment(_activity, _measureIndex, _goal, _startTime, _stake);
+    console.log(output)
+
+    expect(1).to.equal(1);
+  });
+
+}

test/SinglePlayerCommit.commitment.ts

@@ -0,0 +1,57 @@
+import { expect } from "chai";
+import { BytesLike } from "ethers/lib/utils";
+import { SinglePlayerCommit } from "../typechain/SinglePlayerCommit";
+
+export function shouldDeployWithInitialParameters(): void {
+
+  it("has the 'biking' activity and it is allowed", async function () {
+    const activityKey: BytesLike = await this.singlePlayerCommit.activityList(0);
+    const _activityName: string = await this.singlePlayerCommit.getActivityName(activityKey);
+
+    const _activity = await this.singlePlayerCommit.allowedActivities(activityKey);
+
+    expect(_activityName).to.equal('biking');
+    expect(_activity['name']).to.equal(_activityName);
+    // expect(_activity['measures'][0]).to.equal('km');
+    // expect(_activity['ranges']).to.equal([2,1024]);
+    expect(_activity['oracle']).to.be.properAddress;
+    expect(_activity['allowed']).to.be.true;
+    expect('getActivityName').to.be.calledOnContract(this.singlePlayerCommit);
+  });
+
+  //TODO Now expecting VM Runtime 'invalid opcode' error. 
+  // Should/can this be prevented in contract while using dynamic arrays?
+  it("has no other activities", async function () {
+    let error;
+    try{
+      await this.singlePlayerCommit.activityList(1)
+    } catch(err) {
+      error = err;
+    } finally {
+      expect('activityList').to.be.calledOnContract(this.singlePlayerCommit);
+      expect(error.results[error.hashes[0]]['error']).to.equal('invalid opcode');
+    }
+  });
+
+  it("has the 'km' measure and it is allowed", async function () {
+    const measureKey: BytesLike = await this.singlePlayerCommit.measureList(0);
+    const activityMeasure: string[] = await this.singlePlayerCommit.allowedMeasures(measureKey); 
+
+    expect(activityMeasure[0]).to.equal('km');
+    expect(activityMeasure[1]).to.be.true;
+
+  });
+
+  it("has no other measures", async function () {
+    let error;
+    try{
+      await this.singlePlayerCommit.measureList(1)
+    } catch(err) {
+      error = err;
+    } finally {
+      expect('measureList').to.be.calledOnContract(this.singlePlayerCommit);
+      expect(error.results[error.hashes[0]]['error']).to.equal('invalid opcode');
+    }
+  });
+
+}

test/SinglePlayerCommit.deploy.ts

@@ -7,15 +7,16 @@ import chainLinkArtifact from "./resources/ChainLink.json";
 
 import { SinglePlayerCommit } from "../typechain/SinglePlayerCommit";
 import { BigNumberish } from "ethers";
-import { shouldDeployWithInitialParameters, shouldAllowUserToMakeCommitment, shouldSettleCompletedCommitment } from "./SinglePlayerCommit.behavior";
+import { shouldDeployWithInitialParameters } from "./SinglePlayerCommit.deploy";
+import { shouldManageCommitments } from './SinglePlayerCommit.commitment';
 
 chai.use(solidity);
 
 setTimeout(async function () {
-  const provider = new MockProvider();
-  const [wallet] = provider.getWallets();
+  const [wallet, walletTo] = new MockProvider().getWallets();
 
   describe("SinglePlayerCommit contract", function () {
+
     const activity: string = "biking";
     const measures: string[] = ["km"];
     const ranges: BigNumberish[][] = [[2, 1024]];
@@ -36,17 +37,11 @@ setTimeout(async function () {
     });
 
     describe("Deployment was succesful if contract", function () {
-      shouldDeployWithInitialParameters(activity, measures);
-    });
-
-    //TODO User can manage commitments
-    describe("User can", function() {
-      shouldAllowUserToMakeCommitment(activity, measures);
+      shouldDeployWithInitialParameters();
     });
 
-    //TODO Contract pays out stake upon completion
-    describe("Contract can", function() {
-      shouldSettleCompletedCommitment(activity, measures);
+    describe("Commitments can be managed", function() {
+      shouldManageCommitments(wallet, walletTo);
     });
   });