# tsoposki-ptokens

> ptokens main package

Latest version **0.2.1-alpha.0** (published 2020-02-18) · ISC license · 0 weekly downloads

## Install

```sh
npm install tsoposki-ptokens
pnpm add tsoposki-ptokens
yarn add tsoposki-ptokens
bun add tsoposki-ptokens
```

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.1-alpha.0 |
| Published | 2020-02-18 |
| First published | 2020-02-18 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 6 |
| Unpacked size | 9.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | alle.manfredi@gmail.com @provable-things |
| Maintainers | cryptorobot |

## Links

- npm: https://www.npmjs.com/package/tsoposki-ptokens
- npm.io page: https://npm.io/package/tsoposki-ptokens

## Dependencies (6)

- [chai](https://npm.io/package/chai.md) ^4.2.0
- [@babel/runtime](https://npm.io/package/@babel/runtime.md) ^7.3.1
- [tsoposki-ptokens-pbtc](https://npm.io/package/tsoposki-ptokens-pbtc.md) ^0.2.1-alpha.0
- [tsoposki-ptokens-peos](https://npm.io/package/tsoposki-ptokens-peos.md) ^0.2.1-alpha.0
- [tsoposki-ptokens-pltc](https://npm.io/package/tsoposki-ptokens-pltc.md) ^0.2.1-alpha.0
- [tsoposki-ptokens-utils](https://npm.io/package/tsoposki-ptokens-utils.md) ^0.2.1-alpha.0

## Recent versions

- 0.2.1-alpha.0 (latest) — 2020-02-18

## README

# ptokens

Main module for interacting with pTokens. 

 

***

 

### Installation:

```
npm install ptokens
```

 

***

 

### Usage: 

```js
const pTokens = require('ptokens')

const ptokens = new pTokens({
  peos: {
    ethPrivateKey: 'Eth private key',
    ethProvider: 'Eth provider',
    eosPrivateKey: 'EOS private key',
    eosRpc: 'EOS RPC Address'
    eosSignatureProvider: 'An EOS Signature Provider'  //if the private key is not passed
  },
  pbtc: {
    ethPrivateKey: 'Eth private key',
    ethProvider: 'Eth provider',
    btcNetwork: 'testnet'  // 'testnet' or 'bitcoin', default 'testnet'
  }
})
```
It is possible to pass a standard Ethereum Provider as the __`ethProvider`__ value, such as the one injected 
into the content script of each web page by Metamask(__`window.web3.currentProvider`__).

```js
const pTokens = require('ptokens')

if (window.web3) {
  
  const ptokens = new pTokens({
    peos: {
      ethProvider: window.web3.currentProvider,
      ....
    },
    pbtc: {
      ethProvider: window.web3.currentProvider,
      btcNetwork: 'bitcoin'
    }
  })
} else {
  console.log('No web3 detected')
}
```

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