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

sub-accounts-lib

v0.0.4

Published

SubAccounts Library

Downloads

211

Readme

SubAccounts Library

Overview

This library provides a set of utilities and wrappers that simplify working with the SubAccounts project. The core features include encryption and decryption of accounts using AES and integration with Ethereum.

The library is designed to create and manage Substrate accounts securely, enabling their use in applications supporting Ethereum.

Key Features

  • Account Encryption and Decryption: Wrappers for convenient AES encryption and decryption.
  • MetaMask Integration: Utilities for encrypting and decrypting data using Ethereum public and private keys.
  • Polkadot.js Keyring Compatibility: Support for encrypting and decrypting Substrate account keys.

Installation

To use this library, install the dependencies:

npm install sub-accounts-lib

Usage

Encrypting an Account

You can encrypt a Substrate account using both an account password and an AES password:

import { SubAccounts } from './SubAccounts';
import { Keyring } from '@polkadot/api';

// Initialize a keyring and create an account
const keyring = new Keyring({ type: 'sr25519' });
const account = keyring.addFromUri('//Alice');

// Encrypt the account
const encryptedAccount = SubAccounts.encrypt(account, 'accountPassword', 'aesPassword');
console.log('Encrypted Account:', encryptedAccount);

Decrypting an Account

To decrypt the account:

const decryptedAccount = SubAccounts.decrypt(encryptedAccount, 'accountPassword', 'aesPassword');
console.log('Decrypted Account:', decryptedAccount.address);

Encrypting with Ethereum provider

If you want to encrypt the account using MetaMask’s encryption:

const provider = new ethers.providers.Web3Provider(__PROVIDER__);
const walletAddress = await provider.getSigner().getAddress();

const encryptedWithMetaMask = await SubAccounts.encryptWithEthers(
  provider,
  walletAddress,
  account,
  'accountPassword',
  'aesPassword'
);
console.log('Encrypted with Ethereum:', encryptedWithMetaMask);

Decrypting with Ethereum provider

To decrypt the account using Ethereum:

const decryptedWithMetaMask = await SubAccounts.decryptWithEthers(
  provider,
  walletAddress,
  encryptedWithMetaMask,
  'accountPassword',
  'aesPassword'
);
console.log('Decrypted with Ethereum:', decryptedWithMetaMask.address);

Library Structure

Main Files:

  • SubAccounts.ts: Core logic for account encryption and decryption.
  • encryptAES.ts and decryptAES.ts: Utilities for AES encryption and decryption.
  • encryptKeyringPair.ts and decryptKeyringPair.ts: Wrappers for encrypting and decrypting Polkadot.js Keyring pairs.

Contributing

We welcome your questions and contributions to improve the library. Feel free to submit PRs and issues to the repository.

License

MIT License.