fiftysix/ord-litecoin repository overview

⁠Fiftysix Ord-litecoin Docker Image

Maintainer: [email protected]⁠

⁠Overview

This Docker image provides a fully functional ord-litecoin client built using the Fiftysix base image. Ord-litecoin is a fork of the Ord software, designed to interact with a Litecoin Core node to create and manage inscriptions on the Litecoin blockchain. It is a tool for developers and blockchain enthusiasts interested in creating digital artifacts (Ordinals) directly on the Litecoin network. The code can be viewed on the Fiftysix Github⁠.

⁠Tags

• latest: Points to the latest version of ord-litecoin.
• <version>: Points to a specific version of ord-litecoin. For example, 0.18.5, 0.19.1.

⁠What is Ord-litecoin?

ord-litecoin is a software tool that enables the creation of inscriptions on the Litecoin blockchain, leveraging the Litecoin protocol's capabilities to embed arbitrary data within transactions. These inscriptions can be used to create unique digital artifacts known as Ordinals, akin to NFTs on the Litecoin network.

⁠Usage

⁠Prerequisites

Ord-litecoin requires a connection to a fully synced Litecoin Core node to function properly. Ensure you have a Litecoin Core node running and accessible, such as the one provided by Fiftysix's Litecoin Core Docker Image⁠.

⁠Basic Usage

To run Ord-Litecoin:

docker pull fiftysix/ord-litecoin
docker run --name ord-litecoin -d fiftysix/ord-litecoin

This command will start the ord-litecoin container, serving its HTTP interface on port 80 by default. However, ord-litecoin needs to connect to a Litecoin Core node to function, which can be done by using Docker networking or linking containers.

⁠Connecting to Litecoin Core

To use ord-litecoin with a Litecoin Core node, ensure that the Litecoin Core container is running and then connect ord-litecoin to it using the following Docker command:

docker run --name ord-litecoin -d \
  --link litecoin-core:litecoin-core \
  -p 80:80 \
  fiftysix/ord-litecoin \
  ord --litecoin-rpc-url http://litecoin-core:9332 server

⁠Directory Structure

In this Docker image, the following directories are used:

• Data Directory (/node/ord-litecoin/data): This is where ord-litecoin stores its data, such as inscriptions and other relevant files. This directory is specified in the Dockerfile and should be mounted if you want to persist data across container restarts.
• Config Directory (/node/ord-litecoin/configs): This directory is used for storing configuration files for ord-litecoin. The Dockerfile copies a default ord-litecoin.yaml configuration file here, which can be customized.
• Scripts Directory (/node/ord-litecoin/scripts): This directory contains the entrypoint script (ord-litecoin-entrypoint.sh) and any other scripts that may be needed for starting or managing ord-litecoin.

⁠Mounting Directories

You can mount host directories to the container’s data, config, and scripts directories to customize the behavior of the Ord-Litecoin software.

Mounting the Data Directory: To persist ord-litecoin data across container restarts, you can mount a host directory to the container's data directory:

docker run --name ord-litecoin -v /path/to/local/data:/node/ord-litecoin/data -d fiftysix/ord-litecoin

This command mounts the /path/to/local/data directory on your host to /node/ord-litecoin/data in the container, ensuring that ord-litecoin data is preserved between container instances.

Mounting a Config File: To use a custom Ord-Litecoin configuration file, mount your configuration file to the container’s config directory:

docker run --name ord-litecoin -v /path/to/local/ord-litecoin.yaml:/node/ord-litecoin/configs/ord-litecoin.yaml -d fiftysix/ord-litecoin

This command mounts your custom ord-litecoin.yaml file to the container’s config directory and instructs Ord-Litecoin to use it.

Mounting the Scripts Directory: If you have custom scripts you want to include, you can mount them to the scripts directory. For example, to replace the entrypoint script:

docker run --name ord-litecoin -v /path/to/local/scripts:/node/ord-litecoin/scripts -d fiftysix/ord-litecoin

This command mounts your local scripts directory to /node/ord-litecoin/scripts in the container, allowing you to customize the startup behavior.

⁠Logging ord-litecoin

docker logs ord-litecoin --tail 100

⁠Using ord-litecoin with Litecoin Core

⁠Starting ord-litecoin with Litecoin Core

To start ord-litecoin and connect it to a Litecoin Core node (assuming you have a litecoin-core container running), use:

docker run --name ord-litecoin -d \
  --link litecoin-core:litecoin-core \
  -p 80:80 \
  fiftysix/ord-litecoin \
  ord --litecoin-rpc-url http://litecoin-core:9332 server

This command starts the ord-litecoin server and connects it to your Litecoin Core node, serving the HTTP interface on port 80.

⁠Creating Inscriptions

Once ord-litecoin is running and connected to a Litecoin Core node (with a wallet attached and funded), you can create inscriptions on the Litecoin blockchain:

docker exec ord-litecoin ord create-inscription --text "Hello, Litecoin!" --fee-rate 1.0

This command creates an inscription on the Litecoin blockchain with the text "Hello, Litecoin!".

⁠Docker Compose

Ord-litecoin can also be run using Docker Compose alongside Litecoin Core. An example compose file that uses both Litecoin Core and ord-litecoin can be found on the Fiftysix Github⁠.

⁠Support

For support, please contact [email protected]⁠.

⁠About Fiftysix

Fiftysix is committed to making blockchain technology accessible, efficient, and reliable through robust decentralization. Learn more at fiftysix.tech⁠.