Factor Docs
  • 🏭Introduction to Factor
  • Getting Started
    • 🕹️Quickstart
    • 🔗Supported Protocols
    • 🔐Strategy Cheatsheet
      • Swaps Cheatsheet
        • Conditional Market Order
        • Automated Market Order
        • Multi Swap
        • Automated Swap & Earn
        • Automated Scale Order
        • Scale Order Partial Fill Yield
        • Interest On Pending Trades
        • Leverage Trade
        • Leverage DCA
      • Lending Cheatsheet
        • Lending Pool Zap
        • Multi Lend
        • Market Making To Lending Switch
        • Earn Negative Interest
        • Carry Trade
        • Leveraged Staking Yields
        • Leveraged Fixed Yields
      • Borrowing Cheatsheet
        • Collateralized Borrow
        • Collateralized Borrow Zap
        • Multi Borrow
        • Debt Switching
        • Automated Debt Readjustments
        • Debt Refinancing
        • Asset Switching
      • Liquidity Provision Cheatsheet
        • Liquidity Pool Zap
        • Yield Farm Zap
        • Automated LP Adjustments
        • Yield Farm Adjustments
      • Flash Loan Cheatsheet
    • 🧠Strategy Explainers
      • Leverage
        • Leverage Performance Modelling
        • Leverage Long Simulation
        • Leverage Short Simulation
      • Yield
        • Yield Performance Modelling
      • PT Strategies
        • Leverage Long PT Simulation
      • Delta Neutral Yields
        • Levered USD & ETH Carry
    • 📖Glossary
  • Factor Discover
    • 🔍Factor Discover
      • Public Strategies User Guides
        • Deposit Into User Created Strategies
        • Withdraw From User Created Strategies
      • Leverage User Guides
        • Create A Leveraged Position
        • Adjust Position Leverage
        • Add Collateral To Position
        • Withdraw Collateral From Position
        • Repay Position Debt
      • Yield User Guides
        • Auto-compound Your Yields
      • PT User Guides
        • Redeem Your PT
      • APY Calculations
    • ⚙️Factor Operated Strategies
      • Yield Type Strategies
        • Arbitrum (ChainID: 42161)
          • 4.4x rETH Carry + 1x USDC Lending Yields - Aave & Compound
          • 7x Leveraged rETH:ETH Yields - Compound
          • Additional rETH Yields On USDC Lend
          • Amplified wstETH Yields On USDC Lend - Aave
          • Additional Liquid Staked ETH Yields On USDC Lend
          • Additional Liquid Restaked ETH Yields On USDC Lend
          • Diversified USDC Lending Yields - Aave & Compound
        • Base (ChainID: 8453)
          • 3.5x Leveraged cbETH:ETH Yields - Aave
          • Additional cbETH Yields On USDC Lend
          • Additional Liquid Staked ETH Yields On USDC Lend
          • Amplified cbETH Yields On USDC Lend - Aave
          • Amplified cbETH Yields On cbBTC Lend - Aave
      • Trading Type Strategies
        • WBTC Base Switch On rETH For ETH & USDC Yields
      • Delta Neutral Type Strategies
        • Arbitrum (ChainID: 42161)
          • Delta Neutral ETH With rETH & USDC Yields
        • Base (ChainID: 8453)
          • Delta Neutral ETH With cbETH & USDC Yields
  • Factor Studio
    • 🎨Factor Studio
      • Automated Strategies
      • Conditional Strategies
    • 👥Public Strategies
      • User Guide
        • Public Strategy Creation
        • Create An Exit Strategy
        • Deployment Wizard
        • Strategy Execution
      • Security
      • Exit Strategy
    • 🏗️Strategy Builder
      • Building Blocks User Guide
        • Lend
        • Borrow
        • Swap
        • Flash Loan
    • 📜Studio Contracts
      • Leverage
        • FactorLeverageDescriptor.sol
        • FactorLeverageVault.sol
        • WrapperFactorLeverageVault.sol
      • LP Management
        • FactorLPVault.sol
        • FactorLPDescriptor.sol
    • 🏠Private Strategies
      • User Guide
        • Private Strategy Creation
  • Factor SDK
    • 📦Factor SDK
    • ↔️REST APIs
      • Utility APIs
        • Pricing
        • Stats
  • Factor Building Blocks
    • 🧱Factor Building Blocks
    • ➡️Lend
    • ⬅️Borrow
    • 💰Yield
      • Concepts
        • Yield Farming
        • Yield Aggregators
      • ⚡Zap
    • 🌊LP Management
      • Concepts
        • Automated Market Maker
        • Concentrated Liquidity
    • 🥩Stake
    • 🔀Swap
      • Concepts
        • Market Orders
        • DEX Aggregators
    • 🔄Leverage
      • Concepts
        • Collateralized Lending & Borrowing
        • Looping
      • Leverage Dev Guides
        • Create Leveraged Position
        • Add Leverage To Position
      • Strategy Contracts
        • AAVEV3LeverageStrategy.sol
        • CompoundLeverageStrategy.sol
        • LodeStarLeverageStrategy.sol
        • RadiantLeverageStrategy.sol
        • SiloLeverageStrategy.sol
        • SiloYieldTokenStrategy.sol
        • TenderLeverageStrategy.sol
      • FAQ - Leverage Building Block
    • 🪄Flash Loan
      • Concepts
        • Uncollateralized Lending & Borrowing
        • Flash Loan
  • Factor Adapters
    • 🔌Factor Adapters
    • 📜Adapter Contracts
      • Leverage
      • Yield
      • Swap
      • Flash Loan
  • Governance
    • 🏛️FactorDAO
      • Factor Flywheel
      • Factor Participants
      • Governance Incentive Calculations
        • FactorDAO Incentives Model (LTIPP)
      • User Guides
        • Stake FCTR
        • Governance Migration
      • Contracts
        • FactorDAO Contract Addresses
      • FactorDAO Multisig Addresses
      • Platform Fees
    • 🪙FCTR Token
      • Staking and Governance
      • Tokenomics
      • Contract Addresses
      • FAQ - Tokenomics
    • ⚖️Factor Scale
      • Arbitrum Foundation LTIPP
      • Emission Multiplier Calculations
        • Emissions Multiplier Model
      • User Guides
        • Stake FCTR
        • Vote On Emissions Distribution
      • Contracts
        • Factor Scale Contract Addresses
      • ❔FAQ - Factor Scale
    • 🚀Factor Boost
      • Contracts
        • Factor Boost Contract Addresses
    • 💼Factor Bribes
      • Contracts
        • Factor Bribes Contracts
  • Security
    • 🛡️Security
    • 📋Audits
      • PeckShield
        • Leverage Vault Wrapper
        • Silo Yield
        • Silo Leverage
        • Penpie
        • Factor Boost
      • SourceHat
        • FactorDAO Vaults
        • FCTR & Voting Escrow
  • Reference
    • Discover Pro dApp
    • Studio dApp
    • Discover dApp
    • Official Website
    • Press Kit
    • Partnership Form
    • Media Kit
    • Geo Restrictions
  • Community
    • Factor Contributors
    • X
    • Discord
    • Telegram
    • Medium
    • Email Enquiries
