rhinofi · benudall · May 8, 2023 · May 8, 2023 · May 15, 2023 · May 15, 2023
diff --git a/.github/workflows/test-and-publish.yaml b/.github/workflows/test-and-publish.yaml
@@ -15,19 +15,26 @@ jobs:
 
     - id: auth
       name: Authenticate to Google Cloud
-      uses: google-github-actions/auth@v0
+      uses: google-github-actions/auth@v1.1.1
       with:
         workload_identity_provider: projects/1000420590118/locations/global/workloadIdentityPools/github-workflows/providers/github-workflows
         service_account: [email protected]
 
-    - uses: cachix/install-nix-action@v19
+    - uses: cachix/install-nix-action@v20
       with:
         nix_path: nixpkgs=channel:nixos-unstable
         extra_nix_config: |
           experimental-features = nix-command
 
+    - id: secrets
+      uses: google-github-actions/[email protected]
+      with:
+        secrets: github_token:dvf-shared/GITHUB_TOKEN_ALL_REPOS_READ
+
     - name: Bootstrap nix config
-      run: echo ${{ secrets.CI_GITHUB_TOKEN }} | ./nix/netrc-create.sh
+      env:
+        GITHUB_TOKEN: '${{ steps.secrets.outputs.github_token }}'
+      run: ./nix/netrc-create.sh
 
     - name: Run pr-step
       run: nix run --impure -f nix/pkgs-private.nix ci.pr-step

diff --git a/env/test b/env/test
@@ -1,5 +1,5 @@
 # Add Web3 url
-RPC_URL=https://ropsten.infura.io/v3/7bfab7398ae84af3b1b70c955cfd9491
+RPC_URL=https://goerli.infura.io/v3/3d572ae9b01e45c789c3214696bb02d4
 # Add GAS STATION API KEY
 # Ethereum private key prefixed with 0x
 PRIVATE_ETH_KEY=0x49e4d1e2aa7d026188251392dd2d335c176d846d8a894a8092c835f3b345e2ad

diff --git a/examples/00.setup.js b/examples/00.setup.js
@@ -8,7 +8,7 @@
 const fs = require('fs')
 const readline = require('readline')
 const Web3 = require('web3')
-const P = require('aigle')
+const P = require('@rhino.fi/aigle')
 const saveAsJson = require('./helpers/saveAsJson')
 
 const RPC_URL = process.argv[2]

