Skip to main content

Command line client for Ğ1 libre-currency powered by Duniter

Project description

Silkaj

Version License Python versions Code format Imports: isort Coverage report Website Dev pipeline status types - Mypy Built with Material for MkDocs

Command line client for Ğ1 libre-currency powered by Duniter

Install

Distribution

Install with your favorite package manager. See below the packaging status paragraph.

Pipx

If you want a more recent version install with pipx:

sudo apt install pipx
pipx install silkaj

Docker images

There is two kind of images. One build with pip for user purposes, and one using Poetry for developer purposes.

For contributing purposes

Usage

  • Get help usage with -h or --help options, then run:
silkaj <sub-command>

Silkaj command line interface (CLI) is structured by groups of commands:

silkaj blockchain -h
silkaj money -h
silkaj money transfer -h
silkaj wot revocation -h

You can find commands at the root, such as silkaj license

  • Will automatically request and post data on https://g1.duniter.org/node/summary official Ğ1 endpoint.

  • Specify a custom node with -ep option where <port> and <path> are optional:

silkaj -ep <hostname>:<port>/<path> <sub-command>

Features

Currency information & blockchain exploration

  • Check the present currency information stand
  • Display current proof of work difficulty level to generate the next block
  • Explore the blockchain block by block

Money management

  • Transaction emission
    • Multi-recipients transaction support
    • Read transaction recipients and amounts from a file
  • Consult wallets balances
  • Consult wallet history

Web-of-Trust management

  • Look up for public keys and identities
  • Check sent and received certifications and consult the membership status of any given identity in the Web of Trust
  • Certification emission
  • Membership emission
  • Revocation file handling
  • DeathReaper: exclusions reports on Discourse forums

Authentication

  • Authentication methods: Scrypt, Seedhex, PubSec, and (E)WIF

Others

  • Account storage
  • Display Ğ1 monetary license
  • Public key checksum

Wrappers

Dependencies

Silkaj is based on following Python modules:

  • Click: Composable command line interface toolkit
  • DuniterPy: Most complete client oriented Python library for Duniter/Ğ1 ecosystem
  • Pendulum: Datetimes made easy
  • texttable: Creation of simple ASCII tables

Names

I wanted to call that program:

  • bamiyan
  • margouillat
  • lsociety
  • cashmere

I finally called it Silkaj as Silk in esperanto.

Packaging status

Packaging status

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

silkaj-0.12.0.tar.gz (67.2 kB view details)

Uploaded Source

Built Distribution

silkaj-0.12.0-py3-none-any.whl (95.8 kB view details)

Uploaded Python 3

File details

Details for the file silkaj-0.12.0.tar.gz.

File metadata

  • Download URL: silkaj-0.12.0.tar.gz
  • Upload date:
  • Size: 67.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.0.1 CPython/3.12.8 Linux/6.6.19

File hashes

Hashes for silkaj-0.12.0.tar.gz
Algorithm Hash digest
SHA256 893ffaec7e20e82409636bd45bb094f7c802446e2e601ebda8a54ddac2c02040
MD5 2ff0142d43d4e1288282bb266dda76fd
BLAKE2b-256 48cc93f5e03b4b1d1a88c1610d5bd73566ba193b3f2a925038fd18afa8fa26f7

See more details on using hashes here.

File details

Details for the file silkaj-0.12.0-py3-none-any.whl.

File metadata

  • Download URL: silkaj-0.12.0-py3-none-any.whl
  • Upload date:
  • Size: 95.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.0.1 CPython/3.12.8 Linux/6.6.19

File hashes

Hashes for silkaj-0.12.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6a33429d895a9bbc9b5b78eb35ca8bc2805784ec88a9d488407847b8cbb98f2f
MD5 e8806d438c391cdc54b13ee2180525c5
BLAKE2b-256 1bbaa3112e838c6569c66ae4ceafc6ed6fcef231e6ef27e6f18dc9b9d264c3cd

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page