Skip to content
This repository was archived by the owner on May 11, 2024. It is now read-only.

Commit 526447a

Browse files
davidtaikochadavidtaikocha
authored
Merge branch 'main' into fix/golangci-lint_1
2 parents 8aa8d22 + 9ce7d96 commit 526447a

File tree

5 files changed

+27
-28
lines changed

5 files changed

+27
-28
lines changed

‎docs/docs.go

+9-9
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ const docTemplate = `{
1919
"name": "MIT",
2020
"url": "https://github.com/taikoxyz/taiko-client/blob/main/LICENSE.md"
2121
},
22-
"version": "{{.JsonRPC}}"
22+
"version": "{{.Version}}"
2323
},
2424
"host": "{{.Host}}",
2525
"basePath": "{{.BasePath}}",
@@ -40,15 +40,15 @@ const docTemplate = `{
4040
"in": "body",
4141
"required": true,
4242
"schema": {
43-
"$ref": "#/definitions/prover_server.CreateAssignmentRequestBody"
43+
"$ref": "#/definitions/server.CreateAssignmentRequestBody"
4444
}
4545
}
4646
],
4747
"responses": {
4848
"200": {
4949
"description": "OK",
5050
"schema": {
51-
"$ref": "#/definitions/prover_server.ProposeBlockResponse"
51+
"$ref": "#/definitions/server.ProposeBlockResponse"
5252
}
5353
},
5454
"422": {
@@ -74,7 +74,7 @@ const docTemplate = `{
7474
"200": {
7575
"description": "OK",
7676
"schema": {
77-
"$ref": "#/definitions/prover_server.Status"
77+
"$ref": "#/definitions/server.Status"
7878
}
7979
}
8080
}
@@ -85,7 +85,7 @@ const docTemplate = `{
8585
"big.Int": {
8686
"type": "object"
8787
},
88-
"github_com_taikoxyz_taiko-client_bindings_encoding.TierFee": {
88+
"encoding.TierFee": {
8989
"type": "object",
9090
"properties": {
9191
"fee": {
@@ -96,7 +96,7 @@ const docTemplate = `{
9696
}
9797
}
9898
},
99-
"prover_server.CreateAssignmentRequestBody": {
99+
"server.CreateAssignmentRequestBody": {
100100
"type": "object",
101101
"properties": {
102102
"expiry": {
@@ -108,7 +108,7 @@ const docTemplate = `{
108108
"tierFees": {
109109
"type": "array",
110110
"items": {
111-
"$ref": "#/definitions/github_com_taikoxyz_taiko-client_bindings_encoding.TierFee"
111+
"$ref": "#/definitions/encoding.TierFee"
112112
}
113113
},
114114
"txListHash": {
@@ -119,7 +119,7 @@ const docTemplate = `{
119119
}
120120
}
121121
},
122-
"prover_server.ProposeBlockResponse": {
122+
"server.ProposeBlockResponse": {
123123
"type": "object",
124124
"properties": {
125125
"maxBlockID": {
@@ -139,7 +139,7 @@ const docTemplate = `{
139139
}
140140
}
141141
},
142-
"prover_server.Status": {
142+
"server.Status": {
143143
"type": "object",
144144
"properties": {
145145
"maxExpiry": {

‎docs/swagger.json

+8-8
Original file line numberDiff line numberDiff line change
@@ -31,15 +31,15 @@
3131
"in": "body",
3232
"required": true,
3333
"schema": {
34-
"$ref": "#/definitions/prover_server.CreateAssignmentRequestBody"
34+
"$ref": "#/definitions/server.CreateAssignmentRequestBody"
3535
}
3636
}
3737
],
3838
"responses": {
3939
"200": {
4040
"description": "OK",
4141
"schema": {
42-
"$ref": "#/definitions/prover_server.ProposeBlockResponse"
42+
"$ref": "#/definitions/server.ProposeBlockResponse"
4343
}
4444
},
4545
"422": {
@@ -65,7 +65,7 @@
6565
"200": {
6666
"description": "OK",
6767
"schema": {
68-
"$ref": "#/definitions/prover_server.Status"
68+
"$ref": "#/definitions/server.Status"
6969
}
7070
}
7171
}
@@ -76,7 +76,7 @@
7676
"big.Int": {
7777
"type": "object"
7878
},
79-
"github_com_taikoxyz_taiko-client_bindings_encoding.TierFee": {
79+
"encoding.TierFee": {
8080
"type": "object",
8181
"properties": {
8282
"fee": {
@@ -87,7 +87,7 @@
8787
}
8888
}
8989
},
90-
"prover_server.CreateAssignmentRequestBody": {
90+
"server.CreateAssignmentRequestBody": {
9191
"type": "object",
9292
"properties": {
9393
"expiry": {
@@ -99,7 +99,7 @@
9999
"tierFees": {
100100
"type": "array",
101101
"items": {
102-
"$ref": "#/definitions/github_com_taikoxyz_taiko-client_bindings_encoding.TierFee"
102+
"$ref": "#/definitions/encoding.TierFee"
103103
}
104104
},
105105
"txListHash": {
@@ -110,7 +110,7 @@
110110
}
111111
}
112112
},
113-
"prover_server.ProposeBlockResponse": {
113+
"server.ProposeBlockResponse": {
114114
"type": "object",
115115
"properties": {
116116
"maxBlockID": {
@@ -130,7 +130,7 @@
130130
}
131131
}
132132
},
133-
"prover_server.Status": {
133+
"server.Status": {
134134
"type": "object",
135135
"properties": {
136136
"maxExpiry": {

‎docs/swagger.yaml

+8-8
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,29 @@
11
definitions:
22
big.Int:
33
type: object
4-
github_com_taikoxyz_taiko-client_bindings_encoding.TierFee:
4+
encoding.TierFee:
55
properties:
66
fee:
77
$ref: '#/definitions/big.Int'
88
tier:
99
type: integer
1010
type: object
11-
prover_server.CreateAssignmentRequestBody:
11+
server.CreateAssignmentRequestBody:
1212
properties:
1313
expiry:
1414
type: integer
1515
feeToken:
1616
type: string
1717
tierFees:
1818
items:
19-
$ref: '#/definitions/github_com_taikoxyz_taiko-client_bindings_encoding.TierFee'
19+
$ref: '#/definitions/encoding.TierFee'
2020
type: array
2121
txListHash:
2222
items:
2323
type: integer
2424
type: array
2525
type: object
26-
prover_server.ProposeBlockResponse:
26+
server.ProposeBlockResponse:
2727
properties:
2828
maxBlockID:
2929
type: integer
@@ -36,7 +36,7 @@ definitions:
3636
type: integer
3737
type: array
3838
type: object
39-
prover_server.Status:
39+
server.Status:
4040
properties:
4141
maxExpiry:
4242
type: integer
@@ -71,14 +71,14 @@ paths:
7171
name: body
7272
required: true
7373
schema:
74-
$ref: '#/definitions/prover_server.CreateAssignmentRequestBody'
74+
$ref: '#/definitions/server.CreateAssignmentRequestBody'
7575
produces:
7676
- application/json
7777
responses:
7878
"200":
7979
description: OK
8080
schema:
81-
$ref: '#/definitions/prover_server.ProposeBlockResponse'
81+
$ref: '#/definitions/server.ProposeBlockResponse'
8282
"422":
8383
description: prover does not have capacity
8484
schema:
@@ -95,6 +95,6 @@ paths:
9595
"200":
9696
description: OK
9797
schema:
98-
$ref: '#/definitions/prover_server.Status'
98+
$ref: '#/definitions/server.Status'
9999
summary: Get current prover server status
100100
swagger: "2.0"

‎prover/server/server.go

+1-2
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ import (
1818
"github.com/taikoxyz/taiko-client/pkg/rpc"
1919
)
2020

21-
// @title Taiko Prover API
21+
// @title Taiko Prover Server API
2222
// @version 1.0
2323
// @termsOfService http://swagger.io/terms/
2424

@@ -29,7 +29,6 @@ import (
2929
// @license.name MIT
3030
// @license.url https://github.com/taikoxyz/taiko-client/blob/main/LICENSE.md
3131

32-
// @host prover-api.test.taiko.xyz
3332
// ProverServer represents a prover server instance.
3433
type ProverServer struct {
3534
echo *echo.Echo

‎scripts/gen_swagger_json.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
#/bin/sh
22

3-
swag init -g prover/server/api.go --parseDependency --parseGoList
3+
swag init -g api.go -d prover/server --pd

0 commit comments

Comments
 (0)