# irc-sig-util

> A few useful functions for signing irchain data

Latest version **0.0.2** (published 2018-08-14) · ISC license · 0 weekly downloads

## Install

```sh
npm install irc-sig-util
pnpm add irc-sig-util
yarn add irc-sig-util
bun add irc-sig-util
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2018-08-14 |
| First published | 2018-08-07 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 22.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Dan Finlay |
| Maintainers | irchain-io |
| Keywords | irchain, signature |

## Links

- npm: https://www.npmjs.com/package/irc-sig-util
- Repository: https://github.com/AuraMask/irc-sig-util
- Homepage: https://github.com/AuraMask/irc-sig-util#readme
- Issues: https://github.com/AuraMask/irc-sig-util/issues
- npm.io page: https://npm.io/package/irc-sig-util

## Dependencies (2)

- [icjs-abi](https://npm.io/package/icjs-abi.md) ^0.0.1
- [icjs-util](https://npm.io/package/icjs-util.md) ^0.0.1

## Alternatives

- [jsforce](https://npm.io/package/jsforce.md) — 851.2K weekly downloads
- [react-native-qrcode-svg](https://npm.io/package/react-native-qrcode-svg.md) — 693.5K weekly downloads
- [@salesforce/plugin-data](https://npm.io/package/@salesforce/plugin-data.md) — 394.9K weekly downloads
- [@backstage/plugin-search-common](https://npm.io/package/@backstage/plugin-search-common.md) — 308.5K weekly downloads
- [@chain-registry/types](https://npm.io/package/@chain-registry/types.md) — 38.4K weekly downloads

## Recent versions

- 0.0.2 (latest) — 2018-08-14
- 0.0.1 — 2018-08-07

## README

# Irc-Sig-Util [![CircleCI](https://circleci.com/gh/AuraMask/irc-sig-util.svg?style=svg)](https://circleci.com/gh/AuraMask/irc-sig-util)

[![Greenkeeper badge](https://badges.greenkeeper.io/AuraMask/irc-sig-util.svg)](https://greenkeeper.io/)

A small collection of irchain signing functions.

You can find usage examples [here](https://github.com/flyswatter/js-irc-personal-sign-examples)

[Available on NPM](https://www.npmjs.com/package/irc-sig-util)

## Supported Signing Methods

Currently there is only one supported signing protocol. More will be added as standardized. 

- Personal Sign (`personal_sign`) [girc thread](https://github.com/irchain/go-irchain/pull/2940)


## Installation

```
npm install irc-sig-util --save
```

## Methods

### concatSig(v, r, s)

All three arguments should be provided as buffers.

Returns a continuous, hex-prefixed hex value for the signature, suitable for inclusion in a JSON transaction's data field.

### normalize(address)

Takes an address of either upper or lower case, with or without a hex prefix, and returns an all-lowercase, hex-prefixed address, suitable for submitting to an irchain provider.

### personalSign (privateKeyBuffer, msgParams)

msgParams should have a `data` key that is hex-encoded data to sign.

Returns the prefixed signature expected for calls to `irc.personalSign`.

### recoverPersonalSignature (msgParams)

msgParams should have a `data` key that is hex-encoded data unsigned, and a `sig` key that is hex-encoded and already signed.

Returns a hex-encoded sender address.

### signTypedData (privateKeyBuffer, msgParams)

Signs typed data as per [EIP712](https://github.com/irchain/EIPs/pull/712).

Data should be under `data` key of `msgParams`. The method returns prefixed signature.

### recoverTypedSignature ({data, sig})

Return address of a signer that did `signTypedData`.

Expects the same data that were used for signing. `sig` is a prefixed signature.

### typedSignatureHash (typedData)

Return hex-encoded hash of typed data params according to [EIP712](https://github.com/irchain/EIPs/pull/712) schema.

### extractPublicKey (msgParams)

msgParams should have a `data` key that is hex-encoded data unsigned, and a `sig` key that is hex-encoded and already signed.

Returns a hex-encoded public key.

---
_Source: https://npm.io/package/irc-sig-util · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._