# [DashWallet.js](https://github.com/DashHive/DashWallet.js)

A more civilized DASH Wallet SDK for a less civilized age...

# Table of Contents

- Install
  - Web Browsers
  - Node.js & Bundlers
- Usage
- API

# Install

## Web Browsers

```html
<script src="https://unpkg.com/@dashincubator/secp256k1@1.x/secp256k1.js"></script>
<script src="https://unpkg.com/dashkeys@1.x/dashkeys.js"></script>
<script src="https://unpkg.com/dashsight@1.x/dashsight.js"></script>
<script src="https://unpkg.com/dashsight@1.x/dashsocket.js"></script>
<script src="https://unpkg.com/dashtx@0.x/dashtx.js"></script>
<script src="https://unpkg.com/dashwallet@0.5/dashwallet.js"></script>
```

## Node.js & Bundlers

1. Install [`node`](https://webinstall.dev/node)

   ```sh
   # Mac, Linux
   curl -sS https://webi.sh/node | sh

   # Windows
   curl.exe https://webi.ms/node | powershell
   ```

2. Install the `dashwallet` library

   ```sh
   npm install --save dashwallet0.5
   npm install --save @dashincubator/secp256k1@1.7
   ```

3. Install `dashwallet-cli` for testing locally
   ```sh
   npm install --location=global dashwallet-cli@0.5
   ```

# Usage

```js
// TODO
// (look at dashwallet-cli to see current usage)
```

# Alpha API (will change)

## Wallet.create(config)

Creates a wallet instance with the given config

- [DashSight](https://github.com/dashhive/dashsight.js) adapter - or any
  interface matching:
  - `getTxs(addr, page)`
  - `getUtxos(addr)`
  - `instantSend(txHex)`
- `safe`
  - `wallets`
  - `addresses`
- Storage adapter
  - `save()` storage adapter (and "safe").

```js
let w = await Wallet.create({ storage, safe, dashsight });
```

## Wallet.generate(walletInfo)

Generates a complete `PrivateWallet` object.

```js
Wallet.generate({
  name: "main",
  label: "Main",
  priority: 1, // lower sorts higher
});
```

```json
{
  "name": "main",
  "label": "Main",
  "device": null,
  "contact": null,
  "priority": 1,
  "phrase": "zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo wrong",
  "created_at": "2022-02-22T22:02:22.000Z",
  "archived_at": null
}
```

## Wallet.generateAddress(addrInfo)

Generates a complete `addrInfo` object.

```js
Wallet.generateAddress({
  wallet: "main",
  hdpath: "m/44'/5'/0'/0",
  index: 0,
});
```

```json
{
  "checked_at": 0,
  "hdpath": "m/44'/5'/0'/0",
  "index": 0,
  "txs": [],
  "utxos": [],
  "wallet": "main"
}
```

## Wallet.generatePayWallet(walletInfo)

Generates a complete `PayWallet` object.

```json
{
  "name": "@johndoe",
  "label": "@johndoe",
  "device": null,
  "contact": "@johndoe",
  "priority": 1668919000655,
  "xpub": "xpubXXXX...XXXX",
  "address": "Xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "created_at": "2022-02-22T22:02:22.000Z",
  "archived_at": null
}
```

## Wallet#balances()

Show spendable duffs / satoshis per each wallet.

You may need to `await wallet.sync()` first.

```js
await wallet.balances();
```

```json
{
  "main": 1212000,
  "@johndoe:1": 120000
}
```

## Wallet#befriend(friendDetails)

Generate or show an `xpub` for your contact, and import their xpub for you, if
any.

```js
await wallet.befriend({
  handle: "@johndoe",
  // optional (either or, not both)
  xpub: "<the-xpub-that-john-doe-gave-to-you>",
  addr: "<a-static-pay-addr-from-john-doe>",
});
```

```json
["<xpub-YOU-should-give-to-john>", "xpub-JOHN-gave-to-you", "addr-from-JOHN"]
```

## wallet.createTx(txOpts)

TODO: Creates a clean (fingerprint-free) transaction.

## wallet.createDirtyTx(txOpts)

Creates a dirty (fingerprint) transaction (hex string) for the given amount to
the given contact using `utxo`s from across all `PrivateWallet`s.

```js
await wallet.createDirtyTx({ handle, amount, utxos });
```

```json
{
  "hex": "abc123...",
  "utxos": [
    {
      "address": "...",
      "outputIndex": 0,
      "satoshis": 1000,
      "script": "...",
      "txId": "..."
    }
  ]
}
```

The result can be used with `dashsight.instantSend(tx.hex)`.

## wallet#findChangeWallet(friendOpts)

Finds your `PrivateWallet` for the given contact.

```js
await wallet.findChangeWallet({ handle: "@johndoe" });
```

Returns a `PrivateWallet`, as described above.

## wallet#findFriend(friendOpts)

Finds the xpub-only (pay-to, send-only) wallet for the given contact.

```js
await wallet.findFriend({ handle: "@johndoe" });
```

Returns a `PayWallet`, as described above.

## wallet#nextChangeAddr(friendOpts)

Find the next unused change address for the `PrivateWallet` associated with the
given contact, or from the `main` wallet as a fallback.

```js
await wallet.nextChangAddr({ handle: "@johndoe" });
```

Returns a PayAddr.

```js
"Xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx";
```

## Wallet#sync(syncOpts)

(Re)index addresses for each wallet and fetch latest transactions for the next
few addresses.

```js
let now = Date.now();
let staletime = 60 * 1000; // 0 to force immediate sync
await wallet.sync({ now, staletime });
```

## Wallet#utxos()

Get _all_ utxos across all `PrivateWallet`s.

```js
await wallet.utxos();
```

The results are in dashcore/bitcore format:

```json
[
 txId: '<hex-tx-id>',
 outputIndex: 0,
 address: "Xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
 script: 'xxxx...',
 satoshis: 100000000
]
```

There's no response, just updates to `safe.addresses`, and `store.save()` will
be called.