README.md

ANT Registry

This repository contains the ANT Registry AO Process tooling and lua source code.

Table of Contents

• Setup
  • Install
  • Testing
  • Building the AOS code
  • Building the custom module
• Handler Methods
  • Register
  • Access-Control-List
• Developers
• Additional Resources

Setup

Install

First install the npm dependencies

yarn

Then install the ao cli - read the docs here Below is latest version as of writing, refer to the docs for the latest version.

curl -L https://arweave.net/iVthglhSN7G9LuJSU_h5Wy_lcEa0RE4VQmrtoBMj7Bw | bash

You may need to follow the instructions in the cli to add the program to your PATH.

Testing

To test the module, you can use the following command to run the testing suites that use AoLoader and node native testing (requires node 20+)

yarn test

Building the AOS code

Build

This bundles the ant-aos code and outputs it to dist folder. This can then be used to send to the Eval method on AOS to load the ANT source code.

yarn aos:build

Publish

Ensure that in the tools directory you place you Arweave JWK as key.json

yarn aos:publish

Load

This will load an AOS module into the loader, followed by the bundled aos Lua file to verify that it is a valid build.

yarn aos:load

Spawn

this will spawn an aos process and load the bundled lua code into it.

yarn aos:spawn

This will deploy the bundled lua file to arweave as an L1 transaction, so your wallet will need AR to pay the gas.

Building the custom module

Using the ao-dev-cli.

Build

This will compile the standalone ANT module to wasm, as a file named process.wasm and loads the module in AO Loader to validate the WASM program is valid.

yarn module:build

Publish

Publishes the custom ANT module to arweave - requires you placed your JWK in the tools directory. May require AR in the wallet to pay gas.

yarn module:publish

Load

Loads the module in AO Loader to validate the WASM program is valid.

yarn module:load

Requires module:build to have been called so that process.wasm exists.

Spawn

Spawns a process with the process.wasm file.

yarn module:spawn

Handler Methods

Register

This handler registers an ANT with the given Process-Id. It sends a request for the current ANT state and expects a State-Notice in response.

Tags

Tag Name	Type	Pattern	Required	Description
Action	string	"Register"	true	Action tag for triggering handler
Process-Id	string	string	true	Process id of the ANT to register

Example

{
  "Tags": [
    { "name": "Action", "value": "Register" },
    { "name": "Process-Id", "value": "unique-ant-id" }
  ]
}

Access-Control-List

This handler retrieves the list of ANT IDs associated with a given address.

Tags

Tag Name	Type	Pattern	Required	Description
Action	string	"Access-Control-List"	true	Action tag for triggering handler
Address	string	any string	true	Address of ANT holder

{
  "Tags": [
    { "name": "Action", "value": "Access-Control-List" },
    {
      "name": "Address",
      "value": "FVkQqJh5K9q9Zik4Y5-5dV7nk7waR8v4STuwPnTck1z"
    }
  ]
}

Developers

Requirements

• Lua 5.3 - Download
• Luarocks - Download

Lua Setup (MacOS)

1. Clone the repository and navigate to the project directory.

2. Install lua

   • brew install [email protected]

3. Add the following to your .zshrc or .bashrc file:

   echo 'export LDFLAGS="-L/usr/local/opt/[email protected]/lib"' >> ~/.zshrc
   echo 'export CPPFLAGS="-I/usr/local/opt/[email protected]/include"' >> ~/.zshrc
   echo 'export PKG_CONFIG_PATH="/usr/local/opt/[email protected]/lib/pkgconfig"' >> ~/.zshrc
   echo 'export PATH="/usr/local/opt/[email protected]/bin:$PATH"' >> ~/.zshrc

4. Run source ~/.zshrc or source ~/.bashrc to apply the changes.

5. Run lua -v to verify the installation.

aos

To load the module into the aos REPL, run the following command:

aos --load src/main.lua

Code Formatting

The code is formatted using stylua. To install stylua, run the following command:

cargo install stylua
stylua contract

Testing

To run the tests, execute the following command:

yarn test

Working with AoLoader and WASM

Common Errors

WebAssembly Memory Limit Error

Error Message:

RuntimeError: Aborted(CompileError: WebAssembly.instantiate(): maximum memory size (262144 pages) is larger than implementation limit (65536) @+5948)
    at abort (/Users/atticus/Documents/code/ar-io/ar-io-ant-registry-process/node_modules/@permaweb/ao-loader/dist/index.cjs:12071:19)
    at /Users/atticus/Documents/code/ar-io/ar-io-ant-registry-process/node_modules/@permaweb/ao-loader/dist/index.cjs:12132:13

Solution: Ensure that you are using the appropriate Node.js version. This issue was resolved by switching to Node.js version 20.

Additional Resources

• AR.IO Gateways
• AO Cookbook