feat(controller): anchors API service

[siradji]

Signed-off-by: Suraj Auwal [email protected]

What kind of PR is this?:

/kind feature

What this PR does / why we need it:

Expose anchors endpoint

Which issue(s) does this PR fixes?:

Fixes BirthdayResearch/jellyfishsdk#1488

Additional comments?:

[defichain-bot]

@siradji: There are no 'kind' label on this PR. You need a 'kind' label to generate the release automatically.

• /kind feature
• /kind fix
• /kind chore
• /kind docs
• /kind refactor
• /kind dependencies

Details

I am a bot created to help the DeFiCh developers manage community feedback and contributions. You can check out my manifest file to understand my behavior and what I can do. If you want to use this for your project, you can check out the DeFiCh/oss-governance-bot repository.

[codeclimate]

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

View more on Code Climate.

[codecov]

Codecov Report

Merging #719 (1ad54db) into main (6434ccd) will increase coverage by 0.05%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##             main     #719      +/-   ##
==========================================
+ Coverage   92.31%   92.37%   +0.05%     
==========================================
  Files         121      123       +2     
  Lines        3163     3187      +24     
  Branches      384      386       +2     
==========================================
+ Hits         2920     2944      +24     
  Misses        234      234              
  Partials        9        9              

Impacted Files	Coverage Δ
packages/whale-api-client/src/api/anchors.ts	100.00% <100.00%> (ø)
packages/whale-api-client/src/index.ts	100.00% <100.00%> (ø)
packages/whale-api-client/src/whale.api.client.ts	79.76% <100.00%> (+0.49%)	⬆️
src/module.api/_module.ts	100.00% <100.00%> (ø)
src/module.api/anchors.controller.ts	100.00% <100.00%> (ø)

---

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 6434ccd...1ad54db. Read the comment docs.

[siradji]

Adding on top of what @canonbrother mentioned here , using startBtcHeight for pagination won't work. Got it to work using limit and maxBtcHeight

[canonbrother]

minor impr

1. remove waitForSync() since the test only use 1 node
2. test create 2 anchors within a block which just

await createAnchor()
await createAnchor()
await generate(1) // 2 anchors in 1 block

why do we need this because the current query would not handle this data..

[siradji]

@canonbrother i am a little bit confused here. Could you provide more clarification?

[canonbrother]

just updated the fixture which contain 2 anchors within a btc block
the query is needed to handle this scenario

[fuxingloh]

@siradji please resolve the comments and fix the test

[canonbrother]

@siradji
we need solve the scenario on commit 0d81172

[siradji]

@siradji please resolve the comments and fix the test

@fuxingloh i will be fixing it today. Found out a new issue with the query.

[siradji]

Initially, i thought that using startBtcHeight will be ideal for pagination but due to how the anchors are listed (from top to genesis) that would be impossible. The only option left is to use maxBtcHeight which worked out fine till @canonbrother pointed out a scenario where there is more than one anchor in a block.