Skip to content

JavaScript Client Guide for HyperBEAM

This guide demonstrates how to integrate with HyperBEAM nodes using the an example JavaScript client library.

Prerequisites

  • Node.js
  • npm or yarn package manager

Project Setup

First, create a new Node.js project:

mkdir my-hyperbeam-project
cd my-hyperbeam-project
npm init -y

Next, manually edit your package.json file and add the "type": "module" property after the "main" line. This is required for using ES modules with import/export syntax.

Then, install the required dependencies:

npm install @permaweb/aoconnect

Your final package.json should look similar to this:

1
2
3
4
5
6
7
8
9
{
  "name": "my-hyperbeam-project",
  "version": "1.0.0",
  "main": "index.js",
  "type": "module",
  "dependencies": {
    "@permaweb/aoconnect": "^0.0.77"
  }
}

Starter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
import { connect, createSigner } from '@permaweb/aoconnect/node';
import { promises as fs } from 'fs';

const WALLET_PATH = 'wallet.json'
const NODE_URL = 'http://localhost:10000'

const wallet = JSON.parse(await fs.readFile(WALLET_PATH, 'utf8'));

console.log(wallet);

const main = async () => {

  // Create signer
  const signer = createSigner(wallet);

  // Connect to node
  const { request } = connect({
    MODE: 'mainnet', 
    URL: NODE_URL,
    device: '',
    signer
  });

  // Get request
  const metaInfoPath = `/~meta@1.0/info`;

  const getResponse = await fetch(`${NODE_URL}${metaInfoPath}`);
  console.log(getResponse);

  // Post request
  const data = {
    hello: 'world',
    testValue: 'example data'
  };

  const requestParams = {
    path: metaInfoPath,
    method: 'POST',
    ...data
  };

  const postResponse = await request(requestParams);
  console.log(postResponse);

}

main();

Extending Stater Examples

Get Request ~meta@1.0/info

1
2
3
4
  const metaInfoPath = `/~meta@1.0/info`;

  const getResponse = await fetch(`${NODE_URL}${metaInfoPath}`);
  console.log(getResponse);

Post Request ~meta@1.0/info

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
  // Post request
  const data = {
    hello: 'world',
    testValue: 'example data'
  };

  const requestParams = {
    path: metaInfoPath,
    method: 'POST',
    ...data
  };

  const postResponse = await request(requestParams);
  console.log(postResponse);