citizenprotocol v1.0.17

CitizenProtocol

Citizen is a file exchange system built on top of IPFS designed to facilitate digital id (DID) proposals and transfers. The design allows for the single required use of an external api key. Beyond the activation of a user onto the network, the only required credential for ID verification is a secret key held only by the user after establishing their presence on the network.

Install the Library

//install via NPM 
npm install citizenprotocol

Create a Node

In the current version of CitizenProtocol, we rely on web3.storage API keys for our minting requirements.

Parameters:

• username (String): User-choice name of node. Used in public key encryption
• w3token (String): web3.storage user token

//register node 
import {register} from 'citizenprotocol/main.js'

await registerUser(username, w3token)

//returns IFPS file (user public ID) and key wallet private key

The file acts as a profile for a user's digital ID presence. The encryption of the data files allows for a single point of authentication through the private key.

Propose Media

Given that Citizen's intended to be a distributed storage and exchange system for digital IDs, the proposeMedia function below acts an kind of issuer, allowing anyone, anywhere, as long as they're connected to the network, to mint an ID.

Parameters:

• cid (String): Name of minter
• w3token (String): web3.Storage token of minter
• media (String): CID for file ID
• key (String): Account key used to access keyvault
• recipient (String): public address of recipient

//propose credential
import {proposeMedia} from 'citizenprotocol/main.js'

await proposeMedia(cid, w3token, media, key, recipient) 

The above function adds the proposed media file to the 'allocated' item in the ownership object and returns the media proposed.

Claim Crendential Ownership

Claim to confirm credential ownership.

Parameters:

• cid (String): Ownership file
• w3token (String): web3.Storage token of claiming user
• media (String): Media being claimed
• key (String): Private key of claiming user

//claim credential
import {claimMedia} from 'citizenprotocol/main.js'

await claimMedia (cid, w3token, media, key) 

Validate Credential

Validate history of file and ownership. Returns boolean

Parameters:

validate_ownership(owner, creator, ipns, key)

• owner (String): Claimed owner of credentials
• creator (String): Name of minter
• ipns (String): IPNS file name
• key (String): Private key

import {validate_ownership} from 'linearprotocol/assign.js'

await mint_nonmedia(creator, owner, ipns,token)