Skip to content

Commit

Permalink
chore(README): update readme links and add codecoverage badge
Browse files Browse the repository at this point in the history
  • Loading branch information
dtfiedler authored Dec 12, 2023
1 parent 4c9866c commit d6ad3e3
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# ArNS - Arweave Name Token (ANT)

This repository contains the source code used for Arweave Name Tokens used to resolve ArNS names on ar-io gateways. For official documentation on ANT's refer to the [ArNS ANT Docs]. For official documentation on ArNS refer to the [ArNS Docs].
[![codecov](https://codecov.io/gh/ar-io/ant-pilot/graph/badge.svg?token=X433P2HIH8)](https://codecov.io/gh/ar-io/ant-pilot)

This repository contains the source code used for Arweave Name Tokens used to resolve ArNS names on [AR.IO Gateways]. For official documentation on ANT's refer to the [ArNS ANT Docs]. For official documentation on ArNS refer to the [ArNS Docs].

## Overview

Expand Down Expand Up @@ -105,7 +107,7 @@ yarn test

#### AJV

The Arweave Name Token contract uses [AJV] for validating the input data for interactions. The schemas for each is located in [schemas] directory.
The Arweave Name Token contract uses [AJV] to validate the input data for interactions. The schema for each function is located in the [schemas] directory.

### Tools

Expand All @@ -115,7 +117,7 @@ Make sure to update the variables at the top of each tool's `.ts` file, as well

- `yarn ts-node tools/deploy-contract.ts` creates a new ANT with arweave data pointer. Requires a short token ticker, a friendly token name and an Arweave Transaction ID as the data pointer. The state variables can be updated in `initial-state.json` in the root folder of the project.
- `yarn ts-node tools/remove-record` removes an existing subdomain from the ANT. Requires the subdomain name to be removed and the ANT Smartweave Contract ID.
- `yarn ts-node tools/transfer` transfers a ANT to another wallet. Requires the recipient target to transfer the ANT to, and the ANT Smartweave Contract ID that is to be transferred.
- `yarn ts-node tools/transfer` transfers an ANT to another wallet. Requires the recipient target to transfer the ANT to, and the ANT Smartweave Contract ID that is to be transferred.
- `yarn ts-node tools/set-controller` - adds a controller to the record. Requires the ANT Smartweave Contract ID and the target address to add as a controller. Controllers have the ability to update the ANT records.
- `yarn ts-node tools/set-record` - sets a record for a given subdomain. Requires the subdomain name that is to be created or updated, the ANT Smartweave Contract ID and an Arweave Transaction. '@' records are used to set the root record. Other records are resolved as undernames (e.g. a record of `subdomain` with the root name as `arns` on the ArNS Registry Contract will resolve as `subdomain_arns.arweave.dev`)

Expand All @@ -138,3 +140,4 @@ Make sure to update the variables at the top of each tool's `.ts` file, as well
[AJV]: https://ajv.js.org/guide/getting-started.html
[Warp]: https://academy.warp.cc
[SmartWeave]: https://github.com/ArweaveTeam/SmartWeave
[schemas]: ./schemas

0 comments on commit d6ad3e3

Please sign in to comment.