dPoPP Passport-Reader

Compiling a browser bundle

Install deps

yarn install

Build...

yarn run build

Usage

Firstly we need to import the bundle/library and construct a PassportReader instance, passing in a ceramic node URL and a networkId

// import the bundle
<script src="./dist/reader.bundle.js" type="script/javascript"/>

// or import as a module
import PassportReader from '@dpopp/passport-reader'

...
// create a new instance point at the community clay node on mainnet
const reader = new PassportReader('https://ceramic-clay.3boxlabs.com', '1')

The PassportReader instance exposes read-only methods to get the content of a Gitcoin Passport:

• getGenesis - pass in a wallet address and get back the did:pkh and genesis IDX streams

reader.getGenesis(address: string): Promise<CeramicGenesis | false>

• getPassport - pass in a ceramic DID and get back a fully hydrated Passport record

reader.getPassport(did: string): Promise<CeramicPassport | CeramicCredentialPassport | false>

• getPassportStream - pass in a ceramic DID and get back a raw Passport stream record *note that this is a shallow copy of the passport (and needs to have its stamps hydrated)

reader.getPassportStream(did: string): Promise<CeramicPassport | false>