Skip to content
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

Jump to bottom

api: Txn Group Delta Apis #5350

Merged
merged 15 commits into from
May 9, 2023
Merged

api: Txn Group Delta Apis #5350

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
668a858
Initial commit
Eric-Warehime May 2, 2023
d8e8838
Fix method signature in handlers
Eric-Warehime May 2, 2023
0017c96
Omit empty fields in state delta responses
Eric-Warehime May 2, 2023
23fccf6
fix lint
Eric-Warehime May 2, 2023
b7b2fdf
Convert response types
Eric-Warehime May 2, 2023
2db1420
Add extra tests for sanity check
algochoi May 3, 2023
d05a904
Merge pull request #7 from algochoi/extra-tests
Eric-Warehime May 3, 2023
6f8e31a
Add mutex to txntracer
Eric-Warehime May 3, 2023
11aedb6
Fix mutex import
Eric-Warehime May 3, 2023
33081b4
Remove unused import
Eric-Warehime May 3, 2023
ce19350
Convert 503 to 501 response for nil tracer
Eric-Warehime May 3, 2023
7810c92
Update 501 response
Eric-Warehime May 5, 2023
f645671
Update daemon/algod/api/algod.oas2.json
Eric-Warehime May 8, 2023
fee1c2c
Merge remote-tracking branch 'upstream/master' into txn-group-delta-apis
Eric-Warehime May 8, 2023
6cb9322
Fix code gen
Eric-Warehime May 8, 2023
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
175 changes: 175 additions & 0 deletions daemon/algod/api/algod.oas2.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1534,6 +1534,146 @@
}
}
},
"/v2/deltas/{round}/txn/group": {
"get": {
"description": "Get ledger deltas for transaction groups in a given round.",
"tags": [
"public",
"data",
"experimental"
],
"produces": [
"application/json",
"application/msgpack"
],
"schemes": [
"http"
],
"summary": "Get LedgerStateDelta objects for all transaction groups in a given round",
"operationId": "GetTransactionGroupLedgerStateDeltasForRound",
"parameters": [
{
"type": "integer",
"description": "The round for which the deltas are desired.",
"name": "round",
"in": "path",
"required": true,
"minimum": 0
},
{
"$ref": "#/parameters/format"
}
],
"responses": {
"200": {
"$ref": "#/responses/TransactionGroupLedgerStateDeltaForRoundResponse"
},
"401": {
"description": "Invalid API Token",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
},
"404": {
"description": "Could not find deltas for round",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
},
"408": {
"description": "timed out on request",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
},
"500": {
"description": "Internal Error",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
},
"503": {
algochoi marked this conversation as resolved.
Show resolved Hide resolved
"description": "Service Temporarily Unavailable",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
},
"default": {
"description": "Unknown Error"
}
}
}
},
"/v2/deltas/txn/group/{id}": {
"get": {
"description": "Get ledger deltas for a given transaction group.",
algochoi marked this conversation as resolved.
Show resolved Hide resolved
"tags": [
"public",
"data",
"experimental"
],
"produces": [
"application/json",
"application/msgpack"
],
"schemes": [
"http"
],
"summary": "Get a LedgerStateDelta object for a given transaction group",
"operationId": "GetLedgerStateDeltaForTransactionGroup",
"parameters": [
{
"pattern": "[A-Z0-9]+",
"type": "string",
"description": "A transaction ID, or transaction group ID",
"name": "id",
"in": "path",
"required": true
},
{
"$ref": "#/parameters/format"
}
],
"responses": {
"200": {
"$ref": "#/responses/LedgerStateDeltaForTransactionGroupResponse"
},
"401": {
"description": "Invalid API Token",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
},
"404": {
"description": "Could not find a delta for Id",
algochoi marked this conversation as resolved.
Show resolved Hide resolved
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
},
"408": {
"description": "timed out on request",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
},
"500": {
"description": "Internal Error",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
},
"503": {
algochoi marked this conversation as resolved.
Show resolved Hide resolved
"description": "Service Temporarily Unavailable",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
},
"default": {
"description": "Unknown Error"
}
}
}
},
"/v2/stateproofs/{round}": {
"get": {
"tags": [
Expand Down Expand Up @@ -2520,6 +2660,26 @@
"type": "object",
"x-algorand-format": "StateDelta"
},
"LedgerStateDeltaForTransactionGroup": {
"description": "Contains ledger deltas for a single transaction group",
algochoi marked this conversation as resolved.
Show resolved Hide resolved
"type": "object",
"required": [
"delta",
"ids"
],
"properties": {
"delta": {
"$ref": "#/definitions/LedgerStateDelta"
},
"ids": {
"type": "array",
"items": {
"type": "string",
"x-algorand-format": "Address"
Eric-Warehime marked this conversation as resolved.
Show resolved Hide resolved
}
}
}
},
"Account": {
"description": "Account information at a given round.\n\nDefinition:\ndata/basics/userBalance.go : AccountData\n",
"type": "object",
Expand Down Expand Up @@ -3872,6 +4032,21 @@
}
}
},
"LedgerStateDeltaForTransactionGroupResponse": {
"description": "Response containing a ledger state delta for a single transaction group.",
"schema": {
"$ref": "#/definitions/LedgerStateDelta"
}
},
"TransactionGroupLedgerStateDeltaForRoundResponse": {
"description": "Response containing all ledger state deltas for transaction groups, with their associated Ids, in a single round.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/LedgerStateDeltaForTransactionGroup"
}
}
},
"LedgerStateDeltaResponse": {
"description": "Contains ledger deltas",
"schema": {
Expand Down
Loading