Details

Reviewers

emack

Group Reviewers

Restricted Project

Commits

rABC60d43b6d8035: [token-server] Initialize a new app to manage rewards tokens

Summary

token-server will be used to

Validate eligibility for token rewards for Cashtab users
Send token rewards to Cashtab users (eligibility will be reset after a certain time. token rewards can only be claimed by hitting an endpoint exposed by this server from https://cashtab.com)
Potential future token issuance use cases, e.g. alias tokens as NFTs

Initialize with mocha, CI integration, eslint, and README.

Stub functionality -- app connects to ChronikClientNode websocket and exposes a status endpoint.

Test Plan

npm test

confirm CI with ./contrib/teamcity/build-configurations.py token-server-tests

node index.js and observe log

From my machine after waiting for a block:

chronik-client connected to websocket hosted by wss://chronik.pay2stay.com/xec/ws
Express server started on port 3333
/status from IP: ::1, host localhost:3333
{
  type: 'Block',
  msgType: 'BLK_CONNECTED',
  blockHash: '00000000000000001da2a9a5693b38c5a330e7e3703d0effab6c28b41aa050bb',
  blockHeight: 833731
}
{
  type: 'Block',
  msgType: 'BLK_FINALIZED',
  blockHash: '00000000000000001da2a9a5693b38c5a330e7e3703d0effab6c28b41aa050bb',
  blockHeight: 833731
}

navigate to http://localhost:3333/status and view {"status":"running"}

Confirm that ctrl+c will shut down the server

From my machine:
^Ctoken-server shut down by ctrl+c

Diff Detail

Repository

rABC Bitcoin ABC

Lint

Lint Not Applicable

Unit

Tests Not Applicable

Event Timeline

bytesofman created this revision.Feb 29 2024, 18:40

Herald added a reviewer: Restricted Project. · View Herald TranscriptFeb 29 2024, 18:40

Harbormaster completed remote builds in B27545: Diff 45771.Feb 29 2024, 18:40

bytesofman mentioned this in D15587: [mock-chronik-client] Add subscribeToBlocks and isSubscribedBlocks to match in-node chronik-client.Feb 29 2024, 18:43

add to CI

Harbormaster completed remote builds in B27549: Diff 45775.Feb 29 2024, 18:52

lint

Harbormaster completed remote builds in B27550: Diff 45776.Feb 29 2024, 18:53

update .gitignore

Harbormaster completed remote builds in B27551: Diff 45777.Feb 29 2024, 18:57

Add stub express functionality and tests

Harbormaster completed remote builds in B27552: Diff 45778.Feb 29 2024, 19:39

bytesofman edited the test plan for this revision. (Show Details)Feb 29 2024, 19:42

bytesofman edited the summary of this revision. (Show Details)Feb 29 2024, 19:44

better comments

Harbormaster completed remote builds in B27553: Diff 45779.Feb 29 2024, 19:47

bytesofman published this revision for review.Feb 29 2024, 19:54

bytesofman edited the test plan for this revision. (Show Details)

bytesofman added inline comments.

apps/mock-chronik-client/README.md
93 ↗	(On Diff #45779)	The mock-chronik-client changes are split out into D15587
contrib/teamcity/build-configurations.yml
732 ↗	(On Diff #45779)	this CI implementation is relevant to this diff The other ones are in their own diff at D15588

bytesofman edited the test plan for this revision. (Show Details)Feb 29 2024, 19:57

bytesofman added a child revision: D15599: [token-server] Add function to check eligibility for token reward.Mar 1 2024, 01:19

emack requested changes to this revision.Mar 1 2024, 12:17

emack added a subscriber: emack.

emack added inline comments.

apps/token-server/test/chronik/wsHandler.test.js
25 ↗	(On Diff #45779)	can you add two extra steps in this test, one to simulate exit via SIGTERM or SIGINT, and then verify `mockedChronik.wsWaitForOpenCalled` is back to the false state.

This revision now requires changes to proceed.Mar 1 2024, 12:17

bytesofman mentioned this in rABC318fc5e7ab92: [mock-chronik-client] Add subscribeToBlocks and isSubscribedBlocks to match in….Mar 1 2024, 13:15

bytesofman requested review of this revision.Mar 1 2024, 13:19

bytesofman marked an inline comment as done.

bytesofman added inline comments.

apps/token-server/test/chronik/wsHandler.test.js
25 ↗	(On Diff #45779)	one to simulate exit via SIGTERM or SIGINT This would not belong in the unit test. Would be an integration test as happens outside the scope of this function. I'm not sure if this is testable or not in the overall app, which is why I included a manual test plan for this. then verify mockedChronik.wsWaitForOpenCalled is back to the false state. `waitForOpen` has been called -- so we should not expect this to be false. `wsWaitForOpenCalled` is a bit of a bootleg `mocked-chronik-client` method. Potentially worth getting rid of it. It's only helping confirm that the dev did not make a typo while attempting to open the websocket. Then again, I added it because it took me awhile to debug forgetting to open the websocket after building it once, so can't say it's worthless.

bytesofman added a child revision: D15609: [token-server] Implement typescript.Mar 2 2024, 06:28

emack accepted this revision.Mar 2 2024, 07:52

This revision is now accepted and ready to land.Mar 2 2024, 07:52

rebase

Harbormaster completed remote builds in B27600: Diff 45848.Mar 2 2024, 13:42

lint

Harbormaster completed remote builds in B27601: Diff 45849.Mar 2 2024, 13:42

Closed by commit rABC60d43b6d8035: [token-server] Initialize a new app to manage rewards tokens (authored by bytesofman). · Explain WhyMar 2 2024, 13:48

This revision was automatically updated to reflect the committed changes.

bytesofman added a commit: rABC60d43b6d8035: [token-server] Initialize a new app to manage rewards tokens.

[token-server] Initialize a new app to manage rewards tokens
ClosedPublic
Actions

Details

Diff Detail

Event Timeline

Revision Contents
Changeset List

Diff 45850

apps/token-server/.eslintrc.js

apps/token-server/.gitignore

apps/token-server/.mocharc.js

apps/token-server/.nvmrc

apps/token-server/README.md

apps/token-server/config.js

apps/token-server/index.js

apps/token-server/package-lock.json

apps/token-server/package.json

apps/token-server/src/chronik/wsHandler.js

apps/token-server/src/routes.js

apps/token-server/test/chronik/wsHandler.test.js

apps/token-server/test/routes.test.js

contrib/teamcity/build-configurations.yml

[token-server] Initialize a new app to manage rewards tokensClosedPublicActions

Details

Diff Detail

Event Timeline

Revision ContentsChangeset List

Diff 45850

apps/token-server/.eslintrc.js

apps/token-server/.gitignore

apps/token-server/.mocharc.js

apps/token-server/.nvmrc

apps/token-server/README.md

apps/token-server/config.js

apps/token-server/index.js

apps/token-server/package-lock.json

apps/token-server/package.json

apps/token-server/src/chronik/wsHandler.js

apps/token-server/src/routes.js

apps/token-server/test/chronik/wsHandler.test.js

apps/token-server/test/routes.test.js

contrib/teamcity/build-configurations.yml

[token-server] Initialize a new app to manage rewards tokens
ClosedPublic
Actions

Revision Contents
Changeset List