https://github.com/aurora-is-near/aurora.js

[DEPRECATED] Aurora Engine client library for JavaScript.
https://github.com/aurora-is-near/aurora.js

Last synced: 10 days ago
JSON representation

[DEPRECATED] Aurora Engine client library for JavaScript.

• Host: GitHub
• URL: https://github.com/aurora-is-near/aurora.js
• Owner: aurora-is-near
• License: cc0-1.0
• Created: 2021-03-31T20:47:55.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2023-10-18T10:56:31.000Z (about 1 year ago)
• Last Synced: 2024-08-09T02:55:51.401Z (5 months ago)
• Language: TypeScript
• Homepage: https://aurora-is-near.github.io/aurora.js/
• Size: 758 KB
• Stars: 38
• Watchers: 37
• Forks: 8
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGES.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
> **⚠ WARNING: This library has been deprecated.**  

> The replacement solution will be offered shortly.

# Aurora Engine Client for JavaScript

[![Project license](https://img.shields.io/badge/License-Public%20Domain-blue.svg)](https://creativecommons.org/publicdomain/zero/1.0/)

[![Discord](https://img.shields.io/discord/490367152054992913?label=Discord)](https://discord.gg/jNjHYUF8vw)

[![Lints](https://github.com/aurora-is-near/aurora.js/actions/workflows/lints.yml/badge.svg)](https://github.com/aurora-is-near/aurora.js/actions/workflows/lints.yml)

## Prerequisites

- Node.js (v14+)

## Installation

```shell

npm install -D aurora-is-near/aurora.js

```

```json

  "dependencies": {

    "@aurora-is-near/engine": "git://github.com/aurora-is-near/aurora.js",

  }

```

## Usage

```js

import Aurora from '@aurora-is-near/engine';

```

See the [Aurora CLI] source code for example usage.

### Key Management

The library will load the following local keys by default, if found:

- `$HOME/.near-credentials/*/*.json`: credentials stored by the NEAR CLI

- `$HOME/.near/validator_key.json`: the local `nearcore` validator key

  (for the `test.near` master account)

[Aurora CLI]: https://github.com/aurora-is-near/aurora-cli/blob/master/src/aurora.ts