Gitcoin Passport
Search…
⌃K

Getting Started

Overview of the Gitcoin Passport Projects and SDK

The Gitcoin Passport SDK

The SDK is comprised of a set of libraries designed to help developers interact with the Gitcoin Passport. Your setup process will vary based on how involved you are with the SDK. Reader is the least involved library, while writer is the most involved. This section explains how to install each of the libraries with npm. To learn more about using them in your dApp, progress to the integration section.

Packages

Writer

Writes to an authenticated DIDs Passport stream in Ceramic.
You can install the Writer library using npm or yarn. You can also download the Git repository and install dependencies manually.
# install dependencies
yarn add @gitcoinco/passport-sdk-writer
yarn install
# begin by running webpack
yarn run webpack

Reader

Reads from any Passport stream (on Ceramic).
To get started, import the library and construct a passportReader instance.
You can add to your project as a module
import PassportReader from "@gitcoinco/passport-sdk-reader"
or import the bundle.
<script src="./dist/reader.bundle.js" type="script/javascript"/>

Scorer

Score the contents of a Passport.
To add to your project, either add with npm or yarn, or download the Git repository and install the dependencies manually.
# install dependencies
yarn add @gitcoinco/passport-sdk-scorer
yarn install
# then run webpack
yarn run webpack

Types

Shared types (used by other packages in the SDK).
To use this library, ensure @gitcoinco/passport-sdk-types is included as a package dependency. Then, import types like so :
// import sdk types
import { VerifiableCredential } from "@gitcoinco/passport-sdk-types"

Working with Ceramic

Gitcoin Passport and the Passport SDK are built on top of the Ceramic Network for data persistence. If you're new to Ceramic, check out their documents to get familiarized with the basics:
With the Passport SDK it's not necessary to interact with Ceramic directly, but you may find it helpful for debugging, or just general understanding of the system.

Developing on Testnet

We recommend developers work with a testnet instance of Passport when building with the SDK.
We have an instance of the Passport app deployed and configured to interact with a Ceramic testnet node here:
Gitcoin Passport
Testnet instance of the Gitcoin Passport
This instance of the Passport app is configured to run on top of the Ceramic clay test-net, and is hosted at https://ceramic.staging.dpopp.gitcoin.co.
Wallet signatures can still be made on Ethereum mainnet, but the underlying data will remain on the ceramic testnet.