Walrus

https://docs.wal.app/
Admin
Walrus is a decentralized storage and data availability protocol designed for large binary files,...
Tokens:106,678
Snippets:616
Trust Score:6.3
Update:1 year ago
Show doc for...
Tokens:
Raw
### Installing the Walrus Site Builder

Source: https://docs.wal.app/dev-guide/sui-struct

This section guides users through the installation process of the Walrus site builder tool. It provides step-by-step instructions for setting up the builder to create and manage Walrus Sites.

```bash
# Example installation command (placeholder)
npm install -g @walrus/site-builder
```

--------------------------------

### Clone Example Walrus Sites Repository

Source: https://docs.wal.app/print

This command clones the example-walrus-sites repository from GitHub and changes the current directory to the cloned repository. This is the first step to get sample sites for publishing.

```bash
git clone https://github.com/MystenLabs/example-walrus-sites.git && cd example-walrus-sites
```

--------------------------------

### Publish a Walrus Site

Source: https://docs.wal.app/walrus-sites/tutorial

This section guides users through publishing a Walrus Site and adding a SuiNS name for easier access. It covers the initial setup and deployment process.

```Rust
// Example Rust code for publishing a Walrus Site
fn publish_walrus_site() {
    println!("Publishing Walrus Site...");
    // Add site publishing logic here
}

fn add_sui_ns_name() {
    println!("Adding SuiNS name...");
    // Add SuiNS name registration logic here
}
```

--------------------------------

### Walrus Sites Linking Examples

Source: https://docs.wal.app/walrus-sites/linking

Demonstrates how to create portal-independent links for Walrus Sites resources using SuiNS names or blob IDs.

```plaintext
https://gallery.suiobj/walrus_arctic.webp
https://abcd123….suiobj/walrus_arctic.webp
https://blobid.walrus/qwer5678…
```

--------------------------------

### Walrus Site Builder Configuration Example

Source: https://docs.wal.app/print

An example `sites-config.yaml` file showing configurations for 'testnet' and 'mainnet' contexts, including package IDs and general settings.

```yaml
contexts:
  testnet:
    # module: site
    # portal: wal.app
    package: 0xf99aee9f21493e1590e7e5a9aea6f343a1f381031a04a732724871fc294be799
    staking_object: 0xbe46180321c30aab2f8b3501e24048377287fa708018a5b7c2792b35fe339ee3
    general:
       wallet_env: testnet
       walrus_context: testnet # Assumes a Walrus CLI setup with a multi-config containing the "testnet" context.
       walrus_package: 0xd84704c17fc870b8764832c535aa6b11f21a95cd6f5bb38a9b07d2cf42220c66
       # wallet_address: 0x1234...
       # rpc_url: https://fullnode.testnet.sui.io:443
       # wallet: /path/to/.sui/sui_config/client.yaml
       # walrus_binary: /path/to/walrus
       # walrus_config: /path/to/testnet/client_config.yaml
       # gas_budget: 500000000
  mainnet:
    # module: site
    # portal: wal.app
    package: 0x26eb7ee8688da02c5f671679524e379f0b837a12f1d1d799f255b7eea260ad27
    staking_object: 0x10b9d30c28448939ce6c4d6c6e0ffce4a7f8a4ada8248bdad09ef8b70e4a3904
    general:
       wallet_env: mainnet
       walrus_context: mainnet # Assumes a Walrus CLI setup with a multi-config containing the "mainnet" context.
       walrus_package: 0xfdc88f7d7cf30afab2f82e8380d11ee8f70efb90e863d1de8616fae1bb09ea77
       # wallet_address: 0x1234...
       # rpc_url: https://fullnode.mainnet.sui.io:443
       # wallet: /path/to/.sui/sui_config/client.yaml
       # walrus_binary: /path/to/walrus
       # walrus_config: /path/to/mainnet/client_config.yaml
       # gas_budget: 500000000

default_context: mainnet
```

--------------------------------

### Copy Environment Example (Bash)

Source: https://docs.wal.app/walrus-sites/portal

Copies the testnet environment example file to a local environment file for customization. This is the initial step for configuring the portal's behavior.

```bash
cp ./portal/worker/.env.testnet.example ./portal/worker/.env.local
```

--------------------------------

### Copy Testnet Server Portal Environment Variables

Source: https://docs.wal.app/walrus-sites/portal

This command copies the example environment variables for the testnet server portal to a local .env file, enabling the setup of a testnet instance.

```bash
cp ./portal/server/.env.testnet.example ./portal/server/.env.local
```

--------------------------------

### Install Dependencies with Bun (Bash)

Source: https://docs.wal.app/walrus-sites/portal

Navigates to the portal directory and installs project dependencies using Bun. This command is essential before running the portal locally.

```bash
cd portal
bun install
```

--------------------------------

### Install Walrus Client via Script (Mainnet)

Source: https://docs.wal.app/usage/setup

Downloads and installs the latest Mainnet version of the Walrus client to the `$HOME/.local/bin` directory using a curl script. Ensure `$HOME/.local/bin` is in your PATH.

