[tracking branch] Next Release

.github/workflows/cla.yaml

@@ -0,0 +1,52 @@
+# This workflow automates the process of signing our CLA. It makes use of
+# the action at https://github.com/contributor-assistant/github-action in
+# order to provide automations.
+#
+# This workflow file should be present in every repository that wants to
+# use the Contributor License Agreement automation process. Ideally, it
+# would remain more-or-less synchronized across each repository as updates
+# are rolled out.
+#
+# Since the database of signatories is maintained in a remote repository,
+# each repository that wishes to make use of the CLA Assistant will also
+# need to have a repository secret (named `CLA_ASSISTANT_LITE_PAT`) that
+# grants permission to write to the "signatures" file in that repository.
+---
+name: "CLA Assistant"
+on:
+  issue_comment:
+    types:
+      - created
+  pull_request_target:
+    types:
+      - opened
+      - closed
+      - synchronize
+
+# Explicitly configure permissions, in case the GITHUB_TOKEN workflow permissions
+# are set to read-only in the repository's settings.
+permissions:
+  actions: write
+  contents: read # We only need to `read` since signatures are in a remote repo.
+  pull-requests: write
+  statuses: write
+
+jobs:
+  CLAAssistant:
+    runs-on: ubuntu-latest
+    steps:
+      - name: "CLA Assistant"
+        if: (github.event.comment.body == 'recheck' || github.event.comment.body == 'I have read the CLA Document and I hereby sign the CLA') || github.event_name == 'pull_request_target'
+        uses: entropyxyz/contributor-assistant-github-action@c5f4628ffe1edb97724edb64e0dd4795394d33e5 # exemptRepoOrgMembers
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          # Required, so that the bot in this repository has `write` permissions to Contents of remote repo.
+          PERSONAL_ACCESS_TOKEN: ${{ secrets.CLA_ASSISTANT_LITE_PAT }}
+        with:
+          path-to-signatures: 'legal/cla/v1/signatures.json'
+          path-to-document: 'https://github.com/entropyxyz/.github/blob/main/legal/cla/v1/cla.md'
+          branch: 'main'
+          allowlist: dependabot[bot]
+          exemptRepoOrgMembers: true
+          remote-organization-name: entropyxyz
+          remote-repository-name: .github

.github/workflows/test.yaml

@@ -28,6 +28,6 @@ jobs:
         run: yarn run build
       - name: Add TSS server host mappings
         run: |
-          echo "127.0.0.1 alice-tss-server bob-tss-server" | sudo tee -a /etc/hosts
+          echo "127.0.0.1 alice-tss-server bob-tss-server charlie-tss-server dave-tss-server" | sudo tee -a /etc/hosts
       - name: Test
         run: yarn run test

CHANGELOG.md

