Bitgreen Browser Wallet

Bitgreen Browser extension and android, iOS hybrid apps with wallet functionalities.

The Bitgreen Browser Wallet is a browser extension, android and iOS app that allows users to create wallets, send and receive funds, and make disbursements to the Bitgreen ecosystem in order to create, sell, purchase and retire Verified Carbon Credits (VCUs). To incorporate this functionality into your own project, please see the technical description below. If you require any assistance using these features, or this repo, please contact us, we are happy to assist.

Features:

• New Account creation with 24 secret words (also defined secret seed).
• Stores the secret words in an encrypted structure in the permanent storage of the browser.
• 1 layer encryption by AES256-OFB with a first key of 256 bit.
• 1 layer encryption by AES256-CRT with a different key of 256 bit.
• 1 layer encryption by AES256-OFB with a different key of 256 bit.
• Total key length is 768 bit derived from the password by thousands of nested hashes of Sha512, Blake2 and Kekkak.
• Derives the encryption password by random init vector and 900,000 recurring hashing with sha2,kekkak and blake2 algorithms.
• Shows current balance from the blockchain.
• Transfer Funds by signing the transaction.
• Shows account address to receive funds.
• Import of an existing secret seed
• Creation of additional Accounts
• Programmatically calls to any pallet with signed transactions
• Stakes/Unstakes funds
• Authentication by signing a random token

---

Quickstart

• npm run setup installs all npm packages and initializes app platforms
• npm run dev:{target} builds development build and runs watchdog for the desired target (chrome, firefox, safari, android, ios)

---

Browser Compatibility

The wallet extension is available for the following browsers:

• Chrome
• Firefox
• Safari (Desktop and Mobile version)
• Edge (compatible with Chrome Extension)
• Brave (compatible with Chrome Extension)
• Other Browsers based on chromium Engine

---

OS Compatability

The wallet app is available on the following operating systems:

• android
• iOS

---

Project Structure

• packages/browser-wallet-base - Extension base structure, including capacitorjs project and webpack configs.
• packages/browser-wallet-core - Main features mostly used for background tasks, stores, API messaging.
• packages/browser-wallet-ui - The UI components for the extension.
• packages/browser-wallet-utils - Helpers and utilities for both UI and background.

---

Developing & Building

Install node.js >18.12.
Install the required dependencies and initialize the capacitorjs project from the root for this repo, by running the following command:

npm run setup

More detailed information to the build process can be found here

Versioning

Please see browser-wallet-base README for detailed information

Production Build

You can build all production versions of extensions and apps, and output will be located at /build directory, where each sub folder represents each browser extension type or app platform:

npm run build:all

You can also specify which version to build. There is 3 possible versions of this extension/app: chrome, firefox, safari, android and ios.

npm run build:{target}

---

Development

Also, you can use the npm run dev:{target} to start the local development of the extension/app. Please keep in mind that in this case, you need to specify browser type or app platform. Webpack will be running with watch flag set to true and inline-sourcemaps for all JS and SCSS files. Output directory is the same (read above).

---

Wallet Docs

Check out set of examples.

Wallet automatically injects into a webpage when installed within the browser. All Supported functions are listed below.

---

Authenticate wallet account by signing a message

// No params
signIn()

Check how to setup your own authentication server.

Example successful response:

{
  "success": true,
  "data": {
    "message": "1672235549170#https://bitgreen.org",
    "signature": "0x0261c1a49ce818269acedc695b1fa71366aaa99d2e1615a0201aa532a7bc7a2d3af75df98bb3daf8973f9c8999c9dce4fb826e0974ef777e6743fdb721a53085",
    "address": "5GqFxK56NW4gTsuLC6xhHVSLp5xURYuQJHoJA6NGVy259fSJ"
  }
}

Example unsuccessful response:

{
  "success": false,
  "status": "closed", // possible values: failed || denied || closed
  "error": "Communication to the popup has been lost."
}

---

Transfer funds to another address

// amount: number = amount to send, in human-readable format
// recipient: substrateAddress = address of a recipient
// kill_popup: boolean = should popup be closed in case origin tab was closed 
send(amount = 0, recipient = false, kill_popup = true)

Example successful response:

{
  "success": true,
  "data": {
    // block hash at which this transaction was recorded
    "block_hash": "0x8b1703831c17a3950764f585197a6f8454fa7cf08f1da4ad4ceea34766ac5d9d"
  }
}

Example unsuccessful response:

{
  "success": false,
  "status": "failed", // possible values: failed || denied || closed
  "error": "Error message."
}

---

Submit a transaction to the blockchain (extrinsic)

// pallet: string = name of the pallet
// call: string = function to execute on this pallet
// call_parameters: array = parameters for this call
// kill_popup: boolean = should popup be closed in case origin tab was closed
extrinsic(pallet, call, call_parameters, kill_popup = true)

Example successful response:

{
  "success": true,
  "data": {
    // block hash at which this transaction was recorded
    "block_hash": "0x8b1703831c17a3950764f585197a6f8454fa7cf08f1da4ad4ceea34766ac5d9d"
  }
}

Example unsuccessful response:

{
  "success": false,
  "status": "failed", // possible values: failed || denied || closed
  "error": "Error message."
}

---

Query any pallet/contract in the blockchain

// same params as for extrinsic(), without kill_popup
query(pallet, call, call_parameters)

Example successful response:

{
  "success": true,
  "data": {
    // data will vary depending on the pallet call
  }
}

Example unsuccessful response:

{
  "success": false,
  "error": "Error message."
}

---

Check if the wallet is installed

After window object load, you can check if the wallet injection code is there. That way we can know if the user has the extension installed or not.

window.addEventListener('load', async() => {
    // undefined if wallet extension is not installed
    const bitgreen_wallet = window.injectedWeb3?.['bitgreen-wallet-js']
});