Search Apps Documentation Source Content File Folder Download Copy Actions Download State String Boolean Number Struct Map Slice Pointer Function Closure Reference Nil Package Type Interface Unknown

README.md

4.10 Kb · 112 lines
Download

Launchpad

Token distribution platform for launching projects with time-locked GNS deposits and project-token rewards.

Overview

The launchpad supports projects with three lock tiers: 30, 90, and 180 days. Project creators configure the project-token reward allocation for each tier, and depositors receive rewards according to the selected tier.

Configuration

  • Pool Tiers: 30 days, 90 days, and 180 days
  • Minimum Start Delay: 3 days from project creation
  • Minimum Deposit: 1 GNS (1,000,000 base units) and integer multiples of that amount
  • Reward Claim Delay: 1 day after each deposit, capped at the selected tier's end time
  • Condition Delimiter: Use *PAD* between condition expressions
  • Auto-Delegation: Project deposits can be reflected in governance-staker accounting

Core Features

  • Project Creation: Admin or governance creates a project and its tiers
  • GNS Deposits: Users deposit GNS into a selected project tier
  • Time-Locked Withdrawals: A depositor can withdraw the original GNS only after the tier ends
  • Project-Token Rewards: Rewards accrue over the tier duration and can be claimed after the claim delay
  • Administrative Refund: Admin can transfer the remaining refundable project-token balance from an ended project to a supplied recipient; active depositor claims remain reserved

Key Functions

CreateProject

Creates a new project with token address, reward amount, tier configuration, and optional *PAD*-separated conditions. Only admin or governance may call it.

DepositGns

Deposits GNS into a project tier. The deposit amount must meet the minimum and multiple rules.

CollectRewardByDepositId

Claims the project-token reward for a deposit. Only the deposit owner can call it, and the reward is claimable one day after deposit creation, capped by the tier end time.

CollectDepositGns

Settles any claimable project-token reward and then returns the original GNS deposit. Only the deposit owner can call it, and the current time must be strictly after the selected tier's end time.

TransferLeftFromProjectByAdmin

Transfers the remaining refundable project-token balance from an ended project to the supplied recipient. Only admin may call it; amounts reserved for active depositor claims are not transferred.

Approval Requirements

  • DepositGns pulls GNS from the caller into the launchpad realm, so approve the launchpad realm for at least the deposit amount before calling.
  • CollectRewardByDepositId and CollectDepositGns pay out to the caller and require no approval.
1// Approve the launchpad realm before depositing
2launchpadAddress := access.MustGetAddress(prabc.ROLE_LAUNCHPAD.String())
3gns.Approve(cross(cur), launchpadAddress, 10_000_000)

Usage

 1// Create a project (admin or governance; start must be at least 3 days away)
 2projectID := CreateProject(
 3    cross(cur),
 4    "Example Project",
 5    "gno.land/r/demo/projecttoken",
 6    recipientAddr,
 7    1_000_000_000,
 8    "", // no condition tokens
 9    "", // no condition amounts
10    10, // 30-day tier ratio
11    20, // 90-day tier ratio
12    70, // 180-day tier ratio
13    futureStartTimestamp,
14)
15
16// Deposit GNS into a 30-day tier; referrer is optional
17depositID := DepositGns(cross(cur), projectID+":30", 10_000_000, "")
18
19// Claim after the one-day delay
20CollectRewardByDepositId(cross(cur), depositID)
21
22// After the tier has ended, settle reward and withdraw principal
23CollectDepositGns(cross(cur), depositID)
24
25// Admin refund of the remaining project-token balance
26TransferLeftFromProjectByAdmin(cross(cur), projectID, recipientAddr)

Security

  • Admin or governance authorization is required for project creation
  • Deposits are locked until strictly after the selected tier's end time
  • Project-token rewards are claimable only by the deposit owner and only after the one-day delay
  • Withdrawal settles any claimable project-token reward before returning principal
  • Administrative refunds require an ended project and preserve active depositor claims
  • Conditions are evaluated for each deposit when configured
  • Depositor and reward recipient addresses are validated