The API is responsible for handling all the cryptographic operations and all network communication with:

• the Digital Ballot Box
• the Voter Authorization Coordinator service
• the OTP provider(s)

Expected sequence of methods being executed

Method	Description
initialize	Initializes the library by fetching election configuration
requestAccessCode	Initiates the authorization process, in case voter has not authorized yet. Requests access code to be sent to voter email
validateAccessCode	Gets voter authorized to vote.
registerVoter	Registers the voter on the bulletin board
{@link AVClient.constructBallotCryptograms	constructBallotCryptograms }
spoilBallot	Optional. Initiates process of testing the ballot encryption.
castBallot	Finalizes the voting process.
purgeData	Optional. Explicitly purges internal data.

Example walkthrough test

import { AVClient } from '../lib/av_client';
import { expect } from 'chai';
import { readmeTestSetup, readmeTestTeardown } from './readme_example_helper';
import { BallotSelection } from '../lib/av_client/types';

describe('entire voter flow using OTP authorization', () => {
  beforeEach(() => readmeTestSetup());
  afterEach(() => readmeTestTeardown());

  it.skip('returns a receipt', async () => {
    const client = new AVClient('http://us-avx:3000/dbb/us/api');
    await client.initialize()

    await client.requestAccessCode('123', 'us-voter-123@aion.dk');

    // ... voter receives email with access code (OTP code) ...

    await client.validateAccessCode('1234');

    await client.registerVoter();

    const ballotSelection: BallotSelection = {
      reference: 'ballot-1',
      contestSelections: [
        {
          reference: 'contest ref 1',
          optionSelections: [{reference: 'option ref 1'}]          
        },
        {
          reference: 'contest ref 2',
          optionSelections: [{reference: 'option ref 3'}]
        }
      ]
    }

    const trackingCode  = await client.constructBallot(ballotSelection);
    expect(trackingCode.length).to.eq(64);

    const affidavit = Buffer.from('some bytes, most likely as binary PDF').toString('base64');
    const ballotTrackingCode = await client.castBallot(affidavit);

    expect(typeof ballotTrackingCode === "string").to.be.true;
  });
});