Talus Token Project

This repository contains the smart contracts for the Talus Token project on Sui blockchain, featuring a custom token, a decentralized faucet for token distribution, a deposit pool for yield generation, and a reward pool for loyalty incentives.

Prerequisites

• Sui CLI installed
• jq for JSON processing
• bc for calculations
• Basic understanding of Sui smart contracts

Project Structure

talus-token/
├── talus/             # US token (Coin) 
├── faucet/            # Bi-directional faucet contract
├── loyalty/           # Loyalty token
├── deposit_pool/      # Deposit pool and reward pool contracts
└── deploy.sh          # Deployment script

Contracts

Talus Contract

A custom coin implementation on the Sui blockchain.

Loyalty Token Contract

A custom token implementation on the Sui blockchain. Repeated used for every deposit pool instance.

Faucet Contract

The faucet contract implements a faucet that enables exchanging between target token (e.g. TALUS) and base token (e.g. SUI) at a configurable exchange rate. Key features include:

• Configurable exchange rate between two tokens for test net so the Sybil attack resistance is based on supply of base token
• Percentage-based withdrawal limits to prevent draining
• Ability to inject additional liquidity
• Simple interface for minting and refunding

// Create a new faucet
let talus_coin = // ... obtain TALUS tokens
let exchange_rate = 10; // 1 SUI = 10 TALUS
let withdrawal_pct = 50; // 50% max withdrawal per tx
faucet::initiate<TALUS, SUI>(talus_coin, exchange_rate, withdrawal_pct, ctx);

// Mint TALUS using SUI
faucet::mint(faucet, sui_coin, ctx);

// Refund SUI by returning TALUS
faucet::refund(faucet, talus_coin, ctx);

// Add more liquidity
faucet::inject(faucet, additional_talus, ctx);

Deposit Pool Contract

A set of modules supports locking coins to receive tokens and exchanging them for rewards.

Deposit Pool Module

The deposit pool module allows users to deposit base tokens and earn loyalty tokens as rewards. Users can lock their tokens for different time periods with varying APY rates. Key features include:

• Multiple lock terms with configurable APY
• Early withdrawal support (configurable)
• Pending withdrawal period (optional)
• Admin-controlled reward pool integration
• Receipts for each deposit, enabling precise reward calculation
• Admin-controlled term extending option
• User can extend a pre-mature existed deposit to a higher term

// Initialize a deposit pool
let treasury_cap = // ... obtain Loyalty token treasury cap
let base_apy = 5; // APY
let rate_decimal = Some(2); // unit of 1% 
let early_withdrawal = true;
let withdrawal_pending_days = 2;
deposit_pool::deposit_pool::new<Base, Loyalty>(
    treasury_cap, base_apy, base_decimal, early_withdrawal, withdrawal_pending_days, ctx
);

// Deposit base tokens
deposit_pool::deposit_pool::deposit(pool, base_coin, term_days, clock, recipient, ctx);

// Withdraw and claim rewards
deposit_pool::deposit_pool::withdrawal(pool, receipt, clock, ctx);

Reward Pool Module

The reward pool module manages reward pools and allows users to claim rewards by spending loyalty tokens. Pools can be refreshed with more rewards, and events are emitted for transparency.

// Create a new reward pool
let reward_coin = 100// ... obtain reward tokens
let loyalty_per_unit = 10; 
let reward_per_unit = 1; // 10 Loyalty tokens per reward token
let minimum_expected_reward = 10; 
deposit_pool::reward_program::new_reward_pool<Loyalty, Reward>(reward_coin, loyalty_rate, reward_rate, ctx);

// Add more rewards to the pool
deposit_pool::reward_program::reward_fresh(pool, additional_reward_coin);

// Claim rewards by spending loyalty tokens
deposit_pool::reward_program::claim(pool, loyalty_token, policy, Some(minimum_expected_reward), ctx);

Deployment

The project includes an automated deployment script that:

1. Starts a local Sui node if remote RPC is not provided
2. Sets up the environment
3. Publishes all contracts
4. Initializes the faucet and deposit pool with initial liquidity

To deploy:

./deploy.sh

# You will be prompted for:
- RPC URL (default: http://127.0.0.1:9000)
- Environment alias (default: local)
- Exchange rate (default: 10 TALUS/SUI)
- Deploy Faucet OR NOT (default: yes)
- Max withdrawal ratio (default: 50%)
- Initial amount (default: 50% of total supply)