Merge pull request #65 from flow-hydraulics/latenssi/api-update-2

API update, refactor transaction error handling

Author: nanuuki

api/misc.http

@@ -5,7 +5,7 @@ POST  http://localhost:3000/v1/distributions HTTP/1.1
 content-type: application/json
 
 {
-  "distId": 1,
+  "distFlowID": 1,
   "issuer":"0x1",
   "meta": {
     "title": "Test",

benchmarkcreate_test.go

@@ -23,15 +23,15 @@ func benchmarkCreate(packs, slots uint, b *testing.B) {
 	collection := makeTestCollection(int(packs * slots))
 
 	dReq := pds_http.ReqCreateDistribution{
-		DistID: common.FlowID{Int64: int64(1), Valid: true},
+		FlowID: common.FlowID{Int64: int64(1), Valid: true},
 		Issuer: addr,
-		PackTemplate: pds_http.PackTemplate{
+		PackTemplate: pds_http.ReqPackTemplate{
 			PackReference: pds_http.AddressLocation{
 				Name:    "TestPackNFT",
 				Address: addr,
 			},
 			PackCount: packs,
-			Buckets: []pds_http.Bucket{
+			Buckets: []pds_http.ReqBucket{
 				{
 					CollectibleReference: pds_http.AddressLocation{
 						Name:    "TestCollectibleNFT",

e2e_large_test.go

@@ -185,7 +185,7 @@ func TestE2ELarge(t *testing.T) {
 	}
 
 	distribution := app.Distribution{
-		DistID: distId,
+		FlowID: distId,
 		Issuer: issuer,
 		PackTemplate: app.PackTemplate{
 			PackReference: app.AddressLocation{
@@ -222,7 +222,7 @@ func TestE2ELarge(t *testing.T) {
 	t.Log("Wait for the distribution to complete")
 
 	for {
-		d, _, err := a.GetDistribution(context.Background(), distribution.ID)
+		d, err := a.GetDistribution(context.Background(), distribution.ID)
 		if err != nil {
 			if !strings.Contains(err.Error(), "database is locked") {
 				t.Fatal(err)

e2e_test.go

@@ -172,7 +172,7 @@ func TestE2E(t *testing.T) {
 	}
 
 	distribution := app.Distribution{
-		DistID: distId,
+		FlowID: distId,
 		Issuer: issuer,
 		PackTemplate: app.PackTemplate{
 			PackReference: app.AddressLocation{
@@ -209,7 +209,7 @@ func TestE2E(t *testing.T) {
 	t.Log("Wait for the distribution to complete")
 
 	for {
-		d, _, err := a.GetDistribution(context.Background(), distribution.ID)
+		d, err := a.GetDistribution(context.Background(), distribution.ID)
 		if err != nil {
 			t.Fatal(err)
 		}

main_test.go

@@ -30,15 +30,15 @@ func TestCreate(t *testing.T) {
 	collection := makeTestCollection(packs * slotsPerBucket)
 
 	dReq := pds_http.ReqCreateDistribution{
-		DistID: common.FlowID{Int64: int64(1), Valid: true},
+		FlowID: common.FlowID{Int64: int64(1), Valid: true},
 		Issuer: addr,
-		PackTemplate: pds_http.PackTemplate{
+		PackTemplate: pds_http.ReqPackTemplate{
 			PackReference: pds_http.AddressLocation{
 				Name:    "TestPackNFT",
 				Address: addr,
 			},
 			PackCount: uint(packs),
-			Buckets: []pds_http.Bucket{
+			Buckets: []pds_http.ReqBucket{
 				{
 					CollectibleReference: pds_http.AddressLocation{
 						Name:    "TestCollectibleNFT",
@@ -79,13 +79,13 @@ func TestCreate(t *testing.T) {
 		t.Fatal(err)
 	}
 
-	AssertNotEqual(t, createRes.DistributionId, uuid.Nil)
+	AssertNotEqual(t, createRes.ID, uuid.Nil)
 
 	// Get
 
 	rr2 := httptest.NewRecorder()
 
-	getReq, err := http.NewRequest("GET", fmt.Sprintf("/v1/distributions/%s", createRes.DistributionId), nil)
+	getReq, err := http.NewRequest("GET", fmt.Sprintf("/v1/distributions/%s", createRes.ID), nil)
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -97,14 +97,11 @@ func TestCreate(t *testing.T) {
 		t.Fatalf("handler returned wrong status code: got %v want %v, error: %s", status, http.StatusOK, rr2.Body)
 	}
 
-	getRes := pds_http.ResDistribution{}
+	getRes := pds_http.ResGetDistribution{}
 	if err := json.NewDecoder(rr2.Body).Decode(&getRes); err != nil {
 		t.Fatal(err)
 	}
 
-	AssertEqual(t, getRes.ID, createRes.DistributionId)
+	AssertEqual(t, getRes.ID, createRes.ID)
 	AssertEqual(t, getRes.Issuer, addr)
-	AssertEqual(t, len(getRes.ResolvedCollection), len(collection))
-	AssertEqual(t, len(getRes.Packs), packs)
-	AssertEqual(t, getRes.Packs[0].CommitmentHash.IsEmpty(), false)
 }

models/Bucket.yaml models/Bucket-Create.yamlmodels/Bucket.yaml renamed to models/Bucket-Create.yaml

@@ -13,13 +13,17 @@ properties:
     $ref: ./Contract-Reference.yaml
   collectibleCount:
     type: integer
-    format: int64
     minimum: 1
+    example: 4
   collectibleCollection:
     type: array
     uniqueItems: true
     minItems: 1
     items:
       type: integer
-      format: int64
       minimum: 1
+      example: 42
+required:
+  - collectibleReference
+  - collectibleCount
+  - collectibleCollection

models/Bucket-Get.yaml

@@ -0,0 +1,17 @@
+type: object
+title: Bucket
+description: ''
+examples:
+  - collectibleCount: 1
+    collectibleCollection:
+      - 1
+      - 2
+      - 3
+      - 4
+properties:
+  collectibleReference:
+    $ref: ./Contract-Reference.yaml
+  collectibleCount:
+    type: integer
+    minimum: 1
+    example: 4

models/Contract-Reference.yaml

@@ -4,6 +4,7 @@ description: Way of referencing a contract on Flow.
 properties:
   name:
     type: string
+    example: ExampleNFT
   address:
     $ref: ./Flow-Address.yaml
 required:

models/Distribution.yaml models/Distribution-Get.yamlmodels/Distribution.yaml renamed to models/Distribution-Get.yaml

@@ -1,19 +1,20 @@
 title: Distribution
 type: object
+description: ''
 properties:
-  id:
+  distID:
     type: string
+    format: uuid
+  distFlowID:
+    type: integer
+    minimum: 0
+    example: 1
   createdAt:
     type: string
     format: date-time
   updatedAt:
     type: string
     format: date-time
-  distId:
-    type: integer
-    format: int64
-    minimum: 0
-    example: 1
   issuer:
     $ref: ./Flow-Address.yaml
   state:
@@ -27,15 +28,4 @@ properties:
   meta:
     $ref: ./Distribution-Meta.yaml
   packTemplate:
-    $ref: ./Pack-Template.yaml
-  packs:
-    type: array
-    items:
-      $ref: ./Pack.yaml
-  resolvedCollection:
-    type: array
-    items:
-      type: string
-      example: A.0000000000000003.CollectibleNFT.11
-  settlementStatus:
-    $ref: ./Settlement-Status.yaml
+    $ref: ./Pack-Template-Get.yaml

models/DistributionListItem.yaml models/Distribution-List.yamlmodels/DistributionListItem.yaml renamed to models/Distribution-List.yaml

@@ -1,19 +1,19 @@
 title: Distribution List Item
 type: object
 properties:
-  id:
+  distID:
     type: string
+    format: uuid
+  distFlowID:
+    type: integer
+    minimum: 0
+    example: 1
   createdAt:
     type: string
     format: date-time
   updatedAt:
     type: string
     format: date-time
-  distId:
-    type: integer
-    format: int64
-    minimum: 0
-    example: 1
   issuer:
     $ref: ./Flow-Address.yaml
   state: