attrace-client

0.4.12 • Public • Published

Attrace JS client

JS library which allows you to interact with local/remote Attrace nodes.

Should work in recent browsers and NodeJS.

Install

npm install --save attrace-client

// of if using yarn
yarn add attrace-client

Usage

// Import using ES6 module style
import Attrace from 'attrace-client';

// Or import using CommonJS module style
// const Attrace = require('attrace-client');

// Create an account
const account = Attrace.Account.generateAccount();

// Load an Address
const to = new Attrace.Address('ABK2JS5KSESDR4J7LIUR7YXEXP4T3XPUKOMPKOJ2PU37MXQ5RQUR4KZQ');

// Create TransferValue operation
const aces = Attrace.stringToBig("100");
const op = Attrace.OperationTransferValue.create(account.getAddress(), to, aces);

// Wrap in transaction and sign
const tx = Attrace.Transaction.createSigned(account, [op.op()]);

// Select another network if required
// Attrace.useNetwork('testnet'); // uncomment if working with testnet

// Publish to the network
Attrace
  .publishTransaction(tx)
  .then(() => console.log('published'))
  .catch(err => console.error(err));

Building

yarn build builds the library to dist, generating three files:

  • dist/attrace-client.cjs.js A CommonJS bundle, suitable for use in Node.js, that requires the external dependency. This corresponds to the "main" field in package.json
  • dist/attrace-client.esm.js an ES module bundle, suitable for use in other people's libraries and applications, that imports the external dependency. This corresponds to the "module" field in package.json
  • dist/attrace-client.umd.js a UMD build, suitable for use in any environment (including the browser, as a <script> tag), that includes the external dependency. This corresponds to the "browser" field in package.json

Tests

Run the tests:

yarn test

Run a single test:

yarn test test/account.spec.js

Development

Directory structure:

src/        // Actual source code
assets/     // Protobuf models
test/       // Mocha tests

Run DEV server (continuously re-compiles):

yarn dev

If you run through node against the docker devnet (devnet has a cert chain issue):

// Add the following line at the top of your min app file.
// Warning: this accepts invalid certificates, do this only in a local dev setup and make sure this is not active in production...
process.env.NODE_TLS_REJECT_UNAUTHORIZED = "0";

If you want to locally develop and test:

Make yarn known about this repo

yarn link

In your app, use the linked package, together with the dev server this will hot reload package changes in your app.

yarn link attrace-client

Release new version

  • Checkout latest master branch
npx np --no-tests --no-publish

Readme

Keywords

none

Package Sidebar

Install

npm i attrace-client

Weekly Downloads

0

Version

0.4.12

License

GPLv3

Unpacked Size

1.43 MB

Total Files

7

Last publish

Collaborators

  • roelb
  • attracedev