Auth Plugins

Plug in a external package to arweavekit/auth

The use function exposed via the ArweaveKit object from arweavekit/auth package allows you to plugin external packages into arweave kit package.

Basic Syntax

The function is called as follows:

usage.js

import * as externalPackage from 'externalPackage';
import { ArweaveKit } from 'arweavekit/auth';

const arweaveKit = ArweaveKit.use({ name: 'MyPlugIn', plugin: externalPackage });

console.log(arweavekit.functionFromExternalPackage())

The ArweaveKit object imported also contains all functions from the ArweaveKit package for ease of use.

Create a Plugin

Most existing packages in Arweave will already be supported without any additional work, the functions just need to be defined and exported in the external package:

externalPackage.js

import * as ExternalPackage from 'package'
export function PackagePlugIn() {
    return ExternalPackage
}