@gateway.fm/gtw-dvf-client-js/src/api/registerAndDeposit.js

DVF client js lib with gateway.fm rpc endpoints

const FP = require('lodash/fp')
const post = require('../lib/dvf/post-authenticated')
const { Joi, fromQuantizedToBaseUnitsBN } = require('dvf-utils')

const contractRegisterAndDepositFromStarkTx = require('./contract/registerAndDepositFromStarkTx')
const getVaultId = require('./getVaultId')
const validateWithJoi = require('../lib/validators/validateWithJoi')
const getSafeQuantizedAmountOrThrow = require('../lib/dvf/token/getSafeQuantizedAmountOrThrow')
const getTokenAddressFromTokenInfoOrThrow = require('../lib/dvf/token/getTokenAddressFromTokenInfoOrThrow')
const permitParamsSchema = require('../lib/schemas/permitParamsSchema')
const createPromiseAndCallbackFn = require('../lib/util/createPromiseAndCallbackFn')
const DVFError = require('../lib/dvf/DVFError')

const schema = Joi.object({
  token: Joi.string(),
  amount: Joi.bigNumber().greaterThan(0), // number or number string
  permitParams: permitParamsSchema.optional(),
  web3Options: Joi.object().optional() // For internal use (custom gas limits, etc)
})

const validateArg0 = validateWithJoi(schema)('INVALID_METHOD_ARGUMENT')({
  context: 'depositV2'
})

module.exports = async (dvf, depositData, starkPublicKey, nonce, signature, contractWalletAddress, encryptedTradingKey, meta, web3Options = {}, txHashCb) => {
  if (dvf.config.DVF.starkExVersion === '4') {
    console.warn('This endpoint is deprecated in StarkEx v4, please use dvf.register to soft-register and dvf.deposit to deposit.')
    throw new DVFError('DEPRECATED')
  }

  const starkKey = starkPublicKey.x

  const registrationData = {
    starkKey,
    nonce,
    signature,
    ...(encryptedTradingKey && { encryptedTradingKey }),
    ...(contractWalletAddress && { contractWalletAddress }),
    ...(meta && { meta })
  }

  const userRegistered = await post(dvf, '/v1/trading/w/register', nonce, signature, registrationData)

  if (userRegistered.isRegistered) {
    return userRegistered
  }

  if (userRegistered.deFiSignature) {
    const { token, amount, permitParams } = validateArg0(depositData)

    const tokenInfo = dvf.token.getTokenInfoOrThrow(token)
    const quantisedAmount = getSafeQuantizedAmountOrThrow(amount, tokenInfo)
    const vaultId = await getVaultId(dvf, token, nonce, signature)

    if (!permitParams) {
      await dvf.contract.approve(
        token,
        fromQuantizedToBaseUnitsBN(tokenInfo, quantisedAmount).toString(),
        dvf.config.DVF.registrationAndDepositInterfaceAddress,
        'ETHEREUM'
      )
    }

    const tokenAddress = getTokenAddressFromTokenInfoOrThrow(tokenInfo, 'ETHEREUM')

    // Sending the deposit transaction to the blockchain first before notifying the server
    const tx = {
      vaultId,
      tokenId: tokenInfo.starkTokenId,
      starkKey: '0x' + starkKey,
      amount: quantisedAmount,
      tokenAddress,
      quantum: tokenInfo.quantization,
      permitParams
    }

    const [transactionHashPromise, transactionHashCb] = createPromiseAndCallbackFn(txHashCb)

    const options = {
      transactionHashCb,
      ...web3Options
    }

    if (dvf.dvfStarkProvider && dvf.dvfStarkProvider.getWalletType() === 'LEDGER') {
      await dvf.token.provideContractData(null, tx.tokenAddress, tx.quantum)
    }
    // Don't await for the tx, resolve on tx hash and the integration will take care of the rest
    const onChainRegisterDeposit = contractRegisterAndDepositFromStarkTx(dvf, userRegistered.deFiSignature, tx, options)

    const transactionHash = await transactionHashPromise

    const payload = {
      token,
      amount: quantisedAmount,
      txHash: transactionHash
    }
    // Force the use of header (instead of payload) for authentication.
    dvf = FP.set('config.useAuthHeader', true, dvf)
    const httpDeposit = await post(dvf, '/v1/trading/deposits', nonce, signature, payload)

    return { ...httpDeposit, transactionHash, onChainRegisterDeposit }
  }
}