Skip to content

Commit

Permalink
chore(README): update scripts in README
Browse files Browse the repository at this point in the history
  • Loading branch information
dtfiedler committed Dec 10, 2023
1 parent 6639a70 commit 5be8051
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit 5be8051

Please sign in to comment.