Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

popm/wasm: add new @hemilabs/pop-miner NPM package #162

Merged
merged 11 commits into from
Jul 2, 2024

Conversation

joshuasing
Copy link
Contributor

@joshuasing joshuasing commented Jun 28, 2024

Summary
Add @hemilabs/pop-miner package, a TypeScript API for the WebAssembly PoP Miner.

Changes

  • Add initial @hemilabs/pop-miner package (web/packages/pop-miner) and supporting files
  • Add GitHub Actions workflow to build and lint NPM packages
  • Update release workflow to publish NPM packages

This is the initial version of this package, more functionality will be added in future pull requests.
This contains more than +9K line changes, however the majority of this is from the PNPM lock files and can be ignored.

@joshuasing joshuasing added type: enhancement This improves existing functionality size: XL This change is very large (+/- <1000) area: ci This is a change to CI files. Excluded from changelog area: make This changes a Makefile area: @hemilabs/pop-miner This is a change to the @hemilabs/pop-miner NPM package labels Jun 28, 2024
@joshuasing joshuasing self-assigned this Jun 28, 2024
marcopeereboom
marcopeereboom previously approved these changes Jul 1, 2024
@marcopeereboom marcopeereboom dismissed their stale review July 1, 2024 08:23

accidentally clicked approve

@joshuasing joshuasing marked this pull request as ready for review July 1, 2024 12:10
@joshuasing joshuasing requested a review from a team as a code owner July 1, 2024 12:10
Copy link
Contributor

@jcvernaleo jcvernaleo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All looks reasonable to me.

OK

Copy link

@ArturDolzan ArturDolzan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We discussed a couple of things on slack, like how the front-end would provide the scriptHash to call the bitcoin balance or utxos functions, or when the user input a bitcoin private key only, how the front-end would know all the other info that is provided by generating a new key, or how the front-end will render the transactions list table, where the user will see the latests blocks and its status.

These are topics for future PR's, so LGTM.

.github/workflows/node.yml Outdated Show resolved Hide resolved
Copy link
Contributor

@gndelia gndelia left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM - I just left a couple of minor suggestions / improvements 😄

.github/workflows/node.yml Outdated Show resolved Hide resolved
@joshuasing joshuasing requested a review from gndelia July 2, 2024 15:59
@joshuasing joshuasing merged commit 8922ce8 into main Jul 2, 2024
5 checks passed
@joshuasing joshuasing deleted the joshua/popminer-package branch July 2, 2024 18:16
@joshuasing joshuasing added type: feature This adds new functionality and removed area: ci This is a change to CI files. Excluded from changelog labels Jul 10, 2024
web3cryptoguy pushed a commit to web3cryptoguy/heminetwork that referenced this pull request Nov 1, 2024
Add the initial implementation of the `@hemilabs/pop-miner` NPM package,
a TypeScript API layer for the WebAssembly PoP Miner.

Also adds supporting files, GitHub Actions workflow changes to build and
publish the NPM package.

This is the initial version of this package, more functionality will be
added in future pull requests.

Reviewed-on: hemilabs#162
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: @hemilabs/pop-miner This is a change to the @hemilabs/pop-miner NPM package area: make This changes a Makefile size: XL This change is very large (+/- <1000) type: enhancement This improves existing functionality type: feature This adds new functionality
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants