Skip to content

PKI State Proof Incremental Key Loading #3281

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tsachiherman merged 21 commits into from
Jan 6, 2022
Merged

PKI State Proof Incremental Key Loading #3281

Show file tree
Hide file tree
Changes from 17 commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
6b348cb
WIP: append keys.
winder Nov 23, 2021
02fbb3d
Implement functions.
winder Nov 30, 2021
129e3a0
Add missing license header.
winder Nov 30, 2021
26d2afa
PR Feedback + another test.
winder Dec 1, 2021
3632133
Minor cleanup.
winder Dec 1, 2021
8ad0dd5
Rename GetWithRound to GetForRound.
winder Dec 3, 2021
7ae1cfc
AppendKeys endpoint placeholder.
winder Dec 1, 2021
f1a15d5
Update spec with consumes and correct body description.
winder Dec 2, 2021
ded5e57
WIP: writing some code and working on serialization.
winder Dec 3, 2021
e000ac8
Add a unit test.
winder Dec 3, 2021
1713416
Merge branch 'master' into will/pki-incremental-load-rest
winder Dec 8, 2021
aa81a00
make fmt
winder Dec 8, 2021
fb917bc
Add negative tests.
winder Dec 8, 2021
e41656a
Better invalid msgpack bytes.
winder Dec 8, 2021
f49aee3
fmt again
winder Dec 8, 2021
135f3e9
See if this fixes weird reviewdog warning.
winder Dec 8, 2021
36976d0
Cleanup test a little bit more...
winder Dec 8, 2021
12bebd5
id to ID
winder Dec 9, 2021
30008d2
Add missing PartitionTest call.
winder Dec 9, 2021
c62d6c0
Update summary
winder Dec 10, 2021
286dd60
Merge remote-tracking branch 'upstream/master' into will/pki-incremen…
winder Dec 17, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
78 changes: 76 additions & 2 deletions daemon/algod/api/algod.oas2.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -494,7 +494,7 @@
}
},
"404": {
"description": "Application Not Found",
"description": "Participation Key Not Found",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
Expand Down Expand Up @@ -553,6 +553,12 @@
"$ref": "#/definitions/ErrorResponse"
}
},
"404": {
"description": "Participation Key Not Found",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
},
"500": {
"description": "Internal Error",
"schema": {
Expand Down Expand Up @@ -601,6 +607,12 @@
"$ref": "#/definitions/ErrorResponse"
}
},
"404": {
"description": "Participation Key Not Found",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
},
"500": {
"description": "Internal Error",
"schema": {
Expand Down Expand Up @@ -643,7 +655,69 @@
}
},
"404": {
"description": "Application Not Found",
"description": "Participation Key Not Found",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
},
"500": {
"description": "Internal Error",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
},
"default": {
"description": "Unknown Error"
}
}
},
"post": {
"tags": [
"private"
],
"description": "Given a participation id, append state proof keys to a particular set of participation keys.",
"consumes": [
"application/msgpack"
],
"produces": [
"application/json"
],
"parameters": [
{
"description": "The state proof keys to add to an existing participation id",
"name": "keymap",
"in": "body",
"required": true,
"schema": {
"type": "string",
"format": "binary"
}
}
],
"schemes": [
"http"
],
"summary": "Append state proof keys to a participation key",
"operationId": "AppendKeys",
"responses": {
"200": {
"description": "OK",
"$ref": "#/responses/ParticipationKeyResponse"
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
},
"401": {
"description": "Invalid API Token",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
},
"404": {
"description": "Participation Key Not Found",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
Expand Down
111 changes: 109 additions & 2 deletions daemon/algod/api/algod.oas3.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2577,7 +2577,7 @@
}
}
},
"description": "Application Not Found"
"description": "Participation Key Not Found"
},
"500": {
"content": {
Expand Down Expand Up @@ -2653,6 +2653,16 @@
},
"description": "Invalid API Token"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Participation Key Not Found"
},
"500": {
"content": {
"application/json": {
Expand Down Expand Up @@ -2724,6 +2734,16 @@
},
"description": "Invalid API Token"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Participation Key Not Found"
},
"500": {
"content": {
"application/json": {
Expand Down Expand Up @@ -2796,7 +2816,7 @@
}
}
},
"description": "Application Not Found"
"description": "Participation Key Not Found"
},
"500": {
"content": {
Expand All @@ -2817,6 +2837,93 @@
"tags": [
"private"
]
},
"post": {
"description": "Given a participation id, append state proof keys to a particular set of participation keys.",

@tsachiherman tsachiherman Dec 8, 2021

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. id -> ID
  2. drop the "." at the end of the sentence ( just to align with the rest of the descriptions )

@winder winder Dec 9, 2021

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like the descriptions are almost equally divided! 158 with periods, 192 without. I'll save that exercise for another PR, there are probably other things that could make the verbiage more consistent in addition to punctuation.

"operationId": "AppendKeys",
"parameters": [
{
"in": "path",
"name": "participation-id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/msgpack": {
"schema": {
"format": "binary",
"type": "string"
}
}
},
"description": "The state proof keys to add to an existing participation id",
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ParticipationKey"
}
}
},
"description": "A detailed description of a participation id"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Invalid API Token"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Participation Key Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Internal Error"
},
"default": {
"content": {},
"description": "Unknown Error"
}
},
"summary": "Append state proof keys to a participation key",
"tags": [
"private"
],
"x-codegen-request-body-name": "keymap"
}
},
"/v2/shutdown": {
Expand Down
Loading