@nfttrader-io/sdk-js - npm Package Compare versions

Comparing version 1.0.11 to 1.0.12

package.json

 {
   "name": "@nfttrader-io/sdk-js",
-  "version": "1.0.11",
+  "version": "1.0.12",
   "description": "The NFT Trader official javascript SDK.",
@@ -5,0 +5,0 @@ "main": "dist/nfttrader-sdk.js",

README.md

@@ -200,2 +200,10 @@ # NFT Trader Javascript SDK
 
+###### - **estimateGasCreateSwap() : Object**
+
+###### - **estimateGasCloseSwap() : Object**
+
+###### - **estimateGasCancelSwap() : Object**
+
+###### - **estimateGasEditTaker() : Object**
+
 ## Create A Swap
@@ -641,2 +649,34 @@
 
+##### estimateGasCreateSwap() : ethers.BigNumber | null
+
+Returns the gas estimation cost of the create swap operation. Example:
+
+```js
+const estimateGas = await sdk.estimateGasCreateSwap(...params)
+```
+
+##### estimateGasCloseSwap() : ethers.BigNumber | null
+
+Returns the gas estimation cost of the close swap operation. Example:
+
+```js
+const estimateGas = await sdk.estimateGasCloseSwap(...params)
+```
+
+##### estimateGasCancelSwap() : ethers.BigNumber | null
+
+Returns the gas estimation cost of the cancel swap operation. Example:
+
+```js
+const estimateGas = await sdk.estimateGasCancelSwap(...params)
+```
+
+##### estimateGasEditTaker() : ethers.BigNumber | null
+
+Returns the gas estimation cost of the cancel swap operation. Example:
+
+```js
+const estimateGas = await sdk.estimateGasEditTaker(...params)
+```
+
 ## Utilities
@@ -643,0 +683,0 @@

src/sdk.js

@@ -326,2 +326,130 @@ const { swap, contractAbi, erc721Abi } = require("./contracts")
 /**
+ * Returns the estimation gas cost of the create swap operation.
+ *
+ * @param {Object} createSwapObj - the createSwap configuration object
+ * @param {number} createSwapObj.ethMaker - the ethereum amount provided by the creator of the swap.
+ * @param {string} createSwapObj.taker - the taker (counterparty) of the swap.
+ * @param {number} createSwapObj.ethTaker - the ethereum amount provided by the taker (counterparty) of the swap.
+ * @param {number} createSwapObj.swapEnd - the number of the days representing the validity of the swap
+ * @param {Array} createSwapObj.assetsMaker - the assets (ERC20/ERC721/ERC1155) provided by the creator of the swap
+ * @param {Array} createSwapObj.assetsTaker - the assets (ERC20/ERC721/ERC1155) provided by the taker (counterparty) of the swap
+ * @param {string} createSwapObj.referralAddress - the referral address of the transaction.
+ * @param {number} gasLimit - the gas limit of the transaction
+ * @param {string} gasPrice - the gas price of the transaction
+ */
+NFTTraderSDK.prototype.estimateGasCreateSwap = async function (
+  {
+    ethMaker,
+    taker,
+    ethTaker,
+    swapEnd = 0,
+    assetsMaker = [],
+    assetsTaker = [],
+    referralAddress = "0x0000000000000000000000000000000000000000",
+  },
+  gasLimit = 2000000,
+  gasPrice = null
+) {
+  if (this.avoidPrivateKeySigner && this.isJsonRpcProvider)
+    throw new Error(
+      "you cannot create a swap when you're in jsonRpcProvider mode with avoidPrivateKeySigner param set to true. In this mode you should just read data from the blockchain, not write a transaction."
+    )
+  if (swapEnd < 0) throw new Error("swapEnd cannot be lower than zero.")
+
+  const addressMaker = this.isJsonRpcProvider
+    ? this.signer.address
+    : (await this.provider.listAccounts())[0]
+  const discountMaker = false
+  const valueMaker = this.ethers.BigNumber.from(ethMaker.toString())
+  const flatFeeMaker = 0
+  const addressTaker = taker
+  const discountTaker = false
+  const valueTaker = this.ethers.BigNumber.from(ethTaker.toString())
+  const flatFeeTaker = 0
+  const swapStart = 0
+  const flagFlatFee = false
+  const flagRoyalties = false
+  const status = 0
+  const royaltiesMaker = 0
+  const royaltiesTaker = 0
+  const swapIntent = [
+    addressMaker,
+    discountMaker,
+    valueMaker.toString(),
+    flatFeeMaker,
+    addressTaker,
+    discountTaker,
+    valueTaker.toString(),
+    flatFeeTaker,
+    swapStart,
+    swapEnd,
+    flagFlatFee,
+    flagRoyalties,
+    status,
+    royaltiesMaker,
+    royaltiesTaker,
+  ]
+
+  let hasSquad = false
+  let fee
+
+  try {
+    const { flagFlatFee, flatFee } = await this.getPayment()
+    fee = flagFlatFee ? flatFee.toNumber() : 0
+
+    const { TRADESQUAD, PARTNERSQUAD } = await this.getReferenceAddress()
+
+    const contractTradeSquad = new this.ethers.Contract(
+      TRADESQUAD,
+      erc721Abi,
+      this.provider
+    )
+    const contractPartnerSquad = new this.ethers.Contract(
+      PARTNERSQUAD,
+      erc721Abi,
+      this.provider
+    )
+
+    const balanceTradeSquad = await contractTradeSquad.balanceOf(addressMaker)
+    const balancePartnerSquad = await contractPartnerSquad.balanceOf(
+      addressMaker
+    )
+
+    if (balanceTradeSquad.toNumber() > 0 || balancePartnerSquad.toNumber() > 0)
+      hasSquad = true
+  } catch (error) {
+    throw new Error(error)
+  }
+
+  let txOverrides = {}
+  txOverrides["value"] = hasSquad
+    ? valueMaker.toString()
+    : valueMaker.add(fee).toString()
+  gasLimit && (txOverrides["gasLimit"] = gasLimit)
+  gasPrice && (txOverrides["gasPrice"] = gasPrice)
+
+  let signerTx
+  let contract = this.contract
+
+  if (this.isWeb3Provider) {
+    signerTx = this.provider.getSigner(addressMaker)
+    contract = this.contract.connect(signerTx)
+  }
+
+  try {
+    let estimateGas = await contract.estimateGas.createSwapIntent(
+      swapIntent,
+      assetsMaker,
+      assetsTaker,
+      referralAddress,
+      { ...txOverrides }
+    )
+    return estimateGas
+  } catch (error) {
+    console.error(error)
+    return null
+  }
+}
+
+/**
  * Close the swap. Only the taker (counterparty) can close it if its address is specified. Otherwise everyone can close the swap.
@@ -416,2 +544,84 @@ *
 /**
+ * Returns the gas estimation cost of the close swap operation.
+ *
+ * @param {Object} closeSwapObj - the closeSwap configuration object
+ * @param {number} closeSwapObj.swapId - the identifier of the swap.
+ * @param {string} closeSwapObj.referralAddress - the referral address of the transaction.
+ * @param {string} closeSwapObj.referralAddress - the referral address of the transaction.
+ * @param {string} closeSwapObj.referralAddress - the referral address of the transaction.
+ * @param {number} gasLimit - the gas limit of the transaction
+ * @param {string} gasPrice - the gas price of the transaction
+ */
+NFTTraderSDK.prototype.estimateGasCloseSwap = async function (
+  { swapId, referralAddress = "0x0000000000000000000000000000000000000000" },
+  gasLimit = 2000000,
+  gasPrice = null
+) {
+  if (this.avoidPrivateKeySigner && this.isJsonRpcProvider)
+    throw new Error(
+      "you cannot close a swap when you're in jsonRpcProvider mode with avoidPrivateKeySigner param set to true. In this mode you should just read data from the blockchain, not write a transaction."
+    )
+
+  try {
+    let hasSquad = false
+    const { flagFlatFee, flatFee } = await this.getPayment()
+    const fee = flagFlatFee ? flatFee.toNumber() : 0
+    const taker = this.isJsonRpcProvider
+      ? this.signer.address
+      : (await this.provider.listAccounts())[0]
+    const { valueTaker } = await this.getSwapDetails(swapId)
+    const { TRADESQUAD, PARTNERSQUAD } = await this.getReferenceAddress()
+    const contractTradeSquad = new this.ethers.Contract(
+      TRADESQUAD,
+      erc721Abi,
+      this.provider
+    )
+    const contractPartnerSquad = new this.ethers.Contract(
+      PARTNERSQUAD,
+      erc721Abi,
+      this.provider
+    )
+
+    const balanceTradeSquad = await contractTradeSquad.balanceOf(taker)
+    const balancePartnerSquad = await contractPartnerSquad.balanceOf(taker)
+
+    let txOverrides = {}
+    txOverrides["value"] = hasSquad
+      ? valueTaker.toString()
+      : valueTaker.add(fee).toString()
+    gasLimit && (txOverrides["gasLimit"] = gasLimit)
+    gasPrice && (txOverrides["gasPrice"] = gasPrice)
+
+    if (balanceTradeSquad.toNumber() > 0 || balancePartnerSquad.toNumber() > 0)
+      hasSquad = true
+
+    let senderTx
+    let signerTx
+    let contract = this.contract
+
+    if (this.isWeb3Provider) {
+      senderTx = (await this.provider.listAccounts())[0]
+      signerTx = this.provider.getSigner(senderTx)
+      contract = this.contract.connect(signerTx)
+    }
+
+    try {
+      let estimateGas = await contract.estimateGas.closeSwapIntent(
+        swapId,
+        referralAddress,
+        {
+          ...txOverrides,
+        }
+      )
+      return estimateGas
+    } catch (error) {
+      console.error(error)
+      return null
+    }
+  } catch (error) {
+    throw new Error(error)
+  }
+}
+
+/**
  * Cancel the swap. Only the maker (creator) can cancel it.
@@ -468,2 +678,45 @@ *
 /**
+ * Returns the estimation gas cost of the cancel swap operation.
+ *
+ * @param {number} swapId - the identifier of the swap.
+ * @param {number} gasLimit - the gas limit of the transaction
+ * @param {string} gasPrice - the gas price of the transaction
+ */
+NFTTraderSDK.prototype.estimateGasCancelSwap = async function (
+  swapId,
+  gasLimit = 2000000,
+  gasPrice = null
+) {
+  if (this.avoidPrivateKeySigner && this.isJsonRpcProvider)
+    throw new Error(
+      "you cannot cancel a swap when you're in jsonRpcProvider mode with avoidPrivateKeySigner param set to true. In this mode you should just read data from the blockchain, not write a transaction."
+    )
+
+  let txOverrides = {}
+  gasLimit && (txOverrides["gasLimit"] = gasLimit)
+  gasPrice && (txOverrides["gasPrice"] = gasPrice)
+
+  let senderTx
+  let signerTx
+  let contract = this.contract
+
+  if (this.isWeb3Provider) {
+    senderTx = (await this.provider.listAccounts())[0]
+    signerTx = this.provider.getSigner(senderTx)
+    contract = this.contract.connect(signerTx)
+  }
+
+  try {
+    let estimateGas = await contract.estimateGas.cancelSwapIntent(swapId, {
+      ...txOverrides,
+    })
+
+    return estimateGas
+  } catch (error) {
+    console.error(error)
+    return null
+  }
+}
+
+/**
  * Edit the taker (counterparty) of the swap. Only the maker (creator) can edit it.
@@ -524,2 +777,51 @@ *
 /**
+ * Returns the estimation gas cost of the edit counterparty operation.
+ *
+ * @param {number} swapId - the identifier of the swap.
+ * @param {string} addressTaker - the address of the taker (counterparty).
+ * @param {number} gasLimit - the gas limit of the transaction
+ * @param {string} gasPrice - the gas price of the transaction
+ */
+NFTTraderSDK.prototype.estimateGasEditTaker = async function (
+  swapId,
+  addressTaker,
+  gasLimit = 2000000,
+  gasPrice = null
+) {
+  if (this.avoidPrivateKeySigner && this.isJsonRpcProvider)
+    throw new Error(
+      "you cannot edit the taker of a swap when you're in jsonRpcProvider mode with avoidPrivateKeySigner param set to true. In this mode you should just read data from the blockchain, not write a transaction."
+    )
+
+  let txOverrides = {}
+  gasLimit && (txOverrides["gasLimit"] = gasLimit)
+  gasPrice && (txOverrides["gasPrice"] = gasPrice)
+
+  let senderTx
+  let signerTx
+  let contract = this.contract
+
+  if (this.isWeb3Provider) {
+    senderTx = (await this.provider.listAccounts())[0]
+    signerTx = this.provider.getSigner(senderTx)
+    contract = this.contract.connect(signerTx)
+  }
+
+  try {
+    let estimateGas = await contract.estimateGas.editCounterPart(
+      swapId,
+      addressTaker,
+      {
+        ...txOverrides,
+      }
+    )
+
+    return estimateGas
+  } catch (error) {
+    console.error(error)
+    return null
+  }
+}
+
+/**
  * Returns the swap main details information.
@@ -526,0 +828,0 @@ *

No alert changes

Improved metrics

Total package byte prevSize

250297

increased by4.34%

Lines of code

2289

increased by13.37%

Number of lines in readme file

871

increased by4.81%

No dependency changes