Atomic Toolkit

Atomic Toolkit is your streamlined path to building on Atomic Standards. Craft rock-solid, spec-compliant assets with ease, thanks to robust type safety.

Key Features

1. Robust Type Safety: Ensure accurate asset creation and adherence to Arweave specifications.
2. Clear and Concise SDK: Get up and running quickly with a developer-friendly experience.
3. Comprehensive Function Coverage: Create, fetch, and manage a variety of atomic assets, collections, and more.

Getting Started

Installation

npm install atomic-toolkit

Setup

Import the SDK:

import AtomicToolkit from 'atomic-toolkit';

Initialize with Arweave Wallet, Irys SDK, or Turbo SDK

Using Arweave Wallet

const key = JSON.parse(readFileSync('wallet.json').toString());

const toolkit = new AtomicToolkit({ key });

Using Irys:

import Irys from '@irys/sdk';

const irys = new Irys({
    url: 'https://node2.irys.xyz',
    token: 'matic',
    key: 'your-private-key',
});

await irys.ready();

const toolkit = new AtomicToolkit({ irys });

Using Turbo Through Irys:

import Irys from '@irys/sdk';

const irys = new Irys({
    url: 'https://turbo.ardrive.io',
    token: 'matic',
    key: 'your-private-key',
});

await irys.ready();

const toolkit = new AtomicToolkit({ irys });

Using Turbo:

const { TurboFactory } = require('@ardrive/turbo-sdk');
const AtomicToolkit = require('atomic-toolkit').default;
const fs = require('fs');

const jwk = JSON.parse(fs.readFileSync('./KeyFile.json').toString());
const turbo = TurboFactory.authenticated({ privateKey: jwk });

const toolkit = new AtomicToolkit({ turbo });

Using Turbo in the web:

import { ArconnectSigner } from 'arbundles/web';
import { TurboFactory } from '@ardrive/turbo-sdk/web';
import { AtomicToolkitWeb } from 'atomic-toolkit';

async function connectToolkit() {
    await window.arweaveWallet.connect([
        'ACCESS_PUBLIC_KEY',
        'SIGNATURE',
        'ACCESS_ADDRESS',
        'SIGN_TRANSACTION',
    ]);
    const arConnectSigner = new ArconnectSigner(window.arweaveWallet);
    const turbo = await TurboFactory.authenticated({ signer: arConnectSigner });
    const toolkit = new AtomicToolkitWeb({ turbo });
}

Documentation

For a complete overview of available functions and usage examples, please refer to the official documentation: https://atomictoolkit.mintlify.app

Contributing

We welcome contributions! Check out our contributing guide for more information

Future Plans

We're actively working on expanding functionality. Stay tuned for:

• Stamp Functions
• Atomic Tweet Functions
• UCM Marketplace Functions
• UDL Functions

Let's build the future of atomic assets together!