LogoLogo
V2 DocsV2 dApp
English 🇬🇧
English 🇬🇧
  • Welcome to Folks Finance official documentation!
  • Getting started
  • HOW TO
    • Deposit
    • Lock & Earn
    • fStaking
    • Withdraw
    • Borrow
    • Rebalance
    • Repay
    • Rewards aggregator
    • Algo Liquid Governance
      • Algo Liquid Governance - G3
  • User profile
    • Dashboard
    • History
    • Notifier
  • Developer
    • Contracts
    • Official SDKs
  • Protocol architecture
    • Overview
      • Liquidity pool dynamics
      • Interest rates model
      • Interest accrual
      • Deposit
      • Withdraw
      • Borrow
      • Slippage
      • Liquidation
      • Algo Liquid Governance
      • Incentive system
      • fStaking
      • Token types
  • Security
    • Audits
    • Bug bounty
  • Support
    • FAQ
    • Glossary
    • Fees
  • helpful guides
    • Creating a My Algo Wallet
    • Buying Algo using FIAT - CEXs guide
    • Buying Algo with FIAT - Pera wallet/MyAlgo wallet guide
    • Allowing pop-up
    • Folks Finance's Testnet
  • Community
    • What can I do with gALGO?
    • Aeneas liquidity program
    • Contact
    • Community treasury
    • FOLKS
  • Legal
    • Privacy Policy
    • Terms & Conditions
    • Disclaimer
Powered by GitBook
On this page
  • Javascript SDK
  • Python SDK
  • Technical Design - Algo Liquid Governance
  • Global and Local State
  • Minting

Was this helpful?

  1. Developer

Official SDKs

PreviousContractsNextOverview

Last updated 2 years ago

Was this helpful?

Before using our official SDKs, please read the

Javascript SDK

Python SDK

Coming Soon

Technical Design - Algo Liquid Governance

The Folks Finance SDK includes the functionality to mint, unmint, claim rewards, early 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