@waves/signer

• Overview
• Restrictions
• Getting Started
• Constructor
• Methods
• Provider Interface
• Error Codes

Overview

Provider

• ProviderSeed developed by Waves team creates user account from SEED. ProviderSeed can be used at the app debugging stage.
• ProviderWeb developed by Waves.Exchange team uses an account created or imported into the Waves.Exchange web app via user's private key or seed phrase.
• ProviderCloud developed by Waves.Exchange team uses an email-based Waves.Exchange.

Signer + ProviderWeb: How It Works

Restrictions

Getting Started

1. Signer and Provider library installation

• To install Signer library use

```bash
npm i @waves/signer
```

• To install ProviderSeed developed by Waves team, use

```bash
npm i @waves/provider-seed @waves/waves-transactions
```

• To install ProviderWeb developed by Waves.Exchange, use

```bash
npm i @waves.exchange/provider-web
```

For Windows, use the following format:

```bash
npm i '@waves.exchange/provider-web'
```

• To install ProviderCloud developed by Waves.Exchange, use

```bash
npm i @waves.exchange/provider-cloud
```

For Windows, use the following format:

```bash
npm i '@waves.exchange/provider-cloud'
```

1. Library initialization

• For Testnet & ProviderSeed:

```js
import { Signer } from '@waves/signer';
import { ProviderSeed } from '@waves/provider-seed';
import { libs } from '@waves/waves-transactions';

const seed = libs.crypto.randomSeed(15);
const signer = new Signer({
  // Specify URL of the node on Testnet
  NODE_URL: 'https://nodes-testnet.wavesnodes.com'
});
signer.setProvider(new ProviderSeed(seed));
```

• For Testnet & Waves.Exchange ProviderWeb:

```js
import { Signer } from '@waves/signer';
import { ProviderWeb } from '@waves.exchange/provider-web';

const signer = new Signer({
  // Specify URL of the node on Testnet
  NODE_URL: 'https://nodes-testnet.wavesnodes.com'
});
signer.setProvider(new ProviderWeb('https://testnet.waves.exchange/signer/'))
```

• For Testnet & Waves.Exchange ProviderCloud:

```js
import { Signer } from '@waves/signer';
import { ProviderCloud } from '@waves.exchange/provider-cloud';

const signer = new Signer({
  // Specify URL of the node on Testnet
  NODE_URL: 'https://nodes-testnet.wavesnodes.com'
});
signer.setProvider(new ProviderCloud('https://testnet.waves.exchange/signer/'))
```

• For Mainnet & Waves.Exchange ProviderWeb:

```js
import { Signer } from '@waves/signer';
import { ProviderWeb } from '@waves.exchange/provider-web';

const signer = new Signer();
signer.setProvider(new ProviderWeb());
```

• For Mainnet & Waves.Exchange ProviderCloud:

```js
import { Signer } from '@waves/signer';
import { ProviderCloud } from '@waves.exchange/provider-cloud';

const signer = new Signer();
signer.setProvider(new ProviderCloud());
```

1. Basic example

const user = await signer.login();
const balances = await signer.getBalance();
const [broadcastedTransfer] = await signer
  .transfer({amount: 100000000, recipient: 'alias:T:merry'}) // Transfer 1 WAVES to alias merry
  .broadcast(); // Promise will resolved after user sign and node response

const [signedTransfer] = await signer
  .transfer({amount: 100000000, recipient: 'alias:T:merry'}) // Transfer 1 WAVES to alias merry
  .sign(); // Promise will resolved after user sign

More examples

Constructor

new Signer({
  NODE_URL: 'string',
})

* [login](#login)
* [logout](#logout)
* [getBalance](#getbalance)
* [getSponsoredBalances](#getsponsoredbalances)

* [Common fields](#common-fields)
* [How to sign and broadcast transactions](#how-to-sign-and-broadcast-transactions)
* [alias](#alias)
* [burn](#burn)
* [cancelLease](#cancellease)
* [data](#data)
* [invoke](#invoke)
* [issue](#issue)
* [lease](#lease)
* [massTransfer](#masstransfer)
* [reissue](#reissue)
* [setAssetScript](#setassetscript)
* [setScript](#setscript)
* [sponsorship](#sponsorship)
* [transfer](#transfer)
* [batch](#batch)

* [broadcast](#broadcast)
* [getNetworkByte](#getnetworkbyte)
* [setProvider](#setprovider)
* [waitTxConfirm](#waittxconfirm)

login();

const {address, publicKey} = await signer.login();

{
  address: '3P8pGyzZL9AUuFs9YRYPDV3vm73T48ptZxs',
  publicKey: 'FuChbN7t3gvW5esgARFytKNVuHSCZpXSYf1y3eDSruEN',
}

logout();

await signer.logout();

getBalance();

const balances = await signer.getBalance();

[{
  assetId: 'WAVES',
  assetName: 'Waves',
  decimals: 8,
  amount: 100000000,
  isMyAsset: false,
  tokens: 1,
  sponsorship: null,
  isSmart: false
},
{
  assetId: 'AcrRM9STdBu5PNiFveTCbRFTS8tADhKcsbC2KBp8A4tx',
  assetName: 'CoffeeCoin',
  decimals: 3,
  amount: 1500,
  isMyAsset: false,
  tokens: 1.5,
  isSmart: false,
  sponsorship: 500
}]

getSponsoredBalances();

const sponsoredBalances = await signer.getSponsoredBalances();

[{
  assetId: 'AcrRM9STdBu5PNiFveTCbRFTS8tADhKcsbC2KBp8A4tx',
  assetName: 'CoffeeCoin',
  decimals: 3,
  amount: 1500,
  isMyAsset: false,
  tokens: 1.5,
  isSmart: false,
  sponsorship: 500
}]

signer.invoke({
   dApp: address,
   call: { function: name, args: convertedArgs },
}).sign();

signer.invoke({
   dApp: address,
   call: { function: name, args: convertedArgs },
}).broadcast();

signer.alias({ 'new_alias', })
  .data([{ key: 'value', type: 'integer', value: 1 ])
  .transfer({ recipient: '3P8pGyzZL9AUuFs9YRYPDV3vm73T48ptZxs', amount: 10000 })
}).broadcast();

alias(data: {
  alias: 'string'
})

const data = {
  alias: 'new_alias',
}

const [tx] = await signer
  .alias(data)
  .broadcast();

burn(data: {
    assetId*: 'string',
    quantity*: LONG,
})

const data = {
  assetId: '4uK8i4ThRGbehENwa6MxyLtxAjAo1Rj9fduborGExarC',
  quantity: 100,
}

const [tx] = await signer
  .burn(data)
  .broadcast();

cancelLease(data: {
    leaseId: 'string',
})

const data = {
  leaseId: '69HK14PEHq2UGRfRYghVW8Kc3487uJaoUmk2ntT4kw7X',
}

const [tx] = await signer
  .cancelLease(data)
  .broadcast();

data(data: [{
  key: 'string',
  type: 'string' | 'integer' | 'binary' | 'boolean',
  value: 'string' | number | boolean,
])

const records = [
  { key: 'name', type: 'string', value: 'Lorem ipsum dolor sit amet' },
  { key: 'value', type: 'integer', value: 1234567 },
  { key: 'flag', type: 'boolean', value: true }
]

const [tx] = await signer
  .data({ data: records })
  .broadcast();