Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/celrenheit/alfred
Alfred - A loyal and tireless butler for your stellar wallets
https://github.com/celrenheit/alfred
Last synced: about 2 months ago
JSON representation
Alfred - A loyal and tireless butler for your stellar wallets
- Host: GitHub
- URL: https://github.com/celrenheit/alfred
- Owner: celrenheit
- License: apache-2.0
- Created: 2018-02-21T22:06:00.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-04-26T21:27:09.000Z (over 6 years ago)
- Last Synced: 2024-06-20T12:50:09.570Z (3 months ago)
- Language: Go
- Homepage:
- Size: 2.43 MB
- Stars: 30
- Watchers: 5
- Forks: 5
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Alfred
A loyal and tireless butler for your stellar wallets
**Table of Contents**
- [Feature](#feature)
- [Install](#install)
- [Usage](#usage)
- [Typical workflow](#typical-workflow)
- [Importing a wallet](#importing-a-wallet)
- [Creating a random wallet](#creating-a-random-wallet)
- [Creating a vanity address](#creating-a-vanity-address)
- [Show balances:](#show-balances)
- [Sending lumens or assets](#sending-lumens-or-assets)
- [Adding contacts](#adding-contacts)
- [Sharing an account](#sharing-an-account)
- [Setting data](#setting-data)
- [Trust an asset](#trust-an-asset)
- [Disclaimer](#disclaimer)
- [Credits](#credits)
- [Donate](#donate)
# Feature
- Single human readable yaml file
- AES encryption for seeds
- Contacts/aliases
- (very) easy to use
- Create shared accounts
- 1 master in full control (dictator) with multiple possible payers (having medium access)
- Set Data using manage_data
# Install
- MacOS: `brew install celrenheit/taps/alfred`
- Windows/Linux: https://github.com/celrenheit/alfred/releases
- From Source: `go get -u github.com/celrenheit/alfred`
# Usage
## Typical workflow
## Importing a wallet
```shell
alfred import
```
Optionaly, you can name your wallet using `alfred import --name "my awesome wallet"`
## Creating a random wallet
```shell
alfred new
```
### Creating a vanity address
```shell
alfred new --suffix "HUG"
```
Optionaly, you can name your wallet using `alfred new --name "my awesome wallet"`
## Show balances:
```shell
alfred balances
```
Output:
```
+----------------------------------------------------------+----------+-----------+
| WALLET | CURRENCY | BALANCE |
+----------------------------------------------------------+----------+-----------+
| GCXXY622NRUFSBIA5Z3MVYKOXKZYGPC5Z6VCPVQ2JUPYSNHQJNXC3P7Z | XLM | 2.9999700 |
+----------------------------------------------------------+----------+-----------+
```
## Sending lumens or assets
```shell
alfred send 10 XLM from master to jennifer
```
## Adding contacts
```shell
alfred new contact
```
## Sharing an account
```shell
alfred please share account savings with alice, bob and celine
```
## Setting data
In this example, it will set data key-value pairs for the selected account:
```shell
alfred please set data mykey1 = myvalue1, mykey2 = myvalue2
```
It possible to setup the contents of a file (using `from` keyword) as the value of a key:
```shell
alfred please set data mykey1 from ./text.txt
```
**NOTE**: If you want your keys or values to have spaces or special characters, you have to use quotes (`"`or `'`) around the whole query and the key/value:
```shell
alfred please 'set data "my key 1" = "my value 1", "my key 2" from "./text space.txt"'
```
## Trust an asset
To trust an asset known to Alfred:
```shell
alfred trust MOBI
```
Alternatively, you can trust for a custom asset using:
```shell
alfred trust HUG GXXXX
```
Where GXXX is the issuing account.
# Disclaimer
USE AT YOUR OWN RISK.
Always keep your secret seeds in a safe place (for example, a paper wallet).
# Credits
Partial list of assets are coming from the great [stellarterm](https://github.com/irisli/stellarterm) project. Go check it out.
# Donate
If you which to donate, use the command below:
```shell
alfred donate
```
... or the following address:
**XLM**: GCDMBL2SDMM74I2EOM5XHF7LMMDXFEJQIZ5N2ORK6HBSHM5INLALFRED