Quadratic Voting API

Start Local Service

Configure a Dummy Local AWS Profile

In your ~/.aws/config file:

[profile local]
region = ap-southeast-1

In your ~/.aws/credentials file:

[local]
aws_access_key_id = MOCK_ACCESS_KEY_ID
aws_secret_access_key = MOCK_SECRET_ACCESS_KEY

Run this on Terminal/other command-line utility:

export AWS_PROFILE=local

Run Your Lambda Service Offline

Start your mock Lambda service, and mock dynamodb locally.

sls offline start

Your mock Lambda service will exist at http://localhost:3000 by default.

Once you are happy with your local changes, you may deploy to an AWS account. Remember to re-assign AWS_PROFILE.

sls deploy

sls is otherwise known as the serverless Framework. This framework allows your to test your functions without actually deploying them to AWS Lambda, amongst other things. More information here.

DynamoDB

The development environment uses serverless-dynamodb-local to emulate the DynamoDB in AWS.

Install DynamoDB locally

sls dynamodb install

Start DynamoDB

sls dynamodb start

DynamoDB will run at http://localhost:8000/ by default.

Note, you don't have to start dynamodb separately if you've already done sls offline start.

You may use http://localhost:8000/shell to execute JavaScript commands to DynamoDB, or access it via your regular AWS command-line dynamodb instructions.

Retrieve Data

Example

To get a dump of the data in a particular table quadratic-voting-election-dev in local:

aws dynamodb scan --table-name quadratic-voting-election-dev --endpoint-url http://localhost:8000

Lambda Functions

Create new election

Public Election

{
  "owner": "uuid-user",
  "config": {
    "name": "Name of vote",
    "budget": 99,
    "private": false
  },
  "candidates": [
    {
      "title": "Decision 1",
      "description": "Long description 1"
    },
    {
      "title": "Decision 2",
      "description": "Long description 2"
    }
  ]
}

Private Election with Notify Invite

{
  "owner": "uuid-user",
  "config": {
    "name": "Name of vote",
    "budget": 99,
    "private": true,
    "notifyInvites": true,
    "invite": [
      {
        "name": "Person A",
        "email": "[email protected]"
      },
      {
        "name": "Person B",
        "email": "[email protected]"
      }
    ]
  },
  "candidates": [
    {
      "title": "Decision 1",
      "description": "Long description 1"
    },
    {
      "title": "Decision 2",
      "description": "Long description 2"
    }
  ]
}

Private Vote with Encrypted Votes

{
  "owner": "uuid-user",
  "config": {
    "name": "Name of vote",
    "budget": 99,
    "private": true,
    "notifyInvites": true,
    "encryptionKey": "044f355bdcb7cc0af728ef3cceb9615d90684bb5b2ca5f859ab0f0b704075871aa385b6b1b8ead809ca67454d9683fcf2ba03456d6fe2c4abe2b07f0fbdbb2f1c1",
    "invite": [
      {
        "name": "Person A",
        "email": "[email protected]"
      },
      {
        "name": "Person B",
        "email": "[email protected]"
      }
    ]
  },
  "candidates": [
    {
      "title": "Decision 1",
      "description": "Long description 1"
    },
    {
      "title": "Decision 2",
      "description": "Long description 2"
    }
  ]
}

Get status of an election

Cleartext Votes Status

{
  "id": "uuid-election",
  "owner": "uuid-user",
  "config": {
    "name": "Name of vote",
    "budget": 99
  },
  "candidates": [
    {
      "title": "Decision 1",
      "description": "Long description 1"
    },
    {
      "title": "Decision 2",
      "description": "Long description 2"
    }
  ],
  "votes": [
    {
      "voter": "uuid-user",
      "votes": [
        {
          "decisionId": 1,
          "vote": 2
        },
        {
          "decisionId": 2,
          "vote": 2
        }
      ]
    }
  ]
}

Encrypted Votes Status

{
  "id": "uuid-election",
  "owner": "uuid-user",
  "config": {
    "name": "Name of vote",
    "budget": 99
  },
  "candidates": [
    {
      "title": "Decision 1",
      "description": "Long description 1"
    },
    {
      "title": "Decision 2",
      "description": "Long description 2"
    }
  ],
  "votes": [
    {
      "voter": "uuid-user",
      "encryptedVote": {
        "iv": "dce31988c0a1d22d42f356bac699c9bf",
        "ciphertext": "72a22c7b52ad4511bdb70125ced9396afe8278525be423d6d2bbe1da018c49a2a20167fe5a015bb6283516548b4a46d1298690dc73ea8bc7332a5a02b58cc6d9",
        "mac": "47737e21e1b9aa1b972c54cbfb9da5b59ee0cf2a58802182db616f6394363581",
        "ephemPublicKey": "0487e5dbda84ef30cf0b8b72a38e9b8a419d9a64ccb3adc42731126954b59104069ce952b71f947bedbf961a09f45f4cc83e93a38884d45f730d7f6fe8f2e93171"
      }
    }
  ]
}

Cast votes

Cleartext Vote

{
  "voter": "uuid-user",
  "election": "uuid-election",
  "votes": [
    {
      "candidate": 0,
      "vote": 2
    },
    {
      "candidate": 1,
      "vote": 0
    }
  ]
}

Encrypted Vote

{
  "voter": "uuid-user",
  "election": "uuid-election",
  "encryptedVote": {
    "iv": "dce31988c0a1d22d42f356bac699c9bf",
    "ciphertext": "72a22c7b52ad4511bdb70125ced9396afe8278525be423d6d2bbe1da018c49a2a20167fe5a015bb6283516548b4a46d1298690dc73ea8bc7332a5a02b58cc6d9",
    "mac": "47737e21e1b9aa1b972c54cbfb9da5b59ee0cf2a58802182db616f6394363581",
    "ephemPublicKey": "0487e5dbda84ef30cf0b8b72a38e9b8a419d9a64ccb3adc42731126954b59104069ce952b71f947bedbf961a09f45f4cc83e93a38884d45f730d7f6fe8f2e93171"
  }
}