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

# SDK

Planned JavaScript/TypeScript SDK for Dominium.

JavaScript/TypeScript SDK (planned).

***

{% hint style="warning" %}
**Under construction.** Dominium is currently in development.

These docs describe our vision and planned functionality.

Follow [@dominiumxyz](https://twitter.com/dominiumxyz) for official announcements.
{% endhint %}

***

### Installation

```bash
# npm
npm install @dominium/sdk

# yarn
yarn add @dominium/sdk
```

### Initialize client

```typescript
import { Dominium } from '@dominium/sdk';

const dominium = new Dominium({
  signer,
  network: 'mainnet'
});
```

### Basic operations

```typescript
// Register IP
const ip = await dominium.ip.register({
  name: "My Character",
  type: "CHARACTER",
  contentHash: "ipfs://Qm...",
  terms: {
    commercialUse: true,
    baseLicenseFee: parseUnits("100", 6)
  }
});

// Acquire license
const license = await dominium.license.acquire({
  ipAssetId: ip.tokenId,
  licenseType: "commercial"
});

// Check license validity
const isValid = await dominium.license.verify(license.tokenId);
```