```bash
curl -sSf https://install.wal.app | sh
```

--------------------------------

### CI/CD Setup for GitHub

Source: https://docs.wal.app/operator-guide/operator-guide

Guidance on setting up Continuous Integration and Continuous Deployment pipelines for Walrus Sites using GitHub, including secrets and workflow creation.

```Rust
// Placeholder for Rust code related to GitHub CI/CD setup for Walrus Sites
```

--------------------------------

### Install Walrus CLI via suiup

Source: https://docs.wal.app/usage/setup

Installs specific versions of the Walrus CLI using the `suiup` tool. This allows for managing different Walrus releases for testnet or mainnet.

```bash
suiup install walrus@testnet # install the latest testnet release
suiup install walrus@mainnet # install the latest mainnet release
suiup install walrus@testnet-v1.27.1 # install a specific release
```

--------------------------------

### Install Portal Dependencies with Bun

Source: https://docs.wal.app/print

Installs project dependencies for the portal using Bun. This command should be run after navigating to the portal directory.

```shell
cd portal
bun install
```

--------------------------------

### Install Bun (Shell)

Source: https://docs.wal.app/walrus-sites/portal

Installs the Bun JavaScript runtime using a curl command to download and execute the installation script. This is necessary if Bun is not already installed.

```shell
curl -fsSL https://bun.sh/install | bash
```

--------------------------------

### Install Walrus CLI via suiup

Source: https://docs.wal.app/print

Installs specific versions of the Walrus CLI using the 'suiup' tool. Examples include installing the latest testnet, mainnet, or a specific tagged release.

```shell
suiup install walrus@testnet # install the latest testnet release
```

```shell
suiup install walrus@mainnet # install the latest mainnet release
```

```shell
suiup install walrus@testnet-v1.27.1 # install a specific release
```

--------------------------------

### Walrus SDK Usage Example (Rust)

Source: https://docs.wal.app/blog/01_announcing_walrus

This example demonstrates how to use the Walrus SDK in Rust to upload and download data. It highlights the core functionalities provided by the SDK.

```Rust
use walrus_sdk::Client;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let mut client = Client::new("http://localhost:8080").await?;

    // Upload a file
    let file_path = "./my_data.txt";
    let object_id = client.upload(file_path).await?;
    println!("Uploaded file with ID: {}", object_id);

    // Download the file
    let download_path = "./downloaded_data.txt";
    client.download(&object_id, download_path).await?;
    println!("Downloaded file to: {}", download_path);

    Ok(())
}
```

--------------------------------

### CI/CD Setup for Walrus Sites with GitHub

Source: https://docs.wal.app/design/operations-sui

This section provides guidance on setting up Continuous Integration and Continuous Deployment (CI/CD) pipelines for Walrus Sites using GitHub Actions.

```YAML
name: Deploy Walrus Site

on:
  push:
    branches: [ main ]

jobs:
  build-and-deploy:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v3
    - name: Build Walrus Site
      run: walrus-site build --output ./dist
    - name: Deploy to Walrus Storage
      # Add deployment steps here
```

--------------------------------

### Walrus CLI Interaction Example

Source: https://docs.wal.app/blog/01_announcing_walrus

This snippet demonstrates how to interact with the Walrus client using its command-line interface (CLI). It's a basic example showing a common operation.

```Shell
walrus client --help
walrus client upload <file_path>
walrus client download <object_id>
```

--------------------------------

### Install Walrus Client via Script (Testnet)

Source: https://docs.wal.app/usage/setup

Downloads and installs the latest Testnet version of the Walrus client using a curl script. This command specifies the testnet network.

```bash
curl -sSf https://install.wal.app | sh -s -- -n testnet
```

--------------------------------

### Install Walrus Site Builder

Source: https://docs.wal.app/print

Downloads and makes the Walrus site-builder executable. The `SYSTEM` variable should be set to your operating system and architecture (e.g., `ubuntu-x86_64`).

```bash
SYSTEM= # set this to your system: ubuntu-x86_64, ubuntu-x86_64-generic, macos-x86_64, macos-arm64, windows-x86_64.exe
curl https://storage.googleapis.com/mysten-walrus-binaries/site-builder-testnet-latest-$SYSTEM -o site-builder
chmod +x site-builder
```

--------------------------------

### Example walrus-upload-relay Configuration

Source: https://docs.wal.app/print

This YAML snippet shows an example configuration for the walrus-upload-relay, including tip configuration with an address and kind, and transaction freshness thresholds.

```yaml
tip_config: !send_tip
  address: 0x2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a
  kind: !const 42
tx_freshness_threshold_secs: 36000
tx_max_future_threshold:
  secs: 30
  nanos: 0
```

--------------------------------

### Creating GitHub Workflow for Walrus Sites

Source: https://docs.wal.app/legal/walrus_general_tos

This section provides an example of a GitHub Actions workflow file to automate the building and deployment of Walrus Sites. It outlines the steps involved in the CI/CD process.

