Squads Public Client v3

This repository hosts the code for a simplified client application for the Squads V3 Program. The app can be built, verified for integrity, and deployed as a static site using multiple hosting options, including self-hostable solutions like Docker with Nginx. Here’s how you can use it effectively.

---

Features

• Verifiable Build: The dist/ directory contains the static files that can be verified via a hash. This ensures the integrity of the build delivered.
  • Verification can be done against:
    • Remote URLs: Downloaded files can be verified for consistency with the expected hash.
    • IPFS CID: Retrieve the build from IPFS and verify its authenticity.
• Self-hosting: Run the application as a Docker container using an Nginx server for fully self-managed hosting.

---

Getting Started

The following steps will guide you to build, verify, and host the application.

1. Build the Web App

Prerequisites:

• Node.js v20+
• Yarn

Steps:

1. Clone the repository:

   git clone https://github.com/Squads-Protocol/public-v3-client
   cd public-v3-client

2. Install dependencies:

   yarn install --frozen-lockfile

3. Build the application:

   yarn build

   A dist/ directory will be created containing the static files.

4. Generate a hash of the build:

   ./scripts/generate-hash.sh

---

2. Verify the Build

Verifying Against a Remote URL

To verify the files hosted at a remote URL:

1. Use the scripts/verify-remote.sh script:

   ./scripts/verify-remote.sh <REMOTE_URL> <EXPECTED_HASH>

   Replace <REMOTE_URL> with the base URL of the remote site and <EXPECTED_HASH> with the known SHA-256 hash of the build.

---

Verifying Against an IPFS CID

To verify an IPFS-hosted build:

1. Ensure you have the IPFS CLI installed (ipfs).
2. Use the scripts/verify-ipfs.sh script:

   ./scripts/verify-ipfs.sh <IPFS_CID> <EXPECTED_HASH>

   Replace <IPFS_CID> with the CID of the IPFS build and <EXPECTED_HASH> with the known SHA-256 hash.

---

3. Self-Host with Docker

Prerequisites:

• Docker

Run the Docker Container

You can deploy the web app via a self-hosted Docker container using Nginx:

1. Build the Docker image:

   docker build -t squads-public-v3-client .

2. Run the container:

   docker run -d -p 8080:80 squads-public-v3-client

The app will now be available at http://localhost:8080.

3. Retrieve the hash from the running container:

   docker exec <container_id> cat /var/build-metadata/hash.txt

---

4. Build Hash

A SHA-256 build hash is generated by combining all files in the dist/ directory in a deterministic order.

To Check or Compute the Build Hash Locally:

1. Run the scripts/generate-hash.sh script:

   ./scripts/generate-hash.sh

   The output will show the computed hash of the local dist/ content. This hash should match the one provided in the deployment.

---

File Integrity During Deployment

Manifest File

A manifest.json file is included in the build, containing references to all static assets. It ensures that asset file mappings remain consistent during deployment.

---

Contributing

Contributions are welcome! Please fork the repository, make your changes, and open a pull request.

---

License

This project is licensed under the MIT License. Please see the included LICENSE file for details.