Merge pull request #3 from vsbogd/get-payment-channel-state-from-daemon

First Java SDK version with usage example

Author: vsbogd

.circleci/config.yml

@@ -38,7 +38,7 @@ jobs:
           command: |
             curl -L https://get.web3j.io | bash
             source $HOME/.web3j/source.sh
-            ./get_contracts.sh
+            ./get_dependencies.sh
       # run tests!
       - run:
           name: Run tests

.gitattributes

@@ -0,0 +1 @@
+*.svg binary

.gitignore

@@ -24,5 +24,7 @@ hs_err_pid*
 
 # maven build files
 target
+
+# vim specific files
 *.swp
 .vim-project

README.md

@@ -5,16 +5,16 @@
 
 ## Class diagram
 
-![Class diagram](https://www.plantuml.com/plantuml/svg/VP9HJy8m58NV-olkupJ07v0G0aOpZMWOFXaVBkrbDAajQMz75lM_kusH30O-zlRqdFkTT1eOFSSl8mHhDWIPjdaqw3MN2s9umW8XktyMGbiclq59y4AC2XapTXvpWcy1i2wPFZuX9qxUbob4hs_knA-G1aE0TBS9Pu_4kSduPpIwA6mzbfJhmBwSEyiU9JUfhplMpg8PP-GBBQaLOJsTrCjScC_AL2KP-ueJdCzJDO3s50xYL3MhNm1-ywxGYdoJtLeVxpffnr7IgU2u_hcLw7atHLoLzseO3c-lgg7Nyd_gBd5BCZUQxA7gLGtuw7SouxXE7gALTPdZ-HQj9JE0rGIaivLlb5LMHGvGEAqWR2ChjxSBj-_sCSD09o7YDB9feI_g4TP0VPcOabNLf_u3)
-[Source code](https://www.planttext.com/?text=VP9HJy8m58NV-olkupJ07v0G0aOpZMWOFXaVBkrbDAajQMz75lM_kusH30O-zlRqdFkTT1eOFSSl8mHhDWIPjdaqw3MN2s9umW8XktyMGbiclq59y4AC2XapTXvpWcy1i2wPFZuX9qxUbob4hs_knA-G1aE0TBS9Pu_4kSduPpIwA6mzbfJhmBwSEyiU9JUfhplMpg8PP-GBBQaLOJsTrCjScC_AL2KP-ueJdCzJDO3s50xYL3MhNm1-ywxGYdoJtLeVxpffnr7IgU2u_hcLw7atHLoLzseO3c-lgg7Nyd_gBd5BCZUQxA7gLGtuw7SouxXE7gALTPdZ-HQj9JE0rGIaivLlb5LMHGvGEAqWR2ChjxSBj-_sCSD09o7YDB9feI_g4TP0VPcOabNLf_u3)
+![Class diagram](./docs/class-diagram.svg)
+[Source code](./docs/class-diagram.plantuml)
 
 ## How to build
 
 Install dependencies for the first time:
 ```
 curl -L https://get.web3j.io | bash
 source $HOME/.web3j/source.sh
-./get_contracts.sh
+./get_dependencies.sh
 ```
 
 Build and test:

docs/class-diagram.plantuml

@@ -0,0 +1,152 @@
+@startuml
+
+title SingularityNet Java SDK
+
+package io.singularitynet.sdk.ethereum {
+
+    interface WithAddress {
+        Address getAddress();
+    }
+
+    interface Signer {
+        byte[] sign(byte[] message);
+    }
+    WithAddress <|-- Signer
+
+    class PrivateKeyIdentity
+    Signer <|.. PrivateKeyIdentity
+
+    class MnemonicIdentity
+    PrivateKeyIdentity <|-- MnemonicIdentity
+
+}
+
+
+package io.singularitynet.sdk.registry {
+
+    interface MetadataStorage {
+        byte[] get(URI uri);
+    }
+    class IpfsMetadataStorage
+    MetadataStorage <|.. IpfsMetadataStorage
+
+    class RegistryContract {
+        Optional<OrganizationRegistration> getOrganizationById(String orgId);
+        Optional<ServiceRegistration> getServiceRegistrationById(String orgId, String serviceId);
+    }
+
+    interface MetadataProvider {
+        ServiceMetadata getServiceMetadata();
+    }
+    class RegistryMetadataProvider
+    MetadataProvider <|.. RegistryMetadataProvider
+    RegistryMetadataProvider *-- RegistryContract
+    RegistryMetadataProvider *-- MetadataStorage
+
+}
+
+package io.singularitynet.sdk.daemon {
+    
+    interface DaemonConnection {
+        <T> T getGrpcStub(Function<Channel, T> constructor);
+        void setClientCallsInterceptor(ClientInterceptor interceptor);
+        void shutdownNow();
+    }
+
+    class FirstEndpointDaemonConnection
+    DaemonConnection <|.. FirstEndpointDaemonConnection
+    FirstEndpointDaemonConnection o-- MetadataProvider
+
+    class PaymentChannelStateService {
+        PaymentChannelStateReply getChannelState(BigInteger channelId);
+    }
+    PaymentChannelStateService o-- Signer
+    PaymentChannelStateService -- DaemonConnection
+
+    interface Payment {
+        void toMetadata(Metadata headers);
+    }
+
+}
+
+package io.singularitynet.sdk.mpe {
+    class MultiPartyEscrowContract {
+        Optional<PaymentChannel> getChannelById(BigInteger channelId);
+        Address getContractAddress();
+    }
+
+    interface PaymentChannelProvider {
+        PaymentChannel getChannelById(BigInteger channelId);
+    }
+
+    class AskDaemonFirstPaymentChannelProvider
+    PaymentChannelProvider <|.. AskDaemonFirstPaymentChannelProvider
+    AskDaemonFirstPaymentChannelProvider *-- MultiPartyEscrowContract
+    AskDaemonFirstPaymentChannelProvider *-- PaymentChannelStateService
+
+    class EscrowPayment
+    Payment ()- EscrowPayment
+
+}
+
+package io.singularitynet.sdk.client {
+
+    interface Configuration {
+        String getEthereumJsonRpcEndpoint();
+        URL getIpfsUrl();
+        SignerType getSignerType();
+        String getSignerMnemonic();
+        byte[] getSignerPrivateKey();
+    }
+
+    class JsonConfiguration
+    Configuration <|.. JsonConfiguration
+
+    interface DependencyFactory {
+        Web3j getWeb3j();
+        ContractGasProvider getContractGasProvider(Web3j web3j);
+        IPFS getIpfs();
+        Signer getSigner();
+    }
+
+    class ConfigurationDependencyFactory
+    DependencyFactory <|.. ConfigurationDependencyFactory
+
+    interface PaymentStrategy {
+        <ReqT, RespT> Payment getPayment(GrpcCallParameters<ReqT, RespT> parameters, ServiceClient serviceClient);
+    }
+
+    class FixedPaymentChannelPaymentStrategy
+    PaymentStrategy <|.. FixedPaymentChannelPaymentStrategy
+
+    class Sdk {
+        Sdk(Configuration config);
+        Sdk(DependencyFactory factory);
+
+        ServiceClient newServiceClient(String orgId, String serviceId, String endpointGroupName, PaymentStrategy paymentStrategy);
+        void shutdown();
+    }
+    Sdk -- Configuration
+    Sdk -- ServiceClient
+    Sdk -- DependencyFactory
+
+    interface ServiceClient {
+        MetadataProvider getMetadataProvider();
+        PaymentChannelProvider getPaymentChannelProvider();
+        Signer getSigner();
+        T getGrpcStub(Function<Channel, T> constructor);
+        void shutdownNow();
+    }
+
+    class BaseServiceClient
+    ServiceClient <|.. BaseServiceClient
+    BaseServiceClient *-- DaemonConnection
+    BaseServiceClient *-- MetadataProvider
+    BaseServiceClient *-- PaymentChannelProvider
+    BaseServiceClient *-- PaymentStrategy
+    BaseServiceClient *-- Signer
+
+}
+
+@enduml
+