```yaml
name: Deploy Walrus Site

on:
  push:
    branches:
      - main

jobs:
  build-and-deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - name: Build Walrus Site
        run: walrus-site build --directory ./my-site
      - name: Deploy Walrus Site
        run: walrus-site publish --directory ./my-site --target production
```

--------------------------------

### Install Walrus Client on Windows

Source: https://docs.wal.app/usage/setup

Downloads the latest Windows 64-bit Testnet version of the Walrus client using PowerShell. The downloaded file will be named `walrus.exe`.

```powershell
(New-Object System.Net.WebClient).DownloadFile(
  "https://storage.googleapis.com/mysten-walrus-binaries/walrus-testnet-latest-windows-x86_64.exe",
  "walrus.exe"
)
```

--------------------------------

### Build and Publish a Walrus Site

Source: https://docs.wal.app/usage/started

This section guides users through the process of building and publishing a Walrus Site. It includes instructions on using the site builder and setting up necessary configurations for deployment.

```Rust
// Command to build a Walrus Site
walrus-site build

// Command to publish a Walrus Site
walrus-site publish
```

--------------------------------

### Start Local Sui Network

Source: https://docs.wal.app/print

Command to start a local Sui network with faucet enabled and force regenesis. This is a prerequisite for running the Walrus testbed fully locally.

```shell
sui start --with-faucet --force-regenesis
```

--------------------------------

### Creating GitHub Workflow for Walrus Sites

Source: https://docs.wal.app/design/architecture

This section provides an example of a GitHub Actions workflow file to automate the building and deployment of Walrus Sites. It outlines the steps involved in the CI/CD process.

```yaml
name: Deploy Walrus Site

on:
  push:
    branches:
      - main

jobs:
  build-and-deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - name: Build Walrus Site
        run: walrus-site build --directory ./my-site
      - name: Deploy Walrus Site
        run: walrus-site publish --directory ./my-site --target production
```

--------------------------------

### Walrus Site Builder Command Example

Source: https://docs.wal.app/blog/01_announcing_walrus

This snippet shows a command for the Walrus site builder, likely used for managing or publishing Walrus Sites.

```Shell
walrus-site-builder publish --source ./my-site --destination <sui_object_id>
```

--------------------------------

### Install Walrus CLI via Script (Mainnet)

Source: https://docs.wal.app/print

Installs the latest Mainnet version of the Walrus CLI by downloading and executing a script from the official wal.app URL. Ensure your PATH includes '$HOME/.local/bin'.

```bash
curl -sSf https://install.wal.app | sh
```

--------------------------------

### Start Walrus Node and Monitor Logs (Bash)

Source: https://docs.wal.app/operator-guide/backup-restore-guide

This command starts the Walrus storage node service after a restore operation. It also includes instructions to monitor the startup logs using `journalctl` to track the node's progress and transition to an active state.

```bash
sudo systemctl start walrus-node.service

# Monitor startup logs
sudo journalctl -u walrus-node.service -f

```

--------------------------------

### Creating GitHub Workflow for Walrus Sites

Source: https://docs.wal.app/glossary

This section provides an example of a GitHub Actions workflow file to automate the building and deployment of Walrus Sites. It outlines the steps involved in the CI/CD process.

```yaml
name: Deploy Walrus Site

on:
  push:
    branches:
      - main

jobs:
  build-and-deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - name: Build Walrus Site
        run: walrus-site build --directory ./my-site
      - name: Deploy Walrus Site
        run: walrus-site publish --directory ./my-site --target production
```

--------------------------------

### Walrus Upload Relay Configuration Example

Source: https://docs.wal.app/operator-guide/upload-relay

An example configuration file for the walrus-upload-relay. It includes settings for sending tips, such as the recipient address and the type of tip (constant or linear), as well as transaction freshness thresholds.

```yaml
tip_config: !send_tip
  address: 0x2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a
  kind: !const 42
tx_freshness_threshold_secs: 36000
tx_max_future_threshold:
  secs: 30
  nanos: 0
```

--------------------------------

### Creating GitHub Workflow for Walrus Sites

Source: https://docs.wal.app/design/encoding

This section provides an example of a GitHub Actions workflow file to automate the building and deployment of Walrus Sites. It outlines the steps involved in the CI/CD process.

```yaml
name: Deploy Walrus Site

on:
  push:
    branches:
      - main

jobs:
  build-and-deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - name: Build Walrus Site
        run: walrus-site build --directory ./my-site
      - name: Deploy Walrus Site
        run: walrus-site publish --directory ./my-site --target production
```

--------------------------------

### Run Server-Side Portal with Bun

Source: https://docs.wal.app/print

Starts the server-side portal using the Bun runtime. This command executes the 'server' script defined in the project's package.json.

```shell
bun run server
```

--------------------------------

### Walrus Site CI/CD GitHub Workflow

Source: https://docs.wal.app/walrus-sites/advanced

This section provides an example of setting up a GitHub Actions workflow for Continuous Integration and Continuous Deployment (CI/CD) of Walrus Sites.

