Caravan Health Package #112

Harshil-Jani · 2024-07-03T17:33:44Z

TODO :

Discuss if we really want a standalone app or can we integrate it into the existing coordinator.
Complete all the bitcoind or block explorer client related configurations. (I would need to use lots of caravan-bitcoin functionalities)
Finalize the frontend design
Take a decision of showing Z-Score.
Writing a blog and linking it at top of the package so people don't get confused on math.

Signed-off-by: Harshil-Jani <harshiljani2002@gmail.com>

changeset-bot · 2024-07-03T17:33:47Z

🦋 Changeset detected

Latest commit: b07b5a4

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 2 packages

Name	Type
@caravan/bitcoin	Minor
@caravan/clients	Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

vercel · 2024-07-03T17:33:47Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
caravan-coordinator	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Aug 30, 2024 7:59pm

bucko13 · 2024-07-03T19:13:50Z

Finalize the frontend design

Let's separate this work from the frontend work. I think formalizing the "backend" functions can be merged in without having the UI fully formalized.

Complete all the bitcoind or block explorer client related configurations. (I would need to use lots of caravan-bitcoin functionalities)

Take a look at the @caravan/clients package. The older client stuff is deprecated (we should probably add a notice for that...), and clients has more up to date functionality as well as some interfaces to generalize operations a bit more.

Signed-off-by: Harshil-Jani <harshiljani2002@gmail.com>

bucko13

Looking good! left some comments and questions. Biggest thing though is that I'd like better typescript support before anything is merged.

packages/caravan-health/src/privacy.ts

packages/caravan-health/src/feescore.ts

packages/caravan-health/src/privacy.ts

Signed-off-by: Harshil-Jani <harshiljani2002@gmail.com>

…inability Signed-off-by: Harshil-Jani <harshiljani2002@gmail.com>

Signed-off-by: Harshil-Jani <harshiljani2002@gmail.com>

bucko13 · 2024-07-19T19:58:16Z

packages/caravan-clients/src/client.ts

@@ -172,6 +194,24 @@ export class BlockchainClient extends ClientBase {
    }
  }

