https://github.com/lmacken/binance-chain-python
Binance chain SDK in Python
https://github.com/lmacken/binance-chain-python
aiohttp asyncio binance binancechain blockchain bnb crypto dex python trading wallet
Last synced: about 1 year ago
JSON representation
Binance chain SDK in Python
- Host: GitHub
- URL: https://github.com/lmacken/binance-chain-python
- Owner: lmacken
- License: mit
- Created: 2019-04-15T15:50:50.000Z (about 7 years ago)
- Default Branch: develop
- Last Pushed: 2019-05-01T06:00:35.000Z (about 7 years ago)
- Last Synced: 2025-03-15T05:47:11.205Z (over 1 year ago)
- Topics: aiohttp, asyncio, binance, binancechain, blockchain, bnb, crypto, dex, python, trading, wallet
- Language: Python
- Size: 210 KB
- Stars: 24
- Watchers: 7
- Forks: 6
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# binance-chain-python
[](https://travis-ci.org/lmacken/binance-chain-python)
[](https://coveralls.io/github/lmacken/binance-chain-python)
An unofficial asyncio Python API for the Binance Chain.
## Installation
pip install binancechain
## Implementation Details
- [Extensive test suite](https://github.com/lmacken/binance-chain-python/tree/master/test)
- Optional rate limiter with the `HTTPClient(rate_limit=True)`, which uses a token-bucket style queue for each endpoint.
- [aiohttp](https://aiohttp.readthedocs.io) for all HTTP requests, which automatically performs connection-pooling
- [SPDX license identifiers](https://spdx.org/)
- Python [type hints](https://docs.python.org/3/library/typing.html) for ease of development
- Python3.6+ f-strings for faster string interpolation
- Exception-chaining with [`raise from`](https://docs.python.org/3/library/exceptions.html#built-in-exceptions)
- Clean and consistent syntax formatting with [Black](https://github.com/ambv/black)
- Example [CLI tool](https://github.com/lmacken/binance-chain-python/blob/master/examples/cli.py) that just outputs raw JSON responses
- Event-driven WebSocket using [pyee](https://github.com/jfhbrook/pyee)
- Automatically sends `keepAlive` WebSocket messages every 30 minutes
- Utilizes [orjson](https://github.com/ijl/orjson), the fastest JSON library in Python.
### Utilizes popular crypto libraries
- [bitcoinlib](https://github.com/1200wd/bitcoinlib)
- [bech32](https://github.com/sipa/bech32)
- [secp256k1](https://github.com/ludbb/secp256k1-py)
- [eth_keyfile](https://github.com/ethereum/eth-keyfile)
## API SECTIONS
- [WEBSOCKET](https://github.com/lmacken/binance-chain-python#websocket)
- [REST API](https://github.com/lmacken/binance-chain-python#rest-api)
- [NODE RPC](https://github.com/lmacken/binance-chain-python#node-rpc)
- [WALLET](https://github.com/lmacken/binance-chain-python#binance-chain-wallet)
- [TRANSACTION](https://github.com/lmacken/binance-chain-python#binance-chain-transaction)
### NAMESPACE
```python
from binancechain import HTTPClient, NodeRPC, WebSocket, Wallet, Transaction, BinanceChainException
```
------------------
## WEBSOCKET
### Decorator API
```python
dex = WebSocket(address, testnet=True)
@dex.on("open")
async def on_open(): …
@dex.on("allTickers", symbols=["$all"])
async def on_ticker(msg): …
@dex.on("kline_1m", symbols=["000-0E1_BNB"])
async def on_kline(kline): …
@dex.on("orders")
async def user_orders(msg): …
@dex.on("accounts")
async def user_accounts(msg): …
@dex.on("transfers")
async def user_transfers(msg): …
@dex.on("error")
async def on_error(msg): …
dex.start() # or dex.start_async() coroutine
```
### Callback API
```python
dex = WebSocket(address, testnet=True)
def on_open():
dex.subscribe_user_orders(callback=user_orders)
dex.subscribe_user_accounts(callback=user_accounts)
dex.subscribe_user_transfers(callback=user_transfers)
dex.subscribe_trades(callback=callback, symbols=symbols)
dex.subscribe_market_depth(callback=callback, symbols=symbols)
dex.subscribe_market_diff(callback=callback, symbols=symbols)
dex.subscribe_klines(callback=callback, symbols=symbols)
dex.subscribe_ticker(callback=callback, symbols=symbols)
dex.subscribe_all_tickers(callback=callback)
dex.subscribe_mini_ticker(callback=callback, symbols=symbols)
dex.subscribe_all_mini_tickers(callback=callback)
dex.subscribe_blockheight(callback=callback)
dex.start(on_open, on_error)
```
See the WebSocket [examples](https://github.com/lmacken/binance-chain-python/tree/master/examples) for more information.
----------------
## REST API
### Query information
```python
client = HTTPClient(testnet=True)
server_time = await client.get_time()
node_info = await client.get_node_info()
validators = await client.get_validators()
peers = await client.get_peers()
account_info = await client.get_account_info(address)
sequence_info = await client.get_account_sequence(address)
transaction = await client.get_transaction(hash)
token_list = await client.get_token_list()
markets = await client.get_markets(limit=500, offset=0)
fees = await client.get_fees()
depth = await client.get_depth(symbol, limit=100)
klines = await client.get_klines(symbol, interval, limit=300, start=None, end=None)
closed_orders = await client.get_closed_orders(
address,
end=None,
limit=None,
offset=None,
side=None,
start=None,
status=None,
symbol=None,
total=None,
)
open_orders = await client.get_open_orders(
self, address, limit=None, offset=None, symbol=None, total=None
)
order = await client.get_order(id)
ticker = await client.get_ticker(symbol)
trades = await client.get_trades(
address=None,
buyerOrderId=None,
height=None,
limit=None,
offset=None,
quoteAsset=None,
sellerOrderId=None,
side=None,
start=None,
end=None,
total=None,
symbol=None,
)
block_fee = await client.block_exchange_fee(
address=None, end=None, limit=None, offset=None, start=None, total=None
)
transactions = await client.get_transactions(
address,
height=None,
end=None,
limit=None,
offset=None,
side=None,
start=None,
tx_asset=None,
tx_type=None,
)
```
### Broadcast transaction
```python
broadcast_info = await client.broadcast(hash)
```
------------------
## NODE RPC
### Query Information
```python
noderpc = binancechain.NodeRPC(testnet=True)
abic_info = await noderpc.get_abci_info(path, data=None, height="0", prove=False)
concensus_state = await noderpc.get_consensus_state()
dump_concensus_state = await noderpc.get_dump_consensus_state()
genesis = await noderpc.get_genesis()
health = await noderpc.get_health()
net_info = await noderpc.get_net_info()
status = await noderpc.get_status()
query = await noderpc.abci_query("/param/fees")
block = await noderpc.block(height=None)
block_hash = await noderpc.block_by_hash(hash)
block_results = await noderpc.block_results(height=None) # ABCIResults
blockchain = await noderpc.blockchain(min_height, max_height)
concensus_params = await noderpc.consensus_params("1")
validators = await noderpc.validators(height=None)
transaction = await noderpc.tx(txid, prove=False)
tx_search = await noderpc.tx_search(query, prove=False, page=1, per_page=30)
pending_transactions = await noderpc.unconfirmed_txs(limit=None)
pendings_number = await noderpc.get_num_unconfirmed_txs()
```
### NodeRPC WebSocket
```python
query = "tm.event = 'Tx'"
def on_open():
noderpc.subscribe(query)
def on_msg(msg): …
noderpc.start(on_open=on_open, on_msg=on_msg, on_error=on_error)
noderpc.unsubscribe(query=query)
noderpc.unsubscribe_all()
```
See list of all possible events here
https://godoc.org/github.com/tendermint/tendermint/types#pkg-constants
For complete query syntax, check out https://godoc.org/github.com/tendermint/tendermint/libs/pubsub/query.
### Broadcast transaction
```python
tx_hash = await noderpc.broadcast_tx_async(hash)
tx_onchain = await noderpc.broadcast_tx_sync(hash)
tx_confirmed = await noderpc.commit(height=None)
```
-------------------
## BINANCE CHAIN WALLET
### Create or recover wallet and keystore
```python
wallet = Wallet.create_wallet(password=None, testnet=False)
wallet = Wallet.create_wallet_mnemonic(language="english", password=None, testnet=False)
keystore = Wallet.create_keystore(password=None)
wallet = Wallet(key="HDKEY object", testnet=False)
wallet = Wallet.wallet_from_keystore(keystore=keystore, password=None, testnet=False)
wallet = Wallet.wallet_from_mnemonic(words="mnemonic words", password=None, testnet=False)
wallet = Wallet.wallet_from_privatekey(privatekey="private_key", password=None, testnet=False)
```
### Using the wallet
```python
address = wallet.get_adress()
priv = wallet.get_privatekey()
pub = wallet.get_publickey()
pub, signature = wallet.sign(msg)
is_valid = wallet.verify_signature(msg, signature)
```
-------------------
## BINANCE CHAIN TRANSACTION
### Using Transaction with wallet and client, handle signing and broadcast internally
```python
from binancechain.enums import Ordertype, Side, Timeinforce, Votes
#if client is passed in , testnet arg will be ignored
transaction = Transaction(wallet=wallet, client=client)
transfer = await transaction.transfer(
to_address=wallet_two.get_address(), symbol="BNB", amount=0.1
)
multi_transfer = await transaction.multi_transfer(
to_address,
transfers=[{"symbol": "BTC", "amount": 0.1}, {"symbol": "BNB", "amount": 0.1}],
)
new_order_txid = await transaction.create_new_order(
symbol="binance_pair",
side=Side.BUY,
ordertype=Ordertype.LIMIT,
price=1,
quantity=1,
timeInForce=Timeinforce.GTE,
)
cancel_order_txid = await transaction.cancel_order(symbol="BTC-531_BNB", refid="")
freeze_token_txid = await transaction.freeze_token(symbol="BNB", amount=1)
unfreeze_token_txid = await transaction.unfreeze_token(symbol="BNB", amount=1)
vote_txid = await transaction.vote(proposal_id, option=Votes.YES) # only validator can vote
issue_token_txid = await transaction.issue_token(symbol, name, supply, mintable)
mint_token_txid = await transaction.mint_token(symbol, amount)
burn_token_txid = await transaction.burn_token(symbol, amount)
```
### Create Transaction Message. This message can be signed and broadcast somewhere else
```python
transfer_transaction = await Transaction.transfer_transaction(
from_address, to_address, symbol, amount
)
multi_transfer_transaction = await Transaction.multi_transfer_transaction(
from_address,
to_address,
transfers=[{"symbol": "BTC", "amount": 0.1}, {"symbol": "BNB", "amount": 0.1}],
)
limit_buy_transaction = await Transaction.new_order_transaction(
address="owner address",
symbol="pair",
side=Side.BUY,
ordertype=Ordertype.LIMIT,
price=1,
quantity=1,
timeInForce=Timeinforce.GTE,
testnet=True,
client=None,
)
limit_sell_transaction = await Transaction.new_order_transaction(
address="owner address",
symbol="pair",
side=Side.BUY,
ordertype=Ordertype.LIMIT,
price=1,
quantity=1,
timeInForce=Timeinforce.GTE,
testnet=True,
client=None,
)
cancel_order_transaction = await Transaction.cancel_order(
address="owner_address", symbol="pair", refid="", testnet=True, client=None
)
freeze_token_transaction = await Transaction.freeze_token(
address="ownder_address", symbol="BNB", amount=1, testnet=True, client=None
)
unfreeze_token_tranasaction = await Transaction.unfreeze_token_transaction(
address="ownder_address", symbol="BNB", amount=1, testnet=True, client=None
)
vote_transaction = await Transaction.vote_transaction(
voter, proposal_id, option=Votes.YES, client=None, testnet=True
)
issue_token_transaction = await Transaction.issue_token_transaction(
owner, name, symbol, sypply, mintable, client=None, testnet=True
)
mint_token_transaction = await Transaction.mint_token_transaction(
owner, symbol, amount, client=None, testnet=True
)
burn_token_transaction = Transaction.burn_token_transaction(
owner, symbol, amount, client=None, testnet=True
)
""" Get transaction message to sign"""
sign_message_bytes_format = Limit_Buy_Transaction.get_sign_message()
```
- Example transaction message :
```
b'{"account_number":"668107","chain_id":"Binance-Chain-Nile","data":null,"memo":"","msgs":[{"inputs":[{"address":"tbnb1r5jc35v338tlphnjx65wy7tecm6vm82tftfkt7","coins":[{"amount":10000000,"denom":"BNB"}]}],"outputs":[{"address":"tbnb1nhvpuq0u5pgpry0x2ap2hqv9n5jfkj90eps6qx","coins":[{"amount":10000000,"denom":"BNB"}]}]}],"sequence":"35","source":"1"}'
```
----------------------
## Running the test suite
```bash
git clone https://github.com/lmacken/binance-chain-python.git
cd binance-chain-python
pip install -r test-requirements.txt -r requirements.txt
python setup.py develop
pytest
```
----------------------
## Contributors
[@lmacken](https://github.com/lmacken)
[@propulsor](https://github.com/propulsor)
## Donate
BNB: `bnb1qx8u39hqcykjy5puv582gvqy5520dsz7fdh9ak`
BTC: `39n2J2hWY5FHCnGwNgRSZTe4TdFKcQea9v`