```YAML
name: Deploy Walrus Site

on:
  push:
    branches: [ main ]

jobs:
  build-and-deploy:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v3
    - name: Build Walrus Site
      run: walrus-site build --output ./dist
    - name: Deploy to Walrus
      env:
        WALRUS_API_KEY: ${{ secrets.WALRUS_API_KEY }}
      run: walrus-site deploy --source ./dist --target production
```

--------------------------------

### Creating a GitHub Workflow for Walrus Sites

Source: https://docs.wal.app/operator-guide/upload-relay

This section provides instructions and examples for creating a GitHub Actions workflow file to automate the build and deployment process for Walrus Sites.

```yaml
name: Deploy Walrus Site

on: [push]

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v3
    - name: Setup Node.js
      uses: actions/setup-node@v3
      with:
        node-version: '18'
    - name: Install Dependencies
      run: npm install
    - name: Build Site
      run: npm run build
    - name: Deploy to Walrus
      run: walrus-site publish ./build
```

--------------------------------

### Install Walrus Site Builder CLI (Mainnet)

Source: https://docs.wal.app/walrus-sites/tutorial-install

This snippet shows how to download and make executable the Walrus site builder CLI for the mainnet. It requires setting a system variable to specify the target OS and architecture.

```bash
SYSTEM= # set this to your system: ubuntu-x86_64, ubuntu-x86_64-generic, macos-x86_64, macos-arm64, windows-x86_64.exe
curl https://storage.googleapis.com/mysten-walrus-binaries/site-builder-mainnet-latest-$SYSTEM -o site-builder
chmod +x site-builder
```

--------------------------------

### Build Walrus from Source using Cargo

Source: https://docs.wal.app/usage/setup

This snippet shows how to build and install the Walrus client from its Rust source code using the cargo package manager. This is an alternative to using the pre-compiled binary.

```Rust
cargo install walrus
```

--------------------------------

### Download and Execute Walrus Site Builder

Source: https://docs.wal.app/walrus-sites/tutorial-install

This snippet shows how to download the Walrus site builder binary for your system using curl and make it executable. It also explains how to place the binary in your system's PATH for easy access.

```shell
SYSTEM= # set this to your system: ubuntu-x86_64, ubuntu-x86_64-generic, macos-x86_64, macos-arm64, windows-x86_64.exe
curl https://storage.googleapis.com/mysten-walrus-binaries/site-builder-testnet-latest-$SYSTEM -o site-builder
chmod +x site-builder
```

--------------------------------

### Operating a Walrus Aggregator or Publisher

Source: https://docs.wal.app/dev-guide/sui-struct

This section provides guidance on operating an aggregator or publisher node within the Walrus network. It covers the responsibilities, setup, and management of these roles, including authentication.

```text
Publisher Authentication:
- API Key Management
- Secure connection protocols
```

--------------------------------

### CI Workflow for Publishing Walrus Sites with GitHub Actions

Source: https://docs.wal.app/usage/examples

This example details the CI workflow used to publish the Walrus documentation site itself, demonstrating how to build a static website and store it as a Walrus Site using GitHub Actions. It highlights the practical application of Walrus in website deployment pipelines.

```YAML
# CI workflow example for publishing Walrus Sites using GitHub Actions
```

--------------------------------

### GitHub Workflow for Walrus Site CI/CD

Source: https://docs.wal.app/blog/01_announcing_walrus

This example illustrates a GitHub Actions workflow for Continuous Integration and Continuous Deployment (CI/CD) of a Walrus Site. It automates the publishing process.

```YAML
name: Deploy Walrus Site

on:
  push:
    branches:
      - main

jobs:
  build-and-deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - name: Set up Node.js
        uses: actions/setup-node@v3
        with:
          node-version: '18'
      - name: Install Dependencies
        run: npm install
      - name: Build Walrus Site
        run: npm run build
      - name: Deploy to Walrus
        env:
          SUI_KEYSTORE_PATH: ${{ secrets.SUI_KEYSTORE_PATH }}
          SUI_ADDRESS: ${{ secrets.SUI_ADDRESS }}
        run: |
          walrus-site-builder publish --source ./dist --destination <your_sui_object_id>
```

--------------------------------

### Display Walrus Client Help Information

Source: https://docs.wal.app/usage/setup

Shows the usage instructions and available commands for the Walrus CLI client. This is helpful for understanding the client's capabilities.

```bash
$ walrus --help
```

--------------------------------

### Build and Publish a Walrus Site

Source: https://docs.wal.app/print

This section guides users through the process of building and publishing a Walrus Site using the site builder. It covers installation, publishing, and setting up SuiNS names.

```bash
site-builder install
site-builder publish <site_directory>
sui-ns set <site_name>.sui
```

--------------------------------

### Build and Publish a Walrus Site

Source: https://docs.wal.app/index

This section guides users through the process of building and publishing a Walrus Site using the site builder. It covers installation, publishing, and setting up SuiNS names.

```bash
site-builder install
site-builder publish <site_directory>
sui-ns set <site_name>.sui
```

