index.md

Documentation

Here, you will learn about how to use all of what thenewboston-js has to offer. If you notice an error or typo, then please create a pull request yourself and we can pull in the changes to save everyone some time.

Getting Started

There are two ways to use the library.

• Clone the repository / download the files and load them into your project.
• Using NPM npm install thenewboston , this will install the library to your package.json file

For simplicity, we will not be including import or require statements in our examples.

Table of Contents

• Account

  • Creating Accounts

  • Getting Account Numbers and Signing Keys

  • Creating Signatures

  • Using Signed Data and Signed Messages

  • Using Block Data and Block Messages

• Account Payment Handler

  • Sending Coins

  • Send Bulk Payments

• Bank

  • Creating Banks

  • Getting Config

  • Getting and Updating Accounts

  • Options Object

  • Getting Transactions

  • Getting Banks

  • Getting and Adding Blocks

  • Getting Confirmation and Invalid Blocks

  • Getting Validators and Validator Confirmation Services

  • Sending Upgrade Notice and Upgrade Request

  • Getting the Bank's Primary Validator

  • Getting the Bank's Transaction Fee

• Validator

  • Creating Validators

  • Working With Accounts

  • Working With Other Nodes

  • Working With Blocks

• Primary Validator

  • Adding Bank Blocks

  • Getting the Primary Validator's Transaction Fee

• Confirmation Validator