Skip to content

Latest commit

 

History

History
128 lines (94 loc) · 4.33 KB

README.md

File metadata and controls

128 lines (94 loc) · 4.33 KB
Raw

Kaspa Wallet

A web wallet for the Kaspa blockchain network

Development

Setup

# Navigate to the app folder
cd app

# Install dependencies
npm install

# Run for development in PWA mode
npm run dev

# Build for production in PWA mode
npm run build

# Lint files
npm run lint

# Run unit tests with Jest
npm run test:unit

# Run e2e tests visually and interactively with Cypress
# For Cypress tests, make sure the app is running on port 8080 with `npm run dev`
npm run test:e2e

# Run e2e tests from the terminal with Cypress
npm run test:e2e:CI

Wallet Setup

The steps below are necessary to see your actual balance and transaction history from the local KDX instance on the web app.

  1. Log in to the web app and copy your receive address
  2. Open KDX, navigate to settings, make sure "Enable Mining" is checked, and in "Service Configuration" replace miningaddr with the address you copied
  3. Click "Apply" at the bottom
  4. Head to the console and run wallet balance <yourAddress> to check your balance. Once the Balance is non-zero (not the Pending Balance), go to the next step.
  5. Turn off mining in KDX and reload the web app. We turn off mining to ensure balances are constant which makes it easier to verify the app is displaying the correct data.
  6. After opening your wallet in the app, it may take a minute or two to fetch the data due to address discovery.
  7. Afterwards, the balance in the app should match the balance shown in KDX and your transactions will display.

Development considerations

Creating Components and Pages

Create a new component with quasar new component ComponentName and a new page with quasar new page ComponentName. By default, the component or page will not be configured for Typescript. After updating the name property, make the following changes to the default component content shown below:

<template>
  <div>My component</div>
</template>

- <script>
+ <script lang="ts">
+ import Vue from 'vue';

- export default {
+ export default Vue.extend({
  name: 'MyComponentName',
  data () {
    return {}
  }
- }
+ })
</script>

This change is necessary so Typescript can infer the component type when imported by other components or pages.

Git Hooks

Pre-commit and pre-push hooks are configured using Husky.

The pre-commit hook runs Prettier and ESLint on the code, and the pre-push hook will do the same but also run the configured e2e tests and unit tests. Hooks can be skipped by adding the --no-verify flag to the git command.

If you need to ignore a file or a section of a file, use the special comment format documented here.

To manually prettify a file without relying on the hooks, run npm run pretty.

Testing Considerations

End-to-end (e2e) tests are written with Cypress, and unit tests are written with Jest.

Cypress

To facilitate testing, add an attribute of the form data-cy="page-component-value" to any HTML elements that may need to be accessed during testing. This format is not rigid, and you can remove a section as needed. See the Best Practices page of the Cypress documentation for more information about the reasoning behind this approach. Some example implementations:

  • data-cy="home-header" to describe the header element on the home page (notice that the component aspect is not used here)
  • data-cy="newWallet-enterPassword-input1" to describe the first password input field during the wallet creation process

Jest

The @quasar/testing framework used for integrating Cypress and Jest enables the ability to place test code directly in Vue files, as explained here. This is not currently used, but will become useful when we need to test methods that live within Vue components.