Folks Finance
xChain App (NEW)Algorand AppContact usV1 Docs
  • Welcome to Folks Finance
  • Folks Finance Algorand app documentation
  • Introduction
    • Get started
      • Create a wallet
      • Get ALGO or ASAs
      • Connect wallet to Folks Finance
    • V2, what's new?
    • Need help?
      • Contact
      • Glossary
      • FAQ
      • Fees
      • Allowing pop-up
    • V2 Testnet tips
  • Functionalities
    • 🏦Deposit
    • 💰Loan
      • Collateral
      • Borrow
    • 🔄Swap and...
    • 🏛️xALGO - Liquid Staking
      • How to Migrate from gALGO to xALGO
    • 🚜Lending Pools
    • 📈Ultraswap
    • 🛣️Folks Router
    • 🔗Algorand Consensus
      • No code
      • SDK
  • Architecture
    • Parameters
    • Pool dynamics
    • Interest rate model
    • Rebalancing
    • Loan collateral
    • Loan borrow
    • Liquidation
    • Loan types
    • Flash loan
  • TOKENOMICS
    • FOLKS
  • DEVELOPER
    • Security
      • Bug bounty
      • Audits
    • Contracts
    • Official SDKs
  • COMMUNITY
    • Contact
    • Work with us
    • Ambassador program
    • Brand & Logos
    • Community treasury
    • Aeneas liquidity program
    • Privacy and T&C
Powered by GitBook
On this page
  • Javascript SDK
  • Technical Design - Algo Liquid Governance
  • Global and Local State
  • Minting
  1. DEVELOPER

Official SDKs

Last updated 9 months ago

Before using our official SDKs, please read the .

Javascript SDK

Technical Design - Algo Liquid Governance

The Folks Finance SDK includes the functionality to mint, unmint, claim rewards and burn. In addition, there are methods to obtain the smart contract state.

Global and Local State

There are two smart contracts. The dispenser, which mints gALGO and the distributor, which manages the governance operations.

Minting

Before a user can mint gALGO in the commitment period, they must first opt-in to the smart contract. Since the transactions are composable, the SDK includes a boolean to indicate whether to prepend the opt-in transaction inside the atomic transaction group.

Projects that are interested in incorporating mint functionality and participating in the revenue share, should include in the note field of the application call the following:

  • ff/gov/v1:j{"n":”<NAME>”}

The <NAME> should be a maximum of 8 characters in length. Please pre-confirm the name you will be using with the Folks Finance team in order to check eligibility requirements and avoid any duplications.

The smart contracts are ABI compliant and composable. This specification can be found .

The dispenser’s global state can be found . The distributor's global state can be found . The distributor’s local state can be found . Alongside you will see a description of how to interpret each variable.

You can use the method to obtain the group transaction for minting gALGO. If within the commitment period, then it also commits the user into liquid governance.

here
here
here
here
prepareMintTransactions
Disclaimer
GitHub - Folks-Finance/folks-finance-js-sdk: The official JavaScript SDK for the Folks Finance ProtocolGitHub
Logo