### Build and Start Documentation (Docusaurus)

Source: https://github.com/hackdays-io/toban/blob/main/README.md

Commands to build the static documentation site and start a local development server for previewing changes.

```bash
pnpm document build
```

```bash
pnpm document start
```

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

### Project Installation

Source: https://github.com/hackdays-io/toban/blob/main/README.md

Installs all project dependencies using pnpm, a package manager. This command should be run after cloning the repository and setting up environment variables.

```bash
pnpm install
```

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

### Toban CLI Setup and Build

Source: https://github.com/hackdays-io/toban/blob/main/pkgs/cli/README.md

Commands to install dependencies, build the CLI tool, and link it globally for development.

```bash
yarn
```

```bash
yarn cli build
```

```bash
yarn cli link
```

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

### Start Remix Development Server

Source: https://github.com/hackdays-io/toban/blob/main/pkgs/frontend/README.md

Executes the command to start the Remix development server. This command is typically used during the development phase to enable hot-reloading and easy testing.

```shellscript
npm run dev
```

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

### Install Project Dependencies

Source: https://github.com/hackdays-io/toban/blob/main/pkgs/subgraph/README.md

Installs all necessary project dependencies using Yarn. This command must be run before any other build or deployment steps.

```bash
yarn install
```

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

### Install Dependencies

Source: https://github.com/hackdays-io/toban/blob/main/pkgs/document/README.md

Installs project dependencies using Yarn. This is typically the first step after cloning the repository.

```bash
$ yarn
```

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

### Frontend Build and Development

Source: https://github.com/hackdays-io/toban/blob/main/README.md

Commands to build the frontend application for production and start a local development server for real-time updates.

```bash
pnpm frontend build
```

```bash
pnpm frontend dev
```

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

### Toban CLI Command Examples

Source: https://github.com/hackdays-io/toban/blob/main/pkgs/cli/README.md

Examples demonstrating the usage of specific Toban CLI commands for managing functions and hats.

```bash
yarn cli toban function show -t test
```

```bash
yarn cli toban hats list --treeId 163
```

```bash
yarn cli toban hats wears --hatId 0x000000a300010002000100000000000000000000000000000000000000000000
```

```bash
yarn cli toban hats wear --address 0xfedfa388151b6f8d5901f5482564988ed87b64f1
```

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

### Build Remix App for Production

Source: https://github.com/hackdays-io/toban/blob/main/pkgs/frontend/README.md

Builds the Remix application for production deployment. This command generates optimized static assets and server code.

```bash
npm run build
```

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

### Start Local Development Server

Source: https://github.com/hackdays-io/toban/blob/main/pkgs/document/README.md

Starts a local development server for Docusaurus. Changes are reflected live without server restart. Opens the site in a browser.

```bash
$ yarn start
```

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

### Smart Contract Environment Variables Setup

Source: https://github.com/hackdays-io/toban/blob/main/README.md

Configuration for the smart contract development environment. These variables are used for private keys, API keys, and contract addresses during development and deployment.

```txt
PRIVATE_KEY=""
ETHERSCAN_API_KEY=""
ALCHEMY_API_KEY=""
GAS_REPORT=
COINMARKETCAP_API_KEY=""
HATS_ADDRESS=""
HATS_MODULE_FACTORY_ADDRESS=""
PULL_SPLITS_FACTORY_ADDRESS=""
```

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

### Run Remix App in Production Mode

Source: https://github.com/hackdays-io/toban/blob/main/pkgs/frontend/README.md

Starts the Remix application in production mode after it has been built. This command is used to run the compiled application on a server.

```bash
npm start
```

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

### Frontend Environment Variables Setup

Source: https://github.com/hackdays-io/toban/blob/main/README.md

Configuration for the frontend application's environment variables. These settings are crucial for connecting to blockchain networks and external services.

