feat(jellyfish-api-core): listVaultHistory RPC #834

jingyi2811 · 2021-11-17T10:24:00Z

What kind of PR is this?:
/kind feature

What this PR does / why we need it:
Add getVaultHistory rpc

Which issue(s) does this PR fixes?:
Fixes part of #488

Additional comments?:

codeclimate · 2021-11-17T10:24:24Z

Code Climate has analyzed commit efa469e and detected 0 issues on this pull request.

View more on Code Climate.

codecov · 2021-11-18T13:55:15Z

Codecov Report

Merging #834 (efa469e) into main (2ba2c7f) will decrease coverage by 2.59%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##             main     #834      +/-   ##
==========================================
- Coverage   95.74%   93.14%   -2.60%     
==========================================
  Files         140      140              
  Lines        4485     4493       +8     
  Branches      586      587       +1     
==========================================
- Hits         4294     4185     -109     
- Misses        191      306     +115     
- Partials        0        2       +2

Impacted Files	Coverage Δ
packages/jellyfish-api-core/src/category/loan.ts	`94.20% <100.00%> (-5.80%)`	⬇️
...s/src/containers/RegTestContainer/LoanContainer.ts	`100.00% <100.00%> (ø)`
packages/jellyfish-wallet/src/wallet.ts	`20.00% <0.00%> (-80.00%)`	⬇️
packages/jellyfish-testing/src/rawtx.ts	`15.00% <0.00%> (-77.50%)`	⬇️
packages/jellyfish-address/src/p2wsh.ts	`48.27% <0.00%> (-51.73%)`	⬇️
...nsaction-builder/src/txn/txn_builder_masternode.ts	`60.00% <0.00%> (-40.00%)`	⬇️
packages/jellyfish-address/src/script/P2WSH.ts	`72.72% <0.00%> (-27.28%)`	⬇️
...nsaction-builder/src/txn/txn_builder_governance.ts	`66.66% <0.00%> (-23.81%)`	⬇️
...action-builder/src/txn/txn_builder_icxorderbook.ts	`71.42% <0.00%> (-21.43%)`	⬇️
packages/jellyfish-testing/src/poolpair.ts	`80.95% <0.00%> (-19.05%)`	⬇️
... and 17 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 2ba2c7f...efa469e. Read the comment docs.

packages/jellyfish-api-core/__tests__/category/loan/getVaultHistory.test.ts

…tory

netlify · 2021-11-24T10:55:02Z

✔️ Deploy Preview for jellyfish-defi ready!

🔨 Explore the source changes: efa469e

🔍 Inspect the deploy log: https://app.netlify.com/sites/jellyfish-defi/deploys/619e8c92d7c7010008f724ed

😎 Browse the preview: https://deploy-preview-834--jellyfish-defi.netlify.app

jingyi2811 · 2021-11-24T18:58:48Z