diff --git a/examples/08.cancelOrder.js b/examples/08.cancelOrder.js
@@ -40,7 +40,7 @@ const rhinofiConfig = {
 ;(async () => {
   const rhinofi = await RhinofiClientFactory(web3, rhinofiConfig)
 
-  const P = require('aigle')
+  const P = require('@rhino.fi/aigle')
   let order
   const orders = await rhinofi.getOrders()
 

diff --git a/examples/25.fastWithdrawalFee.js b/examples/25.fastWithdrawalFee.js
@@ -40,6 +40,7 @@ const rhinofiConfig = {
 ;(async () => {
   const rhinofi = await RhinofiClientFactory(web3, rhinofiConfig)
 
+  // NOTE: fastWithdrawalFee method as been deprecated
   const response = await rhinofi.fastWithdrawalFee('ETH')
 
   logExampleResult(response)

diff --git a/examples/28.ammWithdrawal.js b/examples/28.ammWithdrawal.js
@@ -67,7 +67,7 @@ const rhinofiConfig = {
     ammDepositOrderData
   )
 
-  const P = require('aigle')
+  const P = require('@rhino.fi/aigle')
 
   await P.retry(
     { times: 360, interval: 1000 },

diff --git a/examples/33.generateL1RegistrationPayload.js b/examples/33.generateL1RegistrationPayload.js
@@ -0,0 +1,65 @@
+#!/usr/bin/env -S yarn node
+/* eslint-disable no-unused-vars */
+
+/*
+DO NOT EDIT THIS FILE BY HAND!
+Examples are generated using helpers/buildExamples.js script.
+Check README.md for more details.
+*/
+
+const sw = require('@rhino.fi/starkware-crypto')
+const getWeb3 = require('./helpers/getWeb3')
+
+const RhinofiClientFactory = require('../src')
+const envVars = require('./helpers/loadFromEnvOrConfig')(
+  process.env.CONFIG_FILE_NAME
+)
+const logExampleResult = require('./helpers/logExampleResult')(__filename)
+
+const ethPrivKey = envVars.ETH_PRIVATE_KEY
+// NOTE: you can also generate a new key using:`
+// const starkPrivKey = rhinofi.stark.createPrivateKey()
+const starkPrivKey = envVars.STARK_PRIVATE_KEY
+const rpcUrl = envVars.RPC_URL
+
+const { web3, provider } = getWeb3(ethPrivKey, rpcUrl)
+
+const rhinofiConfig = {
+  api: envVars.API_URL,
+  dataApi: envVars.DATA_API_URL,
+  useAuthHeader: true,
+  wallet: {
+    type: 'tradingKey',
+    meta: {
+      starkPrivateKey: starkPrivKey
+    }
+  }
+  // Add more variables to override default values
+}
+
+;(async () => {
+  const rhinofi = await RhinofiClientFactory(web3, rhinofiConfig)
+
+  const { starkKeyHex, ethAddress } = await rhinofi.getUserConfig()
+
+  const l1RegistrationSignature = await rhinofi.stark.signRegistration(
+    ethAddress
+  )
+
+  const callData = await rhinofi.stark.l1RegistrationCallData(
+    starkKeyHex,
+    ethAddress,
+    l1RegistrationSignature
+  )
+
+  logExampleResult({
+    ethAddress,
+    starkKeyHex,
+    sig: l1RegistrationSignature,
+    callData
+  })
+})()
+.catch(error => {
+  console.error(error)
+  process.exit(1)
+})
diff --git a/examples/34.estimatedNextBatchTime.js b/examples/34.estimatedNextBatchTime.js
@@ -0,0 +1,51 @@
+#!/usr/bin/env -S yarn node
+/* eslint-disable no-unused-vars */
+
+/*
+DO NOT EDIT THIS FILE BY HAND!
+Examples are generated using helpers/buildExamples.js script.
+Check README.md for more details.
+*/
+
+const sw = require('@rhino.fi/starkware-crypto')
+const getWeb3 = require('./helpers/getWeb3')
+
+const RhinofiClientFactory = require('../src')
+const envVars = require('./helpers/loadFromEnvOrConfig')(
+  process.env.CONFIG_FILE_NAME
+)
+const logExampleResult = require('./helpers/logExampleResult')(__filename)
+
+const ethPrivKey = envVars.ETH_PRIVATE_KEY
+// NOTE: you can also generate a new key using:`
+// const starkPrivKey = rhinofi.stark.createPrivateKey()
+const starkPrivKey = envVars.STARK_PRIVATE_KEY
+const rpcUrl = envVars.RPC_URL
+
+const { web3, provider } = getWeb3(ethPrivKey, rpcUrl)
+
+const rhinofiConfig = {
+  api: envVars.API_URL,
+  dataApi: envVars.DATA_API_URL,
+  useAuthHeader: true,
+  wallet: {
+    type: 'tradingKey',
+    meta: {
+      starkPrivateKey: starkPrivKey
+    }
+  }
+  // Add more variables to override default values
+}
+
+;(async () => {
+  const rhinofi = await RhinofiClientFactory(web3, rhinofiConfig)
+
+  const estimatedNextBatchTimeResponse = await rhinofi.estimatedNextBatchTime()
+
+  logExampleResult(estimatedNextBatchTimeResponse)
+
+})()
+.catch(error => {
+  console.error(error)
+  process.exit(1)
+})
diff --git a/examples/helpers/examplesList.js b/examples/helpers/examplesList.js
@@ -33,6 +33,8 @@ module.exports = Object.freeze([
   'publicPermissions',
   'transfer',
   'getRegistrationStatuses',
+  'generateL1RegistrationPayload',
+  'estimatedNextBatchTime',
   // TODO
   // 'submitBuyOrder',
   // 'submitSellOrder',

diff --git a/examples/helpers/getOrCreateActiveOrder.js b/examples/helpers/getOrCreateActiveOrder.js
@@ -1,4 +1,4 @@
-const P = require('aigle')
+const P = require('@rhino.fi/aigle')
 
 const defaultOrderProps = Object.freeze({
   cid: 'mycid-' + Math.random().toString(36).substring(7),

diff --git a/examples/helpers/logMyIP.js b/examples/helpers/logMyIP.js
@@ -1,6 +1,6 @@
 #!/usr/bin/env -S yarn node
 
-const P = require('aigle')
+const P = require('@rhino.fi/aigle')
 
 const request = require('./request')
 

diff --git a/examples/helpers/waitForDepositCreditedOnChain.js b/examples/helpers/waitForDepositCreditedOnChain.js
@@ -1,4 +1,4 @@
-const P = require('aigle')
+const P = require('@rhino.fi/aigle')
 
 module.exports = async (rhinofi, deposit) => {
   console.log('waiting for deposit to be credited on chain...')

diff --git a/examples/src/ammWithdrawal.js b/examples/src/ammWithdrawal.js
@@ -25,7 +25,7 @@ const ammDeposit = await rhinofi.postAmmFundingOrders(
   ammDepositOrderData
 )
 
-const P = require('aigle')
+const P = require('@rhino.fi/aigle')
 
 await P.retry(
   { times: 360, interval: 1000 },

diff --git a/examples/src/cancelOrder.js b/examples/src/cancelOrder.js
@@ -1,4 +1,4 @@
-const P = require('aigle')
+const P = require('@rhino.fi/aigle')
 let order
 const orders = await rhinofi.getOrders()
 

diff --git a/examples/src/fastWithdrawalFee.js b/examples/src/fastWithdrawalFee.js
@@ -1,3 +1,4 @@
+// NOTE: fastWithdrawalFee method as been deprecated
 const response = await rhinofi.fastWithdrawalFee('ETH')
 
 logExampleResult(response)
diff --git a/examples/src/generateL1RegistrationPayload.js b/examples/src/generateL1RegistrationPayload.js
@@ -0,0 +1,18 @@
+const { starkKeyHex, ethAddress } = await rhinofi.getUserConfig()
+
+const l1RegistrationSignature = await rhinofi.stark.signRegistration(
+  ethAddress
+)
+
+const callData = await rhinofi.stark.l1RegistrationCallData(
+  starkKeyHex,
+  ethAddress,
+  l1RegistrationSignature
+)
+
+logExampleResult({
+  ethAddress,
+  starkKeyHex,
+  sig: l1RegistrationSignature,
+  callData
+})
diff --git a/nix/netrc-create.sh b/nix/netrc-create.sh
@@ -1,10 +1,12 @@
 #!/usr/bin/env bash
 set -ueo pipefail
 
-github_token=''${GITHUB_TOKEN-}
+github_token=${GITHUB_TOKEN-}
 
 if [[ -z $github_token ]]; then
-  read -s github_token
+  while read -r github_token; do
+    break
+  done
 fi
 
 github_user=${1:-dvf-ci}

diff --git a/nix/sources.json b/nix/sources.json
@@ -29,10 +29,10 @@
         "homepage": "",
         "owner": "rhinofi",
         "repo": "rhino-core",
-        "rev": "c2183a731421203e076c7dba37d339fa15e70b1d",
-        "sha256": "0ygx4q7pna7qr8d8wx42ynk7ygz3cpz8zjd7hz1nz3wx39d4ps9h",
+        "rev": "8424a851d2bd6913bbf111859e2aeda2a8924c7a",
+        "sha256": "1zvk99gfa5lfzvkyzjxlpp05abfvvyixzwhhshr3nc5gjq8yiiwb",
         "type": "tarball",
-        "url": "https://github.com/rhinofi/rhino-core/archive/c2183a731421203e076c7dba37d339fa15e70b1d.tar.gz",
+        "url": "https://github.com/rhinofi/rhino-core/archive/8424a851d2bd6913bbf111859e2aeda2a8924c7a.tar.gz",
         "url_template": "https://github.com/<owner>/<repo>/archive/<rev>.tar.gz"
     },
     "yarn-berry-cjs-rhinofi": {

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@rhino.fi/client-js",
-  "version": "5.1.1",
+  "version": "5.4.0",
   "main": "src/index.js",
   "files": [
     "src",
@@ -10,7 +10,8 @@
   "scripts": {
     "test": "env-cmd -f ./env/test jest --testTimeout 10000",
     "test:watch": "env-cmd -f ./env/test jest --watch --testTimeout 10000 --verbose true",
-    "test:coverage": "env-cmd -f ./env/test jest --testTimeout 10000 --coverage"
+    "test:coverage": "env-cmd -f ./env/test jest --testTimeout 10000 --coverage",
+    "link-rhino-portal": "rm -rf ../rhino-portal/node_modules/@rhino.fi/client-js && rm -rf ../rhino-portal/node_modules/.cache && cp -r . ../rhino-portal/node_modules/@rhino.fi/client-js"
   },
   "jest": {
     "coverageReporters": [
@@ -27,18 +28,17 @@
   "homepage": "https://github.com/rhinofi/client-js",
   "license": "MIT",
   "dependencies": {
-    "@ledgerhq/hw-app-eth": "6.23.0",
-    "@ledgerhq/hw-transport-webhid": "6.20.0",
+    "@ledgerhq/hw-app-eth": "6.28.1",
+    "@ledgerhq/hw-transport-webhid": "6.27.1",
+    "@rhino.fi/aigle": "^1.15.0-alpha.3",
     "@rhino.fi/dvf-utils": "^1.4.5",
     "@rhino.fi/starkware-crypto": "^0.1.7",
-    "aigle": "suguru03/aigle#8739846ba9d4cfc116e1546da1181c73564cae0b",
     "aware": "^0.3.1",
     "bignumber.js": "^9.0.0",
     "eip-712": "1.0.0",
     "lodash": "^4.17.20",
     "ramda": "^0.27.1",
     "request": "^2.88.2",
-    "request-promise": "^4.2.6",
     "web3": "^1.7.5",
     "web3-utils": "^1.3.0"
   },
@@ -47,6 +47,7 @@
     "@truffle/hdwallet-provider": "^2.0.13",
     "env-cmd": "^10.1.0",
     "jest": "^26.4.2",
+    "jest-environment-jsdom": "25",
     "mustache": "^4.0.0",
     "nock": "^13.0.4",
     "solc": "^0.4.24"

diff --git a/src/api/bridgedDeposit.js b/src/api/bridgedDeposit.js
@@ -28,7 +28,7 @@ const validateArg0 = validateWithJoi(schema)('INVALID_METHOD_ARGUMENT')({
 const endpoint = '/v1/trading/bridgedDeposits'
 const validationEndpoint = '/v1/trading/deposits-validate'
 
-module.exports = async (dvf, data, nonce, signature, txHashCb) => {
+module.exports = async (dvf, data, nonce, signature, txHashCb, onlyOnChain) => {
   const { chain, token, amount, web3Options, permitParams, referralId } = validateArg0(data)
 
   const tokenInfo = dvf.token.getTokenInfoOrThrow(token)
@@ -37,7 +37,7 @@ module.exports = async (dvf, data, nonce, signature, txHashCb) => {
 
   // Base units should be using the execution chain
   const tokenChainInfo = dvf.token.getTokenInfoForChainOrThrow(token, chain)
-  const baseUnitAmount = toBN(amount).shiftedBy(tokenChainInfo.decimals).toString()
+  const baseUnitAmount = dvf.token.toBaseUnitAmount(token, amount, tokenChainInfo)
 
   // Force the use of header (instead of payload) for authentication.
   dvf = FP.set('config.useAuthHeader', true, dvf)
@@ -73,6 +73,11 @@ module.exports = async (dvf, data, nonce, signature, txHashCb) => {
 
   const { transactionHash, clearCallback } = await transactionHashPromise
 
+  if (onlyOnChain) {
+    await onChainDepositPromise
+    return { transactionHash }
+  }
+
   const payload = {
     chain,
     token,
@@ -82,17 +87,10 @@ module.exports = async (dvf, data, nonce, signature, txHashCb) => {
   }
   const httpDeposit = await post(dvf, endpoint, nonce, signature, payload)
 
-  const onChainDeposit = await onChainDepositPromise
+  await onChainDepositPromise
   if (typeof clearCallback === 'function') {
     clearCallback()
   }
 
-  if (!onChainDeposit.status) {
-    throw new DVFError('ERR_ONCHAIN_BRIDGED_DEPOSIT', {
-      httpDeposit,
-      onChainDeposit
-    })
-  }
-
   return { ...httpDeposit, transactionHash }
 }