```txt
VITE_CHAIN_ID=11155111
VITE_PRIVY_APP_ID=
VITE_BIGBANG_ADDRESS=0x08B4c53b98f46B14E2AD00189C2Aa3b9F3d0c8f3
VITE_HATS_ADDRESS=0x3bc1A0Ad72417f2d411118085256fC53CBdDd137
VITE_FRACTION_TOKEN_ADDRESS=0xd921517fdF141d97C289bDb9686f51A1375dCc69
VITE_SPLITS_CREATOR_ADDRESS=0x6b5d2e27ff74e9adf4d23aebb9efb52867823583
VITE_PIMLICO_API_KEY=

// You need to get pinata jwt, gateway domain and gateway token by yourself.
VITE_PINATA_JWT=
VITE_PINATA_GATEWAY=
VITE_PINATA_GATEWAY_TOKEN=

VITE_NAMESTONE_API_KEY=
VITE_GOLDSKY_GRAPHQL_ENDPOINT=
VITE_ALCHEMY_KEY=
```

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

### Hardhat Tasks

Source: https://github.com/hackdays-io/toban/blob/main/pkgs/contract/README.md

Demonstrates common Hardhat tasks like getting help, running tests, and deploying contracts using Hardhat Ignition. These commands are executed via npx.

```shell
npx hardhat help
npx hardhat test
REPORT_GAS=true npx hardhat test
npx hardhat node
npx hardhat ignition deploy ./ignition/modules/Lock.ts
```

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

### Toban CLI Basic Usage

Source: https://github.com/hackdays-io/toban/blob/main/pkgs/cli/README.md

Example of how to invoke the Toban CLI tool and access its help information.

```bash
yarn cli toban function --help
```

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

### Subgraph Management

Source: https://github.com/hackdays-io/toban/blob/main/README.md

Commands for interacting with Goldsky subgraph deployments, including logging in, preparing, codegen, building, and deploying to the Sepolia network.

```bash
goldsky login
```

```bash
pnpm subgraph prepare:sepolia
```

```bash
pnpm subgraph codegen
```

```bash
pnpm subgraph build
```

```bash
pnpm subgraph deploy:sepolia
```

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

### Smart Contract Operations

Source: https://github.com/hackdays-io/toban/blob/main/README.md

A suite of commands for managing smart contracts, including compilation, testing, coverage analysis, cleaning build artifacts, and various deployment and interaction tasks.

```bash
pnpm contract compile
```

```bash
pnpm contract test
```

```bash
pnpm contract coverage
```

```bash
pnpm contract clean
```

```bash
pnpm contract getBalance --network sepolia
```

```bash
pnpm contract getChainInfo --network sepolia
```

```bash
pnpm contract deploy:Lock --network sepolia
```

```bash
pnpm contract deploy:Lock --verify --network sepolia
```

```bash
pnpm contract deploy:all --network sepolia
```

```bash
pnpm contract upgrade:BigBang --network sepolia
```

```bash
pnpm contract upgrade:FractionToken --network sepolia
```

```bash
pnpm contract getContractAddress --contract Lock --network sepolia
```

```bash
pnpm contract registerSubdomain --label <your label> --network sepolia
```

```bash
pnpm contract bigbang --owner 0x51908F598A5e0d8F1A3bAbFa6DF76F9704daD072 --tophatdetails "tophatDetails" --tophatimageuri "tophatURI" --hatterhatdetails "hatterhatURI" --hatterhatimageuri "tophatDetails" --forwarder 0x51908F598A5e0d8F1A3bAbFa6DF76F9704daD072 --network sepolia
```

```bash
pnpm contract getWoreTime --wearer 0x51908F598A5e0d8F1A3bAbFa6DF76F9704daD072 --network sepolia
```

```bash
pnpm contract mintHat --hatid 17011726346972053710434886519909386955065038130623101235576378067255296 --wearer 0x1295BDc0C102EB105dC0198fdC193588fe66A1e4 --network sepolia
```

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

### Authenticate Goldsky CLI

Source: https://github.com/hackdays-io/toban/blob/main/pkgs/subgraph/README.md

Logs the user into the Goldsky command-line interface. This is a required step for authenticating deployments to Goldsky.

```ssh
goldsky login
```

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

### Deploy Toban Subgraph

Source: https://github.com/hackdays-io/toban/blob/main/pkgs/subgraph/README.md

Executes the build and deployment process for the Toban Subgraph to a specified network. Replace `<network>` with the target network identifier (e.g., 'mainnet', 'goerli'). Note: Existing subgraphs may need to be deleted before deploying a new version.

```bash
yarn prepare:<network>
yarn codegen
yarn build
yarn deploy:<network>
```

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

