This repository has been archived and moved to a new location. This means that the repository is no longer actively maintained or updated. Please note the new location of the repository and update your references accordingly.
The repository has been moved to https://github.com/affinidi/reference-app-portable-rep
This repository will remain available in its current location for historical purposes. You may continue to use or reference the code, but please be aware that it is no longer being actively maintained or updated.
We will not be accepting any new issues or pull requests for this repository. If you encounter any issues with the code, please refer to the archived repository or the new repository location for potential solutions.
This is a ready-to-use reference app that showcases usage of Affinidi API for issuing, sharing and storing verifiable credentials in the wallet.
Portable reputation app allows you to import your data from data providers like Github, Steam, LinkedIn, Medium, etc. and store it as a verifiable credential in your wallet.
You can then share this credential with anyone, who can then verify its validity without ever accessing these data providers again.
Setting up the reference app is easy, just follow these steps:
-
Clone the repo:
$ git clone git@github.com:affinidi/reference-app-portable-reputation.git $ cd reference-app-portable-reputation -
Install the dependencies:
$ npm install -
Create a
.envfile:$ cp .env.example .envEnter values for
PROJECT_ID,PROJECT_DIDandAPI_KEY_HASHfrom your Affinidi project properties. These are filled for you automatically if you used the VS Code Extension or CLI to generate the app.Create a Github OAuth app and enter values for
GITHUB_APP_CLIENT_IDandGITHUB_APP_CLIENT_SECRET. When creating the app set Authorization callback URL tohttp://localhost:3000or to the host that you are using for this application. You can set any value for Application name, Homepage URL and Enable Device Flow. -
Launch the app:
$ npm run devApp will be available locally on http://localhost:3000.
We have created multiple variations of the same app for you to use.
These are called "flavors" and they're adapted for a specific industry.
Import your professional and career data.
For example: Github projects and languages, Medium articles and comments, LinkedIn courses and certificates, and more.
Built-in data provider: Github.
Import your gaming statistics and account data.
For example: games owned, hours played, achievements unlocked, skins purchased, wins and losses, and more.
Built-in data provider: upcoming.
Verifiable Credential (VC) – a tamper-evident credential that has authorship that can be cryptographically verified.
In this app, user's imported profile data is the subject of the verifiable credential.
Read W3C specification.
Holder – an entity that owns the verifiable credential. Usually, a holder is the subject of the credential that they hold.
A holder in the portable reputation app is the person whose data is imported from a data provider and who stores the issued VCs in their wallet.
Issuer – an entity that issues the verifiable credential to the holder.
Issuer in this app is the entity that owns the app itself and signs the credentials.
Verifier – an entity that accepts verifiable credentials to verify their validity and authorship.
Verification functionality is not present in the portable reputation app.
Check out our Certification & Verification reference app for verification functionality.
Wallet (Cloud Wallet) – a service that provides functionality to sign credentials (for issuers) and to store credentials in the wallet (for holders).
Portable reputation app uses the Affinidi Cloud Wallet API for authentication, holder credential storage and credential issuance.
Data provider – an external service, that contains some information about the holder. This information is then imported and used for generating the verifiable credential.
A few examples: Github projects, Medium articles, Steam games and LinkedIn certificates.
Learn more about VCs, trust triangle and Decentralized Identifiers (DIDs).
We'll use Github as a data provider in this example.
sequenceDiagram
actor User
participant App
participant CW as Cloud Wallet
participant Github
User->>+App: Sign into the Holder's wallet
App->>+CW: Sign in
CW->>-App: [Cloud Wallet access token]
App->>App: Store [Cloud Wallet access token] in the localStorage
App->>+CW: Fetch Holder's VCs
CW->>-App: [Holder's VCs]
App->>App: Find latest GithubProfile VC in Holder's VCs
opt Holder doesn't have a GithubProfile VC yet
App->>-User: Show "Setup profile" page
User->>+App: Import Github profile
App->>+Github: Request Github authentication
Github->>-User: Ask user to login into their Github account
User->>+Github: Login into the Github account and authorize the action
Github->>-App: [Github access token]
App->>App: Store [Github access token] in as a cookie
App->>+Github: Request user's Github profile data
Github->>-App: [Github profile data]
App->>App: Build an unsigned GithubProfile VC
App->>+CW: Sign GithubProfile VC with Issuer's wallet
CW->>-App: [GithubProfile VC]
App->>+CW: Store [GithubProfile VC] in the Holder's wallet
CW->>-App: (ok)
end
App->>-User: Show "Github profile" page with GithubProfile VC's contents
This project is built with NextJS framework, which allows you to quickly build apps using TypeScript and React. NextJS has built-in router, server-side rendering, backend support and useful extensions like Next Auth for authenticating via Github and other data providers.
Read NextJS docs, React docs.
We also use Styled Components and Tailwind CSS to build the UI.
Read Styled Components docs, Tailwind CSS docs.
To make API requests, axios library is used.
Read axios docs.
Backend requests are validated with zod and logged with pino.
Read Zod docs, pino docs.
Github profile data is fetched using Octokit and GraphQL.
Read Octokit docs, GraphQL docs.
Affinidi collects usage data to improve our products and services. For information on what data we collect and how we use your data, please refer to our Privacy Policy.
Click here to create a ticket and we will get on it right away. If you are facing technical or other issues, you can reach out to us on Discord.
Affinidi Developer Tools are currently in the open beta phase and we are refining our product every day. The Affinidi Developer Tools may be incomplete and may contain errors – they may be unstable and may cause a loss of functionality and data. Use of the Affinidi Developer Tools will be at your own risk. As our engineers seek to improve our platform, we would not have the resources to provide any maintenance or tech support at this time. Please bear with us as we continue to improve the platform.
You are only limited by your imagination! Affinidi Developer Tools is a toolbox with which you can build software apps for personal or commercial use.
We only provide the tools - how you use them is largely up to you. We have no control over what you develop with our tools - but please use our tools responsibly!
We hope that you would not develop anything that contravenes any applicable laws or regulations. Your projects should also not infringe on Affinidi’s or any third party’s intellectual property (for instance, misusing other parties’ data, code, logos, etc).
Please ensure that you have in place your own terms and conditions, privacy policies, and other safeguards to ensure that the projects you build are secure for your end users.
If you are processing personal data, please protect the privacy and other legal rights of your end-users and store their personal or sensitive information securely.
Some of our components would also require you to incorporate our end-user notices into your terms and conditions.
Affinidi Developer Tools are free during the open beta phase, so come onboard and experiment with our tools and see what you can build! We may bill for certain components in the future, but we will inform you beforehand.
We may from time to time impose limits on your use of the Affinidi Developer Tools, such as limiting the number of API requests that you may make in a given duration. This is to ensure the smooth operation of the Affinidi Developer Tools so that you and all our other users can have a pleasant experience as we continue to scale and improve the Affinidi Developer Tools.
From time to time, we may request certain information from you to ensure that you are complying with the Terms of Use.
When you create a developer’s account with us, we will issue you your private login credentials. Please do not share this with anyone else, as you would be responsible for activities that happen under your account. If you have friends who are interested, ask them to sign up – let's build together!
Please note that this FAQ is provided for informational purposes only and is not to be considered a legal document. For the legal terms and conditions governing your use of the Affinidi Developer Tools, please refer to our Terms of Use.