feat: Add more documentation

This commit is contained in:
Nathan Woodburn 2025-01-29 12:56:58 +11:00
parent 52e248dfb3
commit df14698ec5
Signed by: nathanwoodburn
GPG Key ID: 203B000478AD0EF1
5 changed files with 16 additions and 1 deletions

View File

@ -8,3 +8,18 @@ Import this URL:
```
https://git.woodburn.au/nathanwoodburn/hns-address-plugin.git
```
## Usage
![Dashboard](assets/dash.png)
### Generate
Enter the number of addresses you want to generate and click Generate
Note that you don't need to fill the fields as the default values will be used. This also creates a file in user_data with the result to allow easier copying
![Generate](assets/generate.png)
### Validate
Enter the address you want to validate and click Validate
Note that you don't need to fill the xPub field
![Validate](assets/validate.png)

BIN
assets/dash.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 52 KiB

BIN
assets/generate.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 122 KiB

BIN
assets/validate.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 51 KiB

View File

@ -113,7 +113,7 @@ def generate(params, authentication):
return {"result": "No xpub found"}
result = subprocess.run(["node", "generate-address.js", "--xpub", xpub, "--number", str(count), "--startIndex", str(startIndex)], capture_output=True, text=True, cwd=hnsAddressPath)
with open(f"{xpub}-addresses.txt", "w") as f:
with open(f"user_data/{xpub}-addresses.txt", "w") as f:
f.write(result.stdout)
return {"result": result.stdout.split("\n")[2:-1]}