> 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/getting-started/installation.md).

# Installation

Use this guide when you add `@bloxchain/sdk` to a TypeScript project.

**Time:** \~10 min

## Prerequisites

* Node.js 18+
* npm or yarn
* RPC access to your target network
* A wallet or key for writes (never commit secrets)

## Install

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

| Package                | Purpose                                                    |
| ---------------------- | ---------------------------------------------------------- |
| `@bloxchain/sdk`       | TypeScript wrappers, meta-tx helpers, EngineBlox utilities |
| `@bloxchain/contracts` | ABIs and artifacts aligned with the Protocol release       |
| `viem`                 | Ethereum clients (`PublicClient`, `WalletClient`)          |

Pin SDK and contracts to the same [Protocol release on GitHub](https://github.com/PracticalParticle/Bloxchain-Protocol/releases) you deploy on-chain. See [Releases and compatibility](/resources/releases.md).

## Environment variables

```bash
RPC_URL=https://...
PRIVATE_KEY=0x...   # development only; use a secure secret store in production
ACCOUNT_ADDRESS=0x...  # your AccountBlox (or clone) address
```

## Security assurance

Pin `@bloxchain/sdk` and `@bloxchain/contracts` to the same [Protocol release](https://github.com/PracticalParticle/Bloxchain-Protocol/releases) you deploy on-chain. The Protocol has completed third-party security audit for the published audited scope. See [Production readiness](/developers/production-readiness.md) and [Audit status](/security/audit-status.md).

## Next step

[Quickstart](/getting-started/quickstart.md), then:

* [Protocol getting started](/protocol/getting-started.md)
* [API reference](/protocol/api-reference.md)

## See also

* [Authentication](/developers/sdk-authentication.md)
* [API reference](/protocol/api-reference.md)
* [Protocol specification](/protocol/protocol.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/getting-started/installation.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.