--------------------------------

### Run Server-Side Portal with Bun (Bash)

Source: https://docs.wal.app/walrus-sites/portal

Starts the server-side version of the Walrus portal using the Bun runtime. This command executes the server script defined in the project's package.json.

```bash
bun run server
```

--------------------------------

### Site Builder Commands

Source: https://docs.wal.app/operator-guide/operator-guide

Documentation for commands used with the Walrus Site builder, enabling customization and deployment of sites.

```Rust
// Placeholder for Rust code related to Walrus Site builder commands
```

--------------------------------

### Install Bun

Source: https://docs.wal.app/print

Installs the Bun JavaScript runtime using a curl command. This is necessary if Bun is not already installed.

```shell
curl -fsSL https://bun.sh/install | bash
```

--------------------------------

### Verify Walrus CLI Installation

Source: https://docs.wal.app/print

Checks the installed Walrus CLI version and displays usage instructions. This command should be executable after a successful installation and PATH configuration.

```shell
$ walrus --help
Walrus client

Usage: walrus [OPTIONS] <COMMAND>

Commands:
⋮
```

--------------------------------

### Install Walrus CLI via Cargo

Source: https://docs.wal.app/print

Installs the Walrus CLI using Cargo, specifying the Git repository and branch for the Mainnet version. Supports installation via tags or commits as alternatives.

```rust
cargo install --git https://github.com/MystenLabs/walrus --branch mainnet walrus-service --locked
```

--------------------------------

### Configure Mainnet Server Portal Environment

Source: https://docs.wal.app/print

Copies the example environment file for the mainnet server portal to create a local configuration file. This sets up the necessary environment variables for running the mainnet server portal.

```bash
cp ./portal/server/.env.mainnet.example ./portal/server/.env.local
```

--------------------------------

### Check Bun Installation

Source: https://docs.wal.app/print

Checks if the Bun JavaScript runtime is installed on the system. Bun is required for local development.

```shell
bun --version
```

--------------------------------

### Python Examples for Walrus HTTP and JSON APIs

Source: https://docs.wal.app/usage/examples

This snippet covers Python examples demonstrating how to interact with Walrus using both its HTTP and JSON APIs. It includes functionalities for storing and reading blobs, checking blob availability, and tracking Walrus-related events. The examples illustrate reading Blob Sui objects for certification.

```Python
# Example for HTTP API to store and read a blob
# Example for JSON API to store, read, and check availability
# Example for tracking Walrus related Events
```

--------------------------------

### Configure Testnet Server Portal Environment

Source: https://docs.wal.app/print

Copies the example environment file for the testnet server portal to create a local configuration file. This sets up the necessary environment variables for running the testnet server portal.

```bash
cp ./portal/server/.env.testnet.example ./portal/server/.env.local
```

--------------------------------

### Update Walrus Client via Script

Source: https://docs.wal.app/usage/setup

Updates an existing installation of the Walrus client to the latest version by re-running the installation script with the force flag.

```bash
curl -sSf https://install.wal.app | sh -s -- -f
```

--------------------------------

### Create GitHub Workflow for Walrus Site CI/CD

Source: https://docs.wal.app/usage/started

This section provides an example of a GitHub Actions workflow file used to automate the build, test, and deployment process for Walrus Sites. It outlines the steps and commands executed in the CI/CD pipeline.

```Rust
name: Deploy Walrus Site

on: [push]

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v3
    - name: Build and Deploy Walrus Site
      run: |
        walrus-site build
        walrus-site publish --target production
```

--------------------------------

### Deploy Walrus Site GitHub Action Workflow

Source: https://docs.wal.app/walrus-sites/ci-cd-gh-workflow

Example of a GitHub Actions workflow file demonstrating how to use the 'Deploy Walrus Site' action. It includes setting up permissions, defining environment variables, and calling the action with necessary inputs.

```YAML
name: Deploy Walrus Site

on: [push]

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v3
    - name: Build Walrus Site
      # Add your site build steps here (e.g., npm run build, yarn build)
      run: echo "Building site..."
    - name: Deploy to Walrus
      uses: MystenLabs/walrus-sites/.github/actions/deploy
      with:
        SUI_ADDRESS: ${{ secrets.SUI_ADDRESS }}
        SUI_KEYSTORE: ${{ secrets.SUI_KEYSTORE }}
        DIST: "./build" # Path to your built site directory
        SUI_NETWORK: "testnet" # Optional: mainnet or testnet
        EPOCHS: "10" # Optional: number of epochs to keep the site stored
        GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
```

--------------------------------

### Start Walrus Aggregator

Source: https://docs.wal.app/operator-guide/aggregator

Starts a local Walrus aggregator service that provides an HTTP interface for reading blobs. It requires specifying the bind address for the listener.

```bash
walrus aggregator --bind-address "127.0.0.1:31415"
```

--------------------------------

### Publishing a Walrus Site

Source: https://docs.wal.app/operator-guide/operator-guide

