AbstractWallets.jl

Abstractions for Digital Wallets in Julia
Author bhgomes
Popularity
4 Stars
Updated Last
5 Months Ago
Started In
October 2019

AbstractWallets.jl

Stable Docs Latest Docs Travis Build Status Build status Formatting

GitHub Repo DOI

Abstractions for Digital Wallets in Julia

Installation

To install open a Julia REPL and run the following:

]add AbstractWallets

Basic API

The AbstractWallets API defines the following basic structures:

Type Description
AbstractAddress Abstraction over digital addresses.
AbstractPortfolio A container of assets with methods for evaluating their value relative to other assets.
AbstractWallet A wallet is a portfolio with a digital address to identify it.

Transactions

Transactions between digital wallets or from wallets to addresses is mediated by the AbstractTransaction type. Transactions can take the two generic forms

Form Description
AbstractSendTransaction Results in the movement of assets from one party to another.
AbstractDestroyTransaction Results in the net destruction of assets.

which can be mediated by the two generic transaction functions:

Action Constructor
send! build_send_transaction
destroy! build_destroy_transaction

To use more advanced transaction types we have the following states:

State Description
is_pending Transaction is waiting to complete.
has_executed Transaction was executed but not necessarily completed. It is at least pending.
was_completed Transaction was executed and completed.
was_cancelled Transaction was cancelled before completion.
failed Transaction failed to complete, but was not cancelled.

and the allowed actions:

Action Description
sign! Signatures on a transaction verify that it should be executed.
execute! Execution of a transaction is the attempt to perform the appropriate transfer of assets defined in the transaction.
cancel! Stop a pending transaction.
rollback! Reset a completed transaction to return the state of the associated portfolios to before the transaction occured.
cancelback! Cancel and then roll back the transaction.

Crypto-Specific API

Private Keys

For cryptocurrency wallets and other wallets protected by asymmetric-cryptography, public-private key pairs are the method with which wallets can identify themselves. To access the keys, use either the keypairs(wallet) function or the privatekey(wallet, publickey).

Deterministic Wallets

A deterministic wallet can generate new public-private key pairs from one root private key. Such wallets are represented by the AbstractDeterministicWallet type. Use rootkey, mnemonic, or seed to access the root private key, and next_keypair! or next_address! to generate the next key.


(UN)LICENSE

Knowledge is Freedom.