Skip to content
This repository has been archived by the owner on Aug 30, 2022. It is now read-only.

Commit

Permalink
Add UML design for complete workflow and error model
Browse files Browse the repository at this point in the history
  • Loading branch information
anguyen committed May 1, 2019
1 parent 9a4622d commit 97ddc10
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
Expand Up @@ -111,7 +111,7 @@ By simply switching out the signature provider on a transaction, signature reque
EOSIO SDK for Java _does not include_ a signature provider implementation; one must be installed separately.

* [ISignatureProvider](eosiojava/src/main/java/one/block/eosiojava/interfaces/ISignatureProvider.java)
* [Softkey Signature Provider](https://github.com/EOSIO/eosio-java-softkey-signature-provider) - Example signature provider for signing transactions using R1 and K1 keys in memory.*
* [Softkey Signature Provider](https://github.com/EOSIO/eosio-java-softkey-signature-provider) - Example signature provider for signing transactions using SECP256R1 and SECP256R1 keys in memory.*

*_Softkey Signature Provider stores keys in memory and is therefore not secure. It should only be used for development purposes. In production, we strongly recommend using a signature provider that interfaces with a secure vault, authenticator or wallet._

Expand Down Expand Up @@ -141,6 +141,12 @@ The ABI Provider is responsible for fetching and caching ABIs for use during ser
* [IABIProvider](eosiojava/src/main/java/one/block/eosiojava/interfaces/IABIProvider.java)
* [Default ABIProviderImpl Implementation](eosiojava/src/main/java/one/block/eosiojava/implementations/ABIProviderImpl.java)

### Design document

For more details about the complete workflow of EOSIO SDK for Java, see [`EOSIO SDK for Java - Complete workflow`](https://github.com/EOSIO/eosio-java/tree/master/documents/complete_workflow.pdf).

An overview of the error model used in this library can be found in the [`EOSIO SDK for Java - Error Model`](https://github.com/EOSIO/eosio-java/tree/master/documents/error_model.pdf)

## Want to help?

Interested in contributing? That's awesome! Here are some [Contribution Guidelines](./CONTRIBUTING.md) and the [Code of Conduct](./CONTRIBUTING.md#conduct).
Expand Down
Binary file added documents/complete_workflow.pdf
Binary file not shown.
Binary file added documents/error_model.pdf
Binary file not shown.

0 comments on commit 97ddc10

Please sign in to comment.