Instructions for publishing a Walrus Site, likely involving CLI commands or API interactions.

```Rust
// Placeholder for Rust code related to publishing a Walrus Site
```

--------------------------------

### Site Builder Commands

Source: https://docs.wal.app/walrus-sites/tutorial

This section details the commands available for the Walrus Site builder, enabling users to manage and deploy their websites. It covers essential functionalities for site creation and management.

```Light
# Example Light commands for Walrus Site builder
walrus-cli build
walrus-cli deploy --target production
walrus-cli config set api_key "YOUR_API_KEY"
```

--------------------------------

### Creating GitHub Workflow for Walrus Sites

Source: https://docs.wal.app/blog/03_whitepaper

This section provides an example of a GitHub Actions workflow file to automate the building and deployment of Walrus Sites. It outlines the steps involved in the CI/CD process.

```yaml
name: Deploy Walrus Site

on:
  push:
    branches:
      - main

jobs:
  build-and-deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - name: Build Walrus Site
        run: walrus-site build --directory ./my-site
      - name: Deploy Walrus Site
        run: walrus-site publish --directory ./my-site --target production
```

--------------------------------

### Install Walrus Service via Cargo

Source: https://docs.wal.app/usage/setup

Installs the latest Mainnet version of the Walrus service using Cargo. Supports specifying branches, tags, or commits for different versions.

```bash
cargo install --git https://github.com/MystenLabs/walrus --branch mainnet walrus-service --locked
```

--------------------------------

### Start Walrus Aggregator Daemon

Source: https://docs.wal.app/print

Starts a local Walrus aggregator daemon that provides an HTTP interface to read blobs from Walrus. It requires specifying the bind address.

```bash
walrus aggregator --bind-address "127.0.0.1:31415"
```

--------------------------------

### Start Local Sui Network

Source: https://docs.wal.app/usage/networks

Initiates a local Sui network with faucet enabled and forces genesis regeneration. This is a prerequisite for running the Walrus testbed fully locally. Requires Sui version 1.28.0 or higher.

```bash
sui start --with-faucet --force-regenesis
```

--------------------------------

### Update Walrus CLI via Script

Source: https://docs.wal.app/print

Updates an existing Walrus CLI installation to the latest version by re-running the installation script with the '-f' flag, overwriting the prior version.

```bash
curl -sSf https://install.wal.app | sh -s -- -f
```

--------------------------------

### Start Local Grafana Instance

Source: https://docs.wal.app/print

Command to spin up a local Grafana instance for visualizing metrics from Walrus storage nodes. This is done by navigating to the Grafana Docker directory and running `docker compose up`.

```shell
cd docker/grafana-local; docker compose up
```

--------------------------------

### Start Walrus Publisher with Sub-wallets

Source: https://docs.wal.app/operator-guide/aggregator

Starts a local Walrus publisher service for storing blobs, including on-chain operations. It configures a directory for sub-wallets and sets the number of clients for parallel operations.

```bash
PUBLISHER_WALLETS_DIR=~/.config/walrus/publisher-wallets
mkdir -p "$PUBLISHER_WALLETS_DIR"
walrus publisher \
  --bind-address "127.0.0.1:31416" \
  --sub-wallets-dir "$PUBLISHER_WALLETS_DIR" \
  --n-clients 1
```

--------------------------------

### Aggregator HTTP GET Endpoint

Source: https://docs.wal.app/glossary

The aggregator service exposes a simple HTTP GET endpoint for users to retrieve reconstructed blobs. This functionality is central to how users interact with the data stored on Walrus.

```HTTP
HTTP GET
```

--------------------------------

### CI/CD: GitHub Workflow for Walrus Sites

Source: https://docs.wal.app/walrus-sites/ci-cd

This snippet outlines the process of setting up a CI/CD pipeline for automating the deployment of Walrus Sites using GitHub Actions. It involves preparing deployment credentials and writing a workflow file.

```GitHub Actions
# Example GitHub Actions workflow for deploying Walrus Sites
# This is a conceptual example and would need to be adapted
# to your specific project structure and deployment needs.

name: Deploy Walrus Site

on:
  push:
    branches:
      - main

jobs:
  build-and-deploy:
    runs-on: ubuntu-latest

    steps:
    - name: Checkout code
      uses: actions/checkout@v3

    - name: Set up Walrus CLI (example)
      # Replace with actual command to set up Walrus CLI or relevant tools
      run: echo "Setting up Walrus CLI..."

    - name: Build Walrus Site (example)
      # Replace with actual command to build your Walrus Site
      run: echo "Building Walrus Site..."

    - name: Deploy Walrus Site (example)
      # Replace with actual deployment command, e.g., using Walrus CLI or other tools
      # This might involve uploading files to a hosting service or using a Walrus-specific deployment command.
      env:
        # Access secrets stored in GitHub repository settings
        WALRUS_DEPLOY_TOKEN: ${{ secrets.WALRUS_DEPLOY_TOKEN }}
      run: echo "Deploying Walrus Site..."

```

--------------------------------

