https://github.com/rashadansari/wallet-core

An all-in-one cryptocurrency service that enables users to effortlessly generate HD wallets, access wallet information, retrieve transaction details, broadcast transactions, and offers various other cutting-edge features for seamless cryptocurrency management
https://github.com/rashadansari/wallet-core

all-in-one bitcoin blockchain crypto cryptocurrency ethereum javascript litecoin node-js typescript wallet wallet-core

Last synced: 8 months ago
JSON representation

An all-in-one cryptocurrency service that enables users to effortlessly generate HD wallets, access wallet information, retrieve transaction details, broadcast transactions, and offers various other cutting-edge features for seamless cryptocurrency management

• Host: GitHub
• URL: https://github.com/rashadansari/wallet-core
• Owner: RashadAnsari
• License: apache-2.0
• Created: 2023-07-08T12:39:09.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2023-07-20T12:13:36.000Z (about 2 years ago)
• Last Synced: 2025-01-05T05:41:56.564Z (9 months ago)
• Topics: all-in-one, bitcoin, blockchain, crypto, cryptocurrency, ethereum, javascript, litecoin, node-js, typescript, wallet, wallet-core
• Language: JavaScript
• Homepage:
• Size: 80.1 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Wallet Core

[![Build](https://github.com/RashadAnsari/wallet-core/actions/workflows/main.yml/badge.svg?branch=master)](https://github.com/RashadAnsari/wallet-core/actions/workflows/main.yml)

An all-in-one cryptocurrency service that enables users to effortlessly generate HD wallets, access wallet information, retrieve transaction details, broadcast transactions, and offers various other cutting-edge features for seamless cryptocurrency management.

## API Documentation

- [Swagger Documentation](./docs/swagger.yml)

## Environment Variables

The application relies on the following environment variables for configuration:

- `PORT`: The port number on which the application will listen. If not provided, the default value is set to `3000`.

- `MNEMONIC`: The mnemonic phrase used for generating cryptographic keys or addresses. This variable is required and must be provided.

- `PASSPHRASE`: An optional passphrase or password associated with the mnemonic phrase. If not provided, the default value is set to an empty string.

- `BLOCKCHAIR_API_KEY`: An optional secret key that you get from [Blockchair](https://blockchair.com/api/docs#link_M05) when you sign up for their API. This key is used to authenticate your requests to the Blockchair API. If not provided, you can only send 1440 requests per day.

Make sure to set these environment variables accordingly when running the application. You can either export them in your shell environment or provide them in a `.env` file in the root directory of your project.

## Run using Docker

To run the application using Docker, run the command below:

```bash

docker run -p 3000:3000 -e MNEMONIC="remember relief wool then dad equip team guard provide clever mom kiss" ghcr.io/rashadansari/wallet-core

```

## Supported Cryptocurrencies

- Bitcoin (BTC)

- Litecoin (LTC)

- Ethereum (ETH)

- Dogecoin (DOGE)

- Cardano (ADA)