> For the complete documentation index, see [llms.txt](https://boney-1.gitbook.io/boney-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://boney-1.gitbook.io/boney-docs/readme.md).

# About Boney

## Boney

An Overview of the boney protocol and how it powers Boneyyard.

## Overview

**Boney is a marketplace protocol for hosting marketing campaigns in Web3.**

Boney is currently being developed by the Boneyyard team and is in the beta-testing phase.

Boney powers the [boneyyard website](https://boneyyard.xyz/); all campaigns on Boneyyard from creation to settlements uses the boney protocol.

## How Does it Work?

Each boney campaign begins with a project locking a reward pool in boney's escrow vault, declares what counts as progress (KPIs), and the vault pays promoters automatically as verified, attributed progress crosses preset thresholds.

Nobody needs to approve a payout, no manual reviews, no trust-me-bro.

### Why Boney?

Web3 growth deals are settled on trust and screenshots. Boney replaces each point of trust with a trustless mechanism:

| Instead of                                         | Boney uses                                                                                          |
| -------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
| Paying upfront for promises                        | Escrow that releases only against verified progress                                                 |
| Metrics reported by the party being judged on them | Cumulative on-chain reports, capped at an independent observer's reading                            |
| Claimed attribution                                | Attribution the end user signs, which expires                                                       |
| Waiting on manual approval                         | Auto-settlement, in the same transaction as the report as predefined reward thresholds are cleared. |

### The problem it solves

Off-chain growth deals fail in predictable ways:

* **No accountability** — off-chain metrics are trivially manipulated.
* **Upfront payment** — projects pay for promises, not outcomes.
* **Opaque settlement** — promoters wait on manual approval and goodwill.
* **Identity leakage** — qualifying for a deal usually means handing over social accounts.
* **Sybil risk** — bot traffic and fake accounts inflate every off-chain number.

Boney replaces the trust with escrow, on-chain verification, and consent-based attribution.

### Design principles

| Principle                             | How it shows up in the code                                         |
| ------------------------------------- | ------------------------------------------------------------------- |
| Escrow by default                     | `EscrowVault` holds the full pool before a campaign can activate    |
| Minimize trust                        | The vault has no business logic; the facade has no privileged role  |
| Immutability where funds are at stake | Campaign config, KPIs and tiers are frozen at deployment            |
| Fail open, not closed, on exhaustion  | A tier that outruns the pool pays partial and emits `PoolExhausted` |
| Consent as the anti-abuse primitive   | Attribution requires an end-user EIP-712 signature                  |
| Progressive decentralization          | k-of-n attestations and staked oracle reporting from day one        |
| Composability                         | Modules are separately deployed and independently callable          |

### How to read these docs

* New here? Start with [The core loop](https://boney-1.gitbook.io/boney-docs/overview/the-core-loop.md), then [Architecture](https://boney-1.gitbook.io/boney-docs/overview/architecture.md).
* Running a campaign or promoting one? See [Getting started](https://boney-1.gitbook.io/boney-docs/getting-started/for-projects.md).
* Integrating or auditing the contracts? The [Protocol](https://boney-1.gitbook.io/boney-docs/protocol/overview.md) section documents each module, and [Reference](https://boney-1.gitbook.io/boney-docs/reference/contracts.md) collects addresses, constants, events and errors.
* Operating the off-chain stack? See [Off-chain infrastructure](https://boney-1.gitbook.io/boney-docs/off-chain-infrastructure/overview.md).

> **The contracts are not audited.**


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://boney-1.gitbook.io/boney-docs/readme.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