### Toban CLI Help Output

Source: https://github.com/hackdays-io/toban/blob/main/pkgs/cli/README.md

Detailed help information for the Toban CLI, listing global options and available commands.

```APIDOC
Toban CLI Tool:
  This is a CLI tool for toban project

Options:
  -V, --version        output the version number
  -h, --help           display help for command

Commands:
  list                 List all shifts
  add <date> <person>  Add a new shift
  random               Pick a random person for the shift
  show [options]       Show the arguments
  help [command]       display help for command
```

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

### Deploy Website (SSH)

Source: https://github.com/hackdays-io/toban/blob/main/pkgs/document/README.md

Deploys the website using SSH. This command builds the site and pushes it to the 'gh-pages' branch, suitable for GitHub Pages hosting.

```bash
$ USE_SSH=true yarn deploy
```

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

### Build Static Website

Source: https://github.com/hackdays-io/toban/blob/main/pkgs/document/README.md

Generates the static content for the website into the 'build' directory. This output can be hosted on any static hosting service.

```bash
$ yarn build
```

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

### Deploy Website (No SSH)

Source: https://github.com/hackdays-io/toban/blob/main/pkgs/document/README.md

Deploys the website without using SSH, requiring a GitHub username. This command builds the site and pushes it to the 'gh-pages' branch.

```bash
$ GIT_USER=<Your GitHub username> yarn deploy
```

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

### Toban CLI Hats Commands

Source: https://github.com/hackdays-io/toban/blob/main/pkgs/cli/README.md

API documentation for Toban CLI commands related to managing hats. This includes listing hats by tree ID, retrieving wearers by hat ID, and fetching hat information by address.

```APIDOC
Toban Hats Commands:

list --treeId <treeId>
  Retrieves a list of hats associated with a specific tree ID.
  Parameters:
    --treeId: The ID of the tree to filter hats by.

wears --hatId <hatId>
  Retrieves a list of all wearer wallet addresses associated with a specific hat ID.
  Parameters:
    --hatId: The ID of the hat to retrieve wearer addresses for.

wear --address <address>
  Retrieves all hat information associated with a specific wallet address.
  Parameters:
    --address: The wallet address to query for associated hats.
```

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

### Toban Project Build Configuration

Source: https://github.com/hackdays-io/toban/blob/main/pkgs/contract/gas-report.txt

Details the Solidity compiler version, optimizer status, and gas limits used for the Toban project's smart contracts. This configuration impacts gas efficiency and deployment constraints.

```APIDOC
Project: /hackdays-io/toban

Build Configuration:
  Solc version: 0.8.24
  Optimizer enabled: false
  Runs: 200
  Block limit: 30000000 gas
```

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

### Toban Contract Deployment Gas Usage

Source: https://github.com/hackdays-io/toban/blob/main/pkgs/contract/gas-report.txt

Presents gas usage statistics for individual smart contract deployments. It includes minimum, maximum, and average gas consumed per call, along with the percentage of the block limit utilized and call counts. This data helps identify gas-intensive operations.

```APIDOC
Contract Deployments Gas Analysis:

| Contract Name       | Min Gas   | Max Gas   | Avg Gas   | # calls | % of limit | usd (avg) |
|---------------------|-----------|-----------|-----------|---------|------------|-----------|
| BigBang             | -         | -         | 1248128   | 4.2 %   | -          |
| FractionToken       | -         | -         | 3131808   | 10.4 %  | -          |
| Hats                | -         | -         | 7032431   | 23.4 %  | -          |
| HatsModule          | -         | -         | 754132    | 2.5 %   | -          |
| HatsModuleFactory   | -         | -         | 1101122   | 3.7 %   | -          |
| HatsTimeFrameModule | -         | -         | 1287099   | 4.3 %   | -          |
| PullSplitFactory    | 4535815   | 4535827   | 4535825   | 15.1 %  | -          |
| PushSplitFactory    | 4483101   | 4483113   | 4483111   | 14.9 %  | -          |
| SplitsCreator       | -         | -         | 1487532   | 5 %     | -          |
| SplitsCreatorFactory| -         | -         | 526836    | 1.8 %   | -          |
| SplitsWarehouse     | -         | -         | 3934655   | 13.1 %  | -          |
```

=== COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.