npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@civic/profile

v0.5.2

Published

Civic Profile SDK

Downloads

324

Readme

Civic Profile SDK

A library for accessing a user's civic.me profile on Civic's identity-store backend.

Usage

import { CivicProfile, Profile } from "@civic/profile";

// Query using a wallet address, DID, or ETH or SNS name
const profile: Profile = await CivicProfile.get("query");

// wallet information
profile.address
profile.did

// access profile information if available
profile.name;
profile.headline;

// access social identifiers linked to the profile:
profile.identifiers;

// access other wallets linked to the profile:
profile.linkedWallets;

Options

Solana connection

A Solana connection or Ethereum provider can be passed to the library as follows:

const profile = await CivicProfile.get("query", { solana: { connection }, ethereum: { provider } });

Civic backend endpoint

By default, Civic's production endpoint for the identity-store is used: https://api.civic.com/identity-store

A different one can be passed in:

const profile = await CivicProfile.get("query", { civicIdentityStoreEndpoint: 'https://example.com' });

Examples

The below queries will all return the same profile - connected to the "civic.me" account:

// Query using DID
CivicProfile.get("did:sol:9KKaBPxD9mYxLcsrBjdvChcchxSf6hRsQxfUpCbsuaDJ");
// Query using SOL address
CivicProfile.get("9KKaBPxD9mYxLcsrBjdvChcchxSf6hRsQxfUpCbsuaDJ");
// Query using SNS address
CivicProfile.get("civicme.sol");
// Query using ethereum address
CivicProfile.get("0x964617b2d933c6e5c6c1B30681DCAee23Baa9836");
// Query using ENS address
CivicProfile.get("civic-me.eth");

Obtaining Civic passes


import { CivicProfile, GatewayToken } from "@civic/profile";

// Query using a wallet address, did or SNS name
const profile = await CivicProfile.get("query");

const passOptions: PassOptions = {
  includeExpired: true,
};

const passes: GatewayToken[] = await profile.getPasses(passOptions);