Skip to main content

Usage

Fulmine provides both a web UI and an API to interact with:

  1. Web UI - Available at http://localhost:7001 by default
  2. REST API - Available at http://localhost:7001/api
  3. gRPC Service - Available at localhost:7000

Using the API​

Wallet Service​

Generate Seed​

curl -X GET http://localhost:7001/api/v1/wallet/genseed

Create Wallet​

curl -X POST http://localhost:7001/api/v1/wallet/create \
     -H "Content-Type: application/json" \
     -d '{"private_key": "<hex or nsec>", "password": "<strong password>", "server_url": "https://server.example.com"}'

Password must:

  • Be 8 chars or longer
  • Have at least one number
  • Have at least one special char

Private key supported formats:

  • 64 chars hexadecimal
  • Nostr nsec (NIP-19)

Unlock Wallet​

curl -X POST http://localhost:7001/api/v1/wallet/unlock \
     -H "Content-Type: application/json" \
     -d '{"password": "<strong password>"}'

Lock Wallet​

curl -X POST http://localhost:7001/api/v1/wallet/lock \
     -H "Content-Type: application/json" \
     -d '{"password": "<strong password>"}'

Get Wallet Status​

curl -X GET http://localhost:7001/api/v1/wallet/status

Service API​

Get Address​

curl -X GET http://localhost:7001/api/v1/address

Get Balance​

curl -X GET http://localhost:7001/api/v1/balance

Send Funds Offchain​

curl -X POST http://localhost:7001/api/v1/send/offchain \
     -H "Content-Type: application/json" \
     -d '{"address": "<ark address>", "amount": <in sats>}'

Send Funds Onchain​

curl -X POST http://localhost:7001/api/v1/send/onchain \
     -H "Content-Type: application/json" \
     -d '{"address": "<bitcoin address>", "amount": <in sats>}'

Settle Transactions​

curl -X GET http://localhost:7001/api/v1/settle

Get Transaction History​

curl -X GET http://localhost:7001/api/v1/transactions

Refund VHTLC Without Receiver​

curl -X POST http://localhost:7001/api/v1/vhtlc/refundWithoutReceiver \
     -H "Content-Type: application/json" \
     -d '{"preimage_hash": "<hex preimage hash>"}'
  • Replace <hex preimage hash> with the actual preimage hash for the VHTLC you wish to refund.
  • Returns: { "redeem_txid": "<txid>" } on success.