Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@privy-io/privy-browser

Package Overview
Dependencies
Maintainers
7
Versions
6
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@privy-io/privy-browser

Browser client for the Privy API

  • 0.0.3
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
8
increased by14.29%
Maintainers
7
Weekly downloads
 
Created
Source

@privy-io/privy-browser

Privy's browser client allows you to interact with the Privy API from broswer clients.

For interacting with user data from a node backend, use @privy-io/privy-node.

https://www.privy.io

build npm version

Documentation

See https://docs.privy.io/.

Installation

npm i @privy-io/privy-browser

Basic usage

Initialize the Privy client using a session that can fetch tokens from Privy through your backend.

import axios from 'axios';
import {PrivyClient, CustomSession} from '@privy-io/privy-browser';

const session = new CustomSession(async function authenticate() {
  const response = await axios.post<{token: string}>(`/your/custom/endpoint`);
  return response.data.token;
});

const client = new PrivyClient({
  session: session,
});

Using the Privy client, read and write some data for a given user.

const userId = '0x123';

// To write...
const [email, ssn] = await client.put(userId, [
  {field: 'email', value: 'foo@example.com'},
  {field: 'ssn', value: '123-45-6789'},
]);

// To read...
const [email, ssn] = await client.get(userId, ['email', 'ssn']);
console.log(email.text());
console.log(ssn.text());

Testing

The test runner looks for files with a .test.ts extension. There are two groups of tests: unit and integration.

Unit

To run unit tests:

npm test

Integration

Some of the tests are currently expected to be run against a running instance of the API.

Reset data in the API instance before running tests, e.g. by recreating and seeding the test database.

To successfully run tests, you will need to create a .env file in the root of ./privy-browser with the following fields:

PRIVY_API_URL=<privy api url>
PRIVY_KMS_URL=<privy kms url>
PRIVY_API_KEY=<your public key>
PRIVY_API_SECRET=<your private key>

To run integration tests:

npm run test-integration

Keywords

FAQs

Package last updated on 04 Nov 2022

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc