yurenju/tw-did

tw-did

tw-did is a bridging service that integrates TW FidO with W3C Decentralized Identifiers (DIDs) and Verifiable Credentials standards. After verifying a user's Taiwanese residency through TW FidO, the user's identity is linked to a specified decentralized identity, providing various identity verification use cases.

tw-did mainly has three functions:

• Binding: Through TW FidO, the identity of a Taiwanese resident is linked to a DID.
• Revocation: This is performed when users decide to revoke the link between their DID and their Taiwanese residency.
• Verification: Any third party can request to verify the credentials issued by tw-did.

This project supports the binding of TW FidO to Ethereum Address and Semaphore Identity. The former will issue a Verifiable Credential recording that an Ethereum Address holder is a Taiwanese resident. After tw-did has verified through TW FidO, the latter allows a holder to prove through Semaphore's zero-knowledge proof that they have passed TW FidO authentication as a Taiwanese resident. Furthermore, the following verification process does not require disclosure of the holder's identity. Neither the issuer nor the verifier can identify which Taiwanese resident is being verified during the verification process.

For more information, please refer to the following documents:

• Requirements
• Use Cases
• User Interface Design Wireframes
• Interaction Flow
  • Registration
  • Revocation
  • Verification

Usage

tw-did uses nx for monorepo management. Please use the command below to install the dependencies:

$ npm install

This command installs all necessary packages for the project.

To start a development server, use the following command:

$ npm start

This command starts a local development server for the web application.

You can also use the following command to run acceptance test cases:

$ npm run acceptance

This command runs end-to-end acceptance tests for the project.