1.0.0 • Published 10 months ago

bitgesell-lite-wallet v1.0.0

Weekly downloads
-
License
MIT
Repository
github
Last release
10 months ago

Bitgesell Lite Wallet

A light weight Bitgesell Wallet. For a comprehensive Bitgesell Wallet, please visit Official Wallet

Installation

npm install bitgesell-litewallet

Usage

1. Setup

Ensure you have a .env file with your seed phrase:

SEED_PHRASE="your seed phrase here"

2. Create a New Wallet

import { Wallet } from 'bitgesell-litewallet'
import * as dotenv from 'dotenv'

dotenv.config()

const wallet = new Wallet({
  from: {
    index: 0,
    seedPhrase: process.env.SEED_PHRASE
  }
})

// or privateKey
const wallet = new Wallet({
  privateKey: process.env.PRIVATE_KEY
})

const liteWallet = await wallet.createWallet()

console.log(liteWallet)

3. Get Account Address

const address = await wallet.getAddress()

console.log(address)

4. Get Account Balance

const balance = await wallet.getBalance()

console.log(balance)

5. Send BGL to a Recipient

const transaction = {
  value: 1, // 1 BGL
  to: 'bgl1qh3tsz3a7l3m49xaq4xcdx8aefthchuqagmspcn'
}

const txReceipt = await wallet.sendTransaction(transaction)

console.log(txReceipt)

6. Get Account Transaction History

const txHistory = await wallet.getAccountTransactionHistory()

console.log(txHistory)

7. Sign a Transaction

const transaction = {
  value: 0.1,
  to: 'bgl1qh3tsz3a7l3m49xaq4xcdx8aefthchuqagmspcn'
}

const txHex = await wallet.signTransaction(transaction)

console.log(txHex)

Running Tests

To run the test suite:

npm test

Contributions are welcome!

License

MIT