# Installation

## Installation

### Prerequisites

Before installing the Ferra Aggregator SDK, ensure you have the following:

* **Node.js**: Version 16.x or higher
* **npm** or **yarn**: Package manager
* **TypeScript**: Version 4.5 or higher (recommended)

### Package Installation

#### Using npm

```bash
npm install @ferra-labs/aggregator
```

#### Using yarn

```bash
yarn add @ferra-labs/aggregator
```

#### Using pnpm

```bash
pnpm add @ferra-labs/aggregator
```

### Peer Dependencies

The SDK requires several peer dependencies for Sui blockchain interaction:

```bash
npm install @mysten/sui @mysten/sui/transactions @mysten/sui/client
```

#### Complete Installation Command

```bash
# Install SDK and all required dependencies
npm install @ferra-labs/aggregator @mysten/sui @mysten/sui/transactions @mysten/sui/client
```

### Development Dependencies

For development and testing, you may also want to install:

```bash
npm install --save-dev typescript @types/node
```

### Verification

Verify your installation by creating a simple test file:

```typescript
// test-installation.ts
import { initFerraAggregatorSDK } from '@ferra-labs/aggregator'

const useAggreratorFerraSdk = (address: string) => {
  return useMemo(
    () =>
      initFerraAggregatorSDK({
        network: NETWORK,
        fullNodeUrl: FULL_NODE_URL,
        wallet: address,
      }),
    [address]
  );
};
console.log('Ferra SDK initialized successfully!')
```

### Version Compatibility

| SDK Version | Node.js | TypeScript | Sui SDK |
| ----------- | ------- | ---------- | ------- |
| 1.x.x       | ≥16.0   | ≥4.5       | ≥1.0    |

### Next Steps

Once installed, proceed to the [Quick Start](/integration/aggregator-internal-deprecated/typescript-sdk/quick-start.md) guide to initialize your first SDK instance and execute your first swap.


---

# Agent Instructions: 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:

```
GET https://docs.ferra.ag/integration/aggregator-internal-deprecated/typescript-sdk/installation.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.