Home

Awesome

NEAR JavaScript API

Build Status Gitpod Ready-to-Code

NEAR JavaScript API is a complete library to interact with the NEAR blockchain. You can use it in the browser, or in Node.js runtime.

Documentation

Contribute to this library

  1. Install dependencies

    pnpm install
    
  2. Run continuous build with:

    pnpm -r compile -w
    

Publish

Prepare dist version by running:

pnpm dist

Integration Test

Start the node by following instructions from nearcore, then

pnpm test

Tests use sample contract from near-hello npm package, see https://github.com/nearprotocol/near-hello

Update error schema

Follow next steps:

  1. Optionally, set a specific hash for the commit with errors in the nearcore
  2. Fetch new schema: node fetch_error_schema.js
  3. pnpm build and pnpm test to check tests still work
  4. pnpm changeset to generate a changeset with a minor bump for the @near-js/utils package
  5. commit all changes and submit a PR on GitHub

Packages

Package Architecture in Onion Diagram

<!-- https://www.figma.com/file/TzAPceViAbYW6A6KAuEMCe/NAJ-packages?t=N9nlkGBoAx9FYxoN-1 -->

Example Templates

To help you get started quickly, we have prepared example templates for popular frameworks:

License

This repository is distributed under the terms of both the MIT license and the Apache License (Version 2.0). See LICENSE and LICENSE-APACHE for details.