> For the complete documentation index, see [llms.txt](https://ethereals-blockchain.gitbook.io/ethereal-chain-documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ethereals-blockchain.gitbook.io/ethereal-chain-documentation/clients/javascript-api.md).

# JavaScript API

## JavaScript API

This is the EtherealNetwork Javascript API built on [JSON RPC API](https://docs.velas.com/apps/javascript-api)

### Installation <a href="#installation" id="installation"></a>

#### Yarn <a href="#yarn" id="yarn"></a>

```
$ yarn add @Ethereal/web3
```

#### npm <a href="#npm" id="npm"></a>

```
$ npm install --save @Ethereal/web3
```

#### Browser bundle <a href="#browser-bundle" id="browser-bundle"></a>

```
<!-- Development (un-minified) -->
```

```
<script src="https://unpkg.com/@Ethereal/web3.js@0.92.0/lib/index.iife.js"></script>
```

```
 
```

```
<!-- Production (un-minified) -->
```

```
<script src="https://unpkg.com/@Ethereal/web3.js@0.92.0/lib/index.iife.min.js"></script>
```

### Development Environment Setup <a href="#development-environment-setup" id="development-environment-setup"></a>

Install the latest EtherealNetwork release from <https://docs.Ethereal.com/cli/install-Ethereal-cli-tools>

#### BPF program development <a href="#bpf-program-development" id="bpf-program-development"></a>

**Use** `cargo build-bpf` **from the latest release**

### Usage <a href="#usage" id="usage"></a>

#### Javascript <a href="#javascript" id="javascript"></a>

```
const Ethereal= require('@Ethereal/web3.js');
```

```
console.log(Ethereal);
```

#### ES6 <a href="#es6" id="es6"></a>

```
import Etherealfrom '@Ethereal/web3.js';
```

```
console.log(Ethereal);
```

#### Browser bundle <a href="#browser-bundle-1" id="browser-bundle-1"></a>

```
// `Ethereal` is provided in the global namespace by the `Ethereal.min.js` script bundle.
```

```
console.log(Ethereal);
```

### Examples <a href="#examples" id="examples"></a>

Example scripts for the web3.js repo and native programs:

* [Web3 Examples](https://velas.github.io/web3.js/examples)

Example scripts for the Solana Program Library:

* [Token Program Examples](https://github.com/solana-labs/solana-program-library/tree/master/token/js/examples)

### Flow <a href="#flow" id="flow"></a>

A [Flow library definition](https://flow.org/en/docs/libdefs/) is provided at <https://unpkg.com/@solana/web3.js@latest/module.flow.js>. Download the file and add the following line under the \[libs] section of your project’s `.flowconfig` to activate it:

```
[libs]
```

```
node_modules/@solana/web3.js/module.flow.js
```

### Releases <a href="#releases" id="releases"></a>

Releases are available on [Github](https://github.com/velas/web3.js/releases) and [npmjs.com](https://www.npmjs.com/package/@velas/web3.js)

Each Github release features a tarball containing API documentation and a minified version of the module suitable for direct use in a browser environment (`<script>` tag)

### Disclaimer <a href="#disclaimer" id="disclaimer"></a>

All claims, content, designs, algorithms, estimates, roadmaps, specifications, and performance measurements described in this project are done with the Solana Foundation’s (“SF”) best efforts. It is up to the reader to check and validate their accuracy and truthfulness. Furthermore nothing in this project constitutes a solicitation for investment.

Any content produced by SF or developer resources that SF provides, are for educational and inspiration purposes only. SF does not encourage, induce or sanction the deployment, integration or use of any such applications (including the code comprising the Solana blockchain protocol) in violation of applicable laws or regulations and hereby prohibits any such deployment, integration or use. This includes use of any such applications by the reader (a) in violation of export control or sanctions laws of the United States or any other applicable jurisdiction, (b) if the reader is located in or ordinarily resident in a country or territory subject to comprehensive sanctions administered by the U.S. Office of Foreign Assets Control (OFAC), or (c) if the reader is or is working on behalf of a Specially Designated National (SDN) or a person subject to similar blocking or denied party prohibitions.

The reader should be aware that U.S. export control and sanctions laws prohibit U.S. persons (and other persons that are subject to such laws) from transacting with persons in certain countries and territories or that are on the SDN list. As a project based primarily on open-source software, it is possible that such sanctioned persons may nevertheless bypass prohibitions, obtain the code comprising the Solana blockchain protocol (or other project code or applications) and deploy, integrate, or otherwise use it. Accordingly, there is a risk to individuals that other persons using the Solana blockchain protocol may be sanctioned persons and that transactions with such persons would be a violation of U.S. export controls and sanctions law. This risk applies to individuals, organizations, and other ecosystem participants that deploy, integrate, or use the Solana blockchain protocol code directly (e.g., as a node operator), and individuals that transact on the Solana blockchain through light clients, third party interfaces, and/or wallet software.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://ethereals-blockchain.gitbook.io/ethereal-chain-documentation/clients/javascript-api.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.