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

@biconomy/permission-context-builder

v1.1.2

Published

ERC-7715 Permission Context Builder utility package.

Downloads

7

Readme

ContextBuilder

@biconomy/permission-context-builder

Overview

@biconomy/permission-context-builder is a TypeScript library designed to facilitate the creation and management of smart sessions for blockchain interactions. It provides utilities for generating permission contexts, encoding session data, and handling various types of signers including EOA (Externally Owned Accounts) and Passkeys.

Features

  • Generate permission contexts for smart contract interactions
  • Support for multiple signer types (EOA and Passkeys)
  • Encoding and decoding of DID (Decentralized Identifier) keys
  • Integration with Viem for Ethereum interactions
  • Utilities for handling smart account permissions and policies

Installation

npm install @biconomy/permission-context-builder

Usage

Generating Permission Context

To generate a permission context for a smart contract interaction:

import { getContext } from '@biconomy/permission-context-builder';
import { createWalletClient, http } from 'viem';
import { baseSepolia } from 'viem/chains';

const walletClient = createWalletClient({
  account,
  transport: http(),
  chain: baseSepolia,
});

const context = await getContext(walletClient, {
  signer: {
    type: 'keys',
    data: {
      ids: [
        "did:key:zDnaerx...", // Your DID key here
        "did:key:zDnaerDaTF5BXEavCrfRZEk316dpbLsfPDZ3WJ5hRTPFU2169"
      ],
    }
  },
  smartAccountAddress: walletClient.account?.address,
  permissions: [
    {
      type: {
        custom: 'donut-purchase'
      },
      data: {
        target: donutContractAddress,
        abi: donutContractAbi,
        valueLimit: parseEther('0.001'),
        functionName: 'function purchase()'
      },
      policies: [],
      required: true
    }
  ],
  expiry: Date.now() + 1000
});

Decoding DID Keys

To decode a DID key:

import { decodeDIDToPublicKey } from '@biconomy/permission-context-builder';

const result = decodeDIDToPublicKey("did:key:zDnaerDaTF5BXEavCrfRZEk316dpbLsfPDZ3WJ5hRTPFU2169");
console.log(result.key); // Public key
console.log(result.keyType); // Key type (e.g., "secp256r1")

API Reference

getContext(walletClient, options)

Generates a permission context for smart contract interactions.

  • walletClient: Viem WalletClient instance
  • options: Object containing:
    • signer: Signer information
    • smartAccountAddress: Address of the smart account
    • permissions: Array of permission objects
    • expiry: Expiration timestamp

Returns: Promise<string> - The generated context as a hexadecimal string

decodeDIDToPublicKey(didKey)

Decodes a DID key to its public key and key type.

  • didKey: DID key string

Returns: { key: string, keyType: string }

Testing

To run the test suite:

npm test

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License.