@@ -10,24 +10,126 @@ The format extends [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 Version header format: `[version] Name - year-month-day (entropy-core compatibility: version [range])`
 
+## [0.0.4] Carnage - 2024-10-23 (entropy-core compatibility: 0.3.0)
+
+### Added
+
+- programmatic CLI commands
+  - new: `entropy account create`
+  - new: `entropy account import`
+  - new: `entropy account list`
+  - new: `entropy account register`
+  - new: `entropy program deploy`
+  - new: option to display cli and core version
+
+- TUI
+  - new: added faucet to main menu for TUI
+  - updated faucet to use loading spinner to indicate to user the progress of the transfer
+  - new: menu item to trigger a jumpstart to the network (needs to be run once for fresh test networks)
+
+- documentation
+  - updated: `./README.md`
+  - new: `./src/README.md` - an guide to the source of the project
+  - new: `./src/_template/*` - an example "domain" with lots of notes
+
+- tests
+  - new: `./tests/account.test.ts` - tests for `./src/account/`
+  - updated: `./tests/balance.test.ts` - tests for `./src/balance/`
+  - new: `./tests/common.test.ts` - tests for `./src/common/`
+  - updated: `./tests/config.test.ts` - tests for `./src/config/`
+  - new: `./tests/e2e.cli.sh` - a shell script which is an early test for programmatic usage
+
+  - new: `./tests/faucet.test.ts` - tests `./src/faucet/`
+  - new: `./tests/global.test.ts` - 
+  - new: `./tests/program.test.ts` - tests for `./src/program/`
+
+- programs
+  - new: `./tests/programs/faucet_program.wasm` - the faucet program!
+
+- packages
+  - new: `yocto-spinner` for adding loading spinners to the cli
+  - some minor package updates
+
+- github actions
+  - new: CLA action
+
+### Changed
+
+- updated SDK version to v0.3.0 (entropy-core 0.3.0)
+  - updated us to use `four-nodes` docker setup
+- logger to handle nested contexts for better organization of logs
+- update: `./src/common/utils.ts` - removed isValidSubstrateAddress and imported the method in from the sdk
+- file restructure:
+  - removed: `src/flows/*`
+  - added
+    - `./src/common/entropy-base.ts` - base abstract class for all our domains `main.js` files
+    - `./src/_template` - docs explaining the new file structure pattern
+    - `./src/account` - new file structure for our CLI/TUI flows
+      - NOTE: this contains register flow
+    - `./src/balance` - new file structure for our CLI/TUI flows
+    - `./src/faucet` - new file structure for our CLI/TUI flows
+    - `./src/program` - new file structure for our CLI/TUI flows
+      - NOTE: this merges user-program + dev-program domains into a single domain
+    - `./src/sign` - new file structure for our CLI/TUI flows
+    - `./src/transfer` - new file structure for our CLI/TUI flows
+- folder name for user programs to match the kebab-case style for folder namespace
+- ascii art print out now shows up to date core version based, coming from SDK
+
+### Broke
+
+- network now uses `four-nodes` docker setup
+  - requires an update to `/etc/hosts` for local testing, should include line:
+    ```
+    127.0.0.1 alice-tss-server bob-tss-server charlie-tss-server dave-tss-server
+    ```
+- for programmatic CLI
+  - change account listing:
+    - old: `entropy list`
+    - new: `entropy account list [options]`
+  - changed transfer:
+    - old: `entropy transfer [options] <source> <destination> <amount>`
+    - new: `entropy transfer [options] <destination> <amount>`
+  - changed env: `ENDPOINT` => `ENTROPY_ENDPOINT`
+
+- for TUI
+  - "endpoint" configuration has changed
+    - see `entropy --help`
+      - change flag: `--endpoint` => `--tui-endpiont`
+      - change env: `ENTROPY_ENDPOINT` => `ENTROPY_TUI_ENDPOINT`
+    - This is because of [collisions we were seeing](https://github.com/entropyxyz/cli/issues/265) with `commander` flags.
+    - Does not effect programmatic CLI usage
+    - We may revert this in a future release.
+  - deploying programs now requires
+    - `*.wasm` file for `bytecode`
+    - `*.json` file path for `configurationSchema`
+    - `*.json` file path for `auxillaryDataSchema`
+
 ## [0.0.3] Blade - 2024-07-17 (entropy-core compatibility: 0.2.0)
 
 ### Fixed
+
 - HOT-FIX programmatic balance error [183](https://github.com/entropyxyz/cli/pull/183)
 
 ## [0.0.2] AntMan - 2024-07-12 (entropy-core compatibility: 0.2.0)
 
 ### Added
-- new: './src/flows/balance/balance.ts' - service file separated out of main flow containing the pure functions to perform balance requests for one or multiple addresses
-- new: './tests/balance.test.ts' - new unit tests file for balance pure functions
-- new: './src/common/logger.ts' - utility file consisting of the logger used throughout the entropy cli
-- new: './src/common/masking.ts' - utility helper file for EntropyLogger, used to mask private data in the payload (message) of the logging method
+
+- new: `./src/flows/balance/balance.ts` - service file separated out of main flow containing the pure functions to perform balance requests for one or multiple addresses
+- new: `./tests/balance.test.ts` - new unit tests file for balance pure functions
+- new: `./src/common/logger.ts` - utility file consisting of the logger used throughout the entropy cli
+- new: `./src/common/masking.ts` - utility helper file for EntropyLogger, used to mask private data in the payload (message) of the logging method
+
 ### Fixed
+
 - keyring retrieval method was incorrectly returning the default keyring when no keyring was found, which is not the intended flow
+
 ### Changed
+
 - conditional when initializing entropy object to only error if no seed AND admin account is not found in the account data, new unit test caught bug with using OR condition
+
 ### Broke
 
 ### Meta/Dev
+
 - new: `./dev/README.md`
 - `./.github`: their is now a check list you should fill out for creating a PR