# @cetusprotocol/xcetus-sdk

### xCETUS Overview

**Platform equity tokens** are non-circulating currencies and cannot be transferred by default.  These tokens are recorded in the user's **veNFT** account as points.

#### How to Obtain xCETUS

1. **Convert 1 CETUS to 1 xCETUS Mint.**
2. **LP NFT lock-up mining rewards** released.

#### Transfer of xCETUS

* xCETUS can be transferred under certain conditions.
* To prevent special circumstances, only the platform has the permission to transfer xCETUS.

***

### veNFT Overview

**veNFT** stores xCETUS in a **non-transferable** form under the user account.

#### Benefits of Holding xCETUS

* Holding xCETUS allows participation in **Cetus reward dividends**.
* Dividends are distributed based on the proportion of xCETUS in the wallet's veNFT account relative to the total xCETUS in the market.

### Getting Started

### How to Use the Burn SDK ?

### Installation

To start using the `xcetus SDK`, first,  you need to install it in your TypeScript project:

Github Link: <https://github.com/CetusProtocol/xcetus-sdk>

NPM Link: [@cetusprotocol/xcetus-sdk](https://www.npmjs.com/package/@cetusprotocol/xcetus-sdk)

```bash
npm install @cetusprotocol/xcetus-sdk
```

#### Setup

Import the SDK into the TypeScript file where you intend to use it:

```typescript
import { CetusXcetusSDK } from '@cetusprotocol/xcetus-sdk'
```

#### Initializing the SDK

Initialize the SDK with the required configuration parameters. This typically includes setting up the network and API keys, if needed.

If you would like to use the mainnet network and the official Sui rpc url, you can do so as follows:

```typescript
const sdk = CetusXcetusSDK.createSDK()
```

If you wish to set your own full node URL or network (You have the option to select either 'mainnet' or 'testnet' for the network),  you can do so as follows:

```typescript
const env = 'mainnet'
const full_rpc_url = 'YOUR_FULL_NODE_URL'
const wallet = 'YOUR_WALLET_ADDRESS'

const sdk = CetusXcetusSDK.createSDK({ env })
```

If you wish to set your own full node URL or SuiClient, you can do so as follows:

```typescript
const sdk = CetusXcetusSDK.createSDK({ env, sui_client })
// or
const sdk = CetusXcetusSDK.createSDK({ env, full_rpc_url })
```

### Usage

After linking your wallet, if you need use your wallet address to do something,  you should set it by `sdk.setSenderAddress`.

```typescript
const wallet = 'YOUR_WALLET_ADDRESS'
sdk.setSenderAddress(wallet)
```

###


---

# 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://cetus-1.gitbook.io/cetus-developer-docs/developer/via-sdk-v2/sdk-modules/cetusprotocol-xcetus-sdk.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.