chore: rename to holoom and add readme (#9)

.github/workflows/e2e.yml

@@ -29,7 +29,7 @@ jobs:
             ~/.cargo/registry/cache/
             ~/.cargo/git/db/
             target/
-          key: game-identity-dna-${{ hashFiles('**/Cargo.lock') }}
+          key: holoom-dna-${{ hashFiles('**/Cargo.lock') }}
       - name: Build DNA
         run: |
           nix develop --command \
@@ -52,13 +52,13 @@ jobs:
           docker run -i \
             -v "$(pwd):/proj" \
             -w /proj rocket-builder bash -c \
-            "cargo build --release --package game_identity_rocket_server"
+            "cargo build --release --package holoom_rocket_server"
       - run: ls -l target
       # - run: ls -l target/release
       - run: whoami
       - run: sudo chown -R $(whoami) target
       - name: Ready artifact dir
-        run: mkdir artifact && mv target/release/game_identity_rocket_server artifact/
+        run: mkdir artifact && mv target/release/holoom_rocket_server artifact/
       - uses: actions/upload-artifact@v4
         if: always()
         with:
@@ -93,7 +93,7 @@ jobs:
             ~/.cargo/registry/cache/
             ~/.cargo/git/db/
             target/
-          key: game-identity-dna-tests-${{ hashFiles('**/Cargo.lock') }}
+          key: holoom-dna-tests-${{ hashFiles('**/Cargo.lock') }}
       - run: rm -rf workdir
       - name: Download DNA
         uses: actions/download-artifact@v4
@@ -124,13 +124,13 @@ jobs:
         with:
           name: rocket
           path: rocket-artifact
-      - run: mv rocket-artifact/game_identity_rocket_server docker/rocket/
+      - run: mv rocket-artifact/holoom_rocket_server docker/rocket/
       - name: Build images
         run: |
-          docker build --target local-services -t game-identity/local-services docker/misc_hc
-          docker build --target authority-agent-sandbox -t game-identity/authority-agent-sandbox docker/misc_hc
-          docker build --target holo-dev-server -t game-identity/holo-dev-server docker/misc_hc
-          docker build -t game-identity/rocket docker/rocket
+          docker build --target local-services -t holoom/local-services docker/misc_hc
+          docker build --target authority-agent-sandbox -t holoom/authority-agent-sandbox docker/misc_hc
+          docker build --target holo-dev-server -t holoom/holo-dev-server docker/misc_hc
+          docker build -t holoom/rocket docker/rocket
       - name: Setup Node
         uses: actions/setup-node@v3
         with:
@@ -145,6 +145,6 @@ jobs:
       - run: npx puppeteer browsers install chrome
       - run: npm run build:client
       - name: Start frontend in background
-        run: npm run dev -w @holochain-game-identity/e2e &
+        run: npm run dev -w @holoom/e2e &
       - name: Run e2e tests
-        run: npm run test -w @holochain-game-identity/e2e
+        run: npm run test -w @holoom/e2e

.gitignore

@@ -8,4 +8,4 @@ node_modules
 dist
 
 docker/misc_hc/happ_workdir
-docker/rocket/game_identity_rocket_server
+docker/rocket/holoom_rocket_server

.vscode/settings.json

@@ -1,3 +1,11 @@
 {
-  "cSpell.words": ["Dalek", "Holochain", "pubkey", "Solana", "zome", "zomes"]
+  "cSpell.words": [
+    "Dalek",
+    "Holochain",
+    "Holoom",
+    "pubkey",
+    "Solana",
+    "zome",
+    "zomes"
+  ]
 }

Cargo.toml

@@ -28,8 +28,8 @@ holochain_zome_types = "0.2.6"
 rocket = "0.5.0"
 rocket_okapi = { version = "0.8.0", features = ["swagger"] }
 
-[workspace.dependencies.game_identity_types]
-path = "crates/game_identity_types"
+[workspace.dependencies.holoom_types]
+path = "crates/holoom_types"
 
 [workspace.dependencies.username_registry_validation]
 path = "crates/username_registry_validation"
@@ -43,11 +43,11 @@ path = "crates/username_registry_coordinator"
 [workspace.dependencies.signer_coordinator]
 path = "crates/signer_coordinator"
 
-[workspace.dependencies.game_identity_rocket_types]
-path = "crates/game_identity_rocket_types"
+[workspace.dependencies.holoom_rocket_types]
+path = "crates/holoom_rocket_types"
 
-[workspace.dependencies.game_identity_rocket_state]
-path = "crates/game_identity_rocket_state"
+[workspace.dependencies.holoom_rocket_state]
+path = "crates/holoom_rocket_state"
 
-[workspace.dependencies.game_identity_rocket_controllers]
-path = "crates/game_identity_rocket_controllers"
+[workspace.dependencies.holoom_rocket_controllers]
+path = "crates/holoom_rocket_controllers"

README.md

@@ -0,0 +1,35 @@
+# Holoom
+
+Tools for weaving blockchain data into holochain.
+
+## Key Components
+
+### Holoom hApp
+
+A Holoom hApp network provides a space in which users can:
+
+- Register a unique username to their holochain agent (made possible by an authority agent)
+- Bind their various blockchain wallets to their agent with use of signatures
+- Curate freeform metadata strings linked to their own agent
+
+### `@holoom/client`
+
+An npm library that provides helpers for interacting with a Holoom hApp agent, whether that be via the holo network, or with a conductor directly.
+
+### Holoom Rocket Server
+
+Provides a REST API wrapper for a Holoom conductor instance (usually the authority agent). This is useful for building services around a Holoom network that are intended to be accessed without requiring ownership of an agent within the network.
+
+## The Authority Agent
+
+Each Holoom network is intialised with an authority agent specified in the network's DNA properties. The role of the authority agent is to maintain a registry of unique usernames, and is expected to be run on a server maintained by the instigator of the network. The authority agent is considered to be a partially trusted node in that users can validate its correct execution, but cannot prevent its downtime or censorship decisions.
+
+## Testing
+
+### `crates/holoom_dna_tests`
+
+This provides coverage for the holoom hApp's various zomes, and can be invoked locally using `npm run test:dna`.
+
+### `packages/e2e`
+
+This provides coverage for using the hApp in conjunction with the `@holoom/client` and `holoom_rocket_server` components.

crates/game_identity_tests/Cargo.toml → crates/holoom_dna_tests/Cargo.toml

@@ -1,15 +1,15 @@
 [package]
-name = "game_identity_tests"
+name = "holoom_dna_tests"
 version = "0.0.1"
 edition = "2021"
 
 [lib]
 crate-type = ["cdylib", "rlib"]
-name = "game_identity_tests"
+name = "holoom_dna_tests"
 
 [dependencies]
 serde = { workspace = true }
-game_identity_types = { workspace = true }
+holoom_types = { workspace = true }
 hdk = { workspace = true, features = ["encoding", "test_utils"] }
 holochain = { workspace = true, default-features = false, features = [
     "test_utils",