### Publish a Walrus Site

Source: https://docs.wal.app/dev-guide/costs

This section provides instructions on how to publish a Walrus Site. It covers the steps involved in the publishing process, potentially including build commands or deployment configurations.

```bash
# Example command to publish a Walrus Site (placeholder)
walrus-site publish ./my-site
```

--------------------------------

### Install Walrus CLI via Script (Testnet)

Source: https://docs.wal.app/print

Installs the latest Testnet version of the Walrus CLI using a script from wal.app, specifying the 'testnet' flag. Ensure your PATH includes '$HOME/.local/bin'.

```bash
curl -sSf https://install.wal.app | sh -s -- -n testnet
```

--------------------------------

### CI/CD Setup for Walrus Sites with GitHub

Source: https://docs.wal.app/dev-guide/sui-struct

This section details how to set up Continuous Integration and Continuous Deployment (CI/CD) pipelines for Walrus Sites using GitHub Actions. It covers configuring GitHub secrets and creating workflow files.

```yaml
name: Deploy Walrus Site

on: [push]

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v3
    - name: Build and Deploy Site
      run: |
        npm install -g @walrus/site-builder
        walrus-site publish --target staging
```

--------------------------------

### Aggregator HTTP GET Endpoint

Source: https://docs.wal.app/print

The aggregator service exposes a simple HTTP GET endpoint for users to retrieve reconstructed blobs. This functionality is central to how users interact with the data stored on Walrus.

```HTTP
HTTP GET
```

--------------------------------

### Upload Relay Tip Configuration Example

Source: https://docs.wal.app/operator-guide/upload-relay

An example JSON structure for the tip configuration endpoint of the upload relay. It specifies the address to send tips to and the tipping mechanism, which can be a constant amount or linear with data size.

```json
{
  "send_tip": {
    "address": "0x1234...",
    "kind": {
      "const": 105
    }
  }
}
```

--------------------------------

### Creating GitHub Workflow for Walrus Site Deployment

Source: https://docs.wal.app/dev-guide/sui-struct

This section provides a template and explanation for creating a GitHub workflow file to automate the deployment of Walrus Sites. It outlines the steps, triggers, and jobs required for a successful CI/CD pipeline.

```yaml
name: Deploy Walrus Site

on:
  push:
    branches: [ main ]

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v3
    - name: Deploy to Walrus
      env:
        WALRUS_API_KEY: ${{ secrets.WALRUS_API_KEY }}
      run: walrus-site publish --token $WALRUS_API_KEY
```

--------------------------------

### Rust Example: Walrus Protocol Interaction

Source: https://docs.wal.app/blog/06_mainnet

This Rust code snippet demonstrates a basic interaction with the Walrus protocol, potentially involving publishing or retrieving data. It serves as an example for developers integrating Walrus into Rust applications.

```Rust
use walrus_client::Client;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new("http://localhost:8080");
    let file_content = std::fs::read("my_file.txt")?;
    let blob_id = client.publish(file_content).await?;
    println!("Published blob with ID: {}", blob_id);
    Ok(())
}
```

--------------------------------

### Minimal Site Builder Configuration File

Source: https://docs.wal.app/print

This example shows a minimal configuration file (`./sites-config.yaml`) for the site builder, specifying the essential `package` ID for Walrus Sites on Sui. The tool can also be pointed to a different config file using the `--config` flag.

```yaml
package: "<sui_package_object_id>"
```

--------------------------------

### Example Wrapped Blob Smart Contract (Move)

Source: https://docs.wal.app/print

This snippet provides an example of a Move smart contract that implements a wrapped blob for use with the Walrus system. It demonstrates how to interact with Walrus objects within your own Sui smart contracts.

```Move
module examples::wrapped_blob {

    use sui::object::{Self, UID};
    use walrus::blob::{Self, Blob};

    struct WrappedBlob has key {
        id: UID,
        blob: Blob
    }

    public entry fun create_wrapped_blob(blob: Blob, காயின்: &mut Wallet) {
        let wrapped_blob = WrappedBlob {
            id: object::new( காயின்),
            blob: blob
        };
        sui::object::share_object(wrapped_blob);
    }
}
```

--------------------------------

### Walrus Client CLI Help

Source: https://docs.wal.app/usage/client-cli

Displays the help information for the Walrus client CLI, listing all available commands and their general usage. This is the primary way to interact with the Walrus network from the command line.

```Shell
walrus --help
```

--------------------------------

### Start Walrus Node Service and Monitor Logs

Source: https://docs.wal.app/print

Starts the Walrus node service after a restore operation and monitors its startup logs. The node will begin downloading and replaying events, which may take time to reach an 'Active' state.

```shell
sudo systemctl start walrus-node.service

# Monitor startup logs
sudo journalctl -u walrus-node.service -f
```

--------------------------------

### Creating GitHub Workflow for CI/CD

Source: https://docs.wal.app/blog/00_intro

This section provides guidance on creating GitHub Actions workflows to automate the build, test, and deployment processes for Walrus Sites.

