Skip to main content

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

Release files for silkaj 0.12.1

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

Source distribution (sdist)

Source distribution for silkaj 0.12.1
File Size Uploaded
silkaj-0.12.1.tar.gz 66.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for silkaj 0.12.1
File Interpreter ABI Platform
silkaj-0.12.1-py3-none-any.whl Python 3 none any Details

Total release size: 162.2 kB

Release files / silkaj-0.12.1.tar.gz

Download URL silkaj-0.12.1.tar.gz
Size 66.8 kB
Tags Source
SHA-256 checksum
How to use checksums
a8534e4ae57b0f0709bd514488d5b491031e4888a5325485a06ad1798bf2a227
BLAKE2b-256 checksum
How to use checksums
799dca374ce87644ba35d08a48ea76d936aaf26bb386c8bf47e6a3f72474a4dd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.0.1 CPython/3.12.8 Linux/6.6.19

Release files / silkaj-0.12.1-py3-none-any.whl

Download URL silkaj-0.12.1-py3-none-any.whl
Size 95.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
75391453de31f10b73e4ed3ccf098a75f90f883f1e8d0e6cc0f39b5df3167d2e
BLAKE2b-256 checksum
How to use checksums
6a434a968b4490f7f1567fd3819cc05e38cd8986eceb2e023bbce5ec2cd987ca
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.0.1 CPython/3.12.8 Linux/6.6.19
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