Skip to main content
This glossary defines core concepts used throughout RebelFi’s platform and APIs.

​
Core Concepts

​
Venue

A venue represents a DeFi protocol that offers yield opportunities. Examples include Kamino, Drift, and other lending/yield protocols. Each venue contains one or more strategies for different tokens. API Field: venueId, venueName

​
Strategy

A strategy is a specific yield opportunity within a venue. Each strategy:
  • Supports a specific token (e.g., USDC)
  • Has a current APY
  • May have minimum/maximum deposit limits
Use strategyId for supply/unwind operations. API Field: strategyId, strategyName

​
Allocation

An allocation represents funds deployed to a yield strategy. It tracks:
  • Principal: Original amount deposited
  • Current Value: Principal + accrued yield
  • Yield Earned: Total yield accumulated
API Field: allocation, allocations

​
Operation

An operation is a business workflow representing intent:
  • Supply: Deploy funds to a yield strategy
  • Unwind: Withdraw funds from a yield strategy
Operations contain one or more transactions that need to be signed and submitted. Status Values:
  • pending - Operation created
  • awaiting_signature - Unsigned transaction ready for signing
  • submitted - Transaction broadcast, awaiting confirmation
  • confirmed - Successfully confirmed on-chain
  • failed - Transaction failed
API Field: operationId, operationType

​
Transaction

A blockchain transaction within an operation. Goes through these states: 
unsigned → pending → confirmed
                  ↘ failed
  • unsigned: Transaction built, waiting for user signature
  • pending: Signed and broadcast, waiting for confirmation
  • confirmed: Successfully confirmed on-chain
  • failed: Transaction failed
API Field: transactionId, txHash, status

​
Wallet Concepts

​
Organization (Org)

Your company or entity within RebelFi. All wallets, operations, and allocations belong to an organization. API Field: organizationId

​
Operational Wallet (OpWallet)

A wallet that is actively monitored for yield optimization. Configuration:
  • Buffer Amount: Minimum liquidity to maintain
  • Enable Yield: Whether to optimize for yield

​
Buffer Amount

Minimum liquidity to keep available (not deployed to yield) in an operational wallet. Purpose:
  • Ensure funds available for immediate withdrawals
  • Maintain operational liquidity
Behavior:
  • Funds above buffer → eligible for yield deployment
  • Funds at or below buffer → kept liquid

​
Financial Concepts

​
Principal

The original amount of funds deployed, excluding yield earned. Calculation: Principal = Total Balance - Cumulative Yield

​
Yield

Cumulative earnings from yield protocols. Tracking:
  • Lifetime Yield: Total earned since inception
  • Daily Yield: Last 24 hours
  • Current Value: Principal + Yield

​
APY (Annual Percentage Yield)

The annualized rate of return, expressed as a decimal. Format: Decimal (e.g., 0.085 for 8.5% APY) Display: (apy * 100).toFixed(2) + '%' → “8.50%“

​
Reservation

A temporary financial lock on available funds during an operation. Lifecycle:
  1. Created: When operation is planned
  2. Active: Locks funds (reduces available balance)
  3. Consumed: When operation completes successfully
  4. Released: When operation fails or is rejected
Purpose: Prevents double-spending while operation is executing

​
Custody Concepts

​
Agent

A service that polls RebelFi for unsigned transactions, signs them via your custody solution, and reports execution. Responsibilities:
  • Poll for pending transactions
  • Sign via custody provider
  • Submit to blockchain
  • Report status back to RebelFi

​
Custody Adapter

The integration layer between RebelFi and your specific custody provider (Fireblocks, BitGo, Tatum, etc.). Built by RebelFi as part of your onboarding.

​
Lease

A time-bound claim on a transaction attempt. Purpose: Prevents duplicate execution by multiple agents Duration: Typically 30-60 seconds

​
Data Types

​
Amount (Base Units)

Monetary values are expressed in base units (smallest divisible unit of the token). Examples:
  • USDC has 6 decimals: "1000000" = 1 USDC
  • "1000000000" = 1,000 USDC
API Format: String (to preserve precision)

​
Blockchain

Supported blockchain networks:
  • solana - Solana mainnet
  • polygon - Polygon (coming soon)
  • ethereum - Ethereum (planned)

​
Timestamp

ISO 8601 format: "2024-01-15T10:30:00Z"

​
Common Acronyms

AcronymFull TermDescription
APYAnnual Percentage YieldAnnualized rate of return
TVLTotal Value LockedTotal value in protocol
SDKSoftware Development KitClient library for integration
APIApplication Programming InterfaceHTTP endpoints
DeFiDecentralized FinanceBlockchain-based financial protocols

​
Visual Example: Complete Flow

1. Discover Venues
   → GET /v1/venues
   → Returns venues with strategies and APYs

2. Plan Supply Operation
   → POST /v1/operations/supply
   → Returns operation with unsigned transaction

3. User Signs Transaction
   → Wallet signs the transaction
   → Returns signed transaction or broadcasts

4. Submit Transaction
   → POST /v1/transactions/submit-hash (or submit-signed)
   → Returns transaction status

5. Allocation Created
   → GET /v1/allocations
   → Shows new position earning yield

6. Track Earnings
   → GET /v1/allocations/earnings
   → Returns daily yield history

7. Unwind Position
   → POST /v1/operations/unwind
   → Returns unsigned unwind transaction