dennispitallano/rosetta-node-sdk-client

A Standard for Blockchain Interaction - Client Library

rosetta

Rosetta - JavaScript client for rosetta A Standard for Blockchain Interaction This SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.4.1
• Package version: 1.4.1
• Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install rosetta --save

Finally, you need to build the module:

npm run build

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your rosetta from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var RosettaClient = require('rosetta-client');

var api = new RosettaClient.AccountApi();

var accountBalanceRequest = new Rosetta.AccountBalanceRequest(); // {AccountBalanceRequest} 
api.accountBalance(accountBalanceRequest, function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
Rosetta.AccountApi	accountBalance	POST /account/balance	Get an Account Balance
Rosetta.BlockApi	block	POST /block	Get a Block
Rosetta.BlockApi	blockTransaction	POST /block/transaction	Get a Block Transaction
Rosetta.ConstructionApi	constructionMetadata	POST /construction/metadata	Get Transaction Construction Metadata
Rosetta.ConstructionApi	constructionSubmit	POST /construction/submit	Submit a Signed Transaction
Rosetta.MempoolApi	mempool	POST /mempool	Get All Mempool Transactions
Rosetta.MempoolApi	mempoolTransaction	POST /mempool/transaction	Get a Mempool Transaction
Rosetta.NetworkApi	networkList	POST /network/list	Get List of Available Networks
Rosetta.NetworkApi	networkOptions	POST /network/options	Get Network Options
Rosetta.NetworkApi	networkStatus	POST /network/status	Get Network Status

Documentation for Models

• Rosetta.AccountBalanceRequest
• Rosetta.AccountBalanceResponse
• Rosetta.AccountIdentifier
• Rosetta.Allow
• Rosetta.Amount
• Rosetta.Block
• Rosetta.BlockIdentifier
• Rosetta.BlockRequest
• Rosetta.BlockResponse
• Rosetta.BlockTransactionRequest
• Rosetta.BlockTransactionResponse
• Rosetta.ConstructionMetadataRequest
• Rosetta.ConstructionMetadataResponse
• Rosetta.ConstructionSubmitRequest
• Rosetta.ConstructionSubmitResponse
• Rosetta.Currency
• Rosetta.Error
• Rosetta.MempoolRequest
• Rosetta.MempoolResponse
• Rosetta.MempoolTransactionRequest
• Rosetta.MempoolTransactionResponse
• Rosetta.MetadataRequest
• Rosetta.NetworkIdentifier
• Rosetta.NetworkListResponse
• Rosetta.NetworkOptionsResponse
• Rosetta.NetworkRequest
• Rosetta.NetworkStatusResponse
• Rosetta.Operation
• Rosetta.OperationIdentifier
• Rosetta.OperationStatus
• Rosetta.PartialBlockIdentifier
• Rosetta.Peer
• Rosetta.SubAccountIdentifier
• Rosetta.SubNetworkIdentifier
• Rosetta.Transaction
• Rosetta.TransactionIdentifier
• Rosetta.Version

Documentation for Authorization

All endpoints do not require authorization.