Skip to main content

Aliases for Sui Addresses


Fact Sheet

  • Sui cli sui client will automatically generate a alias file (~/.sui/sui_config/sui.aliases) starting in version 1.16.0
  • The alias file has a 1:1 mapping of alias names to the public key of the associated keypair
  • The alias name must start with a letter and can contain only letters, digits, hyphens (-), or underscores (_)
  • Command line caveats:
    • To rename an alias you will need to edit the alias file via editor
    • There is no known alias name length
  • PySui support of aliases:
    • pysui will check for alias file when using default_config(), if not found it will generate one that complies with Sui 1.16.0 alias file format
    • pysui's SuiConfig has methods to list, rename, use aliases for address and keypair lookups, and address or keypair lookup of aliases
    • pysui enforces min and max aliases lengths to be between 3 and 64 characters. However; if alias name in alias file is modified manually pysui will continue to operate
    • An alias can be provided in the creation of new address/keypairs as well as recovering of same
    • pysui docs on Aliasesopen in new window

Inspecting aliases

sui keytool list

Renaming aliases

sui keytool update-alias old_alias_name _new_alias_name_

Using aliases

Not applicable at this time