Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/near/near-api-js

JavaScript library to interact with NEAR Protocol via RPC API
https://github.com/near/near-api-js

blockchain hacktoberfest javascript smartcontracts

Last synced: about 2 months ago
JSON representation

JavaScript library to interact with NEAR Protocol via RPC API

Host: GitHub
URL: https://github.com/near/near-api-js
Owner: near
License: mit
Created: 2019-05-04T06:33:50.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2024-10-29T04:24:42.000Z (3 months ago)
Last Synced: 2024-10-29T21:10:16.851Z (2 months ago)
Topics: blockchain, hacktoberfest, javascript, smartcontracts
Language: TypeScript
Homepage: https://near.github.io/near-api-js
Size: 17.5 MB
Stars: 394
Watchers: 40
Forks: 244
Open Issues: 78
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md

Awesome Lists containing this project

awesome-near - near-api-js
best-of-crypto - GitHub - 21% open · ⏱️ 31.05.2024): (Smart Contract Platforms)

README

        # NEAR JavaScript API

[![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Fnear%2Fnear-api-js%2Fbadge&style=flat&label=Build)](https://actions-badge.atrox.dev/near/near-api-js/goto)

[![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/near/near-api-js) 

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

- [Learn how to use](https://docs.near.org/tools/near-api-js/quick-reference) the library in your project

- Read the [TypeDoc API](https://near.github.io/near-api-js/) documentation

- [Cookbook](./packages/cookbook) with common use cases

- To quickly get started with integrating NEAR in a _web browser_, read our [Web Frontend integration](https://docs.near.org/develop/integrate/frontend) article.

## 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](https://github.com/nearprotocol/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. [Change hash for the commit with errors in the nearcore](https://github.com/near/near-api-js/blob/master/fetch_error_schema.js#L8-L9)

2. Fetch new schema: `node fetch_error_schema.js`

3. `pnpm build` to update `lib/**.js` files

## Packages

![Package Architecture in Onion Diagram](./docs/package-architecture.png)

- [accounts](https://github.com/near/near-api-js/tree/master/packages/accounts) account creation & management

- [crypto](https://github.com/near/near-api-js/tree/master/packages/crypto) cryptographic key pairs & signing

- [keystores](https://github.com/near/near-api-js/tree/master/packages/keystores) general-purpose key persistence & management

- [keystores-browser](https://github.com/near/near-api-js/tree/master/packages/keystores-browser) browser keystores

- [keystores-node](https://github.com/near/near-api-js/tree/master/packages/keystores-node) NodeJS keystores

- [providers](https://github.com/near/near-api-js/tree/master/packages/providers) RPC interaction

- [transactions](https://github.com/near/near-api-js/tree/master/packages/transactions) transaction composition & signing

- [types](https://github.com/near/near-api-js/tree/master/packages/types) common types

- [utils](https://github.com/near/near-api-js/tree/master/packages/utils) common methods

- [wallet-account](https://github.com/near/near-api-js/tree/master/packages/wallet-account) accounts in browser-based wallets

## Example Templates

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

- [React Template](https://github.com/LimeChain/nearjs-react-app)

- [Nuxt.js Template](https://github.com/near/near-api-js-template-nuxt)

- [Angular Template](https://github.com/near/near-api-js-template-angular)

## License

This repository is distributed under the terms of both the MIT license and the Apache License (Version 2.0).

See [LICENSE](LICENSE) and [LICENSE-APACHE](LICENSE-APACHE) for details.