https://github.com/jrh3k5/cryptonabber-offramp
A CLI tool to make offramping with YNAB integration easier
https://github.com/jrh3k5/cryptonabber-offramp
Last synced: 3 months ago
JSON representation
A CLI tool to make offramping with YNAB integration easier
- Host: GitHub
- URL: https://github.com/jrh3k5/cryptonabber-offramp
- Owner: jrh3k5
- License: apache-2.0
- Created: 2024-02-04T16:12:14.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-10T11:04:28.000Z (3 months ago)
- Last Synced: 2025-03-10T12:22:22.280Z (3 months ago)
- Language: Go
- Size: 85 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ynab - Cryptonabber Offramp
README
# cryptonabber-offramp
A CLI tool to make offramping with YNAB integration easier. It does the following:
* For the configured offramp accounts, calculate the total outbound transactions, per account, that are outbound for a week, starting from a week from today
* e.g., if you are executing this on February 2, it will retrieve outbound transactions for February 9 through Febrary 15, inclusive
* For each account and for the configured source and destination account, generate the transactions in YNAB tracking:
* The send of the funds from your wallet to the address being used for offramping
* Transactions from the offramp address to each of the accounts to which funds are being offramped
* Generates a QR code that can be scanned to send the funds to be used for offramping
## Usage
### Prerequisites
* You must have a [YNAB](https://ynab.com) account with a budget and accounts to set up
* You must have a registered OAuth client ID and secret as described [here](https://api.ynab.com/#oauth-applications).
### Executing the Program
You can either supply the OAuth credentials interactively by executing this application as:
```
/cryptonabber-offramp --interactive
```
...or you can supply the OAuth credentials non-interactively by executing this application as:
```
/cryptonabber-offramp --oauth-client-id= --oauth-client-secret=
```
You can provide the following optional arguments:
* `--file`: by default, this application looks for a file called `config.yaml` in the local directory; if you would like to use a different filename or location, you can use this parameter to specify that
### Configuration
Below describes the expected structure of the YAML configuration file:
```yaml
recipient_address: ""
contract_address: ""
decimals:
chain_id:
qr_code_type: ""
ynab_budget_name: ""
ynab_accounts:
funds_origin_account: ""
funds_recipient_account: ""
offramp_accounts:
- name: ""
excluded_flag_colors:
- green
-
```
#### QR Code Type
By default, this tool generates an ERC-681-compliant QR code. You can set the YAML file with the following values to change that:
* `erc681`: the default; this generates an ERC-681-compliant QR code
* `recipient_only`: the QR code will merely contain the address to which the funds are to be sent
## Privacy Policy
This application does not persist any information given to this application. It only uses the access granted to your account within YNAB to read upcoming transactions and create inter-account transfers funding those upcoming transactions, as defined by the configuration you provide to this tool.
No data given to this application or read from YNAB is shared with any third parties.