package personhood_service

Get desktop application:
View/edit binary Protocol Buffers messages

Capabilities returns what the service is able to do.

(message has no fields)

CapabilitiesResponse is the response with the endpoints and the version of each endpoint. The versioning is a 24 bit value, that can be interpreted in hexadecimal as the following: Version = [3]byte{xx, yy, zz} - xx - major version - incompatible - yy - minor version - downwards compatible. A client with a lower number will be able to interact with this server - zz - patch version - whatever suits you - higher is better, but no incompatibilities

• repeated Capability capabilities = 1

Capability is one endpoint / version pair

Used in: CapabilitiesResponse

• required string endpoint = 1

• required bytes version = 2

Challenge allows a participant to sign up and to fetch the latest list of scores.

• optional ChallengeCandidate update = 1

ChallengeCandidate is the information the client sends to the server. Some of the information is not verifiable for the moment (meetups and references).

Used in: Challenge, ChallengeReply

• required bytes credential = 1

• required sint32 score = 2

• required sint64 signup = 3

ChallengeReply is sent back to the client and holds a list of pairs of Credential/Score to display on the client's phone.

• repeated ChallengeCandidate list = 1

EmailRecover requests a recovery of a given account

• required string email = 1

EmailRecoverReply returns the type of action done.

• required sint32 status = 1

EmailSetup to create a new setup.

• required bytes byzcoinid = 1

  ByzCoinID where the email service is running.

• required onet.Roster roster = 2

  Roster of the nodes where the byzcoin service is running.

• required string deviceurl = 3

  DeviceURL, as created from the dynacred-frontend

• required bytes emaildarcid = 4

  EmailDarcID is the darc where new users will be added to

• required string smtphost = 5

  SMTPHost: "[tls://]host:port" - should support emails with a sender "from".

• required string smtpfrom = 6

  SMTPFrom that will be used for the SMTP host

• required string smtpreplyto = 7

  SMTPReplyTo is the email address that will be used as reply-to

• required string baseurl = 8

  BaseURL is prepended to the recovery string and should point to the publicly available frontend.

• required bytes signature = 9

  Signature is on the sha256 of the above fields

EmailSetupReply when everything went well.

(message has no fields)

EmailSignup creates a new user if EmailSetup is configured

• required string email = 1

• required string alias = 2

  Alias can be empty

EmailSignupReply returns the type of action done

• required sint32 status = 1

GetAdminDarcIDs returns a slice of adminDarcs that are allowed to delete the polls and add a party.

(message has no fields)

GetAdminDarcIDsReply returns the list of adminDarcs that are allowed to delete the polls and add a party.

• repeated bytes admindarcids = 1

Meetup is sent by a user who wants to discover who else is around.

• optional UserLocation userlocation = 1

• optional bool wipe = 2

MeetupResponse contains all users from the last x minutes.

• repeated UserLocation users = 1

Party represents everything necessary to find a party in the ledger.

Used in: PartyList, PartyListResponse

• required onet.Roster roster = 1

  Roster is the list of nodes responsible for the byzcoin instance

• required bytes byzcoinid = 2

  ByzCoinID represents the ledger where the pop-party is stored.

• required bytes instanceid = 3

  InstanceID is where to find the party in the ledger.

PartyDelete can be sent from one of the admins to remove a party.

Used in: PartyList

• required bytes partyid = 1

• required darc.Identity identity = 2

• required bytes signature = 3

PartyList can either store a new party in the list, or just return the list of available parties.

• optional Party newparty = 1

• optional bool wipeparties = 2

• optional PartyDelete partydelete = 3

PartyListResponse holds a list of all known parties so far. Only parties in PreBarrier state are listed.

• repeated Party parties = 1

Poll allows for adding, listing, and answering to storagePolls

• required bytes byzcoinid = 1

• optional PollStruct newpoll = 2

• optional PollList list = 3

• optional PollAnswer answer = 4

• optional PollDelete delete = 5

PollAnswer stores one answer for a poll. It needs to be signed with a Linkable Ring Signature to proof that the choice is unique. The context for the LRS must be 'Poll' + ByzCoinID + PollID And the message must be 'Choice' + byte(Choice)

Used in: Poll

• required bytes pollid = 1

• required sint32 choice = 2

• required bytes lrs = 3

• optional bytes partyid = 4

PollChoice represents one choice of one participant.

Used in: PollStruct

• required sint32 choice = 1

• required bytes lrstag = 2

PollDelete has the poll to be deleted, and the signature proving that the client has the right to do so. The signature is a Schnorr signature on the PollID.

Used in: Poll

• required darc.Identity identity = 1

• required bytes pollid = 2

• required bytes signature = 3

PollList returns all known storagePolls for this byzcoinID

Used in: Poll

• repeated bytes partyids = 1

PollResponse is sent back to the client and contains all storagePolls known that still have a reward left. It also returns the coinIID of the pollservice itself.

• repeated PollStruct polls = 1

PollStruct represents one poll with answers.

Used in: Poll, PollResponse

• required bytes personhood = 1

• optional bytes pollid = 2

• required string title = 3

• required string description = 4

• repeated string choices = 5

• repeated PollChoice chosen = 6

RoPaSciList can either store a new RockPaperScissors in the list, or just return the available RoPaScis.

• optional personhood.RoPaSci newropasci = 1

• optional bool wipe = 2

• optional personhood.RoPaSci lock = 3

  RoPaSciLock allows to ask to lock a ropasci-game and take 1 minute to reply. After 1 minute, the game is again released. If the given game is not available, another one will be presented, when available.

RoPaSciListResponse returns a list of all known, unfinished RockPaperScissors games.

• repeated personhood.RoPaSci ropascis = 1

SetAdminDarcIDs sets the list of admin darcs. The signature must be on sha256( AdminDarcID[0] | AdminDarcID[1] | ... )

• repeated bytes newadmindarcids = 1

• required bytes signature = 2

SetAdminDarcIDsReply indicates a correct storage of the AdminDarcIDs.

(message has no fields)

StringReply can be used by all calls that need a string to be returned to the caller.

• required string reply = 1

UserLocation is the moment a user has been at a certain location.

Used in: Meetup, MeetupResponse

• required bytes publickey = 1

• optional bytes credentialiid = 2

• optional personhood.CredentialStruct credential = 3

• optional string location = 4

• required sint64 time = 5