#23 Adds state channels api (#49)

Co-authored-by: Eren <[email protected]>

Author: erenalpaslan

src/main/java/mobi/appcent/helium/api/HeliumApi.java

@@ -20,6 +20,7 @@ public class HeliumApi {
     private final ChallengesApi challengesApi = ChallengesApi.getInstance();
     private final DCBurnsApi dcBurnsApi = DCBurnsApi.getInstance();
     private final OraclePricesApi oraclePricesApi = OraclePricesApi.getInstance();
+    private final StateChannelsApi stateChannelsApi = StateChannelsApi.getInstance();
     private final LocationsApi locationsApi = LocationsApi.getInstance();
     private final AssertLocationsApi assertLocationsApi = AssertLocationsApi.getInstance();
     private final ElectionsApi electionsApi = ElectionsApi.getInstance();
@@ -48,6 +49,7 @@ private void initOkHttpClients(OkHttpClient client) {
         challengesApi.setSdkClient(sdkClient);
         dcBurnsApi.setSdkClient(sdkClient);
         oraclePricesApi.setSdkClient(sdkClient);
+        stateChannelsApi.setSdkClient(sdkClient);
         locationsApi.setSdkClient(sdkClient);
         assertLocationsApi.setSdkClient(sdkClient);
         electionsApi.setSdkClient(sdkClient);
@@ -84,6 +86,8 @@ public CityApi cities() {
 
     public OraclePricesApi oraclePrices() { return oraclePricesApi; }
 
+    public StateChannelsApi stateChannels() { return stateChannelsApi; }
+
     public LocationsApi locations() { return locationsApi; }
 
     public AssertLocationsApi assertLocations() { return assertLocationsApi; }

src/main/java/mobi/appcent/helium/api/IStateChannelsApi.java

@@ -0,0 +1,10 @@
+package mobi.appcent.helium.api;
+
+import mobi.appcent.helium.request.statechannel.StateChannelClosesRequest;
+
+/**
+ * Created by erenalpaslan on 3.12.2022
+ */
+public interface IStateChannelsApi {
+    StateChannelClosesRequest getStateChannelCloses();
+}

src/main/java/mobi/appcent/helium/api/StateChannelsApi.java

@@ -0,0 +1,22 @@
+package mobi.appcent.helium.api;
+
+import mobi.appcent.helium.request.statechannel.StateChannelClosesRequest;
+
+/**
+ * Created by erenalpaslan on 3.12.2022
+ */
+public class StateChannelsApi extends BaseApi implements IStateChannelsApi{
+    @Override
+    String path() {
+        return null;
+    }
+
+    public static StateChannelsApi getInstance() {
+        return new StateChannelsApi();
+    }
+
+    @Override
+    public StateChannelClosesRequest getStateChannelCloses() {
+        return new StateChannelClosesRequest(sdkClient);
+    }
+}

src/main/java/mobi/appcent/helium/common/UrlConstant.java

@@ -14,6 +14,7 @@ public class UrlConstant {
     public static final String VALIDATORS_PATH = BASE_PATH + "/validators";
     public static final String CHALLENGES_PATH = BASE_PATH + "/challenges";
     public static final String DC_BURNS_PATH = BASE_PATH + "/dc_burns";
+    public static final String STATE_CHANNELS_PATH = BASE_PATH + "/state_channels";
     public static final String LOCATIONS_PATH = BASE_PATH + "/locations";
     public static final String ASSERT_LOCATIONS_PATH = BASE_PATH + "/assert_locations";
     public static final String ELECTIONS_PATH = BASE_PATH + "/elections";

src/main/java/mobi/appcent/helium/model/statechannel/StateChannel.java

@@ -0,0 +1,25 @@
+package mobi.appcent.helium.model.statechannel;
+
+import com.google.gson.annotations.SerializedName;
+import lombok.AllArgsConstructor;
+import lombok.Data;
+
+import java.math.BigInteger;
+import java.util.List;
+
+/**
+ * Created by erenalpaslan on 3.12.2022
+ */
+@Data
+@AllArgsConstructor
+public class StateChannel {
+    private List<Summary> summaries;
+    private String state;
+    @SerializedName("root_hash")
+    private String rootHash;
+    private String owner;
+    private Integer nonce;
+    private String id;
+    @SerializedName("expire_at_block")
+    private BigInteger expireAtBlock;
+}

src/main/java/mobi/appcent/helium/model/statechannel/StateChannelCloseTransaction.java

@@ -0,0 +1,24 @@
+package mobi.appcent.helium.model.statechannel;
+
+import com.google.gson.annotations.SerializedName;
+import lombok.AllArgsConstructor;
+import lombok.Data;
+
+import java.math.BigInteger;
+
+/**
+ * Created by erenalpaslan on 3.12.2022
+ */
+@Data
+@AllArgsConstructor
+public class StateChannelCloseTransaction {
+    private String type;
+    private Long time;
+    @SerializedName("state_channel")
+    private StateChannel stateChannel;
+    private BigInteger height;
+    private String hash;
+    @SerializedName("conflicts_with")
+    private String conflictsWith;
+    private String closer;
+}

src/main/java/mobi/appcent/helium/model/statechannel/Summary.java

@@ -0,0 +1,20 @@
+package mobi.appcent.helium.model.statechannel;
+
+import com.google.gson.annotations.SerializedName;
+import lombok.AllArgsConstructor;
+import lombok.Data;
+
+/**
+ * Created by erenalpaslan on 3.12.2022
+ */
+@Data
+@AllArgsConstructor
+public class Summary {
+    private String owner;
+    @SerializedName("num_packets")
+    private Integer numPackets;
+    @SerializedName("num_dcs")
+    private Integer numDcs;
+    private String location;
+    private String client;
+}

src/main/java/mobi/appcent/helium/request/statechannel/StateChannelClosesRequest.java

@@ -0,0 +1,62 @@
+package mobi.appcent.helium.request.statechannel;
+
+import com.google.gson.reflect.TypeToken;
+import mobi.appcent.helium.HeliumSdkClient;
+import mobi.appcent.helium.common.FieldConstant;
+import mobi.appcent.helium.common.UrlConstant;
+import mobi.appcent.helium.httpClient.HttpMethod;
+import mobi.appcent.helium.model.Pair;
+import mobi.appcent.helium.request.BaseRequest;
+import mobi.appcent.helium.response.account.AccountsResponse;
+import mobi.appcent.helium.response.statechannel.StateChannelClosesResponse;
+import okhttp3.Call;
+
+import java.io.IOException;
+import java.lang.reflect.Type;
+import java.util.ArrayList;
+
+/**
+ * Created by erenalpaslan on 3.12.2022
+ */
+public class StateChannelClosesRequest extends BaseRequest {
+    private final HeliumSdkClient client;
+    private String cursor;
+    private String minTime;
+    private String maxTime;
+    private Integer limit;
+
+    public StateChannelClosesRequest(HeliumSdkClient client) {
+        this.client = client;
+    }
+
+    public StateChannelClosesRequest cursor(String cursor) {
+        this.cursor = cursor;
+        return this;
+    }
+
+    public StateChannelClosesRequest minTime(String minTime) {
+        this.minTime = minTime;
+        return this;
+    }
+
+    public StateChannelClosesRequest maxTime(String maxTime) {
+        this.maxTime = maxTime;
+        return this;
+    }
+
+    public StateChannelClosesRequest limit(Integer limit) {
+        this.limit = limit;
+        return this;
+    }
+
+    public StateChannelClosesResponse execute() throws IOException {
+        ArrayList<Pair> queryParams = new ArrayList<>();
+        queryParams.add(Pair.create(FieldConstant.CURSOR, cursor));
+        queryParams.add(Pair.create(FieldConstant.MIN_TIME, minTime));
+        queryParams.add(Pair.create(FieldConstant.MAX_TIME, maxTime));
+        queryParams.add(Pair.create(FieldConstant.LIMIT, limit));
+        Call call = client.buildCall(UrlConstant.STATE_CHANNELS_PATH, HttpMethod.GET, queryParams, null, null);
+        Type type = TypeToken.get(StateChannelClosesResponse.class).getType();
+        return execute(call, type);
+    }
+}

src/main/java/mobi/appcent/helium/response/statechannel/StateChannelClosesResponse.java

@@ -0,0 +1,17 @@
+package mobi.appcent.helium.response.statechannel;
+
+import lombok.AllArgsConstructor;
+import lombok.Data;
+import mobi.appcent.helium.model.statechannel.StateChannelCloseTransaction;
+
+import java.util.List;
+
+/**
+ * Created by erenalpaslan on 3.12.2022
+ */
+@Data
+@AllArgsConstructor
+public class StateChannelClosesResponse {
+    private List<StateChannelCloseTransaction> data;
+    private String cursor;
+}