Install with pip install dfktools
https://pypi.org/project/dfktools/
This is a simple toolbox to interact with the contracts of DefiKingdoms
This software is not endorsed by, directly affiliated with, maintained, authorized, or sponsored by the DefiKingdoms team. All product and company names are the registered trademarks of their original owners. The use of any trade name or trademark is for identification and reference purposes only and does not imply any association with the trademark holder of their product brand.
Like this project ? Consider supporting future developments by:
- Delegating AVAX to our Avalanche node NodeID-4btZGj8TmrycK22kwgBK5wJEFighAFWiZ
- Making a donation to 0xA68fBfa3E0c86D1f3fF071853df6DAe8753095E2
Need help ? Join the GameFi Developers Discord
- Indent with Tab
- 1 empty line within a function, 2 empty lines between function
- Use trait(s) to name any or all of the 8 value
strength, agility, intelligence, wisdom, luck, vitality, endurance, dexterity - Use ability(ies) to name any or all of the 4 value
passive1, passive2, active1, active2 - Use stat(s) as a generic term for any or all the characteristics of a hero (traits, abilities, HP, MP, stamina, etc)
- A function should support all realms, except if contracts differs across realms
- All hardcoded addresses should be CheckSummed
- Use
logging, notprint - No other third-party libraries (if really needed, please explain why in the PR)
- A short & meaningful comment is better than a long & unfathomable documentation
The hero contract is accessible with hero/hero.py
Transfer a hero from one address to another
Hero's data can be retrieved with the get_hero method. A more human-friendly format can be generated
by passing the result of get_hero to the human_readable_hero method.
The owner of a hero can be retrieved with the method get_owner
The profile contract is accessible with profile/profile_v2.py
In-game profile can be retrieved with the get_profile method
The summoning contract is accessible with summoning/summoning.py
Summoning crystal are created with summon_crystal method
Crystal id can be retrieved with get_user_crystal_ids method
Summoning crystal can be open with open_crystal method
Put a hero up for hire with put_hero_for_rent and cancel with cancel_rent
Use is_on_rent and get_rent_auction to monitor auction
The gene science contract is accessible with genes/gene_science_v2.py
Statistics and visual of summoned hero can be forecasted with the mix_genes method.
Note that mix_genes is pseudo random and the resulting traits will be different for each block.
However, a statistical analysis can be used to optimize the summoning of desirable traits
The hero sale auction contract is accessible with auctions/hero/sale_auctions.py The hero rent auction contract is accessible with auctions/hero/rent_auctions.py Generic sale auction (ex: land) contract are accessible with auctions/auction.py
auction_example.py land_example.py
bid_hero and get_auction interact directly with the contract.
get_recent_open_auctions and get_hero_open_auctions use Graphql.
get_recent_open_auctions and get_hero_open_auctions use Graphql.
All quest contracts are located in module quests
Each quest requires at least 7 stamina to complete. Check the current stamina of any given hero with get_current_stamina.
Start the quest with start_quest. The second parameter is the number of attempt. To optimize the cost of gas, it is recommended
to use a hero at full stamina and do 3 attempts every call.
Uses V2 quest
Gardening and mining quest can be started with just one stamina. Mining quest can be done with up to 6 heroes while only 1 hero at a time can be sent on a gardening quest to a specific garden (liquidity pool).
Uses V1 quest
In game tokens and AMM exchange are available in module dex
Use dex.erc20.balance_of to retrieve the balance of an item for the specified address
Use wrapper class dex.uniswap_v2_pair.UniswapV2Pair and call expected_amount0 to get the estimated amount of token0 received in exchange of token1.
Alternatively, call dex.uniswap_v2_router.quote
Use call dex.uniswap_v2_router.swap_exact_tokens_for_eth to swap erc20 token for ONE.
Use call dex.uniswap_v2_router.swap_exact_tokens_for_tokens to swap erc20 tokens for other erc20 tokens.
Use wrapper class dex.master_gardener.Garden to retrieve staking pool info
Meditation circle contract is accessible with meditation/meditation.py
Use start_meditation and complete_meditation to level up a hero. Make sure to have enough rune for the hero's level with get_required_runes
All duel contracts are located in module duel
All raffle contracts are located in module raffle
All pet related contracts are located in module pets
Use pet.py to manage pet NFT
Use hatchery.py to hatch pet egg
Use exchange.py to exchange 2 pets for an egg
All bridge contracts are located in module bridge
Be careful to not mix up RPCs when dealing with multichain transaction