Thanks to visit codestin.com
Credit goes to github.com

Skip to content

nameManager

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

nameManager

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
.gitignore
.gitignore
 
 
README.md
README.md
 
 
actions.go
actions.go
 
 
app.go
app.go
 
 
go.mod
go.mod
 
 
go.sum
go.sum
 
 
help.go
help.go
 
 
main.go
main.go
 
 
main_test.go
main_test.go
 
 
parseArgs.go
parseArgs.go
 
 
publish.go
publish.go
 
 

README.md

NameManager CLI Tool

nameManager is an example command-line tool built with the TrueBlocks SDK designed to manage name entries associated with addresses. It offers various operations such as adding, editing, deleting, cleaning, and pbulishing name entries in the names database.

Building

cd ./nameManager
go build -o nameManager ./...
./nameManager --help

Usage

nameManager [options] address name [tags [source [symbol [decimals]]]]
nameManager --autoname address
nameManager --delete address
nameManager --undelete address
nameManager --remove address
nameManager --clean
nameManager --publish

Commands and Options

Required Arguments

  • address: The address for all operations except --clean and publish(type:string`).
  • name: The name to associate with the address for name editing (type: string).

Optional Arguments

  • tags: Tags associated with the name entry (type: string, default: "99-User-Defined").
  • source: The source of the name entry (type: string, default: "TrueBlocks").
  • symbol: A symbol related to the name entry (type: string, default: "").
  • decimals: The number of decimals associated with the entry (type: uint64, default: 0).

Options

  • --help: Displays the help message and exits.
  • --autoname: Automatically queries the blockchain for ERC20 values associated with the given address and updates the name entry.
  • --delete: Deletes the name entry for the specified address.
  • --undelete: Restores a previously deleted name entry for the given address.
  • --remove: Completely removes the node associated with the given address.
  • --clean: Cleans the names database, sorting entries and removing any duplicates.
  • --publish: Push naems to IPFS and publush returned IPFS CID to the Unchained Index.

Examples

Add or Update a Name Entry

To add or update a name entry for an address:

nameManager 0x1234...ABCD "MyToken" "99-User-Defined" "TrueBlocks" "MYT" 18
  • This command will add or update the entry with the address 0x1234...ABCD and associate it with the name MyToken, the tag 99-User-Defined, the source TrueBlocks, the symbol MYT, and 18 decimals.

Autoname a Given Address

To automatically name an address by querying the blockchain:

nameManager --autoname 0x1234...ABCD
  • This will query the chain for ERC20 values related to the address and update the name entry accordingly.

Delete a Name Entry

To delete a name entry for a specific address:

nameManager --delete 0x1234...ABCD
  • This will remove the name entry associated with the address 0x1234...ABCD.

Undelete a Name Entry

To restore a previously deleted name entry:

nameManager --undelete 0x1234...ABCD
  • This will undelete the name entry associated with the address 0x1234...ABCD.

Remove a Node

To remove a node associated with a specific address:

nameManager --remove 0x1234...ABCD
  • This will remove the node linked to the address 0x1234...ABCD from the database.

Clean the Names Database

To clean the entire names database, sorting entries and removing duplicates:

nameManager --clean
  • This will clean up the names database, ensuring it's sorted and free of duplicates.

Publish modified names to the Unchained Index

This feature is currently under development.

nameManager --publish
  • [Not yet implemented

Environment Variables

The following environment variables can be set to configure the behavior of the nameManager tool:

TB_NAMEMANAGER_EXPORT=<path to location of the export file> TB_NAMEMANAGER_REGULAR=true

We caution strongly against using the TB_NAMEMANAGER_REGULAR variable. It is intended for use by the TrueBlocks team to update the system installed names database. If you use this and later re-install or update TrueBlocks, you will lose your changes. It is documented here only for thouroughness.

Documentation

Please see our website for the best available documentation.

Linting

Please makes sure to lint your code before submitting a pull request. See our primary repo for more information on our linting process.

Contributing

We love contributors. Please see information about our workflow before proceeding.

  1. Fork this repository into your own repo.
  2. Create a branch: git checkout -b <branch_name>.
  3. Make changes to your local branch and commit them to your forked repo: git commit -m '<commit_message>'
  4. Push back to the original branch: git push origin TrueBlocks/trueblocks-core
  5. Create the pull request.

Contact

If you have questions, comments, or complaints, please join the discussion on our discord server which is linked from our website.

List of Contributors

Thanks to the following people who have contributed to this project: