@evolutionland/evolution-js

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>land/v1.ts - Documentation</title> <script src="scripts/prettify/prettify.js"></script> <script src="scripts/prettify/lang-css.js"></script>  <link type="text/css" rel="stylesheet" href="styles/prettify.css"> <link type="text/css" rel="stylesheet" href="styles/jsdoc.css"> <script src="scripts/nav.js" defer></script> <meta name="viewport" content="width=device-width, initial-scale=1.0"> </head> <body> <input type="checkbox" id="nav-trigger" class="nav-trigger" /> <label for="nav-trigger" class="navicon-button x"> <div class="navicon"></div> </label> <label for="nav-trigger" class="overlay"></label> <nav > <h2><a href="index.html">Home</a></h2><h3>Global</h3><ul><li><a href="global.html#apostleAllowanceToClockAuction">apostleAllowanceToClockAuction</a></li><li><a href="global.html#apostleAskWithToken">apostleAskWithToken</a></li><li><a href="global.html#apostleBidWithToken">apostleBidWithToken</a></li><li><a href="global.html#apostleBorn">apostleBorn</a></li><li><a href="global.html#apostleBornAndEnhance">apostleBornAndEnhance</a></li><li><a href="global.html#apostleBreed">apostleBreed</a></li><li><a href="global.html#apostleBreedAsk">apostleBreedAsk</a></li><li><a href="global.html#apostleBreedBid">apostleBreedBid</a></li><li><a href="global.html#apostleCancelAskWithToken">apostleCancelAskWithToken</a></li><li><a href="global.html#apostleCancelBreedAsk">apostleCancelBreedAsk</a></li><li><a href="global.html#apostleCancelHire">apostleCancelHire</a></li><li><a href="global.html#apostleClaim">apostleClaim</a></li><li><a href="global.html#apostleClaimHire">apostleClaimHire</a></li><li><a href="global.html#apostleGetAutoBreedFee">apostleGetAutoBreedFee</a></li><li><a href="global.html#apostleGetCurrentPriceByTokenId">apostleGetCurrentPriceByTokenId</a></li><li><a href="global.html#apostleGetCurrentSiringPriceByTokenId">apostleGetCurrentSiringPriceByTokenId</a></li><li><a href="global.html#apostleHire">apostleHire</a></li><li><a href="global.html#apostleHireBid">apostleHireBid</a></li><li><a href="global.html#apostleStopWork">apostleStopWork</a></li><li><a href="global.html#apostleTransfer">apostleTransfer</a></li><li><a href="global.html#apostleWork">apostleWork</a></li><li><a href="global.html#drillStopWork">drillStopWork</a></li><li><a href="global.html#drillTransfer">drillTransfer</a></li><li><a href="global.html#drillWork">drillWork</a></li><li><a href="global.html#equipmentTransfer">equipmentTransfer</a></li><li><a href="global.html#equipmentUnequip">equipmentUnequip</a></li><li><a href="global.html#erc20Allowance">erc20Allowance</a></li><li><a href="global.html#erc20AllowanceByContractAddress">erc20AllowanceByContractAddress</a></li><li><a href="global.html#erc20Approve">erc20Approve</a></li><li><a href="global.html#erc20ApproveByContractAddress">erc20ApproveByContractAddress</a></li><li><a href="global.html#erc20BalanceOf">erc20BalanceOf</a></li><li><a href="global.html#erc20TotalSupply">erc20TotalSupply</a></li><li><a href="global.html#erc20TransferByContractAddress">erc20TransferByContractAddress</a></li><li><a href="global.html#erc721IsApprovedForAll">erc721IsApprovedForAll</a></li><li><a href="global.html#erc721IsApprovedOrOwner">erc721IsApprovedOrOwner</a></li><li><a href="global.html#erc721OwnerOf">erc721OwnerOf</a></li><li><a href="global.html#erc721SetApprovalForAll">erc721SetApprovalForAll</a></li><li><a href="global.html#erc1155BalanceOf">erc1155BalanceOf</a></li><li><a href="global.html#erc1155BalanceOfBatch">erc1155BalanceOfBatch</a></li><li><a href="global.html#erc1155IsApprovedForAll">erc1155IsApprovedForAll</a></li><li><a href="global.html#erc1155SafeBatchTransferFrom">erc1155SafeBatchTransferFrom</a></li><li><a href="global.html#erc1155SetApprovalForAll">erc1155SetApprovalForAll</a></li><li><a href="global.html#farmGetStakerAddress">farmGetStakerAddress</a></li><li><a href="global.html#farmGetStakerBalanceOf">farmGetStakerBalanceOf</a></li><li><a href="global.html#farmGetStakerEarned">farmGetStakerEarned</a></li><li><a href="global.html#farmGetStakerExit">farmGetStakerExit</a></li><li><a href="global.html#farmGetStakerGetReward">farmGetStakerGetReward</a></li><li><a href="global.html#farmGetStakerStakeToken">farmGetStakerStakeToken</a></li><li><a href="global.html#farmGetStakerTotalSupply">farmGetStakerTotalSupply</a></li><li><a href="global.html#farmStakerWithdraw">farmStakerWithdraw</a></li><li><a href="global.html#furnaceBuyTreasure">furnaceBuyTreasure</a></li><li><a href="global.html#furnaceDisenchantProps">furnaceDisenchantProps</a></li><li><a href="global.html#furnaceDismantleEquipment">furnaceDismantleEquipment</a></li><li><a href="global.html#furnaceEnchantEquipment">furnaceEnchantEquipment</a></li><li><a href="global.html#furnaceEnchantProps">furnaceEnchantProps</a></li><li><a href="global.html#furnaceGetTreasurePrice">furnaceGetTreasurePrice</a></li><li><a href="global.html#furnaceGetTreasureStatus">furnaceGetTreasureStatus</a></li><li><a href="global.html#furnaceOpenTreasure">furnaceOpenTreasure</a></li><li><a href="global.html#goldRushRaffleChangeAmount">goldRushRaffleChangeAmount</a></li><li><a href="global.html#goldRushRaffleChangeInfo">goldRushRaffleChangeInfo</a></li><li><a href="global.html#goldRushRaffleChangeSubAddr">goldRushRaffleChangeSubAddr</a></li><li><a href="global.html#goldRushRaffleDraw">goldRushRaffleDraw</a></li><li><a href="global.html#goldRushRaffleExit">goldRushRaffleExit</a></li><li><a href="global.html#goldRushRaffleGetHistory">goldRushRaffleGetHistory</a></li><li><a href="global.html#goldRushRaffleJoin">goldRushRaffleJoin</a></li><li><a href="global.html#landAskWithToken">landAskWithToken</a></li><li><a href="global.html#landBatchClaimItemResource">landBatchClaimItemResource</a></li><li><a href="global.html#landBatchClaimLandResource">landBatchClaimLandResource</a></li><li><a href="global.html#landBidWithToken">landBidWithToken</a></li><li><a href="global.html#landCancelAskWithToken">landCancelAskWithToken</a></li><li><a href="global.html#landClaimItemResource">landClaimItemResource</a></li><li><a href="global.html#landClaimLand">landClaimLand</a></li><li><a href="global.html#landGetAvailableItemResources">landGetAvailableItemResources</a></li><li><a href="global.html#landGetAvailableResources">landGetAvailableResources</a></li><li><a href="global.html#landGetCurrentPriceByTokenId">landGetCurrentPriceByTokenId</a></li><li><a href="global.html#landTransfer">landTransfer</a></li><li><a href="global.html#lotteryGetPointsBalance">lotteryGetPointsBalance</a></li><li><a href="global.html#lotteryGetTotalRewardInPool">lotteryGetTotalRewardInPool</a></li><li><a href="global.html#lotteryPlayWithTicket">lotteryPlayWithTicket</a></li><li><a href="global.html#materialBalanceOfBatch">materialBalanceOfBatch</a></li><li><a href="global.html#materialBatchTransfer">materialBatchTransfer</a></li><li><a href="global.html#materialIdEncode">materialIdEncode</a></li><li><a href="global.html#pveTeamAt">pveTeamAt</a></li><li><a href="global.html#pveTeamEvict">pveTeamEvict</a></li><li><a href="global.html#pveTeamExist">pveTeamExist</a></li><li><a href="global.html#pveTeamExit">pveTeamExit</a></li><li><a href="global.html#pveTeamExits">pveTeamExits</a></li><li><a href="global.html#pveTeamJoin">pveTeamJoin</a></li><li><a href="global.html#pveTeamJoins">pveTeamJoins</a></li><li><a href="global.html#pveTeamSwap">pveTeamSwap</a></li><li><a href="global.html#uniswapBuyRING">uniswapBuyRING</a></li></ul> </nav> <div id="main"> <h1 class="page-title">land/v1.ts</h1> <section> <article> <pre class="prettyprint source linenums"><code>import { ethers } from "ethers"; import { getAddressesByLandId } from "@evo/utils/ethers/addressHelper"; import { pad0xBegin } from "@evo/utils/common/utils"; import { toHexAndPadLeft, padLeft } from "@evo/utils/ethers/utils"; import { CallbackType, getContractAddressAndAbiByContractName } from "@evo/utils/ethers/contractHelper"; import { triggerContractByContractName, viewContractByContractName } from "@evo/utils/ethers/contractHelper"; import { LandId } from "@evo/config/constants"; import { TransactionResponse } from "@ethersproject/providers"; /** * Land Bid With Token * @param signer Ethers signer * @param landTokenId Land token id * @param referrer Referrer * @param amount Amount of price in RING token * @param callback Callback */ export const landBidWithToken = async ( landId: LandId, signer: ethers.Signer, landTokenId: string, referrer: string | null, amount: string, callback?: CallbackType ): Promise<TransactionResponse> => { const finalReferrer = referrer && ethers.utils.isAddress(referrer) ? referrer : "0x0000000000000000000000000000000000000000"; if (landId === LandId.ETHEREUM || landId === LandId._ETHEREUM) { const data = finalReferrer ? `${pad0xBegin(landTokenId)}${ethers.utils.hexZeroPad(finalReferrer, 32).slice(2)}` : pad0xBegin(landTokenId); const addresses = getAddressesByLandId(landId); if (!addresses || !addresses.LAND_CLOCK_AUCTION) { throw "address error"; } return triggerContractByContractName( landId, signer, "ring", "transfer(address,uint256,bytes)", [addresses.LAND_CLOCK_AUCTION, amount, data], callback ); } return triggerContractByContractName( landId, signer, "landClockAuctionV3", "bidWithToken", [pad0xBegin(landTokenId), finalReferrer, amount], callback ); }; /** * Land Available Resources * @param provider Ethers provider * @param tokenId Token id * @param resources Resources * @param callback Callback * @returns String[] */ export const landGetAvailableResources = async ( landId: LandId, provider: ethers.providers.Provider, tokenId: string, resources: string[], callback?: CallbackType ): Promise<string[]> => { const addresses = getAddressesByLandId(landId); if (!addresses) { return []; } const finalRes = resources.length ? [...resources] : [ addresses.ELEMENT_GOLD, addresses.ELEMENT_WOOD, addresses.ELEMENT_WATER, addresses.ELEMENT_FIRE, addresses.ELEMENT_SOIL, ]; const results = await viewContractByContractName( landId, provider, "apostleLandResource", "availableLandResources", [pad0xBegin(tokenId), finalRes], callback ); return results[0].map((res: ethers.BigNumber[]) => { return res.toString(); }); }; /** * Land Batch Claim Land Resource * @param signer Ethers signer * @param tokenIds Token ids * @param callback Callback */ export const landBatchClaimLandResource = ( landId: LandId, signer: ethers.Signer, tokenIds: string[], callback?: CallbackType ): Promise<TransactionResponse> => { return triggerContractByContractName( landId, signer, "apostleLandResource", "batchClaimLandResource", [tokenIds.map((tokenId) => pad0xBegin(tokenId))], callback ); }; /** * Returns the current price of an auction. * @param provider Ethers signer * @param tokenId Token Id * @param callback Callback * @returns any */ export const landGetCurrentPriceByTokenId = async ( landId: LandId, provider: ethers.providers.Provider, tokenId: string, callback?: CallbackType ): Promise<string> => { const results = await viewContractByContractName( landId, provider, "landClockAuctionV3", "getCurrentPriceInToken", [pad0xBegin(tokenId)], callback ); return (results[0] as ethers.BigNumber).toHexString(); }; /** * Sell land asset * @param signer Ethers signer * @param from * @param tokenId - Land tokenId * @param start - start price * @param end - end price * @param duration - bid duration time in second * @param callback Callback * @returns {Promise<void>} */ export const landAskWithToken = ( landId: LandId, signer: ethers.Signer, from: string, tokenId: string, startPrice: string, endPrice: string, duration: string, callback?: CallbackType ): Promise<TransactionResponse> => { const _from = padLeft(from.slice(2), 64, "0"); const _start = toHexAndPadLeft(startPrice).slice(2); const _end = toHexAndPadLeft(endPrice).slice(2); const _duration = toHexAndPadLeft(duration).slice(2); const data = `0x${_start}${_end}${_duration}${_from}`; const landClockAuctionContract = getContractAddressAndAbiByContractName(landId, signer, "landClockAuctionV3"); return triggerContractByContractName( landId, signer, "objectOwnership", "approveAndCall", [landClockAuctionContract.address, pad0xBegin(tokenId), data], callback ); }; /** * Cancel a land auction. * @param landId Land Id * @param signer Signer * @param tokenId Id of the Land * @param callback Callback * @returns any */ export const landCancelAskWithToken = ( landId: LandId, signer: ethers.Signer, tokenId: string, callback?: CallbackType ): Promise<TransactionResponse> => { return triggerContractByContractName( landId, signer, "landClockAuctionV3", "cancelAuction", [pad0xBegin(tokenId)], callback ); }; /** * Get Avaliable item resources. * @param landId Land Id * @param provider Provider * @param porpsContractAddress Item contract address * @param tokenId Id of item * @param resourcesContractAddress Array of resources contract address * @param callback Callback * @returns any */ export const landGetAvailableItemResources = async ( landId: LandId, provider: ethers.providers.Provider, porpsContractAddress: string, tokenId: string, resourcesContractAddress: string[], callback?: CallbackType ): Promise<string[]> => { const results = await viewContractByContractName( landId, provider, "apostleLandResource", "availableItemResources", [porpsContractAddress, pad0xBegin(tokenId), resourcesContractAddress], callback ); return results[0].map((res: ethers.BigNumber) => res.toString()); }; /** * Batch claim item resource. * @param landId Land Id * @param signer Signer * @param drillContractAddress drill contract address * @param tokenIds Array of drill token Ids * @param callback Callback * @returns any */ export const landBatchClaimItemResource = ( landId: LandId, signer: ethers.Signer, drillContractAddress: string[], tokenIds: string[], callback?: CallbackType ): Promise<TransactionResponse> => { return triggerContractByContractName( landId, signer, "apostleLandResourceV2", "batchClaimItemResource", [drillContractAddress, tokenIds.map((tokenId) => pad0xBegin(tokenId))], callback ); }; /** * Claim item resource. * @param landId Land Id * @param signer Signer * @param drillContractAddress Drill contract address * @param tokenId Token Id * @param callback Callback * @returns any */ export const landClaimItemResource = ( landId: LandId, signer: ethers.Signer, drillContractAddress: string, tokenId: string, callback?: CallbackType ): Promise<TransactionResponse> => { return triggerContractByContractName( landId, signer, "apostleLandResource", "claimItemResource", [drillContractAddress, pad0xBegin(tokenId)], callback ); }; /** * Transfer land * @param landId Land Id * @param signer Signer * @param from Land owner * @param to Recipient * @param tokenId Token Id * @param callback Callback * @returns any */ export const landTransfer = ( landId: LandId, signer: ethers.Signer, from: string, to: string, tokenId: string, callback?: CallbackType ): Promise<TransactionResponse> => { return triggerContractByContractName( landId, signer, "objectOwnership", "transferFrom", [from, to, pad0xBegin(tokenId)], callback ); }; /** * Claim land asset * @param landId Land Id * @param signer Signer * @param landTokenId Land token Id * @param callback Callback * @returns any */ export const landClaimLand = ( landId: LandId, signer: ethers.Signer, landTokenId: string, callback?: CallbackType ): Promise<TransactionResponse> => { return triggerContractByContractName( landId, signer, "landClockAuctionV3", "claimLandAsset", [pad0xBegin(landTokenId)], callback ); }; </code></pre> </article> </section> </div> <br class="clear"> <footer> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Mon Aug 15 2022 13:54:57 GMT+0800 (China Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme. </footer> <script>prettyPrint();</script> <script src="scripts/polyfill.js"></script> <script src="scripts/linenumber.js"></script> </body> </html>