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

@publicmint/widget-sdk

v2.2.0

Published

SDK for the Public Mint Widget.

Downloads

2

Readme

@publicmint/widget-sdk

SDK for the Public Mint widget.

Table of contents:

Installation

Using npm:

npm install @publicmint/widget-sdk

Using yarn:

yarn add @publicmint/widget-sdk

Usage

See the documentation for information on how to use this SDK.

Usage

Initialization

Initialize the SDK by creating an instance of the PmintWidgetSdk class:

import PmintWidgetSdk from '@publicmint/widget-sdk';

const pmint = new PmintWidgetSdk();

Widgets

Deposit widget

To show the deposit widget, call the renderAddFunds method. This method returns a promise that resolves with either completed or canceled.

const status = await pmint.renderAddFunds({
  blockchain: 'publicmint',
  destinationAddress: address,
  locale: 'en'
});

Withdraw widget

To show the withdraw widget, call the renderWithdraw method. This method returns a promise that resolves with either completed or canceled.

import { withdraw } from '@publicmint/widget-sdk';
import PublicMintWeb3 from '@publicmint/publicmint-web3';

const status = await pmint.renderWithdraw({
  blockchain: 'publicmint',
  burn: options => {
    // Perform the blockchain operation.
    // When using the public mint blockchain use our `withdraw` utility:
    const web3 = new PublicMintWeb3();
    return withdraw(web3, { ...options, privateKey });
  },
  locale: 'en',
  originAddress: address
})

Account widget

To show the account widget, call the renderAccount method.

await pmint.renderAccount({ locale: 'en' });

Handling user sessions

There are three events that you can listen to to be notified of user sessions: login, logout and userUpdate:

// Listen to login events.
pmint.addListener('login', user => {
});

// Listen to logout events.
pmint.addListener('logout', () => {
});

// Listen to updates to the user profile.
pmint.removeListener('userUpdate', user => {
});

To check if there is a user logged in and get the user's profile, call the getUser method:

const user = await pmint.getUser();

To terminate the user's session, call the logout method:

await pmint.logout();