Ocean tracker

[Jouzo]

On-going Implementation PR #2724

Summary

• Add axum REST server
• Add ocean API routers
• Ocean models
• Ocean server init
• RocksDB structures to index @nagarajm22 Ocean API: rocks db implementation for ocean API #2728
• CI test suite @canonbrother WIP: Ocean test suite CI #2734
• Pagination support @canonbrother Ocean list pagination + json req/res  #2737
• ocean-archive node flag @Jouzo fb1b832
• Block indexing @canonbrother Ocean: block indexing #2777
• Additional index for verbose poolswap information
• Handle secondary indexes for iteration
• Set ocean API port in params
• Genesis block @canonbrother

WIP

• API typing @canonbrother
• Process block and index TXs as required - Started in 3e11241
• Controllers logic
• Proxy cached endpoints to existing JSON-RPC endpoints
  • Add caching layer. Handled by cached crate
  • Handled via https://github.com/Jouzo/rust-defichain-rpc

TODO

• API Versioning
• Network handling

[Jouzo]

Block indexing @canonbrother

[canonbrother]

Test suites checklist

Checked point @ 31 fails <-- regression if > 31 fails

address.controller.defid.ts

listAccountHistory ⚠️ (perhaps deprecated)

• should not listAccountHistory with mine filter
• should list empty account history
• should list account history without rewards
• should listAccountHistory
• should listAccountHistory with size
• test listAccountHistory pagination

getAccountHistory

• should getAccount
• should be failed for non-existence data
• should be failed as invalid height
• should be failed as getting unsupport tx type - sent, received, blockReward

getBalance

• getBalance should be zero
• should getBalance non zero with bech32 address
• should getBalance non zero with legacy address
• should getBalance non zero with p2sh-segwit address
• should sum getBalance

getAggregation

• should aggregate 3 txn
• should throw error if getAggregation with invalid address

listTransactions

• (addressA) should listTransactions
• (addressA) should listTransactions with pagination
• should throw error if listTransactions with invalid address
• (addressB) should listTransactions
• (addressA) should listTransactions with undefined next pagination

listTransactionsUnspent

• (addressA) should listTransactionsUnspent
• (addressA) should listTransactionsUnspent with pagination ⚠️ rounding
• (addressB) should listTransactionsUnspent
• should listTransactionsUnspent with undefined next pagination

listTokens

• should listTokens
• should listTokens with pagination
• should listTokens with undefined next pagination
• should return empty and page undefined while listTokens with invalid address

oracles.defid.ts

list/get

• should list
• should get oracle a TA-USD feed
• should get oracle a TB-USD feed
• should get oracle b TB-USD feed ⚠️ decimal
• should get oracles by owner address

prices.defid.ts

list/get

• should list
• should get ticker
• should get feeds
• should get oracles

loan.collateral.controller.defid.ts

list

• should listCollateralTokens ⚠️ undefined
• should listCollateralTokens with pagination
• should listCollateralTokens with an empty object if size 100 next 300 which is out of range

get

• should get collateral token by symbol ⚠️ undefined
• should throw error while getting non-existent collateral token id ⚠️ errmsg

loan.token.controller.defid.ts

list

• should listLoanTokens ⚠️ undefined
• should listLoanTokens with pagination
• should listLoanTokens with an empty object if size 100 next 300 which is out of range

get

• should get loan token by symbol ⚠️ undefined
• should throw error while getting non-existent loan token id ⚠️ errmsg

loan.auction.controller.defied.ts

list

• should listAuctions
• should listAuctions with pagination
• should listAuctions witn an empty object if out of range

transaction.controller.defid.ts

get

• should get a single transaction ed0267f
• should fail due to non-existent transaction ⚠️ errmsg

getVins

• should return list of vin
• should return empty page if txid is not valid
  ○ skipped should return list of vin when next is out of range

getVouts

• should return list of vout (3 ms)
• should return empty page if txid is not valid
  ○ skipped should return list of vout when next is out of range

poolpair.fees.service.defid.ts

get best path - DEX burn fees

• should return fees - CAT to DFI - Both token fees direction are in
• should return fees - DFI to CAT - Both token fees direction are in
• should return fees - DFI to DOG - Both token fees direction is out
• should return fees - DOG to DFI - Both token fees direction is out
• should return fees - KOALA to DFI - TokenA fee direction is in
• should return fees - DFI to KOALA - TokenA fee direction is in
• should return fees - FISH to DFI - TokenB fee direction is out
• should return fees - DFI to FISH - TokenB fee direction is out
• should return fees (bidirectional) - DFI <-> TURTLE - TokenA fee direction is both
• should return fees (bidirectional) - DFI <-> PANDA - TokenA fee direction is both
• should return fees (bidirectional) - DFI <-> RABBIT - Both token fees direction are both
• should return fees (bidirectional) - DFI <-> FOX - if tokenA fee direction is not set
• should return fees (bidirectional) - DFI <-> LION - if tokenB fee direction is not set
• should return fees (bidirectional) - DFI <-> TIGER - if both token fees direction are not set
• should return [] if dex fees is not set

get best path - DEX estimated return

• should less dex fees in estimatedReturnLessDexFees - 1 leg ⚠️ [rounding] Expected: "14.01557143" Received: "14.01557142"
• should less dex fees in estimatedReturnLessDexFees - 2 legs ⚠️ [rounding] Expected: "1.39875403" Received: "1.39875402"
• should not less dex fees if dex fees is not set

poolpair.swap.controller.defid.ts

poolswap buy-sell indicator

