updated naming, allowance -> deposit and prepay -> deposit

primev · Apr 23, 2024 · a865180 · a865180
1 parent e4a8cc2
commit a865180
Show file tree

Hide file tree

Showing 19 changed files with 704 additions and 704 deletions.
diff --git a/gen/go/bidderapi/v1/bidderapi.pb.go b/gen/go/bidderapi/v1/bidderapi.pb.go
diff --git a/gen/go/bidderapi/v1/bidderapi.pb.gw.go b/gen/go/bidderapi/v1/bidderapi.pb.gw.go
diff --git a/gen/go/bidderapi/v1/bidderapi_grpc.pb.go b/gen/go/bidderapi/v1/bidderapi_grpc.pb.go
diff --git a/gen/openapi/bidderapi/v1/bidderapi.swagger.yaml b/gen/openapi/bidderapi/v1/bidderapi.swagger.yaml
@@ -37,73 +37,73 @@ paths:
           required: true
           schema:
             $ref: '#/definitions/bidderapiv1Bid'
-  /v1/bidder/get_allowance:
-    get:
-      summary: GetAllowance
-      description: GetAllowance is called by the bidder to get its allowance in the bidder registry.
-      operationId: Bidder_GetAllowance
+  /v1/bidder/deposit/{amount}:
+    post:
+      summary: Deposit
+      description: Deposit is called by the bidder node to add deposit in the bidder registry.
+      operationId: Bidder_Deposit
       responses:
         "200":
           description: A successful response.
           schema:
-            $ref: '#/definitions/v1PrepayResponse'
+            $ref: '#/definitions/v1DepositResponse'
         default:
           description: An unexpected error response.
           schema:
             $ref: '#/definitions/googlerpcStatus'
       parameters:
+        - name: amount
+          description: Amount of ETH to be deposited in wei.
+          in: path
+          required: true
+          type: string
         - name: windowNumber
-          description: Optional window number for querying allowances. If not specified, the current block number is used.
+          description: Optional window number for querying deposit. If not specified, the current block number is used.
           in: query
           required: false
           type: string
           format: uint64
-  /v1/bidder/get_min_allowance:
+        - name: blockNumber
+          description: Optional block number for querying deposit. If specified, calculate window based on this block number.
+          in: query
+          required: false
+          type: string
+          format: uint64
+  /v1/bidder/get_deposit:
     get:
-      summary: GetMinAllowance
-      description: GetMinAllowance is called by the bidder to get the minimum allowance required in the bidder registry to make bids.
-      operationId: Bidder_GetMinAllowance
+      summary: GetDeposit
+      description: GetDeposit is called by the bidder to get its deposit in the bidder registry.
+      operationId: Bidder_GetDeposit
       responses:
         "200":
           description: A successful response.
           schema:
-            $ref: '#/definitions/v1PrepayResponse'
+            $ref: '#/definitions/v1DepositResponse'
         default:
           description: An unexpected error response.
           schema:
             $ref: '#/definitions/googlerpcStatus'
-  /v1/bidder/prepay/{amount}:
-    post:
-      summary: PrepayAllowance
-      description: PrepayAllowance is called by the bidder node to add prepaid allowance in the bidder registry.
-      operationId: Bidder_PrepayAllowance
+      parameters:
+        - name: windowNumber
+          description: Optional window number for querying deposits. If not specified, the current block number is used.
+          in: query
+          required: false
+          type: string
+          format: uint64
+  /v1/bidder/get_min_deposit:
+    get:
+      summary: GetMinDeposit
+      description: GetMinDeposit is called by the bidder to get the minimum deposit required in the bidder registry to make bids.
+      operationId: Bidder_GetMinDeposit
       responses:
         "200":
           description: A successful response.
           schema:
-            $ref: '#/definitions/v1PrepayResponse'
+            $ref: '#/definitions/v1DepositResponse'
         default:
           description: An unexpected error response.
           schema:
             $ref: '#/definitions/googlerpcStatus'
-      parameters:
-        - name: amount
-          description: Amount of ETH to be prepaid in wei.
-          in: path
-          required: true
-          type: string
-        - name: windowNumber
-          description: Optional window number for querying allowances. If not specified, the current block number is used.
-          in: query
-          required: false
-          type: string
-          format: uint64
-        - name: blockNumber
-          description: Optional block number for querying allowance. If specified, calculate window based on this block number.
-          in: query
-          required: false
-          type: string
-          format: uint64
 definitions:
   bidderapiv1Bid:
     type: object
@@ -200,7 +200,7 @@ definitions:
         type: string
         format: int64
         description: Timestamp at which the bid ends decaying.
-  v1PrepayResponse:
+  v1DepositResponse:
     type: object
     example:
       amount: "1000000000000000000"
@@ -211,5 +211,5 @@ definitions:
       windowNumber:
         type: string
         format: uint64
-    description: Get prepaid allowance for bidder in the bidder registry.
-    title: Prepay response
+    description: Get deposit for bidder in the bidder registry.
+    title: Deposit response
diff --git a/go.mod b/go.mod
@@ -13,7 +13,7 @@ require (
 	github.com/libp2p/go-msgio v0.3.0
 	github.com/multiformats/go-multiaddr v0.12.2
 	github.com/multiformats/go-multiaddr-dns v0.3.1
-	github.com/primevprotocol/contracts-abi v0.2.4-0.20240419134844-6dd1a8c7bf60
+	github.com/primevprotocol/contracts-abi v0.2.4-0.20240423171419-a959d3727058
 	github.com/prometheus/client_golang v1.18.0
 	github.com/stretchr/testify v1.8.4
 	github.com/urfave/cli/v2 v2.27.1

diff --git a/go.sum b/go.sum
@@ -350,6 +350,8 @@ github.com/primevprotocol/contracts-abi v0.2.4-0.20240418181518-36932433f9a8 h1:
 github.com/primevprotocol/contracts-abi v0.2.4-0.20240418181518-36932433f9a8/go.mod h1:dE2KkvEqC+itvPa3SCrqQfvH5Hfnfn6omNRwWDTdIp8=
 github.com/primevprotocol/contracts-abi v0.2.4-0.20240419134844-6dd1a8c7bf60 h1:FEYkczFrI/CwTZRm0wARuWshpn185BEw4uFAKxlqQBg=
 github.com/primevprotocol/contracts-abi v0.2.4-0.20240419134844-6dd1a8c7bf60/go.mod h1:dE2KkvEqC+itvPa3SCrqQfvH5Hfnfn6omNRwWDTdIp8=
+github.com/primevprotocol/contracts-abi v0.2.4-0.20240423171419-a959d3727058 h1:IG9XeHGs8/S9tW/4dfLosOa6NL0LGODp+FvWVIWNIBE=
+github.com/primevprotocol/contracts-abi v0.2.4-0.20240423171419-a959d3727058/go.mod h1:dE2KkvEqC+itvPa3SCrqQfvH5Hfnfn6omNRwWDTdIp8=
 github.com/prometheus/client_golang v0.8.0/go.mod h1:7SWBe2y4D6OKWSNQJUaRYU/AaXPKyh/dDVn+NZz0KFw=
 github.com/prometheus/client_golang v1.18.0 h1:HzFfmkOzH5Q8L8G+kSJKUx5dtG87sewO+FoDDqP5Tbk=
 github.com/prometheus/client_golang v1.18.0/go.mod h1:T+GXkCk5wSJyOqMIzVgvvjFDlkOQntgjkJWKrN5txjA=