packages/testcontainers/src/containers/RegTestContainer/LoanContainer.ts

 import { MasterNodeRegTestContainer } from './Masternode'

 /**
 * @deprecated use MasterNodeRegTestContainer instead
 */
 export class LoanMasterNodeRegTestContainer extends MasterNodeRegTestContainer {
+  constructor (masternodeKey: MasterNodeKey = RegTestFoundationKeys[0]) {
+    super(masternodeKey, 'defi/defichain:HEAD-b810eda')


This PR is merged to master a few hours ago. However, when I connect to MasterNodeRegTestContainer directly, funny error returned.

jingyi2811 · 2021-11-24T19:01:49Z

packages/jellyfish-api-core/src/category/loan.ts

+   * @param {number} [pagination.maxBlockHeight] Maximum block height
+   * @param {number} [pagination.depth] Maximum Depth, from the genesis block is the default
+   * @param {string} [pagination.token] Token
+   * @param {string} [pagination.txtype] Tx type


txtype should be txType. We may need to inform C++ side to change this

jingyi2811 · 2021-11-24T19:04:49Z

docs/node/CATEGORIES/16-loan.md

+}
+
+interface CreateLoanScheme {
+  minColRatio: number


C++ side return this as ratio. Need to tell them to use minColRatio like how other RPC does

jingyi2811 · 2021-11-24T19:05:10Z

docs/node/CATEGORIES/16-loan.md

+
+interface CreateLoanScheme {
+  minColRatio: number
+  interestRate: BigNumber


C++ side return this as rate. Need to tell them to use interestRate like how other RPC does

interestRate currently is a whole number. Need to tell C++ side to change to the number with 8 decimal places.

jingyi2811 · 2021-11-24T19:07:38Z

packages/jellyfish-api-core/__tests__/category/loan/listVaultHistory.test.ts

+import { GenesisKeys, LoanMasterNodeRegTestContainer } from '@defichain/testcontainers'
+import { ListVaultHistory } from '../../../src/category/loan'
+
+describe('Loan listVaultHistory', () => {


We should add all the possible scenarios for loan to this PR

jingyi2811 · 2021-11-24T19:09:28Z

packages/jellyfish-api-core/__tests__/category/loan/listVaultHistory.test.ts

+      expect(vaultHistory[9].blockHeight).toStrictEqual(auctionBidBlockHeight1)
+      expect(vaultHistory[9].amounts).toStrictEqual(['-5000.00000000@AAPL'])
+
+      if (vaultHistory[10].address === bobColAddr) {


2 entries are made if a bid outbid by another bid.
However the order is inconsistent.
Need to tell this to C++ side.

jingyi2811 · 2021-11-24T19:10:53Z

packages/jellyfish-api-core/__tests__/category/loan/listVaultHistory.test.ts

+
+    it('should listAuctionHistory with depth only', async () => {
+      {
+        const vaultHistory = await alice.rpc.loan.listVaultHistory(createVaultTxId, { depth: 1 })


If pass in depth = 2, the RPC returns 1 record too.
I am not sure why.

surangap

@kresovic-milos I see a lot of comments from @jingyi2811 about inconsistencies in this RPC. Could you test these, and based on your results compile a list? Then we can share with cpp side.

codeclimate · 2022-06-02T07:46:53Z

Code Climate has analyzed commit efa469e and detected 0 issues on this pull request.

View more on Code Climate.

Add vault history RPC

a66dd24

defichain-bot assigned jingyi2811 Nov 17, 2021

defichain-bot added area/jellyfish-api-core kind/feature New feature request labels Nov 17, 2021

Improve vault history RPC

40b2133

Improve code

9e7900a

jingyi2811 commented Nov 18, 2021

View reviewed changes

packages/jellyfish-api-core/__tests__/category/loan/getVaultHistory.test.ts Outdated Show resolved Hide resolved

jingyi2811 changed the title ~~Add getVaultHistory RPC~~ Add listVaultHistory RPC Nov 18, 2021

jingyi2811 added 7 commits November 22, 2021 17:33

Quick push, switch branch

3b16923

Add more test assertion

d151fbb

Add more test assertion

24a7e93

Quick push, switch branch

e6bd4b3

Add filter by vaultId and JS Doc

0500f4b

Merge remote-tracking branch 'origin/main' into jimmy/rpc-getVaultHis…

b520ba7

…tory

Improve code

33518ef

jingyi2811 added 2 commits November 25, 2021 02:52

Stable code

e59789b

Stable code

0981a63

jingyi2811 marked this pull request as ready for review November 24, 2021 18:54

jingyi2811 requested review from canonbrother, fuxingloh, ivan-zynesis, Jouzo and surangap as code owners November 24, 2021 18:54

Minor

a089beb

jingyi2811 commented Nov 24, 2021

View reviewed changes

jingyi2811 added 2 commits November 25, 2021 03:03

Minor

a53d9f8

Minor

efa469e

jingyi2811 commented Nov 24, 2021

View reviewed changes

surangap requested a review from kresovic-milos December 3, 2021 07:42

surangap reviewed Dec 8, 2021

View reviewed changes

github-actions bot removed area/testcontainers labels Dec 16, 2021

fuxingloh changed the title ~~Add listVaultHistory RPC~~ feat(jellyfish-api-core): listVaultHistory RPC Dec 22, 2021

defichain-bot added the area/packages label Dec 22, 2021

fuxingloh marked this pull request as draft December 30, 2021 06:58

jingyi2811 closed this Apr 6, 2022

jingyi2811 deleted the jimmy/rpc-getVaultHistory branch April 6, 2022 02:37

canonbrother pushed a commit that referenced this pull request Jun 1, 2022

Bump @defichain/jellyfish dependencies (#834)

f1df282

jingyi2811 restored the jimmy/rpc-getVaultHistory branch June 2, 2022 07:46

jingyi2811 reopened this Jun 2, 2022

This was referenced Jun 2, 2022

DeFiCh/ain:2.x.x Loan RPCs implementation #488

Closed

feat(jellyfish-api-core): add token split testing #1475

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(jellyfish-api-core): listVaultHistory RPC #834

feat(jellyfish-api-core): listVaultHistory RPC #834

jingyi2811 commented Nov 17, 2021

codeclimate bot commented Nov 17, 2021 •

edited

Loading

codecov bot commented Nov 18, 2021 •

edited

Loading

netlify bot commented Nov 24, 2021 •

edited

Loading

jingyi2811 Nov 24, 2021 •

edited

Loading

jingyi2811 Nov 24, 2021

jingyi2811 Nov 24, 2021 •

edited

Loading

jingyi2811 Nov 24, 2021 •

edited

Loading

jingyi2811 Nov 24, 2021 •

edited

Loading

jingyi2811 Nov 24, 2021 •

edited

Loading

jingyi2811 Nov 24, 2021 •

edited

Loading

jingyi2811 Nov 24, 2021

surangap left a comment

codeclimate bot commented Jun 2, 2022

feat(jellyfish-api-core): listVaultHistory RPC #834

Are you sure you want to change the base?

feat(jellyfish-api-core): listVaultHistory RPC #834

Conversation

jingyi2811 commented Nov 17, 2021

codeclimate bot commented Nov 17, 2021 • edited Loading

codecov bot commented Nov 18, 2021 • edited Loading

Codecov Report

netlify bot commented Nov 24, 2021 • edited Loading

jingyi2811 Nov 24, 2021 • edited Loading

Choose a reason for hiding this comment

jingyi2811 Nov 24, 2021

Choose a reason for hiding this comment

jingyi2811 Nov 24, 2021 • edited Loading

Choose a reason for hiding this comment

jingyi2811 Nov 24, 2021 • edited Loading

Choose a reason for hiding this comment

jingyi2811 Nov 24, 2021 • edited Loading

Choose a reason for hiding this comment

jingyi2811 Nov 24, 2021 • edited Loading

Choose a reason for hiding this comment

jingyi2811 Nov 24, 2021 • edited Loading

Choose a reason for hiding this comment

jingyi2811 Nov 24, 2021

Choose a reason for hiding this comment

surangap left a comment

Choose a reason for hiding this comment

codeclimate bot commented Jun 2, 2022

codeclimate bot commented Nov 17, 2021 •

edited

Loading

codecov bot commented Nov 18, 2021 •

edited

Loading

netlify bot commented Nov 24, 2021 •

edited

Loading

jingyi2811 Nov 24, 2021 •

edited

Loading

jingyi2811 Nov 24, 2021 •

edited

Loading

jingyi2811 Nov 24, 2021 •

edited

Loading

jingyi2811 Nov 24, 2021 •

edited

Loading

jingyi2811 Nov 24, 2021 •

edited

Loading

jingyi2811 Nov 24, 2021 •

edited

Loading