diff options
123 files changed, 3697 insertions, 1123 deletions
@@ -6,6 +6,9 @@ Arching Kaos Tools > Hint: Find the "Script usage" section for sum up of the scripts +> Disclaimer: Any use of "AI" tools upon this repository, is STRICTLY forbidden. +> This affects all commits and branches. + Introduction ------------ Tools that help to create a blockchain called `zchain` by preparing small JSON @@ -74,6 +77,7 @@ programs used are: - curl (v7.79.1) - git (v2.34.1) - which (v2.21) +- rlwrap (v0.46.2) - jq (v1.6) - nodejs (v16+) - npm (v9.5.0) @@ -104,6 +108,9 @@ git pull Uninstall --------- +> WARNING: It will REMOVE the whole $HOME/.arching-kaos directory but your GPG +> keyring. Proceed with caution! Back up if you want to. + Navigate to your cloned repository and execute the following command: ``` @@ -111,8 +118,6 @@ Navigate to your cloned repository and execute the following command: ``` This will output an archive with your aknet-gpg-keyring to your $HOME folder. -It will NOT remove your IPFS repository, neither is going to clean it. - Podman (or Docker) ------------------ There is a ContainerFile that you can use to build an image which you can then @@ -170,6 +175,8 @@ Utilities - ak-network # Network Tools (connect to, scan for, dump peers) - ak-node-info # Returns IPFS CID or IPNS key for your online config - ak-pkg # Package manager + - ak-fs # File system + - ak-ns # Name system - ak-sblock # sblock tools - ak-schain # schain tools - ak-zblock # zblock tools @@ -234,6 +241,7 @@ Libraries - lib/_ak_settings - lib/_ak_gpg - lib/_ak_fs + - lib/_ak_ns - lib/_ak_pkg - lib/_ak_zblock - lib/_ak_log @@ -393,3 +401,49 @@ $ ak pkg --help # --uninstall Uninstalls a module selected from a menu # ``` + +NS tools +-------- + - ak-ns + +```bash +$ ak ns --help +# ak-ns - Name system +# =================== +# +# AKNS is a name system for Arching Kaos +# +# Usage: +# +# -h, --help Prints this help message +# -c, --create <name> Creates a new key-pair with name +# -l, --list List names +# -ll, --list-long List names with keys +# -rn, --resolve-name <name> Resolves value from name +# -rk, --resolve-key <key> Resolves value from key +# -p, --publish <key> <value> Publishes value to key +# -pn, --publish2name <name> <value> Publishes value to name +# -pz, --publish-zchain Publishes zchain +# -pc, --publish-config Publishes config +# -ek, --encode-key <key> Encodes a key to Base64 +# -dk, --decode-key <base64 key> Decodes a key from Base64 +# +ns command finished +``` + +Donations +--------- +While this project is developed with enthusiasm and it uses the spare time of +the only developer that is coding for it, donations would help allocating more +time on the project instead of the developer looking for different occupations +to support their life and project. + +If you do appreciate the project's goals and the developers efforts towards it, +take your time and consider donating some satoshis to the developer via BTC at +the following address + +``` +bc1q70rgp65t7acfgpwp74m7vdz0g4eduxm6a43gd8 +``` + +Thank you! @@ -0,0 +1,16 @@ +SUPPORT +------- + +1. Chat support +--------------- +Support and guidance can be provided via the #arching-kaos channel in IRC. You +can join via the Libera.chat IRC network. + +2. Bug reporting +---------------- +You can use the github page to report issues. + +3. Pull requests +---------------- +Anyone is free to send a pull request via github. The PR will be reviewed, +discussed and eventually merged into the project if seems useful. diff --git a/api/config.js b/api/config.js index 3fe7c0d..82f90b8 100644 --- a/api/config.js +++ b/api/config.js @@ -25,6 +25,7 @@ const config = { chunksDir: env.AK_CHUNKSDIR, leafsDir: env.AK_LEAFSDIR, mapsDir: env.AK_MAPSDIR, - printDebug: env.AK_DEBUG + printDebug: env.AK_DEBUG, + akNSDir: `${env.AK_WORKDIR}/akns` } module.exports = config; diff --git a/api/index.js b/api/index.js index f5cf8c8..6fd2066 100755 --- a/api/index.js +++ b/api/index.js @@ -1,6 +1,9 @@ const http = require("node:http"); +// Route functions const welcomeMessage = require("./routes/default/index.js"); +const getAKNSKey = require("./routes/getAKNSKey/index.js"); +const getAKNSKeyFromBase = require("./routes/get |