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

cypheriumjs-crypto

v0.2.0

Published

Core crypto utilities for signing/verification/hashing Cypherium transactions.

Downloads

3

Readme

@zilliqa-js/crypto

Cryptographic abstractions for working with Cypherium's crypto primitives

Functions

randomBytes(bytes: number): string

Safely generates bytes using Window.crypto in the browser or the built-in crypto in node.

Parameters

bytes: number - the number of bytes to randomly generate

Returns

string - n randomly-generated bytes (hex-encoded).

generatePrivateKey(): string

Generates a cryptographically-secure 32-byte private key.

Parameters

None

Returns

string - 32-byte hex-encoded private key.

getPubKeyFromPrivateKey(privateKey: string): string

Retrieves the public key of the given hex-encoded private key.

Parameters

privateKey: string - 32-byte hex-encoded private key.

Returns

string - 20-byte hex-encoded address.

getAddressFromPrivateKey(privateKey: string): string

Retrieves the address from the given hex-encoded private key.

Parameters

privateKey: string - 32-byte hex-encoded private key.

Returns

string - 20-byte hex-encoded address.

compressPublicKey(publicKey: string): string

Compresses a full-length public key by using a sign byte (02 or 03).

Parameters

publicKey: string - 65-byte hex-encoded public key.

Returns

string - 32-byte hex-encoded public key.

getAddressFromPublicKey(publicKey: string): string

Returns the address derived from the given publicKey.

Parameters

publicKey: string - 32-byte hex-encoded compressed public key.

Returns

string - 20-byte hex-encoded address.

verifyPrivateKey(privateKey: string): boolean

Returns true if the given privateKey is valid.

Parameters

string - 32-byte hex-encoded private key.

Returns

boolean

sign(msg: Buffer, privateKey: string, pubKey: string): string

Generates a Schnorr signature over a Buffer of arbitrary bytes. This function must be used to sign all transactions to be broadcast on the blockchain.

Parameters

msg: Buffer - arbitrary sequence of bytes to be signed. privateKey: string - 32-byte hex-encoded private key. pubKey: string - 32-byte hex-encoded private key.

Returns

boolean

encryptPrivateKey(kdf: KDF, privateKey: string, passphrase: string): Promise<string>

Generates a version 3 keystore file that complies with the Web3 Secret Storage definition.

Parameters

kdf: 'pbkdf2' | 'scrypt' - the key derivation function. Only pbkdf2 and scrypt are currently supported. privateKey: string - 32-byte hex-encoded private key. passphrase: string - the passphrase to be used to encrypt the private key.

Returns

Promise<string> - the stringified JSON file.

decryptPrivateKey(passphrase: string, keystore: KeystoreV3): Promise<string>

Generates a version 3 keystore file that complies with the Web3 Secret Storage definition.

Parameters

passphrase: string - the passphrase to be used to encrypt the private key. keystore: KeystoreV3 - the object containing the deserialised JSON obtained from encryptPrivateKey.

Returns

Promise<string> - the hex-encoded private key.

toBech32Address(address: string): string

Encodes a 20-byte hex encoded address as a bech32 address. Non-hex-encoded strings will cause an error to be thrown.

Parameters

address: string - the 20-byte hex-encoded address. 0x prefix optional.

Returns

string - the bech32 encoded address. It is always prefixed by cph1, where 1 is a separator.

Example

0x1d19918a737306218b5cbb3241fcdcbd998c3a72 (hex) -> cph1r5verznnwvrzrz6uhveyrlxuhkvccwnju4aehf (bech32)

fromBech32Address(address: string): string

Encodes a a bech32 address as a hex-encoded string. Invalid bech32 addresses will cause an error to be thrown.

Parameters

address: string - the 42-character bech32 address.

Returns

string - the checksum 20-byte hex-encoded address.

Example

cph1r5verznnwvrzrz6uhveyrlxuhkvccwnju4aehf (bech32) -> 0x1d19918a737306218b5cbb3241fcdcbd998c3a72 (hex)

Interfaces

interface PBKDF2Params {
  salt: string;
  dklen: number;
  c: number;
}

interface ScryptParams {
  salt: string;
  dklen: number;
  n: number;
  r: number;
  p: number;
}

type KDFParams = PBKDF2Params | ScryptParams;

interface KeystoreV3 {
  address: string;
  crypto: {
    cipher: string;
    cipherparams: {
      iv: string;
    };
    ciphertext: string;
    kdf: KDF;
    kdfparams: KDFParams;
    mac: string;
  };
  id: string;
  version: 3;
}