Superform v1
  • Introduction
  • Components
    • Protocol
    • Keepers
    • API
    • App
  • E2E Flows
    • Same-chain Deposit
    • Cross-chain Deposit
    • Same-chain Withdrawal
    • Cross-chain Withdrawal
  • Periphery Contracts
    • SuperformRouter
      • SuperformRouterPlus
      • SuperformRouterPlusAsync
    • PayMaster
    • PaymentHelper
    • EmergencyQueue
    • SuperformFactory
    • Forms
      • ERC4626Form
      • ERC5115Form
      • ERC7540Form
    • SuperPositions
      • ERC1155A
    • RewardsDistributor
  • Core Contracts
    • State Registries
      • CoreStateRegistry
      • AsyncStateRegistry
      • PayloadHelper
    • AMB Implementations
      • LayerzeroImplementation
      • LayerzeroV2Implementation
      • WormholeARImplementation
      • HyperlaneImplementation
      • AxelarImplementation
    • Broadcasting
      • BroadcastRegistry
      • WormholeSRImplementation
    • Bridge Validators
      • LiFiValidator
      • SocketValidator
      • SocketOneInchValidator
      • DebridgeValidator (and forwarder)
      • OneInchValidator
    • DstSwapper
    • Settings
      • SuperRBAC
      • SuperRegistry
  • SuperVaults
    • SuperVaults
  • Resources
    • Deployment Addresses
    • Subgraphs
      • Protocol Level Entities
      • Form Related Entities
      • Deposits and Withdrawals
      • SuperPosition Events
      • External Entities
    • Infrastructure Integrations
    • Security & Audits
    • Protocol License
    • Glossary
    • Protocol Multisig
    • Superform Labs Socials
Powered by GitBook
On this page

Was this helpful?

Introduction

Last updated 5 months ago

Was this helpful?

Overview

These are our technical docs. Please refer to for general support.

The Superform Protocol is a suite of non-upgradeable, non-custodial smart contracts that act as a central repository for yield and a router for users.

Superform builds on top of this to solve other core issues in DeFi, together forming a two-sided marketplace paving the way for efficient discovery, execution, and management of yield across chains. It is permissionless, modular, and enables intent-based transactions across chains that allow users to execute into an arbitrary number of tokens, chains, and vaults at once.

For DeFi protocols, it acts as an instant out-of-the-box distribution platform for compliant vaults. For users, it allows access to any vault listed on the platform from the chain and asset of their choice in a single transaction.

Core capabilities for protocols:

  • Permissionlessly list your vaults on Superform by adding your ERC4626 vault to the proper 'Form' (a vault adapter within Superform)

  • Create a profile page with embeddable data sources for users to find more information about your protocol

  • Manage metadata for yield opportunities

  • Users can deposit into your vaults from any chain without the need to deploy your vaults on that chain

Core capabilities for users:

  • Deposit or withdraw into any vault using any asset from any chain

  • Batch desired actions across multiple vaults and multiple chains in a single transaction

  • Automate and manage your yield portfolio from any chain

  • Automatically compound your yield position

  • Make cross-chain transactions using multiple AMBs (Arbitrary Message Bridges)

Currently, AMB quorum is set at one, which means all cross-chain messages are passed with a message relayer and a proof relayer for maximum security. Additionally, routes generated off-chain are validated by specific on-chain bridge validators to protect against malicious actors.

This documentation will only cover external calls in non-abstract contracts. More information on internal functions and abstract contracts are viewable in our Superform Github repo.

Superform allows users to deposit or withdraw both same chain or cross-chain without switching RPCs, swapping tokens, or bridging themselves. When a user wants to transact cross-chain they need both a message to be passed and for the their tokens to be bridged. Superform solves this using three AMB (cross-chain messaging) solutions and two value transfer providers, respectively: , , and & and . Superform's modularity allows for AMBs and liquidity sources to be added as security conditions and user preferences change over time.

Once a deposit is completed into a vault listed on a Form (a yield adapter), the user is minted a , redeemable 1:1 with the underlying vault share, on their source chain that can be burned to claim their deposit. SuperPositions are ERC-1155As and can be transferred as a group or individually and are viewable on NFT marketplaces.

superform-core:

ERC1155A:

SuperVaults:

https://help.superform.xyz/en/
ERC4626
LayerZero
Hyperlane
Wormhole
Socket
Li.Fi
SuperPosition
https://github.com/superform-xyz/superform-core
https://github.com/superform-xyz/ERC1155A
https://github.com/superform-xyz/SuperVaults/