```Rust
# Example GitHub Actions workflow file (.github/workflows/ci.yml)
# This workflow builds and tests a Walrus Site on every push.

# name: CI for Walrus Site
# 
# on: [push, pull_request]
# 
# jobs:
#   build-and-test:
#     runs-on: ubuntu-latest
#     steps:
#     - name: Checkout code
#       uses: actions/checkout@v3
#     - name: Set up Node.js (if site uses Node.js)
#       uses: actions/setup-node@v3
#       with:
#         node-version: '18'
#     - name: Install dependencies
#       run: npm install # Or yarn install, etc.
#     - name: Build Site
#       run: npm run build # Or your site build command
#     - name: Run Tests
#       run: npm test # Or your site test command

```

--------------------------------

### JavaScript Example for Walrus HTTP API Blob Upload/Download

Source: https://docs.wal.app/usage/examples

A JavaScript example is provided to showcase uploading and downloading blobs using the Walrus HTTP API through a web form. This demonstrates client-side interaction with Walrus for basic data transfer operations.

```JavaScript
// Example showing how to upload and download a blob via HTTP API using a web form
```

--------------------------------

### Publish a Walrus Site

Source: https://docs.wal.app/design/overview

This section provides instructions on how to publish a Walrus Site. It covers the necessary steps and commands to deploy a site using the Walrus platform.

```Light
walrus-site publish --site-path ./my-site --network mainnet
```

--------------------------------

### Move Contracts and Example for Walrus On-Chain Interaction

Source: https://docs.wal.app/usage/examples

This snippet focuses on interacting with Walrus on-chain objects using the Move programming language. It includes the currently deployed Walrus contracts and a simple example contract that utilizes these Walrus objects for more complex application development.

```Move
// Deployed Walrus contracts
// Simple example contract importing and using Walrus objects
```

--------------------------------

### Store Quilt API Response Example

Source: https://docs.wal.app/usage/web-api

An example JSON response from the store quilt API, detailing the result of storing a quilt. It includes information about newly created blobs, their IDs, storage details, costs, and identifiers for individual blobs within the quilt.

```json
{
  "blobStoreResult": {
    "newlyCreated": {
      "blobObject": {
        "id": "0xe6ac1e1ac08a603aef73a34328b0b623ffba6be6586e159a1d79c5ef0357bc02",
        "registeredEpoch": 103,
        "blobId": "6XUOE-Q5-nAXHRifN6n9nomVDtHZQbGuAkW3PjlBuKo",
        "size": 1782224,
        "encodingType": "RS2",
        "certifiedEpoch": null,
        "storage": {
          "id": "0xbc8ff9b4071927689d59468f887f94a4a503d9c6c5ef4c4d97fcb475a257758f",
          "startEpoch": 103,
          "endEpoch": 104,
          "storageSize": 72040000
        },
        "deletable": false
      },
      "resourceOperation": {
        "registerFromScratch": {
          "encodedLength": 72040000,
          "epochsAhead": 1
        }
      },
      "cost": 12075000
    }
  },
  "storedQuiltBlobs": [
    {
      "identifier": "another_walrus.jpg",
      "quiltPatchId": "6XUOE-Q5-nAXHRifN6n9nomVDtHZQbGuAkW3PjlBuKoBAQDQAA"
    },
    {
      "identifier": "walrus.jpg",
      "quiltPatchId": "6XUOE-Q5-nAXHRifN6n9nomVDtHZQbGuAkW3PjlBuKoB0AB7Ag"
    }
  ]
}
```

--------------------------------

### Get Blob Attributes

Source: https://docs.wal.app/usage/client-cli

Retrieves all attributes associated with a given blob object ID.

```bash
walrus get-blob-attribute <BLOB_OBJ_ID>
```

--------------------------------

### Operating a Storage Node

Source: https://docs.wal.app/operator-guide/operator-guide

Information on running a storage node, including aspects of commission, governance, and backup/restore procedures.

```Rust
// Placeholder for Rust code related to operating a storage node
```

--------------------------------

### Authenticated Publisher Setup for Walrus

Source: https://docs.wal.app/operator-guide/auth-publisher

This section describes the setup for an authenticated publisher in Walrus, which requires JWT authentication for HTTP requests to store blobs. It outlines the steps for the publisher operator to configure JWT authentication, including setting the algorithm, expiration time, and secret. It also details the client's role in obtaining and using JWT tokens for authorized storage operations.

```http
PUT /<blob_path> HTTP/1.1
Host: <publisher_host>
Authorization: Bearer <JWT_TOKEN>
Content-Type: application/octet-stream

<blob_data>
```

--------------------------------

### Publish New Walrus Site

Source: https://docs.wal.app/print

The `publish` command is used to create a new Walrus Site on Sui. It takes a directory as input and publishes the contained resources. The `--epochs` flag specifies the storage duration, and `--list-directory` can be used for sites without an `index.html`.

```bash
site-builder publish [OPTIONS] --epochs <EPOCHS> <DIRECTORY>
```
Tokens:
Raw