Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hans-wurst-21/iobroker.mempool-space
Connect mempool.space - Websocket API
https://github.com/hans-wurst-21/iobroker.mempool-space
bitcoin fixthemoneyfixtheworld homeautomation iobroker mempool
Last synced: 3 days ago
JSON representation
Connect mempool.space - Websocket API
- Host: GitHub
- URL: https://github.com/hans-wurst-21/iobroker.mempool-space
- Owner: Hans-Wurst-21
- License: mit
- Created: 2024-11-11T22:22:47.000Z (8 days ago)
- Default Branch: main
- Last Pushed: 2024-11-12T23:05:10.000Z (7 days ago)
- Last Synced: 2024-11-13T00:18:10.774Z (7 days ago)
- Topics: bitcoin, fixthemoneyfixtheworld, homeautomation, iobroker, mempool
- Language: JavaScript
- Homepage: https://mempool.space/
- Size: 414 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ioBroker.mempool-space
[](https://www.npmjs.com/package/iobroker.mempool-space)
[](https://www.npmjs.com/package/iobroker.mempool-space)
[](https://nodei.co/npm/iobroker.mempool-space/)
**Tests:** 
## The adapter is under development and can change daily! Not intended for productive use.
### Experience the Bitcoin network up close in your home!
Live data from mempool.space WebSocket API.
This adapter provides real-time Bitcoin network information using WebSocket connections to the mempool.space API. It offers a wide range of data points including block information, transaction fees, network statistics ans price conversions ()
## Live data websocket
**Important: The adapter or mempool.space will never ask for your seed!**
**⚠️ NEVER ⚠️**
**If you share your seed you will lose 100% of everything!**
### Features
1. **Real-time Data**: Utilizes WebSocket connections for live updates from the Bitcoin network.
2. **Price Conversions**:
- Bitcoin to USD and EUR conversion rates
- "Moscow Time" representation (Satoshis per USD/EUR)
3. **Transaction Fees**:
- Fastest, Half-Hour, Hour, Economy, and Minimum fee rates
4. **Block Information**:
- Latest block height, hash, and timestamp
- Time since last block
- Mining pool that mined the last block
5. **Network Statistics**:
- Average block time
- Current and previous difficulty adjustments
- Estimated time until next difficulty adjustment
- Estimated time until next halving
6. **Mempool Information**:
- Number of unconfirmed transactions
### Configuration
In the adapter settings, you can configure the following option:
- **WebSocket URL**:
The URL for the mempool.space WebSocket API
(default: `wss://mempool.space/api/v1/ws`)
- You can use a public or local mempool.space instance.
- For a local instance, refer to the documentation of your bitcoin node software.
No further configuration is required.
All states and connections are created automatically by the adapter.
### States
The adapter creates automatically the following channels and states:
- **conversion**
- usd: Bitcoin to USD conversion rate
- eur: Bitcoin to EUR conversion rate
- moscowtimeUSD: Moscow-Time USD
- moscowtimeEUR: Moscow-Time EUR
- timestamp: Timestamp of the last conversion update
- **fees**
- fastest: Fastest transaction fee rate
- halfHour: Fee rate for confirmation within half an hour
- hour: Fee rate for confirmation within an hour
- economy: Economy fee rate
- minimum: Minimum fee rate
- **block**
- height: Height of the latest block
- hash: Hash of the latest block
- timestamp: Timestamp of the latest block
- miningPool: Name of the pool that mined the last block
- timeSinceLastBlock: Time elapsed since the last block
- **network**
- averageBlockTime: Average Blocktime
- difficultyChange: Current difficulty adjustment (in percent)
- previousDifficultyChange: Previous difficulty adjustment (in percent)
- nextDifficultyAdjustment: Estimated timestamp of the next difficulty adjustment
- remainingTimeToDifficulty: Remaining time until the next difficulty adjustment
- remainingTimeToHalving: Remaining time until the next halving
- **mempool**
- transactionCount: Number of unconfirmed transactions in the mempool
- **info**
- connectionn: Indicates if the WebSocket connection is active
## Library
- API-Documentation: https://mempool.space/docs/api/websocket
- npm-Module: https://www.npmjs.com/package/@mempool/mempool.js
- luxon-Module: https://github.com/moment/luxon
## Changelog
### 0.0.1
- (Hans-Wurst-21) initial release
## To-do
- [ ] Complete translation
- [ ] Clean up code
- [ ] Add examples
- [ ] Query of user-defined addresses
- [ ] Query of user-defined transactions
- [ ] Maybe telegram-bot
## Special Thanks
A special thanks to https://einundzwanzig.space
and https://www.youtube.com/@haus_automation
## License
MIT License
Copyright (c) 2024 Hans-Wurst-21
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.