StreamSwap is a protocol designed for time-based token swaps, enabling projects, DAOs, and users to create streams that last for a set duration and facilitate token swaps.
Token exchange mechanisms have been a driving force for web3 onboarding since the ICO boom. Traditional token exchange methods include:
- Automated ICOs: Team sets the issuance price, and a smart contract controls the swap.
- Regulated, centralized ICOs: Managed by a dedicated company using centralized services that comply with regulatory requirements (e.g., KYC). Example: Coinlist sales.
- Balancer-style LPBs: Employ Dutch Auction mechanism to determine a fair strike price.
StreamSwap introduces a continuous token swap mechanism, allowing dynamic price determination by the community, based on the final swap amount and time.
StreamSwap's architecture is designed to support the continuous and fair execution of token distribution. The main components include:
- Controller Contract: Manages the creation of new streams and handles protocol-level operations.
- Stream Contract: Implements the logic for managing individual token streams, including subscription, distribution, and finalization.
Here’s a breakdown of the main contracts in the StreamSwap system:
| Contract Name | Description |
|---|---|
| controller | Handles the creation of new streams and manages protocol-wide functions. |
| stream | Manages individual streams, including user subscriptions and token distribution, pool creation, vesting and more |
The lifecycle of a StreamSwap stream is divided into several states:
- Waiting: The stream has been created but is not yet active. No interactions are allowed.
- Bootstrapping: Participants can subscribe to the stream, but distribution has not yet started. No assets can be spent.
- Active: The stream is live, and tokens are distributed according to the subscription amounts and timing.
- Ended: The stream has concluded. Participants can exit the stream, and the creator can finalize and collect the proceeds.
- Finalized: The stream is finalized. The creator can withdraw any remaining tokens, and vesting or pools (if configured) are set up.
- Cancelled: The stream is cancelled. Participants can withdraw their assets, and the creator can reclaim any unsold tokens.
- Create a stream by submitting a
CreateStreamtransaction. - Treasury owner sends creation fee tokens and
out_denomtokens to the contract. - Fees are collected and managed through governance voting.
- Join a stream by submitting a
SubscribeMsgtransaction. - Transaction funds are pledged, minting new shares.
- Shares are calculated based on the subscription amount.
- Distribution is based on total shares and time.
update_streamcalculates the amount to be distributed to investors.
- Spend calculations occur during
update_position. - Updates to the stream and position state are done continuously.
- Withdraw unspent tokens via
WithdrawMsg. - Shares are reduced proportionally to the withdrawn amount.
- After the stream ends, participants can withdraw distributed tokens and claim unspent tokens via
ExitMsg.
- Treasury can finalize the stream to collect tokens post-distribution, applying an exit fee.
- Average price:
stream.spent_in / (stream.out_supply - stream.out_remaining). - Last streamed price calculated during the latest
update_stream.
- Collected to prevent spam, managed by the fee collector.
- DAO governs contract changes, fee amounts, fee distribution and emergency interventions.
- Governance ensures project funding for future development.
Ensure you have Rust installed with the wasm32-unknown-unknown target. You can install it using:
rustup target add wasm32-unknown-unknownNavigate to the workspace directory and compile the contracts:
cargo buildTo ensure everything is working correctly, you can run the tests from the workspace root:
cargo testFor a production-ready build, run the following command to generate optimized contracts:
cargo run-script optimizeThe optimized contracts will be placed in the artifacts/ directory.
To generate the typescript bindings for the contracts, run the following command:
scripts/schema.sh| HOST CHAIN | DENOM | ADDRESS |
|---|---|---|
| osmosis-1 | uosmo | osmo17kqws7fy2qnejdw68cqjlw456gdxcdukk0wq6026u826zlda3y7qdhzqlv |
| osmosis-1 | uatom | osmo10vsjh59l8mpncmsl9hggf6ryxpf0kne09qa9wtn8j6ar3mh2mdlsq9h7dh |
| osmosis-1 | axlUSDC | osmo1fy25p87ulxm400dd0q4zp0fzsvhl4a8g2jrq9a670lgh2asrgfrsgy60rn |
| injective-1 | inj | inj1ajlv75ypg9d2arsg4f9syxmz0k7fkad7kyen2l |
The security audit of the StreamSwap contracts will be published here.
TODO: Add audit report
This repo is licensed under Apache 2.0.