Vars and fields renaming (#387)

* Rename asp > server

* Rename pool > round

* Consolidate naming for pubkey/prvkey vars and types

* Fix

* Fix

* Fix wasm

* Rename congestionTree > vtxoTree

* Fix wasm

* Rename payment > request

* Rename congestionTree > vtxoTree after syncing with master

* Fix Send API in SDK

* Fix wasm

* Fix wasm

* Fixes

* Fixes after review

* Fix

* Fix naming

* Fix

* Fix e2e tests

Author: altafan

README.md

@@ -32,10 +32,10 @@ For a quick-start with Docker, head over to our [Quick Start guide](https://arkd
 ## Repository Structure
 
 - [`api-spec`](./api-spec/): Ark Protocol Buffer API specification
-- [`client`](./client/): `ark` Single-key wallet CLI for interacting with the ASP
+- [`client`](./client/): `ark` Single-key wallet CLI for interacting with the server
 - [`common`](./common/): Shared code between the server and client
-- [`pkg/client-sdk`](./pkg/client-sdk/): Go SDK for interacting with ASPs running the Ark protocol. It offers WASM bindings to interact with the SDK from the browser and other environments.
-- [`server`](./server/): `arkd` Ark Service Provider (ASP) - the always-on daemon
+- [`pkg/client-sdk`](./pkg/client-sdk/): Go SDK for interacting with servers running the Ark protocol. It offers WASM bindings to interact with the SDK from the browser and other environments.
+- [`server`](./server/): `arkd` Ark server - the always-on daemon
 
 ## Development
 

api-spec/openapi/swagger/ark/v1/service.swagger.json

@@ -163,7 +163,7 @@
         ]
       }
     },
-    "/v1/round/ping/{paymentId}": {
+    "/v1/round/ping/{requestId}": {
       "get": {
         "operationId": "ArkService_Ping",
         "responses": {
@@ -182,7 +182,8 @@
         },
         "parameters": [
           {
-            "name": "paymentId",
+            "name": "requestId",
+            "description": "The id used to register inputs and ouptuts.",
             "in": "path",
             "required": true,
             "type": "string"
@@ -770,7 +771,7 @@
           "title": "VTXO outpoint signed with script's secret key"
         }
       },
-      "description": "This message is used to prove to the ASP that the user controls the vtxo without revealing the whole VTXO taproot tree."
+      "description": "This message is used to prove to the server that the user controls the vtxo without revealing the whole VTXO taproot tree."
     },
     "v1PingResponse": {
       "type": "object"
@@ -821,26 +822,24 @@
     "v1RegisterInputsForNextRoundResponse": {
       "type": "object",
       "properties": {
-        "id": {
-          "type": "string",
-          "description": "Mocks wabisabi's blinded credentials."
+        "requestId": {
+          "type": "string"
         }
       }
     },
     "v1RegisterOutputsForNextRoundRequest": {
       "type": "object",
       "properties": {
-        "id": {
-          "type": "string",
-          "description": "Mocks wabisabi's blinded credentials."
+        "requestId": {
+          "type": "string"
         },
         "outputs": {
           "type": "array",
           "items": {
             "type": "object",
             "$ref": "#/definitions/v1Output"
           },
-          "description": "List of receivers for a registered payment."
+          "description": "List of receivers for to convert to leaves in the next VTXO tree."
         }
       }
     },
@@ -1058,7 +1057,7 @@
         },
         "signedRoundTx": {
           "type": "string",
-          "description": "If payment has boarding input, the user must sign the associated inputs."
+          "description": "The user has to sign also the round tx if he registerd a boarding UTXO."
         }
       }
     },

api-spec/protobuf/ark/v1/service.proto

@@ -19,7 +19,7 @@ service ArkService {
     };
   };
 
-  /* In-Round Payment APIs */
+  /* In-Round Transaction APIs */
 
   rpc RegisterInputsForNextRound(RegisterInputsForNextRoundRequest) returns (RegisterInputsForNextRoundResponse) {
     option (google.api.http) = {
@@ -58,10 +58,12 @@ service ArkService {
   };
   rpc Ping(PingRequest) returns (PingResponse) {
     option (google.api.http) = {
-      get: "/v1/round/ping/{payment_id}"
+      get: "/v1/round/ping/{request_id}"
     };
   };
 
+  /* Out-of-Round Transaction APIs */
+
   rpc SubmitRedeemTx(SubmitRedeemTxRequest) returns (SubmitRedeemTxResponse) {
     option (google.api.http) = {
       post: "/v1/redeem-tx"
@@ -134,22 +136,20 @@ message GetBoardingAddressResponse {
   }
 }
 
-/* In-Round Payment API messages */
+/* In-Round Transaction API messages */
 
 message RegisterInputsForNextRoundRequest {
   repeated Input inputs = 1;
   optional string ephemeral_pubkey = 2;
   repeated string notes = 3;
 }
 message RegisterInputsForNextRoundResponse {
-  // Mocks wabisabi's blinded credentials.
-  string id = 1;
+  string request_id = 1;
 }
 
 message RegisterOutputsForNextRoundRequest {
-  // Mocks wabisabi's blinded credentials.
-  string id = 1;
-  // List of receivers for a registered payment. 
+  string request_id = 1;
+  // List of receivers for to convert to leaves in the next VTXO tree. 
   repeated Output outputs = 2;
 }
 message RegisterOutputsForNextRoundResponse {}
@@ -171,7 +171,7 @@ message SubmitTreeSignaturesResponse {}
 message SubmitSignedForfeitTxsRequest {
   // Forfeit txs signed by the user. 
   repeated string signed_forfeit_txs = 1;
-  // If payment has boarding input, the user must sign the associated inputs.
+  // The user has to sign also the round tx if he registerd a boarding UTXO.
   optional string signed_round_tx = 2;
 }
 message SubmitSignedForfeitTxsResponse {}
@@ -188,7 +188,8 @@ message GetEventStreamResponse {
 }
 
 message PingRequest {
-  string payment_id = 1;
+  // The id used to register inputs and ouptuts.
+  string request_id = 1;
 }
 message PingResponse {}
 
@@ -343,7 +344,7 @@ message RedeemTransaction {
   repeated Vtxo spendable_vtxos = 3;
 }
 
-// This message is used to prove to the ASP that the user controls the vtxo without revealing the whole VTXO taproot tree.
+// This message is used to prove to the server that the user controls the vtxo without revealing the whole VTXO taproot tree.
 message OwnershipProof {
   string control_block = 1;
   string script = 2;