# polynym

> A simple solution to resolve BSV addresses from popular wallets and services

Latest version **1.0.7** (published 2019-10-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install polynym
pnpm add polynym
yarn add polynym
bun add polynym
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.7 |
| Published | 2019-10-29 |
| First published | 2019-07-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 5.5 KB |
| Known vulnerabilities | 0 (+25 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 26 |
| Author | UptimeSV |
| Maintainers | deanmlittle |

## Links

- npm: https://www.npmjs.com/package/polynym
- Repository: https://github.com/uptimesv/polynym
- Homepage: https://github.com/uptimesv/polynym#readme
- Issues: https://github.com/uptimesv/polynym/issues
- npm.io page: https://npm.io/package/polynym

## Dependencies (1)

- [axios](https://npm.io/package/axios.md) ^0.19.0

## Recent versions

- 1.0.7 (latest) — 2019-10-29
- 1.0.6 — 2019-08-03
- 1.0.5 — 2019-08-03
- 1.0.4 — 2019-08-03
- 1.0.3 — 2019-08-03
- 1.0.2 — 2019-08-03
- 1.0.1 — 2019-07-29
- 1.0.0 — 2019-07-29

## README

<img src="https://polynym.io/logo.svg" width="200" alt="polynym">

A simple library and API that accepts any [HandCash](https://handcash.io) `$handle`, [RelayX](https://relayx.io) `1handle` or PayMail address and resolves it to a Bitcoin SV P2PKH address, as well as accepting and returning valid P2PKH addresses. You can also use it as a lookup service on [polynym.io](https://polynym.io) or consume it as a free API over at `https://api.polynym.io/getAddress/<address or handle>` in any of your projects.

## usage

To get started, run `npm install polynym` in your root directory. Here's an simple example implementation in Node.js:

```
const express = require('express'),
app = express(),
polynym = require('polynym');

app.get('/getAddress/:id', (req, res) => {
    polynym.resolveAddress(req.params.id).then(x => {
        res.json(x);
    }).catch(e=>{
        res.status(400).json(e);
    });
});

app.listen(1337);
```

or using the await/async syntax:

```
const express = require('express'),
app = express(),
polynym = require('polynym');

app.get('/getAddress/:id', async (req, res) => {
    try {
      x = await polynym.resolveAddress(req.params.id);
      res.json(x);
    } catch(e){
      res.status(400).json(e);
    }
});

app.listen(1337);
```

In the above example, a GET request to `http://localhost:1337/getAddress/$unwriter` would return the Bicoin SV address of unwriter's HandCash $handle: `{"address":"15EwahT55Yn566A7tagq5Mbyhs8txjZpus"}`

## support

To request support for any additional services, please leave a feature request. For all other questions or support, please message me [@deanmlittle](https://twitter.com/deanmlittle) or find me in the Atlantis slack group.

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