` with the required `id` attribute to your code:
```html
```
**Step 3: Initialize the Terminal**
Initialize the Suicoins Terminal with your custom parameters:
```html
```
***
####
React SDK Integration
**Step 1: Install the SDK**
Use one of the following package managers to add the SDK to your React project:
```bash
pnpm add @interest-protocol/sui-coins-terminal
# or
yarn add @interest-protocol/sui-coins-terminal
# or
npm install @interest-protocol/sui-coins-terminal
```
**Step 2: Import and Configure the Terminal Component**
Import the `SwapTerminal` component and configure it with the necessary parameters:
```jsx
import { SwapTerminal } from "@interest-protocol/sui-coins-terminal";
const Terminal = () => (
);
export default Terminal;
```
***
Visit [terminal.suicoins.com](https://terminal.suicoins.com/) to learn more and integrate the Suicoins Terminal into your platform.
For any questions or assistance, our team is here to helpâdonât hesitate to reach out.
***
# Memez.gg
MemeFi
###
MemeFi... what? Do you mean DeFi
MemeFi (Meme Coin + Finance) are DeFi applications designed specifically for meme coins. Meme coins have carved their presence in the web3 industry as a vehicle to grab attention, new users and build culture. We have seen social trends and memes spread world wide because of meme coins.
Dapps built for meme coins need to take into account their users are not afraid of risk, fees, high slippage nor volatility. They provide developers with the opportunity to explore new instruments as they are as constraint like in DeFi.
###
Ok, What is Memez.gg ?!
**Memez.gg** is an end to end protocol to launch, bootstrap liquidity and trade meme coins.
*
**Memez.Fun** is a virtual liquidity launchpad with three different distribution mechanisms to price meme coins and bootstrap liquidity.
*
**Memez.Dex** is an exchange designed to appreciate meme coins by implementing
**special mechanisms** that benefit buyers and discourage sellers.
> All Meme coins created on Memez use the [IPX Coin Standard](#user-content-fn-1)[^1]
###
Official Links
* [https://www.memez.gg](https://www.memez.gg/)
*
[^1]:
# Coins on Memez.GG
Step by step Guide of Coins on Memez.
The coin creation tool on [**Memez GG**](/overview/sui/memez.gg) allows users to generate their own custom tokens with a range of configurable options. This functionality enables individuals and projects to launch tokens tailored to their specific needs, whether for utility, governance, or community engagement.
### Configurable Features
When creating a coin, users define key attributes:
#### **Basic Information**
* **Coin Name** â Unique identifier for the token.
* **Ticker** â Short symbol (e.g., ROOT for Rootlets).
* **Description** â Brief summary of the tokenâs purpose.
* **Logo** â Custom image representing the coin.
#### **Supply Settings**
* **Total Supply** â Initial token amount (supports up to **9 decimal places**).
* **Maximum Supply** â Hard cap on total token supply.
#### **Advanced Features**
* **Burnable** â Tokens can be removed from circulation, with burn permissions configurable.
* **Mintable** â Allows the deployer to create additional tokens up to the **maximum supply**.
* **Editable Metadata** â Enables modifications to **name, ticker, description, and logo** after deployme
{% hint style="info" %}
This coin creation tool empowers users to design and launch tokens with flexibility while maintaining key security and governance controls. This tool uses the [IPX Coin Standard](https://docs.interestprotocol.com/overview/sui/ipx-coin-standard).
{% endhint %}
## Creating Coin on Memez GG
On the video below we have launched a token with all the functionalities mentioned above. Here are the details of the token created:
* Name: Kumo
* Ticker: Kumo
* Description: Kumo the cat
* Supply: 1,000,000
* Max Supply: 1000,000,000
* Functions enabled: Burnable, Mintable and Editable
đ„ *Watch the video for a step-by-step walkthrough.*
{% embed url="" %}
## Editing The Metadata
**After creating a coin with the Edit function enabled, you can update its metadata at any time. Now, let's rebrand the Kumo coin we created earlier** by updating the following details:
* **Name**: Rootlets
* **Ticker**: ROOT
* **Description**: âJust Root itâ
* **Image**: A Rootlet PFP
đ„ *Watch the video for the step-by-step walkthrough.*
{% embed url="" %}
And just like thatâwithin a few clicks, weâve successfully rebranded the entire coin!
## Managing Tokens: Burning & Minting
Now that you know how to create and change it's metadata, let's explore two important functionsâ**burning** and **minting** tokens. These actions allow you to manage the token supply dynamically.
Remember that when we created the token, we enabled the ability to **burn** and **mint** tokens, setting the initial supply to **1,000,000** and the max supply to **1,000,000,000**. This means you can perform burns and mints freely within the range of **0 to 1,000,000,000** tokens.
On the video below, we'll use the rebranded **Rootlets** token to demonstrate both processes. In this case we will first mint 100,000 tokens and then mint the same amount.
{% embed url="" %}
## Migrating a Coin from Suicoins to Memez GG
### Introduction
In this guide, we will walk through the process of migrating a coin created on Suicoins to Memez GG. This migration ensures that the coin follows the IPX Coin Standard, gaining key functionalities such as:
* Burning tokens
* Minting new tokens
* Editing metadata
By the end of this tutorial, your migrated coin will have all of these features.
### Prerequisites
{% hint style="info" %}
Before proceeding with the migration, ensure that:
* The deployer owns the treasury cap. Without it, migration is not possible.
* When creating a coin on Suicoins, you have chosen to **keep** the treasury cap. If it has been sent to a dead address, migration is **not** possible.
{% endhint %}
### Step 1: Creating a Coin on Suicoins
1. Navigate to Suicoins and click **Create Token**.
2. Fill in the token details. For this tutorial, we will use the following example:
* **Name**: Prime Machine
* **Ticker**: PRIME
* **Description**: Suii is the endgame and starts with Studio Mirai.
* **Image**: Prime Machine #2059
* **Supply**: 1 million tokens
3. **Important Step:** Do **not** set a fixed supply. Setting a fixed supply sends the treasury cap to a dead address, preventing migration. By keeping a flexible supply, the treasury cap remains with the deployer.
4. Confirm the transaction in your wallet.
Once confirmed, the token is successfully created on Suiicoins.
### Step 2: Migrating to Memez GG
1. Navigate to Memez GG and click **Create Token**, then select **Migrate**.
2. Choose the token you wish to migrate (e.g., **Prime Machine**).
3. Configure the token settings. Memez GG provides options similar to the token creation process but now includes the ability to enable all functionalities of the IPX Coin Standard. Enable:
* Burning tokens
* Minting new tokens
* Editing metadata
4. Set a new max supply (e.g., **1 billion tokens**).
5. Confirm the transaction in your wallet.
đ„ *Watch the video for the step-by-step walkthrough.*
{% embed url="" %}
# Memez.Fun
Virtual liquidity launchpad
### Virtual ... what?
In layman terms, Memez.fun is **a platform to launch meme coins and bootstrap liquidity**. The protocol supports **three launch strategies**:
* **Auction (High Risk):** It mimics a dutch auction in which the meme coin starts at a very high price and quickly declines until a fair price is found by traders.
* **Pump (High Risk):** The traditional method pioneered by pump.fun. The coin starts at a floor price to avoid early buyers from having a very large advantage.
* **Stable (Low Risk):** It provides a fixed trading price for the coin until the target sui amount is acquired. Unlike a normal presale platform, users can exit their position anytime before the target raise is reached.
### Phases
The pools can be in three different phases:
**Bonding**
All pools start at this phase as soon as they are created. In this phase users are allowed to buy and sell freely.
**Migrating**
This is triggered once the pool collects enough Sui to migrate from Memez.fun to a DEX. During this time, no trading is allowed. Anyone can call the migration function to move the liquidity.
**Migrated**
It indicates that a pool has successfully migrated. Trading can now be resumed in the destined DEX. E.g. On Blast.fun, users can trade on Bluefin after migration.
{% hint style="info" %}
It is impossible to return to a previous phase.
{% endhint %}
### Migration
All pools on Memez.fun migrate once a certain amount of Sui is accumulated. This is referred as **Target Sui Amount**. Once this requirement is meant the liquidity is moved from our platform to a DEX chosen by the deployer.
### Closed Loop Tokens
If chosen by the deployer**, Memez.Fun pools can issue a Closed Loop Token** to prevent buyers from creating pools before migration. Read more about them [here](https://docs.sui.io/standards/closed-loop-token).
### Miscellaneous
**Dynamic Supply**
Meme coins on Memez.fun can have any supply. The contracts do not enforce a supply of 1 billion as other launchpads. Moreover, all coins are burnable.
**Upgradeable Metadata**
Meme coins created on Memez.fun can have their metadata updated by the deployer.
* Name
* Symbol
* Description
* Icon
# Multisig
For security purposes, The Memez Upgrade and Admin Caps are controlled by the following Multisig:
[0xbe222be876a0f09c953b6217fba8b64eb77853ce298513cb3efcfe19bfbaf0aa](https://suiscan.xyz/mainnet/account/0xbe222be876a0f09c953b6217fba8b64eb77853ce298513cb3efcfe19bfbaf0aa)
**Members:**
* [Jose](https://x.com/josemvcerqueira): 1 vote
* 0xbbf31f4075625942aa967daebcafe0b1c90e6fa9305c9064983b5052ec442ef7
* AK2EGUxZXMKULhS+UmmqTB3ompdDSogXO9navAa4PAvF
* [Matical](https://x.com/opiateful): 1 vote
* 0x302756ee637804f8ed90af097eee32258ff20662129f64ff3ef31ff697e6ab53
* ANnQR0VWisQ2+RMr3E9azXyIh0XlDAZ7CzndRjkMgr4w
* [Eason](https://x.com/Eason_C13): 1 vote
* 0xdbef82568fc43aab7a48759310362fa9d3f81218а6Д2805f0783a6427322f01a
* AMxcce1sZzg1yS6hOVyar9h0obqtbiviSb0RCyhZnn4I
Transactions require **2 votes** to pass.
It contains the following objects:
* **Memez Publisher:** 0x68fe5e2a135799de5c53ce3cb82902b187217e81b0e24e9f0f030371f555f872
* Add display to all objects in Memez package. Currenly no object has any displays.
* **Memez Upgrade Cap:** 0x252b53c8a16c2a8843dd47f4da60a9fe4b47b790bba37dcc388de12948ea8403
* Allows us to upgrade the Memez Package.
* **Memez Launchpad Upgrade Cap:** 0xff3bea66bb8a6f06ace5bfe1622a61589e387d85955b61a8107ecc5bff6fd16e
* Allows us to upgrade the Memez Launchpad Package.
* **XPump Migrator Upgrade Cap:** 0x32186a566390b462678f4a4204098266e1337b9522ffa4e4d051c22ce1c38900
* Can upgrade the migrator package that control the LP positions for Blast on Bluefin.
* **XPump Migrator Admin Cap:** 0x60a3b91023eaec63301e4fd7011a3f8536f8f94e05895610e749dc189a704a33
* Can claim fees accrued by the Lp Positions on Bluefin.
* **Router Upgrade Cap:** 0x0477c7f09abf142a4e8a78309f00127f05cabb87f6c519168ea9579a9dfd9983
* Allows us to upgrade our router package that auto-creates an on-chain wallet to avoid bricking users' wallets.
* **Vesting Upgrade Cap:** 0x0c1c3cf5dea0a302153192fac4d0767c0fa8f21b7724f85290c148c8f1187896
* Allows us to upgrade our vesting package that linear vests meme coins
# Contract
The Memez.fun contract is [open source in Github.](https://github.com/interest-protocol/memez-gg/tree/main/fun) The contract is upgradeable with version control.
* **Original Id:** 0x779829966a2e8642c310bed79e6ba603e5acd3c31b25d7d4511e2c9303d6e3ef
* **Version 4:** 0x7e6aa6e179466ab2814425a780b122575296d011119fa69d27f289f5a28814bd
# memez\_pump\_config
new - packages a vector of u64 into a PumpConfig struct.
```rust
public fun new(values: vector): PumpConfig
```
**Arguments:**
* **`values: vector`**\
The values to be packaged. They are done linearly.
# memez\_config
set\_public\_key - allows the admin to set a public key address to verify signatures for protected pools. It is one per configuration.
```rust
public fun set_public_key(
self: &mut MemezConfig,
_: &AdminWitness,
public_key: vector,
_ctx: &mut TxContext,
)
```
**Arguments:**
* **`self: &mut MemezConfig`**\
A mutable reference to the Memez global configuration object.\
This is the config being updated with the new public key.
* **`_: &AdminWitness`**\
An admin witness proving that the caller is authorized to update the Memez configuration.
* **`public_key: vector`**\
The new public key (as raw bytes) to be set in the configuration.\
It is used for verifying signatures in the Memez system.
* **`_ctx: &mut TxContext`**\
A mutable reference to the transaction context provided by the Sui blockchain.
set\_fees - allows the admin to set the fees for a configuration. This includes: creation, meme swap, quote swap, allocation and migration fee values.
```rust
public fun set_fees(
self: &mut MemezConfig,
_: &AdminWitness,
values: vector>,
recipients: vector>,
_ctx: &mut TxContext,
)
```
**Arguments:**
* **`self: &mut MemezConfig`**\
A mutable reference to the Memez global configuration object.\
This is the config being updated with new fee settings.
* **`_: &AdminWitness`**\
An admin witness proving that the caller is authorized to update the Memez configuration.
* `values: vector>`\
A nested vector of fee values, expressed in basis points or absolute units.\
Defines the fee structure to apply across different pools or operations.
* **`recipients: vector>`**\
A nested vector of recipient addresses corresponding to each fee value.\
Specifies how fees are distributed among multiple beneficiaries (e.g., treasury, referrers, liquidity providers).
* **`_ctx: &mut TxContext`**\
A mutable reference to the transaction context provided by the Sui blockchain.
set\_meme\_referrer\_fee - allows the admin to set fee that will be shared with a referrer address during meme coin swaps. It is in basis points.
```rust
public fun set_meme_referrer_fee(
self: &mut MemezConfig,
_: &AdminWitness,
fee: u64,
_ctx: &mut TxContext,
)
```
**Arguments:**
* **`self: &mut MemezConfig`**\
A mutable reference to the Memez global configuration object.\
This is the config being updated with a new meme referrer fee setting.
* **`_: &AdminWitness`**\
An admin witness proving that the caller is authorized to update the Memez configuration.\
Ensures only governance or privileged accounts can modify referrer fees.
* **`fee: u64`**\
The new referrer fee value, expressed in basis points. Determines the portion of each meme trade allocated to the referrer.
* **`_ctx: &mut TxContext`**\
A mutable reference to the transaction context provided by the Sui blockchain.
set\_quote\_referrer\_fee - allows the admin to set fee that will be shared with a referrer address during quote coin swaps. It is in basis points.
```rust
public fun set_quote_referrer_fee(
self: &mut MemezConfig,
_: &AdminWitness,
fee: u64,
_ctx: &mut TxContext,
)
```
**Arguments:**
* **`self: &mut MemezConfig`**\
A mutable reference to the Memez global configuration object.\
This is the config being updated with a new meme referrer fee setting.
* **`_: &AdminWitness`**\
An admin witness proving that the caller is authorized to update the Memez configuration.\
Ensures only governance or privileged accounts can modify referrer fees.
* **`fee: u64`**\
The new referrer fee value, expressed in basis points. Determines the portion of each meme trade allocated to the referrer.
* **`_ctx: &mut TxContext`**\
A mutable reference to the transaction context provided by the Sui blockchain.
remove - allows the admin to remove the values of a configuration.
```rust
public fun remove(
self: &mut MemezConfig,
_: &AdminWitness,
_ctx: &mut TxContext,
)
```
**Arguments:**
* **`self: &mut MemezConfig`**\
A mutable reference to the Memez global configuration object.\
This is the config instance being removed.
* **`_: &AdminWitness`**\
An admin witness proving that the caller is authorized to remove a Memez configuration.\
Ensures only governance or privileged accounts can perform this destructive action.
* **`_ctx: &mut TxContext`**\
A mutable reference to the transaction context provided by the Sui blockchain.
add\_quote\_coin - whitelists a quote coin for a specific configuration.
```rust
public fun add_quote_coin(
self: &mut MemezConfig,
_: &AdminWitness,
_: &mut TxContext,
)
```
**Arguments:**
* **`self: &mut MemezConfig`**\
A mutable reference to the Memez global configuration object.\
This is the config instance being removed.
* **`_: &AdminWitness`**\
An admin witness proving that the caller is an admin.
* **`_ctx: &mut TxContext`**\
A mutable reference to the transaction context provided by the Sui blockchain.
remove\_quote\_coin - removes a quote coin from the whitelist of a specific configuration.
```rust
public fun remove_quote_coin(
self: &mut MemezConfig,
_: &AdminWitness,
_: &mut TxContext,
)
```
**Arguments:**
* **`self: &mut MemezConfig`**\
A mutable reference to the Memez global configuration object.\
This is the config instance being removed.
* **`_: &AdminWitness`**\
An admin witness proving that the caller is an admin.
* **`_ctx: &mut TxContext`**\
A mutable reference to the transaction context provided by the Sui blockchain.
add\_migrator\_witness - whitelists a migrator witness for a specific configuration.
```rust
public fun add_migrator_witness(
self: &mut MemezConfig,
_: &AdminWitness,
_: &mut TxContext,
)
```
**Arguments:**
* **`self: &mut MemezConfig`**\
A mutable reference to the Memez global configuration object.\
This is the config instance being removed.
* **`_: &AdminWitness`**\
An admin witness proving that the caller is an admin.
* **`_ctx: &mut TxContext`**\
A mutable reference to the transaction context provided by the Sui blockchain.
remove\_migrator\_witness - removes a migrator witness from the whitelist of a specific configuration.
```rust
public fun remove_migrator_witness(
self: &mut MemezConfig,
_: &AdminWitness,
_: &mut TxContext,
)
```
**Arguments:**
* **`self: &mut MemezConfig`**\
A mutable reference to the Memez global configuration object.\
This is the config instance being removed.
* **`_: &AdminWitness`**\
An admin witness proving that the caller is an admin.
* **`_ctx: &mut TxContext`**\
A mutable reference to the transaction context provided by the Sui blockchain.
# memez\_pump
new - creates a new pump pool using the `ConfigKey` settings.
```rust
public fun new(
config: &MemezConfig,
meme_treasury_cap: TreasuryCap,
mut creation_fee: Coin,
pump_config: PumpConfig,
first_purchase: Coin,
metadata: MemezMetadata,
stake_holders: vector,
is_protected: bool,
dev: address,
allowed_versions: AllowedVersions,
ctx: &mut TxContext,
): (MemezFun, MetadataCap)
```
**Arguments:**
* **`config: &MemezConfig`**\
The Memez [config shared object](https://suiscan.xyz/mainnet/object/0x9c665993f61a902475b083036da75240aa203bb874ebce4031810b589e485a61/tx-blocks).
* **`meme_treasury_cap: TreasuryCap`**\
The treasury cap for the meme coin (`memeCoinTreasuryCap`), which represents the authority or capability to mint and manage supply for the meme coin.
* **`mut creation_fee: Coin`**\
The SUI fee used during creation of the pool (`creationSuiFee`). This coin will be consumed as part of the transaction costs.
* **`pump_config: PumpConfig`**\
Configuration for the pump invariant logic â this may include values like `burnTax`, `virtualLiquidity`, `targetQuoteLiquidity`, and `liquidityProvision`.
* **`first_purchase: Coin`**\
A coin of the quote asset used for the first purchase in the pool (`firstPurchase`).
* **`metadata: MemezMetadata`**\
Arbitrary metadata associated with the meme coin (`metadata`). This may include things like creator address, X, description, and social links.
* **`stake_holders: vector`**\
A list of addresses representing the stakeholders of the meme coin. These might be early backers, team members, or governance participants. The numebr of stake\_holders depending on the configuration set by the admin.
* **`is_protected: bool`**\
A flag that indicates whether transactions require backend signatures to process pump operations (`isProtected`). Helps prevent abuse.
* **`dev: address`**\
The developerâs address (`developer`). This address may be eligible for future fee distributions or administrative rights.
* **`allowed_versions: AllowedVersions`**\
A witness to ensure that the package version is up to date.
* **`ctx: &mut TxContext`**\
A mutable reference to the transaction context provided by Sui.
pump - allows the user to buy meme coins from the pool.
```rust
public fun pump(
self: &mut MemezFun,
quote_coin: Coin,
referrer: Option,
signature: Option>,
min_amount_out: u64,
allowed_versions: AllowedVersions,
ctx: &mut TxContext,
): Coin
```
**Arguments:**
* **`self: &mut MemezFun`**\
A mutable reference to the `MemezPool` (specifically using the Pump invariant) â this is the pool that facilitates the trade.
* **`quote_coin: Coin`**\
The quote coin provided by the user to be exchanged for meme coin.
* **`referrer: Option`**\
An optional address of the referrer who may be eligible for referral rewards.
* **`signature: Option>`**\
An optional server-provided signature. This is **required** if the pool is marked as protected.
* **`min_amount_out: u64`**\
The minimum amount of meme coin that the user expects to receive from the trade.\
This prevents slippage or front-running attacks.
* **`allowed_versions: AllowedVersions`**\
A witness to ensure that the package version being used is current and authorized.
* **`ctx: &mut TxContext`**\
A mutable reference to the Sui transaction context.
dump - allows the user to sell meme coins.
```rust
public fun dump(
self: &mut MemezFun,
treasury_cap: &mut IPXTreasuryStandard,
meme_coin: Coin,
referrer: Option,
min_amount_out: u64,
allowed_versions: AllowedVersions,
ctx: &mut TxContext,
): Coin
```
**Arguments:**
* **`self: &mut MemezFun`**\
A mutable reference to the MemezPool that uses the Pump invariant â this is the pool from which the meme coin will be sold.
* **`treasury_cap: &mut IPXTreasuryStandard`**\
A mutable reference to the shared ipx treasury cap, used to authorize burns.
* **`meme_coin: Coin`**\
The meme coin being sold in exchange for quote (e.g., SUI).
* **`referrer: Option`**\
An optional referrer address to credit for referral rewards.\
*(Corresponds to `referrer` in the client â can be null.)*
* **`min_amount_out: u64`**\
The minimum amount of quote coin (e.g., SUI) the user expects to receive in return.\
Protects against slippage or unfavorable trades.
* **`allowed_versions: AllowedVersions`**\
A witness object ensuring the transaction uses an allowed and up-to-date package version.
* **`ctx: &mut TxContext`**\
A mutable reference to the transaction context provided by the Sui blockchain.
migrate - it migrates a pool to a DEX. The functions returns a hot potato that can only be destroyed by using an authorized migration witness.
```rust
public fun migrate(
self: &mut MemezFun,
allowed_versions: AllowedVersions,
ctx: &mut TxContext,
): MemezMigrator
```
**Arguments:**
* **`self: &mut MemezFun`**\
A mutable reference to the Memez pool that uses the Pump invariant â this is the pool being migrated.
* **`allowed_versions: AllowedVersions`**\
A witness object ensuring the migration call is executed only if the contract package version is valid and up-to-date.
* **`ctx: &mut TxContext`**\
A mutable reference to the transaction context provided by the Sui blockchain. Required for creating, transferring, and managing objects during migration.
dev\_purchase\_claim - allows the developer to claim the meme coins bought in the first purchase.
```rust
public fun dev_purchase_claim(
self: &mut MemezFun,
allowed_versions: AllowedVersions,
ctx: &mut TxContext,
): Coin
```
**Arguments:**
* **`self: &mut MemezFun`**\
A mutable reference to the Memez pool that uses the Pump invariant â this returns the developer first purchase.
* **`allowed_versions: AllowedVersions`**\
A witness object ensuring the migration call is executed only if the contract package version is valid and up-to-date.
* **`ctx: &mut TxContext`**\
A mutable reference to the transaction context provided by the Sui blockchain. Required for creating, transferring, and managing objects during migration.
distribute\_stake\_holders\_allocation - allows anyone to distribute the meme coin allocations to its respective recipients. It can only be done after a pool has been migrated.
```rust
public fun distribute_stake_holders_allocation(
self: &mut MemezFun,
clock: &Clock,
allowed_versions: AllowedVersions,
ctx: &mut TxContext,
)
```
**Arguments:**
* **`self: &mut MemezFun`**\
A mutable reference to the Memez pool that uses the Pump invariant â this returns the developer first purchase.
* **`clock: &Clock`**\
The Clock shared object.
* **`allowed_versions: AllowedVersions`**\
A witness object ensuring the migration call is executed only if the contract package version is valid and up-to-date.
* **`ctx: &mut TxContext`**\
A mutable reference to the transaction context provided by the Sui blockchain. Required for creating, transferring, and managing objects during migration.
quote\_pump - quotes the current exchange rate between quote coin for meme coin.
```rust
public fun quote_pump(
self: &mut MemezFun,
amount_in: u64,
): vector
```
**Arguments:**
* **`self: &mut MemezFun`**\
A mutable reference to the Memez pool that uses the Pump invariant â this is the pool being queried for a pricing quote.
* **`amount_in: u64`**\
The input trade size of the meme coin, expressed in its smallest unit.\
Used to calculate how much of the quote asset (e.g., SUI) would be received under the Pump invariant.
quote\_dump - quotes the current exchange rate between meme coin for the quote coin.
```rust
public fun quote_dump(
self: &mut MemezFun,
amount_in: u64,
): vector
```
**Arguments:**
* **`self: &mut MemezFun`**\
A mutable reference to the Memez pool that uses the Pump invariant â this is the pool being queried for a pricing quote.
* **`amount_in: u64`**\
The input trade size of the **quote coin** (e.g., SUI), expressed in its smallest unit.\
Used to calculate how much of the meme coin would be received when âdumpingâ quote into the pool.
# memez\_fun
destroy - destroys the Migrator hot potato to get the inner balances.
```rust
public fun destroy(
migrator: MemezMigrator,
_: Witness,
): (address, Balance, Balance)
```
**Arguments:**
* **`migrator: MemezMigrator`**\
The migration hot potato representing a Memez pool in its migratable state.\
Consuming this object finalizes the migration process and allows recovery of the underlying assets.
* **`_: Witness`**\
A witness type ensuring only the authorized package can invoke `destroy` function.\
Serves as a compile-time capability check (must have the `drop` ability).
update\_metadata - replaces the pool metadata.
```rust
public fun update_metadata(
self: &mut MemezFun,
metadata_cap: &MetadataCap,
mut metadata: VecMap,
)
```
**Arguments:**
* **`self: &mut MemezFun`**\
A mutable reference to the Memez pool instance (for any curve type).\
This is the pool whose metadata will be updated.
* **`metadata_cap: &MetadataCap`**\
A capability object that authorizes metadata updates.\
Ensures only accounts with the correct permission can modify the poolâs metadata.
* **`metadata: VecMap`**\
A keyâvalue map of metadata fields (as strings) to attach or update on the pool.\
Typical entries may include name, symbol, description, or custom fields relevant to frontends or indexers.
metadata - returns the current pool metadata
```rust
public fun metadata(
self: &MemezFun,
): VecMap
```
**Arguments:**
* **`self: &MemezFun`**\
An immutable reference to the Memez pool instance (for any curve type).\
The pool whose metadata will be read.
next\_nonce - returns the next nonce for the server to create a signature valid for the `user`.
```rust
public fun next_nonce(self: &MemezFun, user: address): u64
```
**Arguments:**
* **`self: &MemezFun`**\
An immutable reference to the Memez pool instance (for any curve type).\
The pool from which the nonce will be queried.
* **`user: address`**\
The address of the user whose next nonce is being requested.\
It is used to prevent replay attacks and ensure transaction uniqueness for that user in the pool.
# SDK
## Overview
**Typescript SDK to interact with** [**Memez.gg**](https://www.memez.gg/) **contracts.**
## Installation
**The sdk is available on the** [**NPM registry.**](https://www.npmjs.com/package/@interest-protocol/memez-fun-sdk)
```sh
npm i @interest-protocol/memez-fun-sdk
```
## SDK
**How to setup the SDK.**
```typescript
import { MemezPumpSDK } from '@interest-protocol/memez-fun-sdk';
/**
* Initiates the MemezPump SDK.
*
* @param args - An object containing the necessary arguments to initialize the SDK.
* @param args.fullNodeUrl - The full node URL to use for the SDK.
* @param args.packages - The package addresses to use for the SDK.
* @param args.sharedObjects - A record of shared objects to use for the SDK.
* @param args.network - The network to use for the SDK. Either `mainnet` or `testnet`.
*/
const memezPumpSdk = new MemezPumpSDK();
```
# Pump API
### Constructor
Allows the SDK to be initiated with custom data.
* [Example](https://github.com/interest-protocol/sdk-monorepo/blob/main/scripts/memez-fun/utils.script.ts#L37)
* [Pump SDK Implementation ](https://github.com/interest-protocol/sdk-monorepo/blob/main/packages/memez-fun-sdk/src/pump.ts#L54)
#### How to use:
```typescript
import { getFullnodeUrl } from '@mysten/sui/client';
import {
MemezPumpSDK,
Network,
} from '@interest-protocol/memez-fun-sdk';
const payload = {
network: Network.MAINNET,
fullNodeUrl: getFullnodeUrl(Network.MAINNET),
};
const memezPump = new MemezPumpSDK(payload);
```
#### Arguments
* **fullNodeUrl {string} -** Url to initiate the Sui Client RPC.
* **network {Enum} -** [Enum denoting if its mainnet or testnet](https://github.com/interest-protocol/memez.gg-sdk/blob/main/src/memez/memez.types.ts#L18)
### newPumpPool
Creates a pool using the Pump invariant.
* [Example](https://github.com/interest-protocol/memez.gg-sdk/blob/main/src/scripts/memez/pump/new.ts)
* [Implementation](https://github.com/interest-protocol/sdk-monorepo/blob/main/packages/memez-fun-sdk/src/pump.ts#L83)
#### How to use:
```typescript
const recipient = keypair.toSuiAddress();
const tx = new Transaction();
const [creationSuiFee, firstPurchase] = tx.splitCoins(tx.gas, [
tx.pure.u64(30_000_000n),
tx.pure.u64(1_000_000_000n),
]);
const { metadataCap } = await memezPumpTestnet.newPool({
tx,
configurationKey,
metadata: {
X: 'https://x.com/Meme',
Website: 'https://meme.xyz/',
GitHub: 'https://github.com/meme',
videoUrl: 'https://memez.gg',
},
creationSuiFee,
memeCoinTreasuryCap: TREASURY_CAP,
firstPurchase,
developer: recipient,
migrationWitness: MIGRATOR_WITNESSES.testnet.TEST,
totalSupply: TOTAL_SUPPLY,
quoteCoinType: SUI_TYPE_ARG,
});
tx.transferObjects([metadataCap], tx.pure.address(recipient));
await executeTx(tx);
```
#### Arguments
* **tx {object} -** Sui client Transaction class to chain move calls.
* **creationSuiFee {object} -** The Sui fee to create a MemezPool.
* **memeCoinTreasuryCap {string} -** The meme coin treasury cap.
* **totalSupply {string | number | bigint} -** The total supply of the meme coin.
* **isProtected {boolean} -** Whether to use pool requires a server signature authorization for users to buy coins.
* **developer {string} -** The address that can claim the dev meme coin purchase and collect post bonding fees on Bluefin.
* **firstPurchase {object} -** A Sui coin object to place the first meme coin purchase.
* **metadata {object} -** A record of the social metadata of the meme coin.
* **configurationKey {string} -** The configuration key to use for the MemezPool.
* **migrationWitness {string} -** The migration witness to use for the MemezPool.
* **stakeholders {string\[]} -** The addresses of the stakeholders. It can be empty or undefined.
* **quoteCoinType {string} -** The quote coin type to use for the MemezPool.
* **burnTax {number} -** The amount of meme coin that will be burnt during sales in basis points.
* **virtualLiquidity {string | number | bigint} -** The initial virtual liquidity in the pool.
* **targetQuoteLiquidity {string | number | bigint} -** The amount of Sui the pool needs to collect to migrate the coin.
* **liquidityProvision {number} -** The percentage of meme coin that will be added as liquidity after migration. It is expressed in basis points.
#### Return
* **tx {object} -** Sui client Transaction class to chain move calls.
* **metadataCap {object} -** The metadata object.
* [Check out the IPX Treasury standard](/overview/sui/ipx-coin-standard)
### pump
Swaps quote coin for a meme coin in a pool.
* [Example](https://github.com/interest-protocol/sdk-monorepo/blob/main/scripts/memez-fun/pump/pump.ts)
* [Implementation](https://github.com/interest-protocol/sdk-monorepo/blob/main/packages/memez-fun-sdk/src/pump.ts#L535)
#### How to use
```typescript
import { coinWithBalance, Transaction } from '@mysten/sui/transactions';
import { getEnv } from '../utils.script';
(async () => {
const tx = new Transaction();
const { pumpSdk, executeTx, testnetPoolId, keypair } = await getEnv();
const quoteCoin = coinWithBalance({
balance: 100,
type: '0x2::sui::SUI',
});
const { memeCoin, tx: tx2 } = await pumpSdk.pump({
pool: testnetPoolId,
quoteCoin,
tx,
});
tx2.transferObjects([memeCoin], keypair.toSuiAddress());
await executeTx(tx2);
})();
```
#### Arguments
* **tx {object} -** Sui client Transaction class to chain move calls.
* **pool {string | object} -** The objectId of the MemezPool or the full parsed pool.
* **quoteCoin {object} -** The quote coin to sell for the meme coin.
* **referrer {string | null} -** The address of the referrer.
* **signature {string | null} -** The server signature. It is required for protected pools.
* **minAmountOut {string | number | bigint} -** The minimum amount of meme coin expected to be received.
#### Return
* **tx {object} -** Sui client Transaction class to chain move calls.
* **memeCoin {object} -** The meme coin bought.
### dump
Swaps meme coin for quote coin in a pool.
* [Example](https://github.com/interest-protocol/sdk-monorepo/blob/main/scripts/memez-fun/pump/dump.ts)
* [Implementation](https://github.com/interest-protocol/sdk-monorepo/blob/main/packages/memez-fun-sdk/src/pump.ts#L603)
#### How to use
```typescript
import { coinWithBalance, Transaction } from '@mysten/sui/transactions';
import { getEnv } from '../utils.script';
(async () => {
const tx = new Transaction();
const { pumpSdk, executeTx, testnetPoolId, keypair } = await getEnv();
const pool = await pumpSdk.getPumpPool(testnetPoolId);
const memeCoin = coinWithBalance({
balance: 100n,
type: pool.memeCoinType,
})(tx);
const { quoteCoin, tx: tx2 } = await pumpSdk.dump({
pool: testnetPoolId,
memeCoin,
tx,
referrer:
'0x894261575b948c035d002adc3ca4d73c683c01a1bfafac183870940bf9afef1a',
});
tx2.transferObjects([quoteCoin], keypair.toSuiAddress());
await executeTx(tx2);
})();
```
#### Arguments
* **tx {object} -** Sui client Transaction class to chain move calls.
* **pool {string | object} -** The objectId of the MemezPool or the full parsed pool.
* **memeCoin {object} -** The meme coin to sell for Sui coin.
* **referrer {string | null} -** The address of the referrer.
* **minAmountOut {string | number | bigint} -** The minimum amount of sui coin expected to be received.
#### Return
* **tx {object} -** Sui client Transaction class to chain move calls.
* **quoteCoin {object} -** The Quote coin bought.
### devClaim
Allows the developer to claim the first purchased coins. It can only be done after the pool migrates.
* [Example](https://github.com/interest-protocol/sdk-monorepo/blob/main/scripts/memez-fun/pump/dev-claim.ts)
* [Implementation](https://github.com/interest-protocol/sdk-monorepo/blob/main/packages/memez-fun-sdk/src/pump.ts#L661)
#### How to use
```typescript
const { memeCoin, tx } = await memezTestnet.devClaim({
pool: POOL_ID,
});
tx.transferObjects([memeCoin], keypair.toSuiAddress());
await executeTx(tx);
```
#### Arguments
* **tx {object} -** Sui client Transaction class to chain move calls.
* **pool {string | object} -** The objectId of the MemezPool or the full parsed pool.
#### Return
* **tx {object} -** Sui client Transaction class to chain move calls.
* **memeCoin {object} -** The meme coin bought by the developer during deployment.
### migrate
Migrates the pool to DEX based on the MigrationWitness.
* [Example](https://github.com/interest-protocol/sdk-monorepo/blob/main/scripts/memez-fun/xpump-migrator/migrate.ts)
* [Implementation](https://github.com/interest-protocol/sdk-monorepo/blob/main/packages/memez-fun-sdk/src/pump.ts#L695)
{% hint style="warning" %}
The migrator is a hot potato that needs to be consumed. Please use the [Migrator SDK](https://github.com/interest-protocol/memez.gg-sdk/blob/main/src/memez/migrator.ts) to consume and migrate to a DEX.
{% endhint %}
#### How to use
```typescript
const { tx, migrator } = await pumpSdk.migrate({
pool: testnetPoolId,
});
const fee = tx.splitCoins(tx.gas, [0n]);
const { tx: tx2, suiCoin } = await xPumpMigratorSdk.migrate({
tx,
migrator,
memeCoinType: pool.memeCoinType,
feeCoinType: SUI_TYPE_ARG,
feeCoin: fee,
ipxMemeCoinTreasury: pool.ipxMemeCoinTreasury,
quoteCoinType: pool.quoteCoinType,
});
tx2.transferObjects([suiCoin], keypair.toSuiAddress());
await executeTx(tx2);
```
#### Arguments
* **tx {object} -** Sui client Transaction class to chain move calls.
* **pool {string | object} -** The objectId of the MemezPool or the full parsed pool.
#### Return
* **tx {object} -** Sui client Transaction class to chain move calls.
* **migrator {object} -** The hot potato migrator containing the balances.
### quotePump
Quotes the amount of meme coin received after selling the quote coin.
* [Example](https://github.com/interest-protocol/sdk-monorepo/blob/main/scripts/memez-fun/pump/quote-pump.ts)
* [Implementation](https://github.com/interest-protocol/sdk-monorepo/blob/main/packages/memez-fun-sdk/src/pump.ts#L769)
#### How to use
```typescript
const { memeAmountOut, quoteFee, memeFee } = await memezPumpSdk.quotePump({
pool: POOL_ID,
amount: 15n * POW_9,
});
```
#### Arguments
* **pool {string | object} -** The objectId of the MemezPool or the full parsed pool.
* **amount {string | number | bigint} -** The amount of Sui being sold.
#### Return
* **memeAmountOut {bigint} -** The amount of meme coin that will be received.
* **quoteFee {bigint} -** The swap fee paid in the Quote coin.
* **memeFee {bigint} -** The swap fee paid in Meme coin.
### quoteDump
Quotes the amount of quote coin received after selling the meme coin.
* [Example](https://github.com/interest-protocol/memez.gg-sdk/blob/main/src/scripts/memez/pump/quote-dump.ts)
* [Implementation](https://github.com/interest-protocol/memez.gg-sdk/blob/main/src/memez/pump.ts#L540)
#### How to use
```typescript
import { memezTestnet, POW_9, TEST_POOL_ID } from '../utils.script';
const { amountOut, quoteFee, memeFee, burnFee } = await memezPumpTestnet.quoteDump({
pool: TEST_POOL_ID,
amount: 1_500_000n * POW_9,
});
```
#### Arguments
* **pool {string | object} -** The objectId of the MemezPool or the full parsed pool.
* **amount {string | number | bigint} -** The amount of Meme coin being sold.
#### Return
* **quoteAmountOut {bigint} -** The amount of quote coin that will be received.
* **quoteFee {bigint} -** The swap fee paid in the Quote coin.
* **memeFee {bigint} -** The swap fee paid in Meme coin.
* **burnFee {bigint} -** Burn fee in meme coin.
### getPumpData
Returns the Pump configuration for a specific integrator using a configuration key.
* [Example](https://github.com/interest-protocol/memez.gg-sdk/blob/main/src/scripts/config/get-pump-data.ts)
* [Implementation](https://github.com/interest-protocol/memez.gg-sdk/blob/main/src/memez/pump.ts#L631)
#### How to use
```typescript
import { CONFIG_KEYS } from '../../memez';
import { log, memezTestnet } from '../utils.script';
const pumpData = await memezPumpTestnet.getPumpData({
configurationKey: CONFIG_KEYS.testnet.DEFAULT,
totalSupply: 1e9 * 1e9,
quoteCoinType: QUOTE_COIN_TYPE
});
```
#### Arguments
* **configurationKey {string} -** The struct tag of a configuration key. E.g. package::module::Key
* **totalSupply {string | bigint | number} -** The total supply of the meme coin. E.g. 1 Sui would be 1e9.
* **quoteCoin {string} -** The total supply of the meme coin. E.g. 1 Sui would be 1e9.
#### Return
* **burnTax -** The tax value of the burner in bps.
* **virtualLiquidity -** The starting virtual liquidity in the pool in Sui.
* **targetQuoteLiquidity -** The amount of quote required for the pool to migrate.
* **liquidityProvision -** The amount of Meme coin that will be supplied to a DEX after migration.
# Interfaces
## MemezPool
**It represents a Memez Pool.**
```typescript
export interface MemezPool {
objectId: string;
poolType: string;
curveType: string;
memeCoinType: string;
quoteCoinType: string;
publicKey: string | null;
ipxMemeCoinTreasury: string;
metadata: Record;
migrationWitness: string;
progress: string;
stateId: string;
developer: string;
curveState: T;
}
```
* **objectId:** The Sui Object id of this pool.
* **poolType:** The struct tag of the pool.
* **curveType:** It denotes the possible variants of the pool. E.g. Stable, Auction and Pump.
* **memeCoinType:** The struct tag of the Meme coin.
* **quoteCoinType:** The struct tag of the Quote coin.
* **publicKey:** Protected pools have a public key to verify agaisnt the signatures submitted via pump function.
* **ipxMemeCoinTreasury:** The id of the Meme coin Treasury.
* [Check out the IPX Treasury standard](/overview/sui/ipx-coin-standard)
* **metadata:** A map of the meme coin metadata.
* **migrationWitness****:** The struct tag of the migrator witness. It shows to which DEX the pool is going to migrate to.
* **progress:** The current status of the pool. E.g. Bonding, Migrating or Migrated.
* **stateId:** The id of of the state object to fetch the inner state.
* **developer:** The address of the user that can claim dev first purchase and earn post bonding fees.
* **curveState:** The inner state related to the variant.
## PumpState
**Represents the state of the Pump Pool that will be saved in the property curveState in the Memez Pool.**
```typescript
export interface PumpState {
devPurchase: bigint;
liquidityProvision: bigint;
migrationFee: number;
virtualLiquidity: bigint;
targetQuoteLiquidity: bigint;
quoteBalance: bigint;
memeBalance: bigint;
burnTax: number;
memeSwapFee: number;
quoteSwapFee: number;
allocation: Allocation;
memeReferrerFee: number;
quoteReferrerFee: number;
}
```
* **devPurchase:** The coins bought by the developer.
* **liquidityProvision:** The amount of meme coin that will be added liquidity.
* **migrationFee:** The payment in Sui that will be charged during migration.
* **virtualLiquidity:** The virtual Sui liquidity to set a floor price.
* **targetQuoteLiquidity:** The amount of Quote coin required to migrate.
* **quoteBalance:** The current amount of Quote coin in the pool.
* **memeBalance:** The amount of meme coin in the pool.
* **burnTax:** The burn tax percentage in bps.
* **memeSwapFee:** The meme coin swap fee percentage in bps.
* **quoteSwapFee:** The Quote coin swap fee percentage in bps.
* **memeReferrerFee:** The meme coin referral fee percentage in bps.
* **quoteReferrerFee:** The Quote coin referral fee percentage in bps
* **allocation:** Balance of meme coins to be sent o stake holders after migration.
## Network
**An enum referring to the current network being used.**
```typescript
export enum Network {
Mainnet = 'mainnet',
Testnet = 'testnet',
}
```
* **Mainnet:** Sui Network main net
* **Testnet:** Sui Network test net.
## Packages
**An object containing the packages to interact with Memez.**
{% hint style="warning" %}
Testnet packages are out of date. Please use mainnet packages only!
{% endhint %}
```typescript
export const PACKAGES = {
[Network.TESTNET]: {
MEMEZ_FUN: {
original: normalizeSuiAddress(
'0xcad2e05e9771c6b1aad35d4f3df42094d5d49effc2a839e34f37ae31dc373fe7'
),
latest: normalizeSuiAddress(
'0xcad2e05e9771c6b1aad35d4f3df42094d5d49effc2a839e34f37ae31dc373fe7'
),
},
MEMEZ: {
original: normalizeSuiAddress(
'0x17209c541f1a372b811a42eaf95e62cd1eb46127e438f052432bd1c2318bc1c9'
),
latest: normalizeSuiAddress(
'0x17209c541f1a372b811a42eaf95e62cd1eb46127e438f052432bd1c2318bc1c9'
),
},
VESTING: {
original: normalizeSuiAddress(
'0xbc838799ce0c571fddb5c650adae05ed141070501558743f2f28d2d3fbede8d6'
),
latest: normalizeSuiAddress(
'0xbc838799ce0c571fddb5c650adae05ed141070501558743f2f28d2d3fbede8d6'
),
},
TEST_MEMEZ_MIGRATOR: {
original: normalizeSuiAddress(
'0x1e15037693e28af09771953ec8179d104fff7a225e5a5d1a65034a3636451026'
),
latest: normalizeSuiAddress(
'0x1e15037693e28af09771953ec8179d104fff7a225e5a5d1a65034a3636451026'
),
},
MEMEZ_WITNESS: {
original: normalizeSuiAddress(
'0x6083aeb2d22514d0e849fdde75b60c7d0f857facefb3b2d7d2e975b78d8a0c75'
),
latest: normalizeSuiAddress(
'0x6083aeb2d22514d0e849fdde75b60c7d0f857facefb3b2d7d2e975b78d8a0c75'
),
},
INTEREST_ACL: {
original: normalizeSuiAddress(
'0x32ffaa298a6d6528864bf2b32acfcb7976a95e26dcc24e40e2535c0551b9d68a'
),
latest: normalizeSuiAddress(
'0x32ffaa298a6d6528864bf2b32acfcb7976a95e26dcc24e40e2535c0551b9d68a'
),
},
XPUMP_MIGRATOR: {
original: normalizeSuiAddress('0x0'),
latest: normalizeSuiAddress('0x0'),
},
WALLET: {
original: normalizeSuiAddress('0x0'),
latest: normalizeSuiAddress('0x0'),
},
ROUTER: {
original: normalizeSuiAddress('0x0'),
latest: normalizeSuiAddress('0x0'),
},
IPX_COIN_STANDARD: {
original: normalizeSuiAddress('0x0'),
latest: normalizeSuiAddress('0x0'),
},
},
[Network.MAINNET]: {
MEMEZ_FUN: {
original: normalizeSuiAddress(
'0x779829966a2e8642c310bed79e6ba603e5acd3c31b25d7d4511e2c9303d6e3ef'
),
latest: normalizeSuiAddress(
'0x7e6aa6e179466ab2814425a780b122575296d011119fa69d27f289f5a28814bd'
),
},
MEMEZ: {
original: normalizeSuiAddress(
'0x6101835e1df12852440c3ad3f079130e31702fe201eb1e3b77d141a0c6a58539'
),
latest: normalizeSuiAddress(
'0x6101835e1df12852440c3ad3f079130e31702fe201eb1e3b77d141a0c6a58539'
),
},
VESTING: {
original: normalizeSuiAddress(
'0x1a184ecf7d0652f8f1285a3b0b2e644bf86ae1742317fcdaa9b11a7f3a30bd70'
),
latest: normalizeSuiAddress(
'0x1a184ecf7d0652f8f1285a3b0b2e644bf86ae1742317fcdaa9b11a7f3a30bd70'
),
},
TEST_MEMEZ_MIGRATOR: {
original: normalizeSuiAddress(
'0x4078fe9f8e60191b1ec85d4092b4ec070736dd7c4a3b0c69b1f121c4c6aee910'
),
latest: normalizeSuiAddress(
'0x4078fe9f8e60191b1ec85d4092b4ec070736dd7c4a3b0c69b1f121c4c6aee910'
),
},
MEMEZ_WITNESS: {
original: normalizeSuiAddress(
'0x6e38cc853e404376b1dc969178aee2c81799cf23af7171e74e492f6786db1cbe'
),
latest: normalizeSuiAddress(
'0x6e38cc853e404376b1dc969178aee2c81799cf23af7171e74e492f6786db1cbe'
),
},
INTEREST_ACL: {
original: normalizeSuiAddress(
'0xb877fe150db8e9af55c399b4e49ba8afe658bd05317cb378c940344851125e9a'
),
latest: normalizeSuiAddress(
'0xb877fe150db8e9af55c399b4e49ba8afe658bd05317cb378c940344851125e9a'
),
},
XPUMP_MIGRATOR: {
original: normalizeSuiAddress(
'0x7ec68f4115dc2944426239b13ce6804dd9971b24069fb4efe88360d29b17f0ce'
),
latest: normalizeSuiAddress(
'0xd4fd7ef75d33f92be5bd11f8cbd06cd15b8df68c6f5016fac6700808de0ff76e'
),
},
WALLET: {
original: normalizeSuiAddress(
'0x21700f31d563949214e0411f22a3cf64928f6a3e5b3c13f830a30d6884fe135b'
),
latest: normalizeSuiAddress(
'0x21700f31d563949214e0411f22a3cf64928f6a3e5b3c13f830a30d6884fe135b'
),
},
ROUTER: {
original: normalizeSuiAddress(
'0x07cb654d8ae22bd18fff08f322d99fdf9d1673712812329b127430b155dc44ff'
),
latest: normalizeSuiAddress(
'0x07cb654d8ae22bd18fff08f322d99fdf9d1673712812329b127430b155dc44ff'
),
},
IPX_COIN_STANDARD: {
original: normalizeSuiAddress(
'0xa204bd0d48d49fc7b8b05c8ef3f3ae63d1b22d157526a88b91391b41e6053157'
),
latest: normalizeSuiAddress(
'0xa204bd0d48d49fc7b8b05c8ef3f3ae63d1b22d157526a88b91391b41e6053157'
),
},
},
} as const;
```
* **MEMEZ\_FUN:** The address of the Memez launchpad package.
* **MEMEZ:** The address of the OTW Memez package.
* **INTEREST\_ACL:** The package of the Memez admin package.
* **VESTING:** The package of the vesting package of Memez package.
* **MEMEZ\_MIGRATOR:** The package of the migrator.
* **MEMEZ\_WITNESS:** A package containing the configuration witnesses.
* **XPUMP\_MIGRATOR:** The Blast.fun migrator package.
* **WALLET:** The Memez wallet package to avoid bricking wallets.
* **ROUTER:** The Memez router package that creates wallets for referrers when buying and selling.
* **IPX\_COIN\_STANDARD:** The IPX coin standard that allowed protected access to update coin metadata and supply.
## Shared Objects
**An object containing the shared objects to interact with Memez. Each object has a mutable and immutable reference for optimization purposes.**
```typescript
export const SHARED_OBJECTS = {
[Network.TESTNET]: {
ACL: ({ mutable }: { mutable: boolean }) => ({
objectId: normalizeSuiObjectId(
'0xc8502b2e13ce57165218abaacd36850c7ea70a5ef4c0b80053eb0f6aaf1d338e'
),
initialSharedVersion: '395367236',
mutable,
}),
VERSION: ({ mutable }: { mutable: boolean }) => ({
objectId: normalizeSuiObjectId(
'0x4662e671861a4cb72ee0fe03193e3dd62645465f7cc61ce13422c8384bc8af46'
),
initialSharedVersion: '395367301',
mutable,
}),
CONFIG: ({ mutable }: { mutable: boolean }) => ({
objectId: normalizeSuiObjectId(
'0x0c8812c7ab6ae0a900a015c7db0048b20dad072c10faaef4759610a7ada97a73'
),
initialSharedVersion: '395367301',
mutable,
}),
XPUMP_MIGRATOR_CONFIG: ({ mutable }: { mutable: boolean }) => ({
objectId: normalizeSuiObjectId('0x0'),
initialSharedVersion: '0',
mutable,
}),
WALLET_REGISTRY: ({ mutable }: { mutable: boolean }) => ({
objectId: normalizeSuiObjectId('0x0'),
initialSharedVersion: '0',
mutable,
}),
},
[Network.MAINNET]: {
ACL: ({ mutable }: { mutable: boolean }) => ({
objectId: normalizeSuiObjectId(
'0x091bd217c6030076a8a97673e3b9f74e0f48bc3035dcb5d5daaf50a8a2d40b7f'
),
initialSharedVersion: '549909164',
mutable,
}),
VERSION: ({ mutable }: { mutable: boolean }) => ({
objectId: normalizeSuiObjectId(
'0x2319e3e76dfad73d8f4684bdbf42be4f32d8ce4521dd61becc8261dc918d82c0'
),
initialSharedVersion: '597477043',
mutable,
}),
CONFIG: ({ mutable }: { mutable: boolean }) => ({
objectId: normalizeSuiObjectId(
'0x9c665993f61a902475b083036da75240aa203bb874ebce4031810b589e485a61'
),
initialSharedVersion: '597477043',
mutable,
}),
XPUMP_MIGRATOR_CONFIG: ({ mutable }: { mutable: boolean }) => ({
objectId: normalizeSuiObjectId(
'0x6ac620306c77e9fb452123b8832b56cb4ec7f9bb638e42d3c6eeecdf173a9498'
),
initialSharedVersion: '603610952',
mutable,
}),
WALLET_REGISTRY: ({ mutable }: { mutable: boolean }) => ({
objectId: normalizeSuiObjectId(
'0xc6ed6d218aff361ed293ba3eaf2805772275c9dc87f650a0f8df9c80471c5fbe'
),
initialSharedVersion: '611022341',
mutable,
}),
},
} as const;
```
* **ACL:** Shared object holding the current whitelisted admins.
* **VERSION:** Shared object containing the latest version of the package.
* **CONFIG:** Shared object contain all different configurations:
* Fees
* Migration Witnesses
* Quote coins
* Public Key
* Pump State
* Stable State
* Auction State
* **XPUMP\_MIGRATOR\_CONFIG:** The Blast.fun migrator configuration shared object.
* **WALLET\_REGISTRY:** The Memez wallet shared object. It ensures, there is only one wallet per address.
## Config Keys
**The configuration supports various values per integrator. For example the fees for Recrd and Default keys will have different values. This is set by the admin.**
```typescript
export const CONFIG_KEYS = {
[Network.Mainnet]: {
MEMEZ: '',
XPUMP: ''
},
[Network.Testnet]: {
MEMEZ: `${PACKAGES[Network.MAINNET].MEMEZ_WITNESS.original}::memez_witness::Memez`,
XPUMP:
'0x5afcb4c691bd3af2eb5de4c416b2ed501e843e81209f83ce6928bc3a10d0205c::xpump::ConfigKey',
},
} as const;
```
* **MEMEZ:** This is the memez configuration.
* **XPUMP:** This is the Blast.fun configuration.
## Migrator Witnesses
**Record of the current allowed migrators.**
```typescript
export const MIGRATOR_WITNESSES = {
[Network.TESTNET]: {
TEST: `${PACKAGES[Network.TESTNET].TEST_MEMEZ_MIGRATOR.original}::dummy::Witness`,
XPUMP: `${PACKAGES[Network.TESTNET].XPUMP_MIGRATOR.original}::xpump_migrator::Witness`,
},
[Network.MAINNET]: {
TEST: `${PACKAGES[Network.MAINNET].TEST_MEMEZ_MIGRATOR.original}::dummy::Witness`,
XPUMP: `${PACKAGES[Network.MAINNET].XPUMP_MIGRATOR.original}::xpump_migrator::Witness`,
},
} as const;
```
* **TEST:** Currently we have a test migrator that returns the balances for testing purposes.
* **XPUMP:** The Blast.fun migrator witness.
# Configuration
## Overview
[**Memez.gg**](https://www.memez.gg/) is **highly configurable to facilitate third party integrations and revenue sharing**.
Integrators can configure the following parameters:
* **Fees**
* **Migrator**
* **Public Key**
During creation, the deployer can choose which configuration the pool will adhere to. E.g., user A could opt for the Memez configuration, while user B opts for Blast.fun configuration.
{% hint style="info" %}
Integrators need to request our team to add their configuration.
{% endhint %}
### Fees
Memez.fun has 3 fees:
```rust
public enum Fee has copy, drop, store {
Value(u64, Distributor),
Percentage(BPS, Distributor),
}
public struct FeePayload has copy, drop, store {
value: u64,
percentages: vector,
recipients: vector,
}
public struct Allocation has store {
balance: Balance,
vesting_periods: vector,
distributor: Distributor,
}
public struct MemezFees has copy, drop, store {
creation: FeePayload,
meme_swap: FeePayload,
quote_swap: FeePayload,
migration: FeePayload,
allocation: FeePayload,
vesting_periods: vector,
dynamic_stake_holders: u64,
}
```
* **Creation:** Sui amount charged to create a meme coin + pool.
* **MemeSwap:** % charged on every sell or buy in meme coin.
* **QuoteSwap:** % charged on every sell or buy in quote coin.
* **Migration:** Meme coin % to be used for DEX liquidity after migration.
* **Allocation:** Meme coin % allocated for the stake holders.
* **Vesting Period:** The duration of the linear vesting for the allocation.
* **Dynamic Stake Holders:** The number of stake holders the pool requires during creation.
The integrator can decide the total amount of each fee and the number of recipients per fee. It is **possible to charge no fees at all** and **different percentages and recipients per fee**. The swap and migration fee include the deployer as one of the recipients if chosen by the integrator.
> **For example an integrator can decide to have:**
>
> * Creation Fee of 2 Sui:
> * 20% to X
> * 60% to Y
> * 20% to Z
> * No Swap fee
> * 10 % Migration quote fee
> * 50% to A
> * 50% to B
> * 5% Meme coin allocation to stake holders
### Pump Configuration
At pool creation the sender configures the values below.
```rust
public struct PumpConfig has copy, drop, store {
burn_tax: u64,
virtual_liquidity: u64,
target_quote_liquidity: u64,
liquidity_provision: BPS,
quote_type: TypeName,
}
```
* **Burn Tax:** The burner tax explained above
* **Virtual Liquidity:** The floor price of the Meme coin as determined by a virtual Sui amount
* **Target Sui Liquidity:** The amount of Sui the pool must collect to migrate. It can be seen as a target price.
* **Liquidity Provision:** Percentage of Meme coin to be used to seed the liquidity pool during migration.
* **Quote Type:** The type of the quote Coin\.
### Burn Tax
The **Auction and Pump** strategies have a burn tax built-in. This is a dynamic tax that increases linearly as the amount of Sui in the pool increases. It can range from 0 to 30%. **This tax is only applied when one sells Meme coins for Sui.** The coins are actually burnt (not sent to 0x0) as Memez uses the [IPX Coin Standard](/overview/sui/ipx-coin-standard) for all meme coins. This is to prevent king of the hill griefing tactics. As the tax is quite high when it is close to bonding.
```rust
public struct MemezBurner has copy, drop, store {
fee: BPS,
target_liquidity: u64,
}
```
* **Fee:** A percentage in bps to determine how much amount to burn.
* **Target Liquidity:** The liquidity required t migrate the pool.
**Example**
> **Burner tar Tax Formula**
>
> progress = current\_liquidity / target\_liquidity
>
> tax = burner\_tax \* progress\
> \ **Example**
>
> Let's assume we have a pool using the **Pump strategy** with a **Sui Target Amount of 1\_000 Sui** and a **Burner tax of 20%** of 2\_000 basis points.
>
> **t0**: The pool has 0 Sui - burn tax would be 0%
>
> **Math:**
>
> progress = 0 / 1\_000 â 0
>
> 20% \* 0 / 1000 â 0%
>
> **t1**: The pool has 800 Sui - burn tax would be 16%
>
> **Math:**
>
> progress = 800 / 1\_000 â 80%
>
> 20% \* 80% â 16%
## Move Dependencies
### Interest BPS
It is an utility library to calculate percentages from values using basis points. It is referred as `BPS`in the code blocks.
### IPX Coin Standard
It is an utility library designed to separate the capabilities of the treasury cap (mint/burn/update) to provide the owner more granular control.
### Interest Math
A math library to safely perform operations.
### Constant Product
A library that calculates the amount in and out of the constant product formula `k = x * y`
# Migrators
## XPump
[Implementation](https://github.com/interest-protocol/memez-gg/blob/main/migrators/xpump/sources/xpump.move#L181)
The Blast.fun migrator creates a new pool on Bluefin and adds liquidity. The liquidity position is saved and can later be used by the Admin or developer to claim fees based on the configuration.
```rust
public fun migrate_to_new_pool_v3(
config: &mut XPumpConfig,
bluefin_config: &mut GlobalConfig,
clock: &Clock,
ipx_treasury: &IPXTreasuryStandard,
meme_metadata: &CoinMetadata,
quote_metadata: &CoinMetadata,
migrator: MemezMigrator,
fee: Coin,
ctx: &mut TxContext,
): Coin
```
The Bluefin pool is initiated with the following parameters:
* **Tick Spacing:** 200.
* **Initialized Price:** Dynamically calculated based on the quote and meme coin balances to be added.
* **Tick Lower Index:** 4294523696
* **Tick Upper Index**: 443600
* This is to ensure full range liquidity
# Bonding Curve
The **pump and auction** strategies utilize the [**constant product invariant**](https://www.reddit.com/r/ethereum/comments/55m04x/lets_run_onchain_decentralized_exchanges_the_way/) popularized by UniswapV2. The **stable** strategy utilizes a **fixed rate** to provide a no loss bonding curve.
## Constant Product
$$
k = x \* y
$$
* **k** = constant
* **x** = Reserves of Coin X
* **y** = Reserves of Coin Y
This formula defines the **pricing relationship** between **Coin X** and **Coin Y** in a pool.
**Pricing Function**
Xâ \* Yâ = K
Xâ = X + amountIn
Yâ = Y - amountOut
X \* Y = (X + amountIn) \* (Y - amountOut)
XY / (X + amountIn) = Y - amountOut
XY / (X + amountIn) - Y = -amountOut
XY / (X + amountIn) - Y (X + amountIn) / (X + amountIn) = - amountOut
\- Y \*amountIn / (X + amountIn) = - amountOut
We conclude that **amountOut in Y** is defined by
$$
Y \* amountIn / X + amountIn
$$
After every mutation, we ensure that the pool **always maintains the invariant k = x \* y** by using the pricing formula above.
## Virtual Liquidity
The use of virtual liquidity to create a floor price for the meme coin brings **two benefits:**
* Allows the token creator to start a market **without supplying any Sui liquidity**
* Prevents early buyers from getting too much supply.
Let us assume a pool of **Meme/Sui**. All pools on Memez.Fun use the Meme coin as the base coin and Sui as the quote coin. For example, let's imagine the absence of fees and first buy from the coin creator. If we would set up a pool with 1 billion coins of Meme and 0 Sui, we would break the invariant as `k = 1e9 * 0.`
This means that the **pool would always be worth 0.** To circumvent this issue, UniV2 forces the user to **always supply both coins**: the base coin and the quote coin. This is where virtual liquidity comes in, we can virtually set the pool with a floor price without requiring any investment from the token creator.
For example, We can set the virtual liquidity to be 1,000 Sui. If we assume that Sui is 5 dollars for simplicity sake, this means that at pool creation. The pool would be worth 10 thousand USD:
* 5 Thousand worth of Sui
* 5 Thousand worth of Meme
Assume we create Meme coin with 1e9 supply. **1 Meme coin** would be worth **0.000001 Sui or \~$0.000005** (assuming Sui is $5).
$$
Price = y / x\MemePrice = Sui Reserve / Meme Reserve
$$
Memez.Fun has a target Sui reserve that once it is achieved, the pool is migrated to a DEX.
Let's assume that we want the pool to migrate once the Meme achieves a market cap of **$60,000.**
**Pool at start:**
* **Virtual Liquidity:** 1,000 Sui
* **Sui Reserves:** 0
* **Meme Reserves:** 1e9
* **Target Sui Reserve:** 2,464 Sui
* **Meme Coin price:** 0.000001 Sui
* **Target Meme Coin price:** 0.000012 SUI
* **Pool Value:** $0
* **Pool Virtual Value**: $10,000
Target Meme Coin price explanation:
> $60\_000 / 1e9 Meme coin = $0.00006 per Meme
>
> In Sui: $0.00006/$5 = 0.000012 SUI per Meme
>
> **0.000012 SUI per Meme Coin \* 1e9 Meme Coin = 12,000 Sui \~ ($60,000)**
**How do we come up with a target Sui Reserve of 2,464 Sui?**
* **Target Price** = 0.000012 Sui
* **k = x \* y** = 1e12 (1e9 \* 1000)
> x \* (0.000012x) = 1e12
>
> 0.000012xÂČ = 1e12
>
> x = sqrt(1e12/0.000012) â 288,675,135 Meme tokens
>
> Final y = 1e12/288,675,135 â 3,464 Sui
>
> Sui needed = 3,464 - 1,000 = 2,464 Sui
**Conclusion:** We would need a total of **$12,321** (2,464 Sui) to migrate.
> If we use the pricing formula above, we can see that it holds true:
>
> (1e9 Meme \* 2,464 Sui) / (1,000 Sui + 2,464 Sui) = 711,316,397 Meme
>
> 1e9 - 711,316,397 = 288,683,603
The pool would have **288,683,603 Meme and 3,464 Sui after a 2,464 Sui purchase**. Using the price formula.
> **Price = y / x**
>
> 3,464 Sui / 288,683,603 Meme \~ 0.000012
>
> 0.000012 \* 1e9 = 12,000 Sui ($60,000)
**Pool at the end:**
* **Virtual Liquidity:** 1,000 Sui
* **Sui Reserves:** 2,464
* **Meme Reserves:** 288,683,603
* **Target Sui Reserve:** 2,464 Sui
* **Meme Coin price:** 0.000012 Sui
* **Target Meme Coin price:** 0.000012 Sui
* **Pool Value:** $12,320
* **Pool Virtual Value**: $17,320
# Fees
Memez.gg has a versatile fee mechanism enforced by the contracts. Each integrator is able to customize their fees parameters.
{% hint style="success" %}
The system supports 0 fees.
{% endhint %}
### Fee Mechanism
Depending on the fee, it can be defined in basis points percentage or in a nominal value.\
The fees are collected by the stake holders depending on how the configuration is set.
#### Fees Configuration
Each fee below requires the following configuration:
* Fee Value
* Address of fee recipients
* Percentage that each recipient should receive in basis points.
If we set the **Creation Fee** to 2 Sui and the recipients to be the following: **Alice (20%)**, **Bob (50%)** and **Jose (30%).**
At pool creation, the contract will automatically send **0.4 Sui to Alice**, **1 Sui to Bob** and **0.6 Sui to Jose**. The system supports **dynamic fee recipients** at pool creation and **system enforced ones** as well.\
\
For example, we can set that **20% of the creation fee always goes to the integrator**, while the rest of the **fees recipients are set dynamically at pool creation**.
* **Creation:** This fee is collected when a pool is created and it is defined in a nominal value. It is always charged in Sui.
* **Meme Coin Swap:** This fee is collected on every swap and is defined in percentage in meme coin.
* **Quote Coin Swap:** This fee is collected on every swap and is defined in percentage in quote coin.
* **Migration:** This fee is charged in Sui from the liquidity being migrated in percentage.
* **Allocation:** This fee is charged in meme coin after migration in percentage.
The fees configuration can be fetched via the SDK using the following [**method**](https://github.com/interest-protocol/sdk-monorepo/blob/main/packages/memez-fun-sdk/src/sdk.ts#L97)**.**
At pool creation, the caller can pass an [**array of stakeholders (Sui addresses)**](https://github.com/interest-protocol/sdk-monorepo/blob/main/packages/memez-fun-sdk/src/pump.ts#L94) to set dynamic fee recipients. This has to match the number of fees distribution set by the integrator.\
\
For example: if the integrator sets the creation fee to be **2 Sui and have 3 recipients** and **one recipient to always be the system**. The pool creator must pass two additional addresses dynamically.
### Blast.fun Configuration
Blast.fun fees configuration has 4 system addresses that earn **migration and swap fees.**
* **Blast** 0xef4145dc8710cb56970a56607a1a36da6db655ddaf1991d9f3bc3d859a81cd42
| Creation | Meme Swap | Quote Swap | Migration | Allocation |
| --------- | ----------- | ---------- | ---------- | ----------- |
| **0 Sui** | 0**%** | 1.2% | **5%** | 5**%** |
| | | 80% Blast | 100% Blast | 100% Blast |
| | | 20% Dev | | |
Blast.fun has two owned public addresses:
* **Treasury:** 0xaab6feadd3236ecc1b4fa34d00356f0f826f5e3d225818cb738ccdf77dcac979
* **Bluefin LP Manager:** 0x22441936a0d6fd21d07d596813dfa29fbc54d44b94eb87916fbcb51d639fde96
# IPX Coin Standard
An extension to Sui Network's Coin. Coins created via the IPX Coin Standard can be minted, burnt and updated with different capabilities.
## Problem
Coins created via Sui Network Coin have all the rights associated with one capability, the **TreasuryCap**.
The holder of the **TreasuryCap can mint, burn and update** the Coin**.** This design is quite limiting because all the rights are associated with a single capability.
> What happens if a user wants to ensure that its coin can be burnt but not mintable? He would have to write its own contract.
Most users choose to simply send the **TreasuryCap** to the systems address, the famous 0x0, because no one has access to it. Therefore it is considered burnt. However, since no one has access to the TreasuryCap, no one can burn the coin nor update its icon, description, symbol or name.\
\
There are cases in which coins need to update its metadata due to a rebrand or broken uris.
## Solution
The IPX Coin Standard separates the three rights of the **TreasuryCap** into t**hree separate capabilities: Burn, Mint and Update metadata**. This flexible design means that a user can make his/her coin burnable while preventing coins to be minted forever.
* `MintCap` allows the holder to mint coins
* `BurnCap` allows the holder to burn coins
* `MetadataCap` allows the holder to update the coin name, description, icon uri and symbol
{% hint style="info" %}
**The deployer can choose to make the coin burnable by anyone who has coins in his/her wallet.**
{% endhint %}
At deployment the user can choose to make the coin mintable, burnable and/or updateable and decide who has those rights.\
\
The code is open source on [Github](https://github.com/interest-protocol/interest-mvr/tree/main/ipx-coin-standard) and [immutable](https://suiscan.xyz/mainnet/tx/CZ8jqNcpm9aJK8NHP6bvLZruz4Rpq2BT46qZrmkV5q7K). Not even the IPX team can change the standard making it safe to use.
**Mainnet Package Address:** 0xa204bd0d48d49fc7b8b05c8ef3f3ae63d1b22d157526a88b91391b41e6053157\
\ **Testnet Package Address:** 0x3d9d9cf7f37daa21d6439bb4f3e90b49312cc1471e159e0b34ef18a36332ccda
## MVR
IPX Coin standard is available on [Move Registry](https://www.moveregistry.com/package/@interest/coin-standard).
```bash
mvr add @interest/coin-standard --network mainnet
```
# Movement
# Interest Protocol Decentralized Exchange (DEX)
Welcome to **Interest Protocol DEX**, a versatile decentralized exchange built on the **Movement Network**. The platform is designed for seamless trading, advanced liquidity management, and effortless token creation, all while incorporating cutting-edge security features to protect users from common exploits like sandwich attacks.
### **Get Started**
1. **Visit the Platform**: [Interest Protocol DEX](https://www.interest.xyz/)
2. **Swap Tokens**: Trade safely with built-in protections.
3. **Manage Liquidity**: Provide liquidity with ease using dynamic tools.
4. **Create Tokens**: Launch and deploy liquidity pools effortlessly.
***
**Interest Protocol DEX** is your gateway to secure, efficient, and innovative DeFi trading. Dive in today and explore its powerful tools to transform your crypto journey!
# Key Features
### **1. Token Swap**
The **Swap Tool** allows users to exchange tokens directly in a simple and intuitive interface. With built-in protection against sandwich attacks, Interest Protocol ensures users can trade safely without the risk of bots exploiting their transactions.
**Example: How to Swap Tokens**
* Visit [**Interest Protocol DEX**](https://www.interest.xyz/).
* Select the tokens you want to swap (e.g., **MOVE** â **RUCO**).
* Enter the desired amount and confirm the transaction.
* The DEX processes your swap securely with price stability thanks to its **slot windows**, which mitigate sandwich attacks.
**Swap Tutorial**
{% embed url="" %}
This feature ensures smooth transactions, even in volatile markets, with no extra steps required from the user.
***
### 2. **Advanced Liquidity Management**
Interest Protocol introduces a robust liquidity layer where projects and users can manage pools effortlessly. This feature supports both **passive liquidity provision** and innovative functionalities for liquidity providers (LPs):
* **One-Sided Liquidity**: LPs can provide liquidity with a single token, eliminating the need for equal-value pairs.
* **Dynamic Liquidity Adjustment**: The protocol automatically adjusts liquidity positions, reducing impermanent loss and enhancing fee capture for LPs.
* **Multi-Coin Pools**: Pools can include more than two assets, enabling creative and efficient trading pairs.
* **LpCoins**: Unlike traditional NFTs for liquidity, **LpCoins** are fungible, composable, and easily tradable, enhancing their usability within DeFi ecosystems.
***
### 3. **Create and Launch Tokens**
The **Token Launcher** is a powerful tool that allows anyone to create and launch new tokens without requiring coding skills. Along with token creation, users can seamlessly deploy liquidity pools to support their tokens.
**Steps to Create and Launch a Token**
1. Navigate to the [**Create Token**](https://www.interest.xyz/create-token) page.
2. Fill in token details:
* **Name**, **Symbol**, **Description**, and upload a **Logo**.
3. Set the **Total Supply**.
4. Choose to deploy a liquidity pool during the creation process.
5. Specify the amount of liquidity to add for your tokenâs pool.
6. Confirm the transaction, and your token is live, backed by a liquidity pool.
{% embed url="" %}
This feature empowers developers and community members to bring new tokens to market efficiently and securely, fostering innovation in the DeFi space.
# Core Innovations
### Sandwich Attack Prevention
Interest Protocol protects users from sandwich attacks by introducing **slot windows** where the bid price remains constant during transactions. This innovative approach discourages malicious bots by making such attacks unprofitable.
### Stable Curve
The protocol uses a hybrid bonding curve for correlated assets, combining:
* **Constant Product Invariant**: Ensures balanced liquidity.
* **Constant Sum Invariant**: Amplifies liquidity around the mid-range for optimal pricing.
### Volatile Curve
For volatile assets, the platform tracks prices with an internal **exponential moving average (EMA)**, concentrating liquidity around the current market price to enhance trading efficiency.
### Hooks for Customization
Inspired by Uniswap V4, **hooks** enable deployers to customize pools with advanced features such as:
* Pre-swap/post-swap computations.
* Fee-on-swap models.
* Custom oracles or limit orders.
# sr-AMM
Sandwich Resistant Automated Market Maker
### What is sandwich attacks and why should I care?
*"Just let me ape"* - everyday degenerate
AMMs are the primarly venue for meme coin trading and users tend to use high slippage to guarantee early entries. What most do not realize is that this exposes them to sandwich bots. This is a major issue that, for reference 50K Solana was essentially stolen in 1 month in 2024 due to this. The way is works is that Bots can see your transaction on the meme pool and simply place one to buy beforehand and another to sell right after. The first transaction increases the price, the user then purchases at a higher price increasing it further and then the bot sells at a profit.
### Fine, what do I do?
Glad you ask, all you have to do is trade on Interest Protocol! Our AMM prevents most of the sandwich bot attacks by introducing slot windows in which the bid price is constant. In simpler terms, if a bot sandwiches you, it will lose money. There are no extra steps needed for the users, it is an invisible solution to the application layer.
\
For further reading check out this [article](https://www.umbraresearch.xyz/writings/sandwich-resistant-amm).
# V3 (Soon)
# Audits
[interest.xyz](https://www.interest.xyz/) Aptos Move CLAMM
{% file src="/files/KJqv3PKQysZEKnOK0re6" %}
[Memez.gg](https://www.memez.gg/) launchpad
{% file src="/files/yCA0pDasGd8RxeM73AKC" %}
{% file src="/files/k5sRBa4h7w3BbHECOwyb" %}
[interest.xyz](https://www.interest.xyz/) Movement Dynamic-Peg + Stable DEX
{% file src="/files/QPEo705dh0edEO0RP276" %}
[interestprotocol.com](https://www.interestprotocol.com/) Sui Dynamic-Peg + Stable DEX
{% file src="/files/AYrRAve8rq8aRZQsFSGK" %}
[https://www.winterwalrus.com](https://www.winterwalrus.com/) LST
{% file src="/files/KpUyQ3oGQNfxo6gYcAmI" %}
# Security
DeFi has justly been criticized for its subpar security standards. Last year, we saw a 300 million USD hack on Solana wormhole. Security is a constant battle, and there is no single solution for it. We will always prioritize security over features or development speed.
We will employ the following **security measures** to fight hacks:
* 100% unit test coverage
* Formal verification tools once Move prover is updated
* Working MVP on a test-net before deployment
* Security audits before every deployment
* Upgradeable contracts to fix bugs post-deployment
* Bug bounties
* Secure oracles with backups
* Time locks to protect users from future changes
* Multi-signature wallets
## **We are Open-source**
Open source platforms like Interest Protocol promote transparency and builds trust, encourages collaboration and innovation. We are accessible to users even those with limited resources. We feel secure because our vulnerabilities can be identified and fixed faster.
{% embed url="" %}
# Deprecated
This is code that is pending to change and is not longer recommended to be used in production.
# Coin X Oracle đź
### Purpose
Coin X Oracle allows developers to easily deploy price oracles from various feeds without having to worry about each provider's intricacies and interfaces.
Upon requesting a price update, the Coin X Oracle will collect the price from various feeds and run a set of checks to make sure of its liveness and accuracy.
### Flow
1. Request a price update
2. Collect the data from predetermined providers.
3. Run a set of checks to ensure the price accuracy and liveness.
### Security
The entire process from the data request to reading it inside a DeFi dApp happens in one transaction block atomically through the use of hot potatoes. Price consumers have 100% confidence in the liveness and accuracy of the data.
### Feeds
The following feeds are available:
* [Pyth Network](/overview/deprecated/coin-x-oracle/pyth-network)
* [Switchboard](/overview/deprecated/coin-x-oracle/switchboard)
{% hint style="info" %}
Refer to the SuiTears[đ§](https://emojipedia.org/droplet)interface documentation to learn Coin X Oracle's interface.
{% endhint %}
{% embed url="" %}
# Pyth Network
Reliable, low-latency market data from institutional sources.
## [Why Pyth?](https://pyth.network/)
The first price provider supported by Coin X Oracle is Pyth Network. It is the leading Oracle provider on Sui Network and the largest first-party Oracle Network in the world. It supports of over 50 chains and offers 450 price feeds.
#### First Party Institutional Providers
Pyth network data sources do not rely on intermediaries to ensure reliability and liveness of the data.
**Price Confidence**
Pyth Network is the only provider that offers a price confidence metric in all price feeds. Assets do not have a single price in a market at any given point in time. By providing a confidence range, DeFi dApps can design their invariant to take into account price variance.
## [Interface](https://github.com/interest-protocol/coin-x-oracle/blob/main/contracts/sources/pyth.move)
### Structs
```rust
struct PriceInfoObjectKey has copy, drop, store {}
```
A dynamic field key to store the `sui::object::ID` of the `pyth::price_info::PriceInfoObject` that can that provide data to the oracle.
```rust
struct ConfidenceKey has copy, drop, store {}
```
A dynamic field key to save the minimum required price confidence. It is a percentage, where 100% is represented by 1e18.
```rust
struct PythFeed has drop {}
```
A witness that is added to the `suitears::oracle::Request` to prove that it collected data from Coin X Oracle's Pyth Network module.
### Functions
#### report
**It requests a price from Pyth Network and submits the information to a Coin X oracle request.**
```rust
public fun report(
oracle: &Oracle,
request: &mut Request,
wormhole_state: &WormholeState,
pyth_state: &PythState,
buf: vector,
price_info_object: &mut PriceInfoObject,
pyth_fee: Coin,
clock_object: &Clock
)
```
* **@param self.** A `suiterars::oracle::Oracle` with this module's witness.
* **@param request.** A hot potato issued from the `self` to create a `suiterars::oracle::Price`.
* **@param wormhole\_state.** The state of the Wormhole module on Sui.
* **@param pyth\_state.** The state of the Pyth module on Sui.
* **@param buf.** Price attestations in bytes.
* **@param price\_info\_object.** An object that contains price information. One per asset.
* **@param pyth\_fee.** There is a cost to request a price update from Pyth.
* **@param clock\_object.** The shared Clock object from Sui
**Aborts**
* the `price_info_object` is not whitelisted.
* the price confidence is out of range.
* the price is negative or zero.
{% embed url="" %}
# Switchboard
## [Why Switchboard ?](https://docs.switchboard.xyz/)
Switchboard provides a trusted execution environment to ensure off-chain oracles are not tempered with.It also allows for developers to deploy custom oracles.
## Interface
### Structs
```rust
struct AggregatorKey has copy, drop, store {}
```
A dynamic field key to store the address of the `switchboard::aggregator::Aggregator` that can that provide data to the oracle.
```rust
struct SwitchboardFeed has drop {}
```
A witness that is added to the `suitears::oracle::Request` to prove that it collected data from Coin X Oracle's Pyth Network module.
### Functions
#### report
**It requests a price from Pyth Network and submits the information to a Coin X oracle request.**
```rust
public fun report(oracle: &Oracle, request: &mut Request, aggregator: &Aggregator)
```
* **@param self.** A `suiterars::oracle::Oracle` with this module's witness.
* **@param request.** A hot potato issued from the `self` to create a `suiterars::oracle::Price`.
* **@param aggregator.** `switchboard::aggregator::Aggregator` that the `self` will use to fetch the price.
**Aborts**
* the `aggregator` is not whitelisted.
* the `aggregator` price is negative or zero.
# Sui Tears đ§
[Sui Tears](https://github.com/interest-protocol/suitears) is an open source production ready Sui Move library to increase the productivity of new and experienced developers alike.
### [Airdrop](#airdrop)
* [**Airdrop Utils** ](/overview/deprecated/sui-tears/airdrop/airdrop-utils)- Verify function for the airdrop modules.
* [**Airdrop**](/overview/deprecated/sui-tears/airdrop) - A pull design airdrop to distribute tokens after a specific date.
* [**Linear Vesting Airdrop** ](/overview/deprecated/sui-tears/airdrop/linear-vesting-airdrop)**-** A pull design airdrop to distribute tokens according to a linear vesting schedule.
### [Capabilities](#capabilities)
* [**Owner**](/overview/deprecated/sui-tears/capabilities/owner) **-** Owner capability to give access to multiple objects.
* [**Quest**](/overview/deprecated/sui-tears/capabilities/quest) **-** A wrapper that can only be unwrapped once a set of actions are completed.
* [**Time Lock**](/overview/deprecated/sui-tears/capabilities/timelock) **-** A wrapper that can only be unwrapped after a set timestamp.
### [Collections](#collections)
* [**Access Collection**](broken://pages/02jnXqjdVKIzyRFmMKgg) - Capability access wrapper for collections.
* [**BitMap**](/overview/deprecated/sui-tears/collections/bitmap) - Bitmap implementation for sequential keys.
* [**Coin Decimals**](/overview/deprecated/sui-tears/collections/coin-decimals) - A Collection that stores coin decimals.
* [**Witness Collection**](broken://pages/Lkp0XsBmGiH4iZw8VM1h) **-** Witness access wrapper for collections.
### [DeFi](#defi)
* [**Farm** ](/overview/deprecated/sui-tears/defi/farm)**-** Module to reward coin stakers over time.
* [**Fund**](/overview/deprecated/sui-tears/defi/fund) - Struct to track shares associated with underlying deposits/withdrawals.
* [**Linear Vesting Wallet**](/overview/deprecated/sui-tears/defi/linear-vesting-wallet) - Wallet that distributes tokens according to a linear vesting schedule.
* [**Linear** **Vesting Clawback Wallet**](/overview/deprecated/sui-tears/defi/linear-clawback-vesting-wallet) **-** Wallet that distributes tokens according to a linear vesting schedule and allows the owner to reclaim the locked coins.
* [**Vesting**](/overview/deprecated/sui-tears/defi/vesting) - Virtual implementation of vesting schedules
### [Governance](#governance)
* [**Dao**](/overview/deprecated/sui-tears/governance/dao) **-** Decentralized autonomous organization
* [**Dao Admin**](/overview/deprecated/sui-tears/governance/dao-admin) **-** The admin capability for DAOs
* [**Dao Treasury**](/overview/deprecated/sui-tears/governance/dao-treasury) - Treasury plugin for DAOs
### [Math](#math)
* [**Fixed Point 64**](/overview/deprecated/sui-tears/math/fixed-point-64) - Fixed point math module for numbers scaled to x << 64.
* [**Fixed Point Roll** ](/overview/deprecated/sui-tears/math/fixed-point-roll)- Fixed point math module for numbers with 1e9 precision.
* [**Fixed Point Wad**](/overview/deprecated/sui-tears/math/fixed-point-wad) **-** Fixed point math for module for numbers with 1e18 decimals.
* [**Math64**](/overview/deprecated/sui-tears/math/math64) **-** Utility math functions for u64 numbers.
* [**Math128**](/overview/deprecated/sui-tears/math/math128) - Utility math functions for u128 numbers.
* [**Math256**](/overview/deprecated/sui-tears/math/math256) **-** Utility math functions for u256 numbers.
* [ **Int**](/overview/deprecated/sui-tears/math/int) - Module to handle signed integer operations.
### [Utils](/overview/deprecated/sui-tears/utils)
* [**Comparator**](/overview/deprecated/sui-tears/utils/comparator) **-** Module to compare u8 vectors (bits).
* [**Merkle Proof**](/overview/deprecated/sui-tears/utils/merkle-proof) **-** Module to verify Merkle proofs.
* [**ASCII Utils**](/overview/deprecated/sui-tears/utils/ascii) **-** A set of functions to operate on ASCII strings.
* [**Vectors**](/overview/deprecated/sui-tears/utils/vectors) **-** Utility functions for vectors.
# Airdrop
# Airdrop
Sui Tears[đ§](https://emojipedia.org/droplet) Airdrop modules are "pulled" based. The modules store the root of a Merkle tree that consists of the address of the user and the airdrop amount. Users are required to submit a Merkle proof to claim their airdrops. The leafs are constructed by hashing (sha3256) the sender's address concatenated with the amount.
Please check [here](https://github.com/interest-protocol/suitears/blob/main/utils/src/airdrop-tree.ts) on how to construct the Merkle Tree.
## Structs
### **Airdrop**
```rust
struct Airdrop has key, store {
id: UID,
balance: Balance,
root: vector,
start: u64,
map: Bitmap
}
```
* **balance** - Coins to airdrop
* **root** - The root of the Merkle tree
* **start** - The timestamp in which users can claim the airdrop
* **map** - Bitmap keeps track of airdrop claims.
## Interface
### new
**It creates the Airdrop object.**
```rust
public fun new(airdrop_coin: Coin, root: vector, start: u64, c: &Clock, ctx: &mut TxContext): Airdrop
```
* **@param airdrop\_coin:** The coin that will be distributed in the airdrop.
* **@param root:** The Merkle tree root that keeps track of all the airdrops.
* **@param start:** The start timestamp of the airdrop in milliseconds.
* **@param c:** The `sui::clock::Clock` shared object.
* **@return** Airdrop\
**Aborts**
* root is empty.
* start time of the airdrop is in the past.
### balance
**Returns the current amount of airdrop coins in the Airdrop object.**
```rust
public fun balance(self: &Airdrop): u64
```
* **@param:** self The shared Airdrop object
* **@return** u64
### root
**Returns the root of the Merkle tree for the airdrop.**
```rust
public fun root(self: &Airdrop): vector
```
* **@param:** self The shared Airdrop object.
* **@return** vector\.
### start
**Returns the start timestamp of the airdrop. Users can claim after this date.**
```rust
public fun start(self: &Airdrop): u64
```
* **@param:** self The shared Airdrop object.
* **@return** u64.
### borrow\_map
**Returns an immutable reference of the Bitmap. It keeps track of the claimed airdrops.**
```rust
public fun borrow_map(self: &Airdrop): &Bitmap
```
* **@param:** self The shared Airdrop object.
* **@return** \&Bitmap.
### has\_account\_claimed
**Checks if a user has already claimed his airdrop.**
```rust
public fun has_account_claimed(
self: &Airdrop,
proof: vector>,
amount: u64,
user: address
): bool
```
* **@param self:** The shared Airdrop object.
* **@param proof:** The proof that the sender can redeem the `amount` from the airdrop.
* **@param amount:** Number of coins the sender can redeem.
* **@param address:** A user address.
* **@return** bool. True if he has claimed the airdrop already.
**Aborts**
* If the `proof` is not valid.
### get\_airdrop
**Allows a user to claim his airdrop by proving that his address and amount are in the Merkle tree.**
```rust
public fun get_airdrop(
self: &mut Airdrop,
proof: vector>,
c: &Clock,
amount: u64,
ctx: &mut TxContext
): Coin
```
* **@param self:** The shared Airdrop object.
* **@param proof:** The proof that the sender can redeem the `amount` from the airdrop.
* **@param c:** The `sui::clock::Clock` shared object.
* **@param amount:** Number of coins the sender can redeem.
* **@return** Coin\. The airdrop Coin.
**Aborts**
* If the `proof` is not valid.
* The airdrop has not started yet.
* The user already claimed it
### destroy\_zero
**Destroys an empty Airdrop object.**
```rust
public fun destroy_zero(self: Airdrop)
```
* **@param self:** The shared {Airdrop} object.
**Aborts**
* The `self` has left over coins.
# Airdrop Utils
Airdrop utils module contains the verify function to check if a Merkle proof combined with an address and amount are part of the Merkle tree root.
### verify
**Checks if the sender is allowed to redeem an `amount` from an airdrop using Merkle proofs. It returns the index of his Merkle proof to add to the Bitmap struct.**
```rust
public fun verify(
root: vector,
proof: vector>,
amount: u64,
sender: address
): u256
```
* **@param root:** The Merkle tree root that keeps track of all the airdrops.
* **@param proof:** The proof that the sender can redeem the `amount` from the airdrop.
* **@param amount:** The airdrop amount.
* **@param sender:** The address of the airdrop user.
* **@return** u256. An index.
**Aborts**
* if the leaf or proof are invalid.
# Linear Vesting Airdrop
Sui Tears[đ§](https://emojipedia.org/droplet) Airdrop modules are "pulled" based. The modules store the root of a Merkle tree that consists of the address of the user and the airdrop amount. Users are required to submit a Merkle proof to claim their airdrops. The leafs are constructed by hashing (sha3256) the sender's address with the amount. This module returns the airdrop inside a linear vesting airdrop wallet.
Please check [here](https://github.com/interest-protocol/suitears/blob/main/utils/src/airdrop-tree.ts) on how to construct the Merkle Tree.
## Structs
### **Airdrop**
```rust
struct Airdrop has key, store {
id: UID,
balance: Balance,
root: vector,
start: u64,
duration: u64,
map: Bitmap
}
```
* **balance** - Coins to airdrop
* **root** - The root of the Merkle tree
* **start** - The timestamp in which the vesting schedule starts.
* **duration** - The duration of the vesting schedule.
* **map** - Bitmap keeps track of airdrop claims.
## Interface
### new
**Creates a linear vested airdrop.**
```rust
public fun new(airdrop_coin: Coin, root: vector, start: u64, duration: u64, c: &Clock, ctx: &mut TxContext): Airdrop
```
* **@param airdrop\_coin:** The coin that will be distributed in the airdrop.
* **@param root:** The Merkle tree root that keeps track of all the airdrops.
* **@param start:** The start timestamp of the vesting schedule.
* **@param duration:** The duration of the vesting schedule.
* **@param c:** The `sui::clock::Clock` shared object.
* **@return** Airdrop\
**Aborts**
* root is empty.
* start time of the airdrop is in the past.
### balance
**Returns the current amount of airdrop coins in the Airdrop object.**
```rust
public fun balance(self: &Airdrop): u64
```
* **@param:** self The shared Airdrop object
* **@return** u64
### root
**Returns the root of the Merkle tree for the airdrop.**
```rust
public fun root(self: &Airdrop): vector
```
* **@param:** self The shared Airdrop object.
* **@return** vector\.
### start
**Returns the start timestamp of the airdrop. Users can claim after this date.**
```rust
public fun start(self: &Airdrop): u64
```
* **@param:** self The shared Airdrop object.
* **@return** u64.
### duration
**Returns the duration of the vesting schedule.**
```rust
public fun duration(self: &Airdrop): u64
```
* **@param:** self The shared Airdrop object.
* **@return** u64.
### borrow\_map
**Returns an immutable reference of the Bitmap. It keeps track of the claimed airdrops.**
```rust
public fun borrow_map(self: &Airdrop): &Bitmap
```
* **@param:** self The shared Airdrop object.
* **@return** \&Bitmap.
### has\_account\_claimed
**Checks if a user has already claimed his airdrop.**
```rust
public fun has_account_claimed(
self: &Airdrop,
proof: vector>,
amount: u64,
user: address
): bool
```
* **@param self:** The shared Airdrop object.
* **@param proof:** The proof that the sender can redeem the `amount` from the airdrop.
* **@param amount:** Number of coins the sender can redeem.
* **@param address:** A user address.
* **@return** bool. True if he has claimed the airdrop already.
**Aborts**
* If the `proof` is not valid.
### get\_airdrop
**Allows a user to claim his airdrop by proving that his address and amount are in the Merkle tree.**
```rust
public fun get_airdrop(
self: &mut Airdrop,
proof: vector>,
clock_object: &Clock,
amount: u64,
ctx: &mut TxContext
): Wallet
```
* **@param self:** The shared Airdrop object.
* **@param proof:** The proof that the sender can redeem the `amount` from the airdrop.
* **@param c:** The `sui::clock::Clock` shared object.
* **@param amount:** Number of coins the sender can redeem.
* **@return** Wallet. The airdrop Coin locked in a linear vested {Wallet}.
**Aborts**
* If the `proof` is not valid.
* The user already claimed it
### destroy\_zero
**Destroys an empty Airdrop.**
```rust
public fun destroy_zero(self: Airdrop)
```
* **@param self:** The shared {Airdrop} object.
**Aborts**
* The `self` has left over coins.
# Capabilities
# Access Control
It allows an admin to manage access control via roles.
## Structs
### AccessControl
```rust
struct AccessControl has key, store {
id: UID,
roles: VecMap, VecSet>
}
```
* **roles -** Map to store a role => set of addresses with said role.
### Admin
```rust
struct Admin has key, store {
id: UID,
access_control: address
}
```
* Address of the `AccessControl` this capability belongs to.
## Interface
### new
**It creates an \`AccessControl\` and an \`Admin\` with the \`SUPER\_ADMIN\_ROLE\`.**
```rust
public fun new(ctx: &mut TxContext): (AccessControl, Admin)
```
* **@return** \`AccessControl\`. It stores the role's data.
* **@return \`**Admin\`. The \`SUPER\_ADMIN\_ROLE\` \`Admin\`.
# Owner
It provides an Owner capability that stores the IDs of other objects, Modules can assert or check if a certain ID is stored in the Owner to prove its ownership. It is used to provide access control.
## Structs
### **OwnerCap**
```rust
struct OwnerCap has key, store {
id: UID,
of: VecSet
}
```
* **of - A set of IDs to prove that the Owner Capability has privileged access to it.**
## Interface
### new
**It creates an OwnerCap capability.**
```rust
public fun new(_: T, of: vector, ctx: &mut TxContext): OwnerCap
```
* **@param \_:** A witness to link an OwnerCap with the module that owns the witness.
* **@param of:** Vector of `sui::object::ID` that this capability owns.
* **@return** OwnerCap.
### contains
**It checks if an ID is stored in the Owner Capability.**
```rust
public fun contains(self: &OwnerCap, x: ID): bool
```
* **@param self:** An OwnerCap object.
* **@param x:** The `sui::object::ID` of an object.
* **@return** bool. True if the `self` owns `x`.
### of
**Returns the vector of `sui::object::ID` that the `self` owns.**
```rust
public fun of(self: &OwnerCap): vector
```
* **@param self:** A {OwnerCap} object.
* **@return** vector. The vector of `sui::object::ID`.
### add
**Assigns the `self` OwnerCap as the owner of `x`.**
```rust
public fun add(self: &mut OwnerCap, _: T, x: ID)
```
* **@param self:** An OwnerCap object.
* **@param \_:** A witness to make sure only the allowed module can add `sui::object::ID` to the self.
* **@param x:** The `sui::object::ID` of the object, which the `self` will have ownership rights to.
### remove
**Removes the `self` OwnerCap as the owner of `x`.**
```rust
public fun remove(self: &mut OwnerCap, _: T, x: ID)
```
* **@param self:** An OwnerCap object.
* **@param \_:** A witness to make sure only the right module can add the `sui::object::ID` to the self.
* **@param x:** The `sui::object::ID` of the object, which the `self` will lose its ownership rights to.
### destroy
**Destroys an OwnerCap. It does not require the of vector to be empty.**
```rust
public fun destroy(self: OwnerCap)
```
* **@param self:** An OwnerCap object.
### destroy\_empty
**Destroys an OwnerCap. It requires the of vector to be empty.**
```rust
public fun destroy(self: OwnerCap)
```
* **@param self:** A OwnerCap object.
**Aborts**
* If `of` vector is not empty.
### assert\_ownership
**Asserts that the `self` owns `x`.**
```rust
public fun destroy(self: OwnerCap)
```
* **@param self:** An OwnerCap object.
* **@param x:** The `sui::object::ID` of the object, which must belong to the capability.
**Aborts**
* If the ID is not owned by the capability.
# Quest
This module wraps an object labeled as rewards that can only be unwrapped if a set of witness objects are passed as arguments to the complete function. A witness is a struct with the drop key. The idea is to have a user complete a set of tasks for a reward in different protocols . The protocols certify that the user completed the task via their Witnesses.
## Structs
### **Quest**
```rust
struct Quest has key, store {
id: UID,
required_tasks: VecSet,
completed_tasks: VecSet,
reward: Reward,
}
```
* **required\_tasks** - Stores the Witnesses of all required tasks.
* **completed\_tasks** - Contains all the Witnesses the user must complete to unwrap the {Reward}.
* **reward** - An object that will be returned once the Quest has been completed.
## Interface
### new
**Creates a {Quest} .**
```rust
public fun new(
required_tasks: VecSet,
reward: Reward,
ctx: &mut TxContext
): Quest
```
* **@param required\_tasks:** A vector set of the required tasks to unlock the `reward`.
* **@param reward:** An object with the store ability that can be redeemed once all tasks are completed.
* **@return** Quest\.
### required\_tasks
**Returns the required tasks of the `self`.**
```rust
public fun required_tasks(self: &Quest): vector
```
* **@param self:** A {Quest}.
* **@return** vector\. A vector of the required Witness names to complete the quest.
### completed\_tasks
**Returns the completed tasks of the `self`.**
```rust
public fun required_tasks(self: &Quest): vector
```
* **@param self:** A {Quest}.
* **@return** vector\. A vector of the completed Witness names to complete the quest.
### complete
**Completes a quest by adding the witness `Task` name to the `self.completed_tasks` vector.**
```rust
public fun complete(self: &mut Quest, _: Task)
```
* **@param self:** A {Quest}.
* **@param:** \_ A witness `Task`.
### finish
**Finishes a quest and returns the `Reward` to the caller.**
```rust
public fun complete(self: &mut Quest, _: Task)
```
* **@param self:** A {Quest}.
* **@return:** Reward.
**Aborts**
* If the required\_tasks do not match the completed\_tasks
# Timelock
It locks any object with the store ability for a specific amount of time. We do not provide a function to read the data inside the {Timelock} to prevent capabilities from being used.
## Structs
### **Timelock**
```rust
struct Timelock has key, store {
id: UID,
unlock_time: u64,
data: T,
}
```
* **unlock\_time** - The unlock time in milliseconds.
* **data** - Any object with the store ability.
## Interface
### unlock\_time
**Returns the unlock time in milliseconds.**
```rust
public fun unlock_time(self: &Timelock): u64
```
* **@param self:** A {Timelock}
* **@return** u64. The `self.unlock_time`.
### lock
**Locks the `data` for `unlock_time` milliseconds.**
```rust
public fun lock(
data: T,
c: &Clock,
unlock_time: u64,
ctx: &mut TxContext
): Timelock
```
* **@param data:** An object with the store ability.
* **@param c:** The shared `sui::clock::Clock` object.
* **@param unlock\_time:** The lock period in milliseconds.
* **@return** {Timelock}.
**Aborts**
* `unlock_time` is in the past.
### unlock
**Unlocks a {Timelock} and returns the locked resource `T`.**
```rust
public fun unlock(self: Timelock, c:&Clock): T
```
* **@param self:** A {Timelock}
* **@param c:** The shared `sui::clock::Clock` object.
* **@return** **`T`**. An object with the store ability.
**Aborts**
* `unlock_time` has not passed.
# Collections
# Bitmap
BitMaps pack 256 booleans across each bit of a single 256-bit slot of `uint256` type. Hence booleans corresponding to 256 *sequential* indices would only consume a single slot, unlike the regular `bool` which would consume an entire slot for a single value.
## Structs
### **Bitmap**
```rust
struct Bitmap has key, store {
id: UID
}
```
The module adds dynamic fields to the Bitmap.
## Interface
### new
**Creates a Bitmap.**
```rust
public fun new(ctx: &mut TxContext): Bitmap
```
* **@return AcCollection.** Bitmap.
### get
**Checks if an `index`is set to true or false in the map.**
```rust
public fun get(self: &Bitmap, index: u256): bool
```
* **@param self:** A reference to the Bitmap.
* **@param index:** The slot to check if it is flagged.
* **@return bool.** If the `index` is true or false.
### set
**Sets the slot `index` to true in `self`.**
```rust
public fun set(self: &mut Bitmap, index: u256)
```
* **@param self:** A reference to the Bitmap.
* **@param index**: The slot we will set to true.
### unset
**Sets the slot `index` to false in `self`.**
```rust
public fun set(self: &mut Bitmap, index: u256)
```
* **@param self:** A reference to the Bitmap.
* **@param index**: The slot we will set to false.
### destroy
**Destroys the `self`.**
```rust
public fun destroy(self: Bitmap)
```
* **@param self:** self A bitmap to destroy.
# Coin Decimals
It stores information about Coins' decimals to allow protocols to fetch them. The idea is to pass a single argument `CoinDecimals` to functions that require several `sui::coin::CoinMetadata` objects.
## Structs
### **Decimals**
```rust
struct Decimals has store {
decimals: u8,
scalar: u64
}
```
* **decimals -** decimals of a `sui::coin`
* **scalar** - The scalar of a `sui::coin`'s decimals. It is calculated by 10^decimals. E.g. `sui::sui` has a scalar of 1\_000\_000\_000 or 1e9.
### **CoinDecimals**
```rust
struct CoinDecimals has key, store {
id: UID
}
```
The Decimals struct is saved in CoinDecimals using dynamic fields.
## Interface
### new
**It creates a new CoinDecimals.**
```rust
public fun new(ctx: &mut TxContext): CoinDecimals
```
* **@return** CoinDecimals.
### contains
**Checks if a coin with type `CoinType` has been added to `self`.**
```rust
public fun contains(self: &CoinDecimals): bool
```
* **@param** self A {CoinDecimals} object.
* **@return** bool. True if the coin's decimals and scalar are in the `self`.
### decimals
**Returns the decimals of a coin with the type `CoinType`.**
```rust
public fun decimals(self: &CoinDecimals): u8
```
* **@param** self A CoinDecimals object.
* **@return** u8. The decimals of the coin.
**Aborts**
* `CoinType` has not been added to the `self`.
### scalar
**Returns the decimals scalar of a coin with type `CoinType`.**
```rust
public fun scalar(self: &CoinDecimals): u64
```
* **@param** self A {CoinDecimals} object.
* **@return** u64. The decimal's scalar. It is calculated by 10^decimals.
**Aborts**
* `CoinType` has not been added to the `self`.
### add
**Adds the decimals and decimal scalar of a coin with type `CoinType` to `self`.**
```rust
public fun add(self: &mut CoinDecimals, coin_metadata: &CoinMetadata)
```
* **@param** self A CoinDecimals object.
* **@return** coin\_metadata The `sui::coin::CoinMetadata` of a coin with type `CoinType`.
# DeFi
# Oracle
An Oracle contract that collects price reports from several feeds and ensures they are within a price range and time limit.
## Structs
### **Oracle**
```rust
struct Oracle has key, store {
id: UID,
// Set of module Witnesses that are allowed to report prices.
feeds: VecSet,
// Reported prices must have a timestamp earlier than `current_timestamp - time_limit`.
// It is in milliseconds.
time_limit: u64,
// Reported prices must be within the following range: `leader_price + deviation % >= reported_price >= leader_price - deviation %`.
deviation: u256
}
```
* **feeds** - Set of module Witnesses that are allowed to report prices.
* **time\_limit** - Reported prices must have a timestamp earlier than \`current\_timestamp - time\_limit\`. It is in milliseconds.
* **deviation** **-** Reported prices must be within the following range: \`leader\_price + deviation % >= reported\_price >= leader\_price - deviation %\`.
### **Report**
```rust
struct Report has store, copy, drop {
price: u256,
timestamp: u64
}
```
* **price** - Price has 18 decimals.
* **timestamp -** Timestamp in milliseconds.
### **Price**
```rust
struct Price {
// `sui::object::ID` of the`Oracle` this request was sent from.
oracle: ID,
// The first reported price.
// Price has 18 decimals.
price: u256,
// It is always 18.
decimals: u8,
// The price was reported at this time.
timestamp: u64
}
```
* **oracle -** the \`sui::object::ID\` of the Oracle this request was sent from.
* **price -** The first reported price after all checks.
* **decimals -** It is always 18.
* **timestamp -** The time at which this price was reported.
## Interface
### new
**Creates an `Oracle` with a set of feeds.**
```rust
public fun new(
cap: &mut OwnerCap,
wit: Witness,
feeds: vector,
time_limit: u64,
deviation: u256,
ctx: &mut TxContext
): Oracle
```
* **@param cap:** An owner cap from `suitears::owner`. This `OwnerCap` will be the owner of the new `Oracle`.
* **@param wit:** A Witness from the module that will manage this `Oracle`.
* **@param feeds:** Feed Witnesses. Only modules in the `Oracle.feeds` can report a price in the `Request` hot potato.
* **@param time\_limit:** A time in milliseconds that determines how old a price timestamp can be.
* **@param deviation:** A percentage that determines an acceptable price range for all reported prices.
* **@return** Oracle\.
**Aborts**
* `feeds` vector has repeated values.
* `time_limit` must be higher than 0 milliseconds.
* `deviation` must be higher than 0.
### share
**Shares the `Oracle` object.**
```rust
public fun share(self: Oracle