# @permaweb/ao-core-libs

> This SDK provides a JavaScript interface for communicating with AO-Core.

Latest version **0.0.10** (published 2026-06-19) · ISC license · 0 weekly downloads

## Install

```sh
npm install @permaweb/ao-core-libs
pnpm add @permaweb/ao-core-libs
yarn add @permaweb/ao-core-libs
bun add @permaweb/ao-core-libs
```

## Health

**Score 65/100 (B)** — status: active.

Positive: has types; esm support; no vulnerabilities; has provenance; high maintenance score.

Warnings: low downloads; large bundle; pre 1.0.

## Facts

| | |
|---|---|
| Version | 0.0.10 |
| Published | 2026-06-19 |
| First published | 2025-08-12 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 5 |
| Unpacked size | 14.7 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 5 |
| Maintainers | nickj_arweave, permatom |

## Links

- npm: https://www.npmjs.com/package/@permaweb/ao-core-libs
- Repository: https://github.com/permaweb/ao-core-libs
- Homepage: https://github.com/permaweb/ao-core-libs#readme
- Issues: https://github.com/permaweb/ao-core-libs/issues
- npm.io page: https://npm.io/package/@permaweb/ao-core-libs

## Dependencies (5)

- [axios](https://npm.io/package/axios.md) ^1.11.0
- [structured-headers](https://npm.io/package/structured-headers.md) ^2.0.1
- [@dha-team/arbundles](https://npm.io/package/@dha-team/arbundles.md) ^1.0.3
- [constants-browserify](https://npm.io/package/constants-browserify.md) ^1.0.0
- [http-message-signatures](https://npm.io/package/http-message-signatures.md) ^1.0.4

## Recent versions

- 0.0.10 (latest) — 2026-06-19
- 0.0.9 — 2026-05-08
- 0.0.8 — 2025-12-02
- 0.0.7 — 2025-11-19
- 0.0.6 — 2025-09-18
- 0.0.5 — 2025-08-29
- 0.0.4 — 2025-08-29
- 0.0.3 — 2025-08-12
- 0.0.2 — 2025-08-12
- 0.0.1 — 2025-08-12

## README

# @permaweb/ao-core-libs

This SDK provides a JavaScript interface for communicating with AO-Core.

AO-Core is a protocol and standard for distributed computation that forms the foundation of the [AO Computer](https://ao.arweave.net). Inspired by and built upon concepts from the Erlang language, AO-Core embraces the actor model for concurrent, distributed systems. It defines a minimal, generalized model for decentralized computation built around standard web technologies like HTTP.

For a full breakdown of AO-Core, see the [documentation](https://hyperbeam.arweave.net/build/introduction/what-is-ao-core.html).

## Prerequisites

- `node >= v18.0`
- `npm` or `yarn`

## Installation

```bash
npm install @permaweb/ao-core-libs
```

or

```bash
yarn add @permaweb/ao-core-libs
```

## Initialization

The SDK can be initialized with either a JWK or a Signer. If a JWK is provided, then the default AO-Core Signer will be created and used on intilization. If both a JWK and Signer are provided, the Signer will be used.

```typescript
import AOCore from '@permaweb/ao-core-libs';

// NodeJS Usage
const jwk = JSON.parse(readFileSync(process.env.PATH_TO_WALLET, 'utf-8'));
const aoCore = AOCore.init({ jwk });

// Or
import { createSigner } from '@permaweb/ao-core-libs'; // Or your own custom signer
const aoCore = AOCore.init({ signer: createSigner(jwk) });

// Browser Usage
import { createSigner } from '@permaweb/ao-core-libs';
const aoCore = AOCore.init({ signer: createSigner(window.arweaveWallet) });
```

## Usage

This SDK exposes a single function, `request`, for communicating with AO Core, which accepts these arguments:

- `path` – The endpoint path (no leading slash)
- `method` – (optional - defaults to `GET`) HTTP Request Method (`GET` or `POST`)
- `signing-format` – (optional - defaults to `httpsig`) Signing Format (`ans104` or `httpsig`)
- _Any additional fields_ – All other fields passed in will be included as part of the request payload (e.g. custom headers, tags, or data fields depending on the signing format)

### Example

```typescript
const response = await aoCore.request({
	method: 'POST',
	path: 'JC0_BVWWf7xbmXUeKskDBRQ5fJo8fWgPtaEYMOf-Vbk~process@1.0/compute/at-slot',
	'signing-format': 'httpsig',
	'my-custom-field': '1234',
});
```

## Testing

To run the `@permaweb/ao-core-libs` tests:

- `cd tests`
- `npm test`

This will install all dependencies into and build the SDK, and then install it locally into a client test project (`tests/index.js`).

## Resources

- [AO-Core](https://cookbook_ao.arweave.net/welcome/ao-core-introduction.html)
- [HyperBEAM](https://hyperbeam.arweave.net/)

---
_Source: https://npm.io/package/@permaweb/ao-core-libs · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._