# Upshift Docs

> Documentation for Upshift — products, vault architecture, curators, and developer tooling.

## Machine-readable surfaces

- [Full corpus](https://docs.upshift.finance/llms-full.txt): every page below concatenated as one markdown file.
- Per-page markdown: append `.md` to any documentation URL, e.g. https://docs.upshift.finance/sdk/quick-start.md
- [Public API schema](https://docs.upshift.finance/openapi.json): OpenAPI for `https://api.upshift.finance/v1` (no auth).
- [Institutional API schema](https://docs.upshift.finance/openapi-institutional.json): OpenAPI for `https://api.upshift.finance/api/v1` (`x-api-key`).
- [Agent skill](https://docs.upshift.finance/.well-known/agent-skills/upshift/skill.md): how an agent installs the SDK, CLI, and MCP server.

## Overview

- [About Upshift](https://docs.upshift.finance/about-upshift): Upshift is the operating system for institutional onchain asset management.
- [FAQ](https://docs.upshift.finance/introduction/faq): Frequently asked questions about Upshift, its vaults, curators and yield.
- [How Upshift Works](https://docs.upshift.finance/introduction/how-it-works): The full lifecycle of a deposit — from receiving vault shares to curator-managed strategies, NAV accrual, and withdrawal.
- [Introduction](https://docs.upshift.finance/introduction): Start here — what Upshift is, how a deposit moves through a vault, and the questions integrators ask first.
- [How neobanks and fintech apps add stablecoin yield with Upshift](https://docs.upshift.finance/introduction/neobanks-and-fintechs): Launch stablecoin vaults under your own brand, from tokenized money market funds to DeFi strategies, on one integration.

## Products

- [DeFi Yield](https://docs.upshift.finance/products/defi-yield): Curated vaults on stablecoins, BTC, ETH and XRP, from overcollateralized lending to DeFi strategies, on non-custodial infrastructure.
- [Products](https://docs.upshift.finance/products): The vaults Upshift runs today: stablecoin yield from tokenized money market funds to DeFi strategies, white-label vaults under your brand, and instant liquidity for tokenized assets.
- [Vault-as-a-Service](https://docs.upshift.finance/products/vaas): White-label vault infrastructure that lets partner protocols offer curated DeFi yield strategies to their users.
- [Architecture](https://docs.upshift.finance/products/rwa-clear/architecture): The two smart contract components of RWA Clear — the LP-facing vault and the Instant Redeem Subaccount — and how they connect.
- [How It Works](https://docs.upshift.finance/products/rwa-clear/how-it-works): The two-sided RWA Clear marketplace — LPs fund a USDC pool while RWA holders redeem instantly against it.
- [RWA Clear](https://docs.upshift.finance/products/rwa-clear): Instant liquidity for tokenized real-world assets, funded by an LP pool that earns spread fees and lending yield.
- [Issuer Integration](https://docs.upshift.finance/products/rwa-clear/issuer-integration): How RWA issuers can enable instant redemptions for their tokenized assets on Upshift.
- [Pricing and Fees](https://docs.upshift.finance/products/rwa-clear/pricing-and-fees): How RWA Clear prices redemptions with oracle feeds, applies spread fees, and generates yield for liquidity providers.
- [Risk Controls](https://docs.upshift.finance/products/rwa-clear/risk-controls): The safety mechanisms protecting RWA Clear redemptions, plus the requirements an asset must meet to be supported.
- [Using RWA Clear](https://docs.upshift.finance/products/rwa-clear/using-rwa-clear): Step-by-step guides for RWA holders redeeming tokens instantly and liquidity providers earning yield on Upshift.

## Vault Architecture

- [Multi Asset Vault](https://docs.upshift.finance/vault-architecture/multi-asset-vault): V2 multi-asset vaults with basket deposits, a single reference asset, and the two institutional custody and execution models.
- [Vault Offering](https://docs.upshift.finance/vault-architecture/overview): The tiered Upshift vault architecture and the two vault types it supports.
- [Portfolio P&L](https://docs.upshift.finance/vault-architecture/portfolio-pnl): How Upshift calculates lifetime portfolio P&L, what activity it tracks, and the safeguards against showing a fabricated number.
- [Risk Management Framework](https://docs.upshift.finance/vault-architecture/risk-management-framework): The multi-layered, defense-in-depth safeguards protecting Upshift vaults, from protocol-level constraints to emergency procedures.
- [Single Asset Vault](https://docs.upshift.finance/vault-architecture/single-asset-vault): The ERC-4626 single-asset vault design, its subaccount custody model, key features, and roles.
- [Vault Accounting Mechanics](https://docs.upshift.finance/vault-architecture/vault-accounting-mechanics): How share-based accounting, the asset-to-share ratio, and yield compounding work in Upshift vaults.
- [Architecture](https://docs.upshift.finance/vault-architecture/atomic-redemption/architecture): The components of the Atomic Redemption Vault and how the vault contract, yield strategies, instant settlement module, and risk controls fit together.
- [How It Works](https://docs.upshift.finance/vault-architecture/atomic-redemption/how-it-works): The deposit flow, the single-transaction atomic redemption flow, and the automated liquidity management that keeps the working reserve funded.
- [Atomic Redemption Vault](https://docs.upshift.finance/vault-architecture/atomic-redemption): An ERC-4626 vault with an instant-settlement module that settles redemptions atomically in a single transaction, with no withdrawal queue or pre-funded buffer.
- [High-Level Architecture](https://docs.upshift.finance/vault-architecture/hypercore-relayer/architecture): The relayer is a pipeline of four asyncio components connected by three bounded queues.
- [End-to-End Flow](https://docs.upshift.finance/vault-architecture/hypercore-relayer/end-to-end-flow): How a single deposit travels from arrival on HyperCore through bridging and batching to final vault settlement on HyperEVM.
- [HyperCore Relayer](https://docs.upshift.finance/vault-architecture/hypercore-relayer): A long-running service that detects deposits arriving on HyperCore, bridges them to HyperEVM, and deposits them into a tokenized vault on the user's behalf.
- [Curator Model](https://docs.upshift.finance/vault-architecture/stellar/curator-model): How an appointed curator moves Stellar vault capital across whitelisted Strategy and EOA subaccounts within admin-set bounds.
- [Stellar Vaults](https://docs.upshift.finance/vault-architecture/stellar): Native Soroban Upshift vaults on Stellar built on OpenZeppelin's stellar-tokens library with ERC-4626 share pricing.
- [Risk and Security Model](https://docs.upshift.finance/vault-architecture/stellar/risk-and-security-model): The safety mechanisms built into Upshift Stellar vaults, from layered AUM rate limits to pause controls, admin transfer safety, and the wallet-attribution invariant.
- [Curator Model](https://docs.upshift.finance/vault-architecture/solana/curator-model): How an appointed curator manages a Solana vault's yield strategy within admin-set bounds.
- [Solana Vaults](https://docs.upshift.finance/vault-architecture/solana): Native Anchor-based Upshift vaults on Solana with on-chain share pricing and instant redemptions.
- [Risk and Security Model](https://docs.upshift.finance/vault-architecture/solana/risk-and-security-model): The safety mechanisms built into Upshift Solana vaults, from AUM change limits to pause controls and admin transfer safety.

## Curators

- [Smart Contract Interface](https://docs.upshift.finance/curators/contract-interface): Every vault contract function that touches curator workflows, grouped by job, with the role that calls it.
- [Accounting, Fees & Fund Flows](https://docs.upshift.finance/curators/fees-and-fund-flows): How share-based accounting and NAV reporting work, the vault fee schedule, and how capital flows from deposit to strategy and back through redemptions.
- [Key Management & Execution](https://docs.upshift.finance/curators/key-management): The two custody and execution models curators can run a vault on — the Upshift Subaccount smart-contract wallet and Fordefi MPC.
- [Upshift for Curators](https://docs.upshift.finance/curators/overview): What curators do on Upshift, how roles and permissions are separated, and why to curate a vault here.
- [Risk Framework & Emergency](https://docs.upshift.finance/curators/risk-and-emergency): The layered guardrails that constrain curator activity and the emergency unwind sequence when something goes wrong.

## Build

- [ABI Functions](https://docs.upshift.finance/sdk/abi-functions): Contract ABIs bundled with the Upshift SDK — vaults, receipt tokens, the swap router, loans, rewards, and the infrastructure contracts the SDK reads.
- [Changelog](https://docs.upshift.finance/sdk/changelog): Release history for the @augustdigital/sdk TypeScript SDK, with integrator highlights for every version.
- [Error Handling](https://docs.upshift.finance/sdk/error-handling): The typed error-class hierarchy, error codes, narrowing patterns, and retry guidance for the Upshift SDK.
- [EVM Actions](https://docs.upshift.finance/sdk/evm-actions): Deposit, request withdrawals, claim redemptions, and manage token approvals on EVM vaults with the Upshift SDK.
- [SDK](https://docs.upshift.finance/sdk): The Upshift TypeScript SDK — install it, read vault data, and build deposits and redemptions across EVM, Solana, and Stellar.
- [Quick Start](https://docs.upshift.finance/sdk/quick-start): Install the Upshift TypeScript SDK, initialize it with your RPC providers, and run a complete deposit flow.
- [Solana Actions](https://docs.upshift.finance/sdk/solana-actions): Query, deposit into, and redeem from Solana vaults with the Upshift SDK, plus low-level Anchor utilities and constants.
- [Stellar Actions](https://docs.upshift.finance/sdk/stellar-actions): Build, sign, and submit Stellar vault deposits and redeems with the SDK's XDR-based transaction flow.
- [Vault Actions](https://docs.upshift.finance/sdk/vault-actions): Query vaults, loans, allocations, positions, PnL, and historical data across all supported chains with the Upshift SDK.
- [ABIs](https://docs.upshift.finance/sdk/reference/abis): Contract ABI definitions bundled with @augustdigital/sdk for interacting with Upshift smart contracts.
- [AugustApi](https://docs.upshift.finance/sdk/reference/august-api): API reference for the AugustApi class (sdk.apiModule) — read-only backend reads: transparency dashboard, unrealized PnL, governance, fee config, and the authenticated loan-book and risk endpoints.
- [AugustSDK](https://docs.upshift.finance/sdk/reference/august-sdk): API reference for the AugustSDK class — the main entry point for interacting with Upshift vaults and services across EVM, Solana, Sui, and Stellar.
- [AugustSubAccounts](https://docs.upshift.finance/sdk/reference/august-subaccounts): API reference for the AugustSubAccounts class — querying subaccount summaries, positions, loans, transactions, and health factors.
- [AugustVaults](https://docs.upshift.finance/sdk/reference/august-vaults): API reference for the AugustVaults class — multi-chain vault queries, user positions, redemptions, and points, plus the module-level vault helper functions.
- [EVMAdapter](https://docs.upshift.finance/sdk/reference/evm-adapter): EVM adapter for the Upshift SDK — vault deposits, redemptions, allowances, previews, and SwapRouter flows for both ethers and viem signers.
- [SDK API Reference](https://docs.upshift.finance/sdk/reference): Generated API reference for @augustdigital/sdk — the SDK entry point, vault and subaccount modules, chain adapters, and contract ABIs.
- [SolanaAdapter](https://docs.upshift.finance/sdk/reference/solana-adapter): Solana adapter for the Upshift SDK — Anchor-based vault deposits, redemptions, and balance/state reads over a configurable RPC connection.
- [StellarAdapter](https://docs.upshift.finance/sdk/reference/stellar-adapter): Stellar adapter for the Upshift SDK — Soroban vault deposits, redemptions, position queries, and signed-transaction submission.
- [SuiAdapter](https://docs.upshift.finance/sdk/reference/sui-adapter): Sui adapter for the Upshift SDK — read-only Ember vault data, TVL, and transforms into the shared IVault shape.
- [Overview](https://docs.upshift.finance/rest-api): How to reach the Upshift REST API — base URLs, authentication, response conventions — and where the generated endpoint reference lives.
- [Overview](https://docs.upshift.finance/rest-api/public): Unauthenticated read endpoints for vaults, performance, and points.
- [Points](https://docs.upshift.finance/rest-api/public/points): Points balances, pool deposits, referral earnings, and deposit streaks for a user address.
- [System](https://docs.upshift.finance/rest-api/public/system): Health check for API availability and database connectivity.
- [Vaults](https://docs.upshift.finance/rest-api/public/vaults): List Upshift tokenized vaults, read a single vault, and calculate its annualized APY.
- [Daily Streak](https://docs.upshift.finance/rest-api/institutional/daily-streak): Daily-streak status and claim.
- [Governance](https://docs.upshift.finance/rest-api/institutional/governance): Roles, permissions, timelocks, and the audit log for a vault.
- [Historical Allocations](https://docs.upshift.finance/rest-api/institutional/historical-allocations): Time series of a vault’s allocation mix.
- [Historical Asset Share Ratio](https://docs.upshift.finance/rest-api/institutional/historical-asset-share-ratio): Time series of the asset-per-share ratio behind NAV.
- [Overview](https://docs.upshift.finance/rest-api/institutional): API-key endpoints for vault analytics, governance, points, and redemptions.
- [Morpho](https://docs.upshift.finance/rest-api/institutional/morpho): Morpho vault APY analytics.
- [NAV Oracle Classification](https://docs.upshift.finance/rest-api/institutional/nav-oracle-classification): How a vault’s NAV oracle is classified.
- [Pending Redemptions](https://docs.upshift.finance/rest-api/institutional/pending-redemptions): Outstanding redemption requests for a vault.
- [Points](https://docs.upshift.finance/rest-api/institutional/points): Points registration, leaderboard, and per-user balances.
- [Strategists](https://docs.upshift.finance/rest-api/institutional/strategists): Strategist directory and metadata.
- [System](https://docs.upshift.finance/rest-api/institutional/system): Connectivity check and on-chain revert-reason decoding.
- [Tokenized Vault](https://docs.upshift.finance/rest-api/institutional/tokenized-vault): Vault listings, summaries, annualized APY, historical timeseries, DeBank exposure, and reward configuration.
- [Unrealized PnL](https://docs.upshift.finance/rest-api/institutional/unrealized-pnl): Mark-to-market profit and loss, latest and historical.
- [Upshift](https://docs.upshift.finance/rest-api/institutional/upshift): Historical APY charts and per-vault strategy APY.
- [Vault Fees](https://docs.upshift.finance/rest-api/institutional/vault-fees): Fee schedule applied to a vault.
- [Vault History](https://docs.upshift.finance/rest-api/institutional/vault-history): Deposit, withdrawal, and archive history for a vault.
- [Vault Positions](https://docs.upshift.finance/rest-api/institutional/vault-positions): A vault's current allocations across protocols and chains.
- [Withdrawals](https://docs.upshift.finance/rest-api/institutional/vaults-withdrawals): Withdrawal queue state per chain and vault.
- [Deployed Contracts](https://docs.upshift.finance/contracts/addresses): Registry of Upshift protocol contract addresses and live vaults across every supported chain, consolidated from the protocol docs and the live vault API.
- [Fee Sharing](https://docs.upshift.finance/contracts/fee-sharing): Earn a share of every deposit you route into Upshift vaults, using origin codes on the Universal Adapter.
- [Smart Contracts](https://docs.upshift.finance/contracts): Contract-level reference — the vault interface, the Universal Adapter entry point, and the deployed address registry.
- [Universal Adapter](https://docs.upshift.finance/contracts/universal-adapter): Full reference for the Universal Adapter (SwapRouter) — the single entry point for atomically swapping any whitelisted token and depositing the proceeds into an Upshift vault.
- [Vault Contract Interface](https://docs.upshift.finance/contracts/vault-interface): Reference for the Upshift vault contract's user-callable, administrative, and read-only functions, including the epoch-based redemption flow.
- [CLI](https://docs.upshift.finance/cli): Read-only command-line client for Upshift vaults and pools.
- [MCP Server](https://docs.upshift.finance/mcp): Read-only Model Context Protocol server exposing Upshift data as tools, resources, and prompts for AI agents.

## Resources

- [Audits & Risk](https://docs.upshift.finance/resources/audits): Risk disclosures for the Upshift protocol and the full list of third-party smart contract audits.
- [Resources](https://docs.upshift.finance/resources): Audits and risk disclosures, plus the legal terms that govern the Upshift platform and its vaults.
- [Cookie Policy](https://docs.upshift.finance/resources/legal/cookie-policy): Fractal Network Ltd.'s policies and practices regarding the use of cookies on the Upshift Platform.
- [Legal](https://docs.upshift.finance/resources/legal): The terms and policies that govern the Upshift platform, its loans, and individual vaults.
- [Loan Product Terms](https://docs.upshift.finance/resources/legal/loan-product-terms): Standard terms and conditions governing loans of Digital Currency originated through the August platform.
- [Privacy Policy](https://docs.upshift.finance/resources/legal/privacy-policy): How Fractal Network Ltd. (Upshift) collects, uses, and discloses information, and your choices regarding that information.
- [Terms of Use](https://docs.upshift.finance/resources/legal/terms-of-use): The Terms of Use governing the Upshift website and services, operated by Fractal Network, Ltd. under the laws of the British Virgin Islands.
- [DayFi Vault Terms](https://docs.upshift.finance/resources/legal/vault-specific-terms/dayfi): Vault-specific terms covering third-party platform involvement, sanctions risk, and governing terms for the DayFi vault.
- [Vault-Specific Terms](https://docs.upshift.finance/resources/legal/vault-specific-terms): Additional terms of use that apply to specific Upshift vaults.