Powered by GitBook
On this page

Was this helpful?

  1. Factor SDK

Factor SDK

PreviousPrivate Strategy CreationNextREST APIs

Last updated 12 months ago

Was this helpful?

Overview

Factor's SDK is a versatile toolkit for easier use of the Factor platform. It helps users develop and deploy custom strategies effortlessly. The SDK has many features and supports multiple programming languages, enabling users to turn unique insights into personalized trading strategies.

What Does The SDK offer?

The Factor SDK is a comprehensive toolset packed with features to assist you in the entire journey of developing, deploying, and managing custom trading strategies on the Factor platform. Its user-friendly interface and seamless integration simplify the complexities of crafting bespoke strategies, enabling users to concentrate on their distinctive insights and trading objectives.

  • Connectivity: Initializes a connection with MetaMask using the SDK and relies on the injected web3 provider and signer for interactions.

  • Smart contract Interactions: Facilitates interaction with smart contracts for creating and managing strategies and projects on the Factor platform.

  • Fetch Data: Leverages the SDK to fetch settings, underlying assets, total value locked (TVL), and performance fees for specific strategies or projects.

  • Strategy Factory: Utilizes the SDK to allow users to deploy custom strategies and interact with them.

  • Algorithm Modules: Users have access to algorithmic modules for customizing rebalancing and execution algorithms. Examples include Time-Weighted Average Price (TWAP) and Iceberg templates to efficiently mitigate slippage.

  • Deposit & Withdrawal: Simplifies deposit and withdraw processes using the SDK.

  • Multi-language Support: Offers an API for writing strategies in Python, R, Pinescript, and other programming languages, making the SDK versatile and adaptable to various user needs.

The Factor SDK is currently under construction. Stay tuned for exciting updates coming real soon!

📦
🚧