+  public async getAddressTransactions(address: string): Promise<any> {


can this be typed? ideally use the unified client to standardize the return type

packages/caravan-health/src/privacy.ts

Signed-off-by: Harshil-Jani <harshiljani2002@gmail.com>

Co-authored-by: buck <buck.perley@protonmail.com>

Signed-off-by: Harshil-Jani <harshiljani2002@gmail.com>

packages/caravan-health/src/waste.ts

Signed-off-by: Harshil-Jani <harshiljani2002@gmail.com>

bucko13 · 2024-08-29T16:19:38Z

packages/caravan-health/src/privacy.ts

+      - Consolidation (more than 1 input, 1 output)
+      - CoinJoin or Mixing (more than 1 input, more than 1 output)
+  */
+  getTopologyScore(transaction: Transaction): number {


This could also be used in the preview transaction view right?

Yes, We can give some degree that how it will behave privacy wise if this previewed transaction is actually made.

packages/caravan-health/src/privacy.ts

bucko13

Couple final nits.

packages/caravan-health/src/utility.ts

packages/caravan-health/src/waste.ts

Signed-off-by: Harshil-Jani <harshiljani2002@gmail.com>

Co-authored-by: buck <buck.perley@protonmail.com>

Signed-off-by: Harshil-Jani <harshiljani2002@gmail.com>

bucko13

This looks good to me!

Initializing Caravan Health and adding privacy score

3ac2703

Signed-off-by: Harshil-Jani <harshiljani2002@gmail.com>

vercel bot deployed to Preview July 3, 2024 17:37 View deployment

Harshil-Jani added 4 commits July 8, 2024 22:18

Utilize client methods from @caravan/client

822cf54

Signed-off-by: Harshil-Jani <harshiljani2002@gmail.com>

Added fees score method to @caravan/health

e3989b9

Signed-off-by: Harshil-Jani <harshiljani2002@gmail.com>

Export all privacy methods

7737e3e

Signed-off-by: Harshil-Jani <harshiljani2002@gmail.com>

Add some context on the fee score functions

7421376

Signed-off-by: Harshil-Jani <harshiljani2002@gmail.com>

vercel bot deployed to Preview July 8, 2024 19:46 View deployment

bucko13 requested changes Jul 12, 2024

View reviewed changes

Harshil-Jani added 4 commits July 14, 2024 13:13

Rename to camelCase and fix wordings

c3f167e

Signed-off-by: Harshil-Jani <harshiljani2002@gmail.com>

Setup prettier for @caravan/health and format

27cacf1

Signed-off-by: Harshil-Jani <harshiljani2002@gmail.com>

Refactor privacyScoreByTxTopology for improved readability and mainta…

29c2207

…inability Signed-off-by: Harshil-Jani <harshiljani2002@gmail.com>

Add types for Transaction and UTXO for privacy.ts

26dfd30

Signed-off-by: Harshil-Jani <harshiljani2002@gmail.com>

vercel bot deployed to Preview July 17, 2024 14:20 View deployment

Changing UTXO type to Wallet UTXO which brings addresses from memory

f1e6a38

Signed-off-by: Harshil-Jani <harshiljani2002@gmail.com>

vercel bot deployed to Preview July 17, 2024 16:12 View deployment

Fix UTXO set length comming wrong

7f7ed1d

Signed-off-by: Harshil-Jani <harshiljani2002@gmail.com>

vercel bot deployed to Preview July 17, 2024 21:00 View deployment

Adding Test Cases for Privacy

1f70cab

Signed-off-by: Harshil-Jani <harshiljani2002@gmail.com>

vercel bot deployed to Preview July 18, 2024 20:40 View deployment

bucko13 requested changes Jul 19, 2024

View reviewed changes

Harshil-Jani added 5 commits July 22, 2024 03:06

Type Improvements and code improvement

afe92ad

Signed-off-by: Harshil-Jani <harshiljani2002@gmail.com>

Better handling of exports and address functionality

0011b21

Signed-off-by: Harshil-Jani <harshiljani2002@gmail.com>

Rewrite test cases for privacy

270a035

Signed-off-by: Harshil-Jani <harshiljani2002@gmail.com>

Fix in privacy and it's test case

fc589e2

Signed-off-by: Harshil-Jani <harshiljani2002@gmail.com>

Completed with feescore test cases

afb69a4

Signed-off-by: Harshil-Jani <harshiljani2002@gmail.com>

vercel bot deployed to Preview July 22, 2024 13:12 View deployment

Improving Documentation

a4c6ed7

Signed-off-by: Harshil-Jani <harshiljani2002@gmail.com>

Update packages/caravan-health/src/waste.ts

ac249a9

Co-authored-by: buck <buck.perley@protonmail.com>

vercel bot deployed to Preview August 28, 2024 14:27 View deployment

SpendTypeScore just takes in Input and Output

10d68d7

Signed-off-by: Harshil-Jani <harshiljani2002@gmail.com>

vercel bot deployed to Preview August 28, 2024 14:37 View deployment

Adding nit for length of UTXO

bb06e48

Signed-off-by: Harshil-Jani <harshiljani2002@gmail.com>

vercel bot deployed to Preview August 28, 2024 14:44 View deployment

Harshil-Jani added 2 commits August 28, 2024 22:05

Remove unused map

d47823b

Signed-off-by: Harshil-Jani <harshiljani2002@gmail.com>

Dust calculations update

564a8ed

Signed-off-by: Harshil-Jani <harshiljani2002@gmail.com>

vercel bot deployed to Preview August 28, 2024 21:24 View deployment

bucko13 reviewed Aug 28, 2024

View reviewed changes

packages/caravan-health/src/waste.ts Outdated Show resolved Hide resolved

Update config variable names

2e22bf3

Signed-off-by: Harshil-Jani <harshiljani2002@gmail.com>

vercel bot deployed to Preview August 28, 2024 21:33 View deployment

Removed unncessary comments

3a2dee1

Signed-off-by: Harshil-Jani <harshiljani2002@gmail.com>

vercel bot deployed to Preview August 28, 2024 21:37 View deployment

bucko13 reviewed Aug 29, 2024

View reviewed changes

packages/caravan-health/src/privacy.ts Outdated Show resolved Hide resolved

bucko13 reviewed Aug 29, 2024

View reviewed changes

packages/caravan-health/src/utility.ts Outdated Show resolved Hide resolved

packages/caravan-health/src/waste.ts Outdated Show resolved Hide resolved

packages/caravan-health/src/waste.ts Show resolved Hide resolved

packages/caravan-health/src/waste.ts Show resolved Hide resolved

Update logic for spend type determination

afa3386

Signed-off-by: Harshil-Jani <harshiljani2002@gmail.com>

vercel bot deployed to Preview August 29, 2024 21:13 View deployment

Harshil-Jani and others added 3 commits August 30, 2024 02:53

Update packages/caravan-health/src/waste.ts

7fc3f81

Co-authored-by: buck <buck.perley@protonmail.com>

Update packages/caravan-health/src/waste.ts

5b7989d

Co-authored-by: buck <buck.perley@protonmail.com>

Update packages/caravan-health/src/privacy.ts

5eec580

Co-authored-by: buck <buck.perley@protonmail.com>

vercel bot deployed to Preview August 29, 2024 21:25 View deployment

utility.js -> spendType.js

eb43fa4

Signed-off-by: Harshil-Jani <harshiljani2002@gmail.com>

vercel bot deployed to Preview August 29, 2024 21:29 View deployment

Merge branch 'main' into caravan/health

b07b5a4

bucko13 approved these changes Aug 30, 2024

View reviewed changes

vercel bot deployed to Preview August 30, 2024 19:59 View deployment

bucko13 merged commit 7cf2bf4 into caravan-bitcoin:main Aug 30, 2024
3 checks passed

github-actions bot mentioned this pull request Aug 30, 2024

Version Packages #123

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Caravan Health Package #112

Caravan Health Package #112

Harshil-Jani commented Jul 3, 2024 •

edited

Loading

changeset-bot bot commented Jul 3, 2024 •

edited

Loading

vercel bot commented Jul 3, 2024 •

edited

Loading

bucko13 commented Jul 3, 2024

bucko13 left a comment

bucko13 Jul 19, 2024

bucko13 Aug 29, 2024

Harshil-Jani Aug 29, 2024

bucko13 left a comment

bucko13 left a comment

Caravan Health Package #112

Caravan Health Package #112

Conversation

Harshil-Jani commented Jul 3, 2024 • edited Loading

changeset-bot bot commented Jul 3, 2024 • edited Loading

🦋 Changeset detected

vercel bot commented Jul 3, 2024 • edited Loading

bucko13 commented Jul 3, 2024

bucko13 left a comment

Choose a reason for hiding this comment

bucko13 Jul 19, 2024

Choose a reason for hiding this comment

bucko13 Aug 29, 2024

Choose a reason for hiding this comment

Harshil-Jani Aug 29, 2024

Choose a reason for hiding this comment

bucko13 left a comment

Choose a reason for hiding this comment

bucko13 left a comment

Choose a reason for hiding this comment

Harshil-Jani commented Jul 3, 2024 •

edited

Loading

changeset-bot bot commented Jul 3, 2024 •

edited

Loading

vercel bot commented Jul 3, 2024 •

edited

Loading