Skip to main content

This is a litecoin library that provides tools/utilities to interact with the Litecoin network and it is based on python-bitcoin-utils library. One of the primary goals of the library is to explain the low-level details of Litecoin. The code is easy to read and properly documented explaining in detail all the thorny aspects of the implementation. It is a low-level library which assumes some high-level understanding of how Litecoin works. In the future this might change.

This is an early version of the library (v0.5.5) and currently, it supports private/public keys, all type of addresses and creation of any transaction (incl. segwit) with all SIGHASH types. All script op codes are included. Timelock and non-standanrd transactions are supported. It does not currently support the new M and Q addresses. Currently, a simple node proxy exists to enable easy calls to a Litecoin core node. Extra functionality will be added continuously and the documentation will be improved as the work progresses.

The API documentation can be build with Sphinx but is also available as a PDF for convenience. One can currently use the library for experimenting and learning the inner workings of Litecoin. It is not meant for production yet and parts of the API might be updated with new versions.

Installation

Python version 3 is required. Then just install with:

$ pip install litecoin-utils

Examples

Keys and Addresses

https://github.com/karask/python-litecoin-utils/blob/master/examples/keys_addresses.py - creates a private key which we use to derive a public key and in turn an address. We also use the private key to sign a message and then verify it using the public key.

Segwit Addresses

https://github.com/karask/python-litecoin-utils/blob/master/examples/keys_segwit_addresses.py - creates P2WPKH, P2SH-P2WPKH, P2WSH and P2SH-P2WSH addresses.

Transaction with P2PKH input and outputs

https://github.com/karask/python-litecoin-utils/blob/master/examples/p2pkh_transaction.py - creates a simple transaction with one input and two outputs.

Create a P2PKH Transaction with different SIGHASHes

https://github.com/karask/python-litecoin-utils/blob/master/examples/multi_input_sighash_transaction.py - creates a 2-input 2-output transaction with different signature types.

Create a P2SH Address

https://github.com/karask/python-litecoin-utils/blob/master/examples/send_to_p2sh_transaction.py - creates a P2SH address that corresponds to a P2PK redeem script and sends some funds to it.

Create (spent) a P2SH Transaction

https://github.com/karask/python-litecoin-utils/blob/master/examples/spend_p2sh_transaction.py - creates a transaction that spends a P2SH output.

Create a non-standard tx

https://github.com/karask/python-litecoin-utils/blob/master/examples/create_non_std_tx.py - sends funds to an address with a non-standard tx (script: OP_ADD OP_5 OP_EQUAL)

Spend a non-standard tx

https://github.com/karask/python-litecoin-utils/blob/master/examples/spend_non_std_tx.py - spends funds from script OP_ADD OP_5 OP_EQUAL

Transaction to pay to a P2WPKH

http://github.com/karask/python-litecoin-utils/blob/master/examples/send_to_p2wpkh_transaction.py - send coins from two P2PKH UTXOs to a native segwit address (P2WPKH)

Spend from a P2SH(P2WPKH) nested segwit address

http://github.com/karask/python-litecoin-utils/blob/master/examples/spend_p2sh_p2wpkh_address.py - spend a P2WPKH that is nested into a P2SH for old client compatibility

Create a P2SH address with a relative timelock

https://github.com/karask/python-litecoin-utils/blob/master/examples/create_p2sh_csv_p2pkh_address.py - creates a P2SH address that locks funds (sent to it) with a private key (P2PKH) and a relative locktime of 200 blocks in the future.

Spend from a timelocked address

https://github.com/karask/python-litecoin-utils/blob/master/examples/spend_p2sh_csv_p2pkh.py - spends from a P2SH(CSV+P2PKH) address as created from above.

Use NodeProxy to make calls to a Litecoin node

https://github.com/karask/python-litecoin-utils/blob/master/examples/node_proxy.py - make Litecoin command-line interface calls programmatically (NodeProxy wraps jsonrpc-requests library)

Please explore the codebase or the API documentation (LitecoinUtilities.pdf) for supported functionality and other options.

Metadata

Release files for litecoin-utils 0.5.5

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for litecoin-utils 0.5.5
File Size Uploaded
litecoin-utils-0.5.5.tar.gz 25.9 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for litecoin-utils 0.5.5
File Interpreter ABI Platform
litecoin_utils-0.5.5-py3-none-any.whl Python 3 none any Details

Total release size: 55.3 kB

Release files / litecoin-utils-0.5.5.tar.gz

Download URL litecoin-utils-0.5.5.tar.gz
Size 25.9 kB
Tags Source
SHA-256 checksum
How to use checksums
da402d864fbeee2d0d9585131d235d2cdd1713917121549c104d9efd094005d4
BLAKE2b-256 checksum
How to use checksums
570903bdeaf1930b5ea41a22100caac44ca7b62bc583cf3f344748510f61cb70
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.10.6

Release files / litecoin_utils-0.5.5-py3-none-any.whl

Download URL litecoin_utils-0.5.5-py3-none-any.whl
Size 29.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
4d7ced6fb9df4e2be3c62b07033ae94206d0195710efc4525a540ccf3e230118
BLAKE2b-256 checksum
How to use checksums
be8b247ac7258c1928399b79c5fa64b846805d505aa6e64cdc4eba9270c480a7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.10.6

Release history Release notifications | RSS feed

This release

0.5.5 This release

2 release files

0.5.4

2 release files

0.5.1

2 release files

0.4.12

2 release files

0.4.11

2 release files

0.4.10

1 release file

0.4.9

1 release file

0.4.8

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page