stellar-deprecated / stellar-lib Goto Github PK

INACTIVE. JS library to facilitate talking to stellard. This repository is not in active development. It points to the stellard network, which is being replaced by stellar-core. Please refer to the replacement repository, js-stellar-lib, which points to the stellar-core network.

License: Other

JavaScript 99.15% C++ 0.85% Batchfile 0.01%

stellar-lib's Introduction

INACTIVE. This repository is not in active development. It points to the stellard network, which is being replaced by stellar-core. Please refer to the replacement repository, js-stellar-lib, which points to the stellar-core network.

#The Stellar JavaScript Library

stellar-lib connects to the Stellar network via the WebSocket protocol. It runs in Node.js or in the browser.

###Use stellar-lib for:

Connecting to a local or remote stellard in JavaScript (Node.js or browser)
Issuing stellard API requests
Listening to events on the stellar network (transaction, ledger, etc.)
Signing and submitting transactions to the stellar network

###In this file:

###For additional documentation see:

###Also see:

##Getting stellar-lib

Via npm for Node.js

  $ npm install stellar-lib

Build from the source using gulp

  $ git clone https://github.com/stellar/stellar-lib
  $ cd stellar-lib
  $ npm install
  $ gulp

Then use the minified build/stellar-*-min.js in your webpage

##Quickstart

Remote (remote.js) is the module responsible for managing connections to stellard servers:

/* Loading stellar-lib with Node.js */
var Remote = require('stellar-lib').Remote;

/* Loading stellar-lib in a webpage */
// var Remote = stellar.Remote;

var remote = new Remote({
  // see the API Reference for available options
  trusted:        true,
  local_signing:  true,
  local_fee:      true,
  fee_cushion:     1.5,
  servers: [
    {
        host:    'live.stellar.org'
      , port:    9001
      , secure:  true
    }
  ]
});

remote.connect(function() {
  /* remote connected */

  // see the API Reference for available functions
});

See The stellar-lib Guides and The stellar-lib API Reference for walkthroughs and details about all of the available functions and options.

##Running tests

Clone the repository
cd into the repository and install dependencies with npm install
npm test or make test or node_modules\.bin\mocha test\*-test.js

Generating code coverage

stellar-lib uses istanbul to generate code coverage. To create a code coverage report, run npm test --coverage. The report will be created in coverage/lcov-report/.

stellar-lib's People

Contributors

Stargazers

Watchers

Forkers

sull kangmo kylemclaren mkrecny sorokinvld galvezz andruby monsieurnicolas xekoukou artrichards magyarb noahjs vocxod divruslan sunny-g alli15

stellar-lib's Issues

transaction.submit() fails silently on 'account not found' error

I'm playing around with this lib and everything went fine until I went to take an action that required a key pair (account id and secret). It was failing silently with no stack trace or error output for the "submit transaction" example. I was at a loss until I set the trace option on the Remote object and saw that "account not found" errors were occurring, but not getting reported in my callback.

Apologies for that lack of detail on reproducing this, I have since moved past it and was only reminded a couple hours after to submit this. It should be reproducible by using an invalid key pair on the set_secret() method when making a transaction.

is it possible to get the address/ secret via login username& password ?

util.expBackoff is not a function

In /src/js/ripple/server.js#L406:

var retryTimeout = util.expBackoff(this._retry, 100, 1000);

util.expBackoff function is called but in the first line of the same file: var util = require('util'); and Node's util module has no expBackoff function. It should use /src/js/ripple/utils.js#L121.

When will this library be fixed?

Will there be a merge with the ripple-lib? There have been many changes since then.

Add function for sending an RPC

basically just like: stellard.accountTx in ix

Sample for signing initiated in a browser?

According to the description and all the API notes, it should be trivial to use a web page to sign a transaction without sending ANYTHING to a server using stellar-lib.

However, it is made non trivial because we really don't have a clue where to start.

Is it possible to create a demonstration of this with notes as to how to use it, for example, in a mobile app?

Fix up the way tefPAST_SEQ is handled

Modify lib tests to work with stellar addresses

Lib tests have lots of hard-coded ripple addresses, we need to convert those to stellar addresses for tests to pass. Ripple address can be converted to corresponding stellar address by swapping all occurrences of 'g' and 'r'. String stellarAddr = rippleAddr.replaceAll('r', '0').replaceAll('g', 'r').replaceAll('0', 'g');

How to use requestSubscribe to subscribe to account transactions

According to https://www.stellar.org/api/#api-subscribe you can subscribe to transactions for a list of accounts. This works well using plain websockets outside of stellar-lib.

I would expect the library to support something like requestSubscribe({accounts: ["id1", "id2"]}), but that didn't work. Is this functionality already supported but not documented or should I fork and contribute it myself?

Add to NPM

account.reserve gets into corrupted state and sending is disabled (because it thinks you have no reserve)

Symptoms:

The current accounts "reserve" property is a NaN amount:

a.account.reserve
 {_value: NaN, _offset: 0, _is_native: true, _is_negative: false, _currency: Object…}

make local_signing the default

We should not default stellar-lib to a mode where the secret gets sent over the wire. This task is to confirm local_signing is the default, and if not, make it the default.

Stellar problems in the browser

Here are the details when the page loads:

Uncaught Error: Cannot find module "lru-cache" stellar-0.9.0.js:130
  webpackMissingModule stellar-0.9.0.js:130
  (anonymous function) stellar-0.9.0.js:130
  __webpack_require__ stellar-0.9.0.js:21
  (anonymous function) stellar-0.9.0.js:48
  __webpack_require__ stellar-0.9.0.js:21
  (anonymous function) stellar-0.9.0.js:41
  (anonymous function) stellar-0.9.0.js:44

and when you try to set up the remote properties:

TypeError: Cannot read property 'Remote' of undefined