# FlowGuard

## Docs

- [Airdrops API](https://docs.flowguard.cash/api/airdrops.md): Current endpoints for creating, funding, claiming, pausing, and cancelling FlowGuard airdrop campaigns.
- [Bounties API](https://docs.flowguard.cash/api/bounties.md): Endpoints for creating, funding, paying winners, pausing, and cancelling bounty contracts.
- [Budgets API](https://docs.flowguard.cash/api/budgets.md): Endpoints for milestone-based grant disbursement contracts linked to a vault.
- [Executor API](https://docs.flowguard.cash/api/executor.md): Automation worker scope and current operational status.
- [Explorer API](https://docs.flowguard.cash/api/explorer.md): Endpoints for querying cross-product activity feeds and global stats.
- [Governance API](https://docs.flowguard.cash/api/governance.md): Endpoints for on-chain token-weighted governance proposals, vote locking, and token unlocking.
- [Grants API](https://docs.flowguard.cash/api/grants.md): Endpoints for milestone-based grant lifecycles: create, fund, release, pause, cancel, transfer.
- [Indexer API](https://docs.flowguard.cash/api/indexer.md): Operator-facing indexer health routes and how they fit into the backend deployment.
- [API Overview](https://docs.flowguard.cash/api/overview.md): Base URL, authentication, and common response patterns for the FlowGuard backend API.
- [Payments API](https://docs.flowguard.cash/api/payments.md): Endpoints for creating and managing recurring payment contracts with configurable intervals.
- [Proposals API](https://docs.flowguard.cash/api/proposals.md): Current endpoints for treasury payout proposals, on-chain proposal state, approvals, and execution sessions.
- [Public Endpoints](https://docs.flowguard.cash/api/public-endpoints.md): Unauthenticated, cacheable endpoints: BCH/USD price feed and system status.
- [Rewards API](https://docs.flowguard.cash/api/rewards.md): Endpoints for variable-amount reward campaigns: create, fund, distribute, pause, cancel.
- [Streams API](https://docs.flowguard.cash/api/streams.md): Current endpoints for stream templates, stream lifecycle actions, activity, treasury batch runs, and refillable recurring streams.
- [Vaults API](https://docs.flowguard.cash/api/vaults.md): Endpoints for creating, funding, and managing multi-sig treasury vaults.
- [Airdrops](https://docs.flowguard.cash/app/airdrops.md): How FlowGuard handles claim-based BCH and CashToken distributions in the app.
- [Bounties](https://docs.flowguard.cash/app/bounties.md): Fund a task with conditional release ,  pay out when the work is verified.
- [Explorer](https://docs.flowguard.cash/app/explorer.md): Browse all FlowGuard activity across streams, payments, airdrops, and treasury proposals.
- [Getting Started with FlowGuard](https://docs.flowguard.cash/app/getting-started.md): Connect your wallet, choose a workspace, and navigate FlowGuard's shared treasury and stream product surfaces.
- [Governance](https://docs.flowguard.cash/app/governance.md): How FlowGuard governance works in the app today, including vote locking and proposal review.
- [Grants](https://docs.flowguard.cash/app/grants.md): Milestone-based budget disbursement for funded projects and contractors.
- [Recurring Payments](https://docs.flowguard.cash/app/recurring-payments.md): How FlowGuard handles fixed-cadence payouts, including refillable recurring runway.
- [Rewards](https://docs.flowguard.cash/app/rewards.md): Issue one-time or recurring BCH or token rewards to contributors and community members.
- [Status](https://docs.flowguard.cash/app/status.md): Current network, service, and operational status for the public FlowGuard stack.
- [Vaults](https://docs.flowguard.cash/app/vaults.md): Create and manage multi-sig treasury vaults to fund FlowGuard products.
- [Vesting Streams](https://docs.flowguard.cash/app/vesting.md): How the shared FlowGuard stream product works across personal and organization workflows.
- [Stream shapes on Bitcoin Cash](https://docs.flowguard.cash/blog/stream-shapes-on-bitcoin-cash.md): A look at the seven schedule shapes FlowGuard ships and how each one maps to a real treasury workflow.
- [Airdrops](https://docs.flowguard.cash/concepts/airdrops.md): Fixed-amount, time-gated, self-service token distribution campaigns enforced on-chain.
- [Bounties](https://docs.flowguard.cash/concepts/bounties.md): How FlowGuard models bounty-style payouts in the current product.
- [CashTokens and Covenants](https://docs.flowguard.cash/concepts/cashtokens-covenants.md): How CashScript covenants and CashTokens NFT commitments enforce all FlowGuard state transitions without trusted intermediaries.
- [Executor Network](https://docs.flowguard.cash/concepts/executor-network.md): The optional operator layer that triggers permissionless covenant actions when the BCH model requires an external transaction builder.
- [Governance](https://docs.flowguard.cash/concepts/governance.md): On-chain proposal lifecycle with M-of-N approval counting and token-weighted vote locking.
- [Grants](https://docs.flowguard.cash/concepts/grants.md): How FlowGuard models milestone-based grant funding in the current product.
- [Protocol Overview](https://docs.flowguard.cash/concepts/overview.md): How FlowGuard uses BCH covenants and CashTokens to enforce treasury, stream, distribution, and governance logic on-chain.
- [Recurring Payments](https://docs.flowguard.cash/concepts/recurring-payments.md): How fixed-cadence payouts work in FlowGuard, including refillable recurring runway.
- [Rewards](https://docs.flowguard.cash/concepts/rewards.md): How FlowGuard handles reward-style payouts in the current product.
- [Stream Lifecycle](https://docs.flowguard.cash/concepts/stream-lifecycle.md): The shared status and flags model used across FlowGuard stream and payout covenants.
- [Supported Assets](https://docs.flowguard.cash/concepts/supported-assets.md): FlowGuard covenants support both BCH (satoshis) and any CashToken fungible token.
- [Vaults](https://docs.flowguard.cash/concepts/vaults.md): The primary treasury primitive in FlowGuard. Current vault contracts use a fixed three-signer design with period spending caps, recipient allowlists, and emergency lock.
- [Vesting and Stream Schedules](https://docs.flowguard.cash/concepts/vesting.md): The schedule families behind FlowGuard streams, how they differ, and which covenant family enforces each one.
- [Wallet options](https://docs.flowguard.cash/concepts/wallet-options.md): Supported wallets: Paytaca (extension and mobile), Cashonize, WalletConnect, WizardConnect (beta).
- [Claim an Airdrop](https://docs.flowguard.cash/guides/airdrops/claim.md): How to claim BCH or tokens from an active FlowGuard airdrop campaign.
- [Create an Airdrop](https://docs.flowguard.cash/guides/airdrops/create.md): Deploy an open or whitelist-gated airdrop campaign and fund it on-chain.
- [Manage an Airdrop](https://docs.flowguard.cash/guides/airdrops/manage.md): Pause or cancel an active airdrop campaign and monitor claims.
- [Claim a Bounty](https://docs.flowguard.cash/guides/bounties/claim.md): How a bounty recipient releases the funded payout after the lock period elapses.
- [Create a Bounty](https://docs.flowguard.cash/guides/bounties/create.md): Fund a task with a time-locked payout and optional cancellation window.
- [Deployment Addresses](https://docs.flowguard.cash/guides/deployment-addresses.md): How to verify FlowGuard deployment addresses and use the deployment registry.
- [Create a Proposal](https://docs.flowguard.cash/guides/governance/proposals.md): How to create and submit an on-chain governance proposal for a vault.
- [Reclaiming Locked Tokens](https://docs.flowguard.cash/guides/governance/reclaim.md): How to unlock voting tokens after a governance vote concludes.
- [Voting on Proposals](https://docs.flowguard.cash/guides/governance/voting.md): How to approve a governance proposal and co-sign the payout execution as a vault signer.
- [Create a Grant](https://docs.flowguard.cash/guides/grants/create.md): Set up a milestone-based budget plan to fund a contractor or project from a vault.
- [Grant Milestones](https://docs.flowguard.cash/guides/grants/milestones.md): How milestones work in FlowGuard grants and how recipients release them.
- [Local Environment](https://docs.flowguard.cash/guides/local-environment.md): Set up a local development environment with chipnet BCH and deploy your first FlowGuard covenant.
- [Cancel a Payment](https://docs.flowguard.cash/guides/recurring-payments/cancel.md): Cancel a recurring payment and recover the remaining pool.
- [Create a Recurring Payment](https://docs.flowguard.cash/guides/recurring-payments/create.md): Create a fixed-cadence payment or refillable recurring runway in FlowGuard.
- [Claim a Recurring Payment](https://docs.flowguard.cash/guides/recurring-payments/execute.md): How recurring payout collection works in the current FlowGuard app.
- [Pause and Resume](https://docs.flowguard.cash/guides/recurring-payments/pause-resume.md): Pause and resume a recurring payment stream as the sender.
- [Create a Reward](https://docs.flowguard.cash/guides/rewards/create.md): Issue an immediate or time-locked reward to a specific BCH address.
- [Issue Rewards](https://docs.flowguard.cash/guides/rewards/issue.md): How recipients see and claim their rewards in the FlowGuard app.
- [Create a Vault](https://docs.flowguard.cash/guides/vaults/create.md): Deploy a new M-of-N treasury vault with spending caps and optional recipient allowlists.
- [Emergency Lock](https://docs.flowguard.cash/guides/vaults/emergency-lock.md): How to trigger a full vault lockdown requiring all registered signers.
- [Fund a Vault](https://docs.flowguard.cash/guides/vaults/fund.md): Deposit BCH or CashTokens into an existing vault UTXO.
- [Spending Proposals](https://docs.flowguard.cash/guides/vaults/proposals.md): Create, approve, and execute vault spending proposals using M-of-N signer coordination.
- [Batch Create Streams](https://docs.flowguard.cash/guides/vesting/batch-create.md): Create and fund multiple streams from one treasury run using FlowGuard's batch builder.
- [Cancel a Stream](https://docs.flowguard.cash/guides/vesting/cancel.md): How senders cancel a vesting stream and how the remaining balance is split at cancellation time.
- [Choose a Stream Shape](https://docs.flowguard.cash/guides/vesting/choose-shape.md): Understand the stream shape gallery, what each schedule family means, and when to use each one.
- [Claim Vested Tokens](https://docs.flowguard.cash/guides/vesting/claim.md): How a recipient claims their currently vested and unclaimed tokens from a vesting stream.
- [Create a Stream](https://docs.flowguard.cash/guides/vesting/create.md): Create a linear, hybrid, recurring, milestone, or tranche stream from the shared FlowGuard stream builder.
- [Pause and Resume](https://docs.flowguard.cash/guides/vesting/pause-resume.md): Pause and resume supported stream families from the sender workflow.
- [Transfer Stream Recipient Rights](https://docs.flowguard.cash/guides/vesting/transfer.md): How the current recipient transfers a transferable vesting stream to a new address.
- [Introduction](https://docs.flowguard.cash/introduction.md): A BCH-native covenant operating layer for treasuries, streams, distributions, and governance.
- [Access Control](https://docs.flowguard.cash/reference/access-control.md): Who can call what on each FlowGuard contract, with the role and permission matrix used by the system.
- [Architecture](https://docs.flowguard.cash/reference/architecture.md): How FlowGuard's contracts, backend services, indexer, executor, and frontend fit together.
- [AirdropCovenant](https://docs.flowguard.cash/reference/contracts/airdrop-covenant.md): Full parameter, function, and state reference for the AirdropCovenant contract.
- [BountyCovenant](https://docs.flowguard.cash/reference/contracts/bounty-covenant.md): Full parameter, function, and state reference for the BountyCovenant contract.
- [GrantCovenant](https://docs.flowguard.cash/reference/contracts/grant-covenant.md): Full parameter, function, and state reference for the GrantCovenant contract.
- [ProposalCovenant](https://docs.flowguard.cash/reference/contracts/proposal-covenant.md): Full parameter, function, and state reference for the ProposalCovenant contract.
- [RecurringPaymentCovenant](https://docs.flowguard.cash/reference/contracts/recurring-payment-covenant.md): Full parameter, function, and state reference for the RecurringPaymentCovenant contract.
- [RewardCovenant](https://docs.flowguard.cash/reference/contracts/reward-covenant.md): Full parameter, function, and state reference for the RewardCovenant contract.
- [VaultCovenant](https://docs.flowguard.cash/reference/contracts/vault-covenant.md): Complete technical reference for the VaultCovenant contract ,  parameters, functions, NFT state, and access control.
- [VestingCovenant](https://docs.flowguard.cash/reference/contracts/vesting-covenant.md): Full parameter, function, and state reference for the VestingCovenant contract.
- [VoteLockCovenant](https://docs.flowguard.cash/reference/contracts/vote-lock-covenant.md): Full parameter, function, and state reference for the VoteLockCovenant contract.
- [Error Reference](https://docs.flowguard.cash/reference/errors.md): Common API error codes and messages returned by the FlowGuard backend.
- [Shared Types](https://docs.flowguard.cash/reference/shared-types.md): TypeScript types shared across frontend, backend, indexer, executor, and contract tooling.
- [Roadmap](https://docs.flowguard.cash/roadmap.md): Product and protocol milestones for FlowGuard.
- [Security](https://docs.flowguard.cash/security.md): What FlowGuard enforces on chain, what depends on off-chain services, and where the trust boundaries are.

## OpenAPI Specs

- [openapi](https://docs.flowguard.cash/api-reference/openapi.json)

## Optional

- [GitHub](https://github.com/winsznx/flow-guard)
- [Farcaster](https://farcaster.xyz/flowguard)
- [Explorer](https://explorer.flowguard.cash)
- [YouTube](https://www.youtube.com/@flowguard_cash)