• should get pool swap details
• should get composite pool swap for 2 jumps
• should get composite pool swap for 2 jumps scenario 2
• should get composite pool swap for 3 jumps
• should get direct pool swap for composite swap

poolpair.defid.ts

poolswap aggregated

• should show aggregated swaps for 24h and 30d

masternode.controller.defid.ts

list

• should list masternodes
• should list masternodes with pagination

get

• should get a masternode with id
• should due to non-existent masternode ⚠️ errmsg

resign

• should get masternode with pre-resigned state ⚠️ rpcerror

timelock

• should get masternode with timelock

poolpair.swap.verbose.controller.defid.ts

poolswap buy-sell indicator

• should get pool swap details
• should get composite pool swap for 2 jumps
• should get composite pool swap for 2 jumps scenario 2
• should get composite pool swap for 3 jumps
• should get direct pool swap for composite swap

loan.vault.controller.defid.ts

loan

• should listVaults with size only

get

• should get vault by vaultId ⚠️ vault state capital letter
• should throw error while getting non-existent vault ⚠️ errmsg

rawtx.controller.defid.ts

test

• should accept valid txn (18 ms)
• should accept valid txn with given maxFeeRate
• should throw BadRequestError due to invalid txn ⚠️
• should throw BadRequestError due to high fees ⚠️

send

• should send valid txn and validate tx out
• should send valid txn with given maxFeeRate and validate tx out
• should throw BadRequestException due to invalid txn
• should throw BadRequestException due to high fees

get

• should accept valid txn and return hex
• should throw NotFoundException due to tx id not found

poolpair.controller.defid.ts

list

• should list ⚠️ undefined and decimal places
• should list with pagination
• should list with undefined next pagination

get

• should get (5 ms) ⚠️ undefined and decimal places
• should throw error while getting non-existent poolpair ⚠️

get best path

• should be bidirectional swap path - listPaths(a, b) === listPaths(b, a)
• should get best swap path - 2 legs
• should get correct swap path - 3 legs
• should ignore correct swap path > 3 legs
• should return direct path even if composite swap paths has greater return
• should deduct commission fee - 1 leg
• should deduct commission and dex fees - 2 legs
• should have no swap path - isolated token H
• should throw error for invalid tokenId ⚠️ errmsg

get all paths

• should be bidirectional swap path - listPaths(a, b) === listPaths(b, a)
• should get correct swap path - 2 legs
• should get correct swap path - 3 legs
• should ignore correct swap paths > 3 legs
• should get multiple swap paths
• should handle cyclic swap paths
• should have no swap path - isolated token H
• should throw error when fromToken === toToken
• should throw error for invalid tokenId ⚠️ errmsg

get list swappable tokens

• should list correct swappable tokens
• should not show status:false tokens
• should list no tokens for token that is not swappable with any
• should throw error for invalid / non-existent tokenId ⚠️ (received ParseIntError error, expect NotFound)

latest dex prices

• should get latest dex prices - denomination: DFI
• should get latest dex prices - denomination: USDT
• should get consistent, mathematically sound dex prices - USDT and DFI
• should get consistent, mathematically sound dex prices - A and B
• should list DAT tokens only - O (non-DAT token) is not included in result ⚠️
• should list DAT tokens only - status:false tokens are excluded ⚠️

param validation - denomination

• should throw error for invalid denomination

governance.controller.defid.ts

governance - listProposals and getProposal

• should listProposals ⚠️ undefined
• should listProposals with size
• should listProposals with status
• should listProposals with type
• should listProposals with cycle
• should listProposals with status and type
• should listProposals with status, type and cycle
• should listProposals with pagination
• should listProposals with all record when limit is 0
• should listProposals with all record when all flag is true
• should listProposals with status and pagination
• should listProposals with type and pagination
• should listProposals with status, type and pagination
• should getProposal for CFP
• should getProposal for VOC ⚠️ undefined

governance - listProposalVotes

• should listProposalVotes
• should listProposalVotes with cycle
• should listProposalVotes with all records when limit is 0
• should listProposalVotes with all records when all flag is true
• should listProposalVotes with all masternodes
• should listProposalVotes with all masternodes and cycle
• should listProposalVotes with all masternodes, cycle and pagination

token.controller.defid.ts

list

• should listTokens ⚠️ undefined
• should listTokens with pagination
• should listTokens with an empty object if size 100 next 300 which is out of range

get

• should get DFI by DFI numeric id ⚠️ undefined
• should get DBTC-DETH by DBTC-DETH numeric id
• should throw error while getting non-existent token ⚠️ errmsg

fee.controller.defid.ts

fee/estimate

• should have fee of 0.00005 and not 0.00005 after adding activity

stats.controller.defid.ts

• should getRewardDistribution

loan.scheme.controller.defid.ts

loan

• should listLoanSchemes
• should listSchemes with pagination
• should listSchemes with an empty object if size 100 next 300 which is out of range

get

• should get scheme by symbol (1 ms)
• should throw error while getting non-existent scheme

block.controller.defid.ts

get

• should get block based on hash
• get should get block with height
• should get undefined with invalid hash

list

• should return paginated list of blocks
• should return all the blocks if the size is out of range
• list would return the latest set if next is outside of range
• list would return the latest set if next is 0

getTransactions

• should get transactions from a block by hash
• getTransactions should not get transactions by height
• getTransactions should get empty array when hash is not valid
• getTransactions should get empty array when height is not valid
• should list transactions in the right order

parseHeight

• should return undefined for negative integer
• should return undefined for float
• should return number for positive integers
• should return undefined for empty string
• should return undefined for undefined
• should return undefined for strings with characters