Skip to content
Snippets Groups Projects
Moul's avatar
Moul authored
Specially for Ruff v0.0.292
8a029400
History

Silkaj

Version License Python versions Code format Imports: isort Coverage report Website Dev pipeline status types - Mypy

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
  • Verify blockchain blocks hashes

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

Authentication

  • Authentication methods: Scrypt, file, and (E)WIF

Others

  • 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.

Website

Packaging status

Packaging status