Package Exports
- @loremlabs/setler
- @loremlabs/setler/src/cli.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@loremlabs/setler) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Setler CLI
A CLI version of Setler. Setler is non-custodial identity wallet with built in Kudos support.
How it works
Setler CLI is a non-custodial identity wallet that is used to send and receive payments as well as "setling" kudos. Setling (intentional new spelling) is the act of distributing a fixed amount to a "pool" of identities. This pool is the accumulation of kudos which includes an identity identifier.
Because the wallet is non-custodial, the user is in control of their own funds and can send and receive payments as well as setle kudos without the need for a third party.
CLI Commands
Usage
% npx @loremlabs/setler
% npx @loremlabs/setler help
Wallet
To use you start by creating a wallet. This is a non-custodial wallet that is used to send and receive payments as well as perform the escrowed payments.
Setup a new wallet with:
% npx @loremlabs/setler wallet init
Then you can fund your wallet with:
% npx @loremlabs/setler wallet fund
Which (for testnet) will fund the wallet with 1000 XRP.
You can also receive payments to your wallet with:
% npx @loremlabs/setler wallet receive
Kudos
You can create kudos with:
% npx @loremlabs/setler kudos create
This creates the data structure of a kudos
. You can save it by appending to a file with:
% npx @loremlabs/setler kudos create --outFile "kudos.ndjson"
Kudos Pool
Kudos can be stored in a pool. This is the accumulation of kudos that you've created. You can create a pool with:
% npx @loremlabs/setler pool create
Inking: Storing Kudos in a Pool
You can store or ink kudos in a pool at the ident agency with:
% npx @loremlabs/setler pool ink --inFile kudos.ndjson
Create and Ink in one step
You can create and ink kudos in one step with:
% npx @loremlabs/setler kudos create --identifier="did:kudos:email:matt@loremlabs.com" --now | setler pool ink --poolId="AkfENzX4A8nVog5FDh4oGr"
Setle: Distributing Funds to a Kudos Pool
To setle kudos you need to have a wallet setup and funded. You can then setle kudos with:
% npx @loremlabs/setler kudos send --poolId POOL_ID
Social Send
To send to a social identifier (DID) send you need to have a wallet setup and funded. You can then send a social send with:
% npx @loremlabs/setler send social did:kudos:email:YOUR_EMAIL@YOUR_DOMAIN
% npx @loremlabs/setler send social did:kudos:email:mankins+demo1@gmail.com did:kudos:email:matt+demo2@loremlabs.com...