From 5be80516bd5aca84c2fee1073bcdfe3600dd8f10 Mon Sep 17 00:00:00 2001 From: dtfiedler Date: Sun, 10 Dec 2023 14:04:05 -0800 Subject: [PATCH] chore(README): update scripts in README --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 03134b9..20a0c2c 100644 --- a/README.md +++ b/README.md @@ -121,11 +121,11 @@ In order to deploy contracts and use the Arweave Name System (along with creatin Make sure to update the variables at the top of each tool's `.ts` file, as well as the local wallet file in `constants.ts` -- `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 `inital-state.json` in the root folder of the project. -- `yarn ts-node tools/remove-ant-subdomain` 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-ant` 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 transfered. -- `update-ant-subdomain` creates a new subdomain in a ANT or updates existing one. Requires the subdomain name that is to be created or updated, the ANT Smartweave Contract ID and an Arweave Transaction. Please note that only the `@` sub domain will work at this time. -- `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. Please note that only the `@` sub domain will work at this time. +- `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/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`) # Additional Resources