> For the complete documentation index, see [llms.txt](https://docs.bloxchain.app/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.bloxchain.app/resources/releases.md).

# Releases

Public compatibility between this documentation site, the open-source Protocol, npm packages, and **bloxchain.app**.

**Production:** Pin deployed contracts and npm packages to the same tagged [Protocol release](https://github.com/PracticalParticle/Bloxchain-Protocol/releases). See [Production readiness](/developers/production-readiness.md).

## bloxchain.app

* Hosted at [bloxchain.app](https://bloxchain.app)
* Current public scope: [Platform overview — product scope](/platform-bloxchain.app/start.md#product-scope-current-release)
* UI sidebar: **Workspace** (Overview, My access, Assets, Transactions), **Deployment** (Operations, Roles, Members, Execution ports, Security), **Allowlists** (Recipients, Payees, Contract targets), **Help & setup**
* Future features: [Roadmap](/resources/roadmap.md)

## Protocol and SDK (open source)

**Source of truth for versions** is the Protocol repository.

| What you need    | Where to look                                                                                                                                        |
| ---------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
| Package version  | [package.json](https://github.com/PracticalParticle/Bloxchain-Protocol/blob/99beac2d6e6d7567c23b25cecaf6f4053f31c987/package.json) at pinned release |
| Release notes    | [GitHub releases](https://github.com/PracticalParticle/Bloxchain-Protocol/releases)                                                                  |
| Solidity version | README / `foundry.toml` in the repo                                                                                                                  |
| License          | MPL-2.0                                                                                                                                              |
| Audit status     | [Audit status](/security/audit-status.md)                                                                                                            |

### npm packages (integrators)

```bash
npm install @bloxchain/sdk @bloxchain/contracts viem
```

| Package                | Role                                                    |
| ---------------------- | ------------------------------------------------------- |
| `@bloxchain/sdk`       | TypeScript clients, meta-tx helpers, EngineBlox mirrors |
| `@bloxchain/contracts` | ABIs and artifacts aligned with the Protocol release    |

Pin SDK and contracts to the same release you deploy. See [Installation](/getting-started/installation.md).

SDK and Protocol reference on this site: [Protocol getting started](/protocol/getting-started.md) · [API reference](/protocol/api-reference.md). Pin matches [protocol documentation pin](#protocol-documentation-pin).

## Documentation site

* Source: [bloxchain-docs](https://github.com/PracticalParticle/bloxchain-docs) (GitBook Git Sync)
* **Platform** guides authored here; **Protocol** pages vendored from Bloxchain-Protocol

### Protocol documentation pin

| Field       | Value                                                                                 |
| ----------- | ------------------------------------------------------------------------------------- |
| Import path | `_import/protocol-docs/` (repo only — not a public page)                              |
| Upstream    | `https://github.com/PracticalParticle/Bloxchain-Protocol.git`                         |
| Advance pin | `./scripts/sync-protocol-docs.sh <tag-or-commit>` then commit `_import/protocol-docs` |

See `_import/PROTOCOL_PIN.md` in the repository for the pinned commit SHA.

## Changelog

Documentation and product notes: [Changelog](/resources/changelog.md).


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.bloxchain.app/resources/releases.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.