API

FactoryBase

class sgb_ftso_contracts.FactoryBase(apiurl='https://songbird-explorer.flare.network/api')[source]

This is a class common to all contract factory operations.

self.apiurl

Location of Blockscout api endpoint for Songbird.

Type

string

__init__(apiurl='https://songbird-explorer.flare.network/api')[source]

The constructor for FactoryBase class.

Parameters

apiurl (string) – Location of Blockscout api endpoint for Songbird. Used for fetching ABI automatically.

contract(web3: Web3)[source]

A method to instantiate a Web3 Contract set at self.address.

Parameters

web3 (Web3) – An instance of the Web3 class, wired up to a valid provider.

Returns

An instantied contract at self.address.

Return type

Contract

getABI(address)[source]

A method to fetch the application binary interface (ABI) for the contract at the specified address.

Parameters

address (string) – Contract address prefixed with 0x.

Returns

The ABI of the contract.

Return type

string

Ftso

class sgb_ftso_contracts.Ftso(symbol, apiurl=None)[source]

A factory to instantiate the Ftso contract. Note that this link is the FTSO for BTC. FTSOs are all the same contract; one instance per asset.

self.symbol

The asset symbol of the FTSO.

Type

string

__init__(symbol, apiurl=None)[source]

The constructor for Ftso class.

Parameters

  • symbol (string) – The asset symbol of the FTSO.

  • apiurl (string) – Location of Blockscout api endpoint for Songbird. Used for fetching ABI automatically.

contract(web3: Web3)[source]

A method to instantiate a Web3 Contract set at self.address.

Parameters

web3 (Web3) – An instance of the Web3 class, wired up to a valid provider.

Returns

An instantied contract at self.address for the FTSO identified by self.symbol.

Return type

Contract

FtsoManager

class sgb_ftso_contracts.FtsoManager(address='0xbfA12e4E1411B62EdA8B035d71735667422A6A9e', apiurl=None)[source]

A factory to instantiate the FtsoManager contract. This contract manages FTSO voting operations and coordinates price and reward epoch execution.

self.address

The address of the contract starting with 0x.

Type

string

__init__(address='0xbfA12e4E1411B62EdA8B035d71735667422A6A9e', apiurl=None)[source]

The constructor for FtsoManager class.

Parameters

  • address (string) – Address of the contract starting with 0x.

  • apiurl (string) – Location of Blockscout api endpoint for Songbird. Used for fetching ABI automatically.

FtsoRegistry

class sgb_ftso_contracts.FtsoRegistry(address='0x6D222fb4544ba230d4b90BA1BfC0A01A94E6cB23', apiurl=None)[source]

A factory to instantiate the FtsoRegistry contract. This provides Centralized access to all FTSOs from one contract. This contract is handy to get FTSO current price info from, as one does not need to go after the FTSO directly.

self.address

The address of the contract starting with 0x.

Type

string

__init__(address='0x6D222fb4544ba230d4b90BA1BfC0A01A94E6cB23', apiurl=None)[source]

The constructor for FtsoRegistry class.

Parameters

  • address (string) – Address of the contract starting with 0x.

  • apiurl (string) – Location of Blockscout api endpoint for Songbird. Used for fetching ABI automatically.

FtsoRewardManager

class sgb_ftso_contracts.FtsoRewardManager(address='0xc5738334b972745067fFa666040fdeADc66Cb925', apiurl=None)[source]

A factory to instantiate the FtsoRewardManager contract. Vote power delegators can use this contract to claim rewards and check reward status.

self.address

The address of the contract starting with 0x.

Type

string

__init__(address='0xc5738334b972745067fFa666040fdeADc66Cb925', apiurl=None)[source]

The constructor for FtsoRewardManager class.

Parameters

  • address (string) – Address of the contract starting with 0x.

  • apiurl (string) – Location of Blockscout api endpoint for Songbird. Used for fetching ABI automatically.

VoterWhiteLister

class sgb_ftso_contracts.VoterWhitelister(address='0xa76906EfBA6dFAe155FfC4c0eb36cDF0A28ae24D', apiurl=None)[source]

A factory to instantiate the VoterWhitelister contract. Price providers must be whitelisted in order to submit prices to the FTSOs. This contract is how they do it.

self.address

The address of the contract starting with 0x.

Type

string

__init__(address='0xa76906EfBA6dFAe155FfC4c0eb36cDF0A28ae24D', apiurl=None)[source]

The constructor for VoterWhitelister class.

Parameters

  • address (string) – Address of the contract starting with 0x.

  • apiurl (string) – Location of Blockscout api endpoint for Songbird. Used for fetching ABI automatically.

WNAT

class sgb_ftso_contracts.WNAT(address='0x02f0826ef6aD107Cfc861152B32B52fD11BaB9ED', apiurl=None)[source]

A factory to instantiate the WNAT contract. Holders of the native chain token (for the Songbird network, SGB) use this contract to wrap their Songbird in order to delegate vote power to FTSOs. WNAT = wrapped native

self.address

The address of the contract starting with 0x.

Type

string

__init__(address='0x02f0826ef6aD107Cfc861152B32B52fD11BaB9ED', apiurl=None)[source]

The constructor for WNAT class.

Parameters

  • address (string) – Address of the contract starting with 0x.

  • apiurl (string) – Location of Blockscout api endpoint for Songbird. Used for fetching ABI automatically.