# arweavekit

> Utility library to build full stack permaweb applications

Latest version **1.5.1** (published 2023-09-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install arweavekit
pnpm add arweavekit
yarn add arweavekit
bun add arweavekit
```

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.5.1 |
| Published | 2023-09-29 |
| First published | 2023-06-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 9 |
| Unpacked size | 115.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 10 |
| Author | CommunityLabs |
| Maintainers | ropats16 |

## Links

- npm: https://www.npmjs.com/package/arweavekit
- Repository: https://github.com/labscommunity/arweavekit
- Homepage: https://github.com/labscommunity/arweavekit#readme
- Issues: https://github.com/labscommunity/arweavekit/issues
- npm.io page: https://npm.io/package/arweavekit

## Dependencies (9)

- [ethers](https://npm.io/package/ethers.md) ^6.6.7
- [othent](https://npm.io/package/othent.md) 1.0.638
- [arweave](https://npm.io/package/arweave.md) ^1.13.5
- [graphql](https://npm.io/package/graphql.md) ^16.7.1
- [warp-contracts](https://npm.io/package/warp-contracts.md) ^1.4.17
- [@metamask/providers](https://npm.io/package/@metamask/providers.md) ^11.1.0
- [arweave-mnemonic-keys](https://npm.io/package/arweave-mnemonic-keys.md) ^0.0.9
- [@bundlr-network/client](https://npm.io/package/@bundlr-network/client.md) ^0.11.12
- [warp-contracts-plugin-deploy](https://npm.io/package/warp-contracts-plugin-deploy.md) ^1.0.9

## Recent versions

- 1.5.1 (latest) — 2023-09-29
- 1.5.0 — 2023-09-21
- 1.4.9 — 2023-08-24
- 1.4.8 — 2023-08-04
- 1.4.7 — 2023-07-30
- 1.4.6 — 2023-07-28
- 1.4.4 — 2023-07-28
- 1.4.3 — 2023-07-28
- 1.4.2 — 2023-07-28
- 1.4.0 — 2023-07-27
- 1.3.0 — 2023-07-25
- 1.2.14 — 2023-06-30
- 1.2.13 — 2023-06-29
- 1.2.12 — 2023-06-26
- 1.2.11 — 2023-06-20
- … 2 more at https://npm.io/package/arweavekit/versions

## README

# ArweaveKit

## Introduction

ArweaveKit aims to lower the barrier of onboarding and building on Arweave by creating a well documented one-stop library.

## Installation

Run the following command to install the package using npm or yarn

```
npm install arweavekit

#OR

yarn add arweavekit
```

## Usage

Functions from specific function types can be imported as follows:

```ts
import { createWallet } from 'arweavekit/wallet';

const wallet = await createWallet({
  seedPhrase: true,
  environment: 'local',
});
```

### Functions available

In this library, the following types of functions are available:

`Wallet Functions`: Functions associated with creating and using wallets. Read more [here](https://docs.arweavekit.com/wallets/introduction).

`Transaction Functions`: Functions associated with creating and interacting with transactions. Read more [here](https://docs.arweavekit.com/transactions/introduction).

`Contract Functions`: Functions associated with creating and interacting with contracts. Read more [here](https://docs.arweavekit.com/smart-contracts/introduction-to-smart-contracts).

`Encryption Functions`: Functions associated with encrypting and decrypting with encryption functions. Read more [here](https://docs.arweavekit.com/encryption/introduction-to-encryption).

`Auth Functions`: Functions associated with authentication. Authentication currently supports ArConnect only. Read more [here](https://docs.arweavekit.com/auth/introduction-to-auth).

### Understanding the docs

Every function has a dedicated page with the following information associated with it:

- Brief description of the function
- Basic syntax for function calls
- Input parameters for the function
  - Parameters with the `optional` keyword means they are optional. Parameters that do not have this keyword are required and must be passed in for successful function calls.
- Returned data for function calls

Read the docs [here](https://community-labs.gitbook.io/arweavekit-docs/permawebjs/introduction)

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