diff --git a/README.md b/README.md index c62ad82..b5dd07c 100644 --- a/README.md +++ b/README.md @@ -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._ @@ -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). diff --git a/documents/complete_workflow.pdf b/documents/complete_workflow.pdf new file mode 100644 index 0000000..25560a2 Binary files /dev/null and b/documents/complete_workflow.pdf differ diff --git a/documents/error_model.pdf b/documents/error_model.pdf new file mode 100644 index 0000000..cedce18 Binary files /dev/null and b/documents/error_model.pdf differ