# arweave-multihost

> JavaScript/TypeScript Arweave SDK with multiple host support

Latest version **0.1.0** (published 2021-07-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install arweave-multihost
pnpm add arweave-multihost
yarn add arweave-multihost
bun add arweave-multihost
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2021-07-13 |
| First published | 2021-06-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 10.2 KB |
| Known vulnerabilities | 0 (+23 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 12 |
| Author | Redstone Team |
| Maintainers | redstone-finance |
| Keywords | arweave, arweave-js, multihost, multi host, many hosts, several hosts, Arweave SDK |

## Links

- npm: https://www.npmjs.com/package/arweave-multihost
- Repository: https://github.com/redstone-finance/arweave-multihost
- Homepage: https://github.com/redstone-finance/arweave-multihost#readme
- Issues: https://github.com/redstone-finance/arweave-multihost/issues
- npm.io page: https://npm.io/package/arweave-multihost

## Dependencies (2)

- [axios](https://npm.io/package/axios.md) ^0.21.1
- [arweave](https://npm.io/package/arweave.md) ^1.10.15

## Recent versions

- 0.1.0 (latest) — 2021-07-13
- 0.0.8 — 2021-07-01
- 0.0.7 — 2021-06-26
- 0.0.6 — 2021-06-23
- 0.0.5 — 2021-06-22
- 0.0.4 — 2021-06-21
- 0.0.3 — 2021-06-21
- 0.0.2 — 2021-06-21
- 0.0.1 — 2021-06-21

## README

# Arweave Multihost JS SDK

JavaScript/TypeScript Arweave SDK with multiple host support. It is a wrapper for the official [Arweave JS SDK](https://github.com/ArweaveTeam/arweave-js), which allows to configure multiple hosts.

By default it uses the first host from the host list, but if it fails to execute any request (like sending a transaction or getting the network info) it will automatically switch the host to the next one from the list and make it the new default. If all the hosts fail to execute the request, error will be thrown.

## 🚀 Demo
Try it directly in CodeSandbox: [demo link](https://codesandbox.io/s/arweave-multihost-demo-8r68b?file=/src/index.ts)

## 📦 Installation

### Using npm
```bash
npm install arweave-multihost
```

### Using yarn
```bash
yarn add arweave-multihost
```

## 💡 Usage

### 1. Importing
```js
// Using Node.js `require()`
const ArweaveMultihost = require("arweave-multihost");

// Using ES6 imports
import ArweaveMultihost from "arweave-multihost";
```

### 2. Initialisation

#### Init with custom hosts

```js
const arweave = ArweaveMultihost.init(
  // Hosts
  [
    {
      host: "arweave.net", // Hostname or IP address for a Arweave host
      protocol: "https",   // Port
      port: 443,           // Network protocol http or https
    },
    {
      host: "gateway.amplify.host",
      protocol: "https",
      port: 443,
    },
    {
      host: "arweave.dev",
      protocol: "https",
      port: 443,
    },
  ], {
    timeout: 10000,         // Network request timeouts in milliseconds
    logging: true,          // Enable network request logging
    logger: console.log,    // Logger function
    onError: console.error, // On request error callback
  });
```

#### Init with the default hosts
You can also use `arweave.initWithDefaultHosts(config)` method to initialise Arweave instance with the default hosts array (aweave.net, gateway.amplify.host, arweave.dev)
```js

const arweave = ArweaveMultihost.initWithDefaultHosts({
  timeout: 10000,         // Network request timeouts in milliseconds
  logging: true,          // Enable network request logging
  logger: console.log,    // Logger function
  onError: console.error, // On request error callback
});
```

### 3. Usage
Then you can use the arweave instance in the same way as you would use it with the standard Arweave JS SDK. [See more examples](https://github.com/ArweaveTeam/arweave-js#usage) from the official Arweave JS SDK.

## 🤖 Examples
- [Codesandbox demo](https://codesandbox.io/s/arweave-multihost-demo-8r68b?file=/src/index.ts)
- [Node js scripts](examples/)

## 📜 License
This software is licensed under the [MIT](https://choosealicense.com/licenses/mit/) © [Redstone](https://github.com/redstone-finance)

---
_Source: https://npm.io/package/arweave-multihost · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._