https://github.com/obsidiansystems/hw-app-pokt
https://github.com/obsidiansystems/hw-app-pokt
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/obsidiansystems/hw-app-pokt
- Owner: obsidiansystems
- Created: 2021-10-26T15:03:02.000Z (over 3 years ago)
- Default Branch: develop
- Last Pushed: 2023-04-27T20:34:17.000Z (about 2 years ago)
- Last Synced: 2024-12-24T21:35:12.641Z (5 months ago)
- Language: TypeScript
- Size: 22.5 KB
- Stars: 1
- Watchers: 5
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: ChangeLog.md
Awesome Lists containing this project
README
[Github](https://github.com/LedgerHQ/ledgerjs/),
[Ledger OP3N Discord](https://discord.gg/hTy7ZXvR7y)
# hw-app-pokt
[Ledger Hardware Wallet](https://www.ledger.com/) JavaScript bindings for [Pocket](https://www.pokt.network/), based on [LedgerJS](https://github.com/LedgerHQ/ledgerjs).
## Using LedgerJS for Pocket
Here is a sample app for Node:
```javascript
const Transport = require("@ledgerhq/hw-transport").default;
const Pocket = require("hw-app-pokt").default;
const getPublicKey = async () => {
const pokt = new Pocket(await Transport.create());
return await pokt.getPublicKey("44'/535348'/0'/0/0");
};
const signTransaction = async () => {
const transport = await Transport.create();
const pokt = new Pocket(await Transport.create());
return await pokt.signTransaction(
"44'/535348'/0'/0/0",
""
);
};
const getVersion = async () => {
const transport = await Transport.create();
const pokt = new Pocket(await Transport.create());
return await pokt.getVersion();
};
const doAll = async () => {
console.log(await getPublicKey());
console.log(await signTransaction());
console.log(await getVersion());
};
doAll().catch(err => console.log(err));
```
## API
### Table of Contents
- [Pocket](#pokt)
- [Parameters](#parameters)
- [Examples](#examples)
- [getPublicKey](#getpublickey)
- [Parameters](#parameters-1)
- [Examples](#examples-1)
- [signTransaction](#signtransaction)
- [Parameters](#parameters-2)
- [Examples](#examples-2)
- [getVersion](#signtransaction)
- [Parameters](#parameters-3)
- [Examples](#examples-3)
### Parameters
- `transport` **`Transport`**
- `scrambleKey` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** (optional, default `"Pocket"`)
### Examples
```javascript
import Pocket from "hw-app-pokt";
const pokt = new Pocket(transport);
```
### getPublicKey
Get Pocket address for a given BIP-32 path.
#### Parameters
- `path` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** a path in BIP-32 format
#### Examples
```javascript
const publicKey = await pokt.getPublicKey("44'/535348'/0'/0/0");
```
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>** an object with a public key.
### signTransaction
Sign a transaction with a given BIP-32 path.
#### Parameters
- `path` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** a path in BIP-32 format
#### Examples
```javascript
const publicKey = await pokt.signTransaction(
"44'/535348'/0'/0/0",
""
);
```
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)>** an object with text field containing a signature.
### getVersion
Get the version of the application installed on the hardware device.
#### Examples
```javascript
console.log(await pokt.getVersion());
```
for version 0.1.0, it produces something like
```
{
major: 0
minor: 1
patch: 0
}
```
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<{[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)}>** an object with major, minor, and patch of the version.