@adora-wallet/adoracore-wallet-client
TypeScript icon, indicating that this package has built-in type declarations

8.31.34 • Public • Published

Adoracore-wallet-client

The official client library for Adoracore-wallet-service

Description

This package communicates with AWS Adoracore wallet service using the REST API. All REST endpoints are wrapped as simple async methods. All relevant responses from AWS are checked independently by the peers, thus the importance of using this library when talking to a third party AWS instance.

See Adoracore-wallet for a simple CLI wallet implementation that relays on AWS and uses adoracore-wallet-client.

Get Started

You can start using @adora-wallet/adoracore-wallet-client : by running npm install @adora-wallet/adoracore-wallet-client from your console.

Example

Start your own local Adoracore wallet service instance. In this example we assume you have adoracore-wallet-service running on your localhost:3232.

Then create two files irene.js and tomas.js with the content below:

irene.js

var Client = require('@adora-wallet/adoracore-wallet-client');


var fs = require('fs');
var AWS_INSTANCE_URL = 'https://adora-api-dev.rocknblock.io/aws/api'

var client = new Client({
  baseUrl: AWS_INSTANCE_URL,
  verbose: false,
});

client.createWallet("My Wallet", "Irene", 2, 2, {network: 'testnet'}, function(err, secret) {
  if (err) {
    console.log('error: ',err);
    return
  };
  // Handle err
  console.log('Wallet Created. Share this secret with your copayers: ' + secret);
  fs.writeFileSync('irene.dat', client.export());
});

tomas.js

var Client = require('@adora-wallet/adoracore-wallet-client');


var fs = require('fs');
var AWS_INSTANCE_URL = 'https://adora-api-dev.rocknblock.io/aws/api'

var secret = process.argv[2];
if (!secret) {
  console.log('./tomas.js <Secret>')

  process.exit(0);
}

var client = new Client({
  baseUrl: AWS_INSTANCE_URL,
  verbose: false,
});

client.joinWallet(secret, "Tomas", {}, function(err, wallet) {
  if (err) {
    console.log('error: ', err);
    return
  };

  console.log('Joined ' + wallet.name + '!');
  fs.writeFileSync('tomas.dat', client.export());


  client.openWallet(function(err, ret) {
    if (err) {
      console.log('error: ', err);
      return
    };
    console.log('\n\n** Wallet Info', ret); //TODO

    console.log('\n\nCreating first address:', ret); //TODO
    if (ret.wallet.status == 'complete') {
      client.createAddress({}, function(err,addr){
        if (err) {
          console.log('error: ', err);
          return;
        };

        console.log('\nReturn:', addr)
      });
    }
  });
});

Install @adora-wallet/adoracore-wallet-client before start:

npm i @adora-wallet/adoracore-wallet-client

Create a new wallet with the first script:

$ node irene.js
info Generating new keys
 Wallet Created. Share this secret with your copayers: JbTDjtUkvWS4c3mgAtJf4zKyRGzdQzZacfx2S7gRqPLcbeAWaSDEnazFJF6mKbzBvY1ZRwZCbvT

Join to this wallet with generated secret:

$ node tomas.js JbTDjtUkvWS4c3mgAtJf4zKyRGzdQzZacfx2S7gRqPLcbeAWaSDEnazFJF6mKbzBvY1ZRwZCbvT
Joined My Wallet!

Wallet Info: [...]

Creating first address:

Return: [...]

Note that the scripts created two files named irene.dat and tomas.dat. With these files you can get status, generate addresses, create proposals, sign transactions, etc.The MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Package Sidebar

Install

npm i @adora-wallet/adoracore-wallet-client

Weekly Downloads

4

Version

8.31.34

License

MIT

Unpacked Size

888 kB

Total Files

168

Last publish

Collaborators

  • murmuri