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

Add data-test.sh #26

Draft
wants to merge 15 commits into
base: main
Choose a base branch
from
Draft

Add data-test.sh #26

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
86b31af
Add data-test.sh
dostrelith678 Apr 6, 2022
6b8fd8d
Schema fix for nullable epoch_params
dostrelith678 Apr 25, 2022
dc1efa3
Merge branch 'main' into data-test-haproxy
rdlrt Apr 28, 2022
b4d52c1
Add trusted instance determination + improvements
dostrelith678 May 9, 2022
e678578
Disable full traceback
dostrelith678 May 9, 2022
1136a90
Change haproxy server_state commands
dostrelith678 May 9, 2022
8baeb9b
Merge branch 'main' into data-test-haproxy
rdlrt May 9, 2022
797e4d5
Merge branch 'main' into data-test-haproxy
dostrelith678 May 27, 2022
6815170
Merge branch 'main' into data-test-haproxy
rdlrt Jun 23, 2022
56b88a0
Merge branch 'main' into data-test-haproxy
rdlrt Jul 6, 2022
138c7df
Merge branch 'main' into data-test-haproxy
dostrelith678 Jul 6, 2022
f77c1dd
Delete specs/results/koiosapi-testnet.yaml
rdlrt Nov 2, 2023
2929cff
Merge branch 'main' into data-test-haproxy
rdlrt Nov 2, 2023
8f7d044
Fix specs for ogmios providing an example alongwith list of methods s…
rdlrt Nov 3, 2023
4e7862a
Merge branch 'main' into data-test-haproxy
rdlrt Nov 3, 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
137 changes: 108 additions & 29 deletions specs/results/koiosapi-guild.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1584,43 +1584,30 @@ paths:
$ref: "#/components/responses/NotFound"
summary: Datum Information
description: List of datum information for given datum hashes
/ogmios/?EvaluateTransaction: #ogmios-api
/ogmios/: #ogmios-api
post:
tags:
- Ogmios
x-code-samples:
- lang: "Shell"
source: |
# Assuming ${data} contains EvaluateTransaction payload as documented on Ogmios v6 site.
curl -X POST \
--header "Content-Type: application/cbor" \
--data-binary ${data} https://api.koios.rest/api/ogmios/?EvaluateTransaction
requestBody:
$ref: "#/components/requestBodies/ogmios"
responses:
"200":
description: OK
description: Current tip of the chain, identified by a slot and a block header hash.
content:
application/json:
schema:
$ref: "#/components/schemas/ogmiostip"
"400":
description: An error occured while submitting transaction.
summary: Evaluate Transaction
description: Evaluate execution units of scripts in a well-formed transaction. Please refer to Ogmios documentation [here](https://ogmios.dev/api/#operation-publish-/?EvaluateTransaction) for complete spec
/ogmios/?SubmitTransaction: #ogmios-api
post:
tags:
- Ogmios
x-code-samples:
- lang: "Shell"
source: |
# Assuming ${data} contains a CBOR-serialized signed transaction (base16-encoded) as documented on Ogmios v6 site.
curl -X POST \
--header "Content-Type: application/cbor" \
--data-binary ${data} https://api.koios.rest/api/ogmios/?SubmitTransaction
responses:
"200":
description: OK
"400":
description: An error occured while querying transaction.
summary: Submit Transaction
description: Submit a signed and serialized transaction to the network. Please refer to Ogmios documentation [here](https://ogmios.dev/api/#operation-publish-/?SubmitTransaction) for complete spec
summary: Query Example
description: |
Query the current tip of the Network.

<br>
<div style="background-color: #222; padding: 12px 0px 12px 12px;border-left: 5px solid rgb(173, 44, 44);font-size: var(--font-size-regular);">
We do support transparent forwarding for various methods from Ogmios, you can read about those <a href="#tag--Ogmios">here</a>.
</div>

components:
parameters:
select:
Expand Down Expand Up @@ -2257,6 +2244,43 @@ components:
- f82e568d42604fd71424d193c86ec00c97aead2b8f018e81c3139d9e3770c735#0
- 88ae22495123c7ee37a0bbe865243757185a302ed5359d1eae9347030628290a#0
_extended: false
ogmios:
content:
application/json:
schema:
required:
- jsonrpc
- method
type: object
properties:
jsonrpc:
format: text
type: string
description: Identifier for JSON-RPC 2.0 standard
example: "2.0"
method:
format: text
type: string
description: The Ogmios method to be called (see more details [here](#tag--Ogmios))
enum:
- "queryNetwork/blockHeight"
- "queryNetwork/genesisConfiguration"
- "queryNetwork/startTime"
- "queryNetwork/tip"
- "queryLedgerState/epoch"
- "queryLedgerState/eraStart"
- "queryLedgerState/eraSummaries"
- "queryLedgerState/liveStakeDistribution"
- "queryLedgerState/protocolParameters"
- "queryLedgerState/proposedProtocolParameters"
- "queryLedgerState/stakePools"
- "submitTransaction"
- "evaluateTransaction"
example: "queryNetwork/tip"
params:
type: object
description: Any parameters relevant to the specific method to be called
nullable: true
securitySchemes:
bearerAuth:
type: http
Expand Down Expand Up @@ -2868,6 +2892,7 @@ components:
nullable: true
epoch_params:
type: array
description: Epoch parameters (all fields nullable for pre-Shelley/Gougen epochs except first block hash)
items:
properties:
epoch_no:
Expand Down Expand Up @@ -4152,6 +4177,31 @@ components:
$ref: "#/components/schemas/script_info/items/properties/value"
bytes:
$ref: "#/components/schemas/script_info/items/properties/bytes"
ogmiostip:
type: object
properties:
jsonrpc:
format: text
type: string
description: Identifier for JSON-RPC 2.0 standard
example: "2.0"
method:
format: text
type: string
description: The Ogmios method that was called in the request
example: "queryNetwork/tip"
result:
type: object
description: Result of the query
properties:
slot:
type: number
description: Absolute slot number on chain
example: 59886800
id:
type: string
description: Block Hash (Blake2b 32-byte hash digest, encoded in base16)
example: "df5678c9774b7bc8c60a4c83b63c3676e618640ad05f7d1ee775b68939cf77d1"
headers: {}
responses:
OK:
Expand Down Expand Up @@ -4192,5 +4242,34 @@ tags:
- name: Script
description: Query information about specific scripts (Smart Contracts)
x-tag-expanded: false
- name: Ogmios
description: |
Various stateless queries against Ogmios v6 instance. Please note that ogmios follows JSON-RPC 2.0 method, the example spec on koios.rest is *ONLY* for `queryNetwork/tip`,
but all the methods listed below are all accepted. Instead of duplicating specs, we would refer you directly to Ogmios documentation [here](https://ogmios.dev/api) for complete specs.

<br>
<div style="background-color: #222; padding: 12px 0px 12px 12px;border-left: 5px solid rgb(173, 44, 44);font-size: var(--font-size-regular);">
Note that for queries to be stateless across instances on the globe, we cannot acquire local state as successive calls will be across different instances. Also, we'd want to avoid getting an instance DDoS'd with large queries.
Thus, we will only expose the following methods from monitoring servers, instance providers can expose entire ogmios endpoints if desirable:
</div>


### Network
- [queryNetwork/blockHeight](https://ogmios.dev/api/#operation-publish-/?QueryNetworkBlockHeight)
- [queryNetwork/genesisConfiguration](https://ogmios.dev/api/#operation-publish-/?QueryNetworkGenesisConfiguration)
- [queryNetwork/startTime](https://ogmios.dev/api/#operation-publish-/?QueryNetworkStartTime)
- [queryNetwork/tip](https://ogmios.dev/api/#operation-publish-/?QueryNetworkTip)
### Ledger-State
- [queryLedgerState/epoch](https://ogmios.dev/api/#operation-publish-/?QueryLedgerStateEpoch)
- [queryLedgerState/eraStart](https://ogmios.dev/api/#operation-publish-/?QueryLedgerStateEraStart)
- [queryLedgerState/eraSummaries](https://ogmios.dev/api/#operation-publish-/?QueryLedgerStateEraSummaries)
- [queryLedgerState/liveStakeDistribution](https://ogmios.dev/api/#operation-publish-/?QueryLedgerStateLiveStakeDistribution)
- [queryLedgerState/protocolParameters](https://ogmios.dev/api/#operation-publish-/?QueryLedgerStateProtocolParameters)
- [queryLedgerState/proposedProtocolParameters](https://ogmios.dev/api/#operation-publish-/?QueryLedgerStateProposedProtocolParameters)
- [queryLedgerState/stakePools](https://ogmios.dev/api/#operation-publish-/?QueryLedgerStateStakePools)
### Transactions
- [submitTransaction](https://ogmios.dev/mini-protocols/local-tx-submission/#submitting-transactions)
- [evaluateTransaction](https://ogmios.dev/mini-protocols/local-tx-submission/#evaluating-transactions)
x-tag-expanded: true
security:
- bearerAuth: []
137 changes: 108 additions & 29 deletions specs/results/koiosapi-mainnet.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1584,43 +1584,30 @@ paths:
$ref: "#/components/responses/NotFound"
summary: Datum Information
description: List of datum information for given datum hashes
/ogmios/?EvaluateTransaction: #ogmios-api
/ogmios/: #ogmios-api
post:
tags:
- Ogmios
x-code-samples:
- lang: "Shell"
source: |
# Assuming ${data} contains EvaluateTransaction payload as documented on Ogmios v6 site.
curl -X POST \
--header "Content-Type: application/cbor" \
--data-binary ${data} https://api.koios.rest/api/ogmios/?EvaluateTransaction
requestBody:
$ref: "#/components/requestBodies/ogmios"
responses:
"200":
description: OK
description: Current tip of the chain, identified by a slot and a block header hash.
content:
application/json:
schema:
$ref: "#/components/schemas/ogmiostip"
"400":
description: An error occured while submitting transaction.
summary: Evaluate Transaction
description: Evaluate execution units of scripts in a well-formed transaction. Please refer to Ogmios documentation [here](https://ogmios.dev/api/#operation-publish-/?EvaluateTransaction) for complete spec
/ogmios/?SubmitTransaction: #ogmios-api
post:
tags:
- Ogmios
x-code-samples:
- lang: "Shell"
source: |
# Assuming ${data} contains a CBOR-serialized signed transaction (base16-encoded) as documented on Ogmios v6 site.
curl -X POST \
--header "Content-Type: application/cbor" \
--data-binary ${data} https://api.koios.rest/api/ogmios/?SubmitTransaction
responses:
"200":
description: OK
"400":
description: An error occured while querying transaction.
summary: Submit Transaction
description: Submit a signed and serialized transaction to the network. Please refer to Ogmios documentation [here](https://ogmios.dev/api/#operation-publish-/?SubmitTransaction) for complete spec
summary: Query Example
description: |
Query the current tip of the Network.

<br>
<div style="background-color: #222; padding: 12px 0px 12px 12px;border-left: 5px solid rgb(173, 44, 44);font-size: var(--font-size-regular);">
We do support transparent forwarding for various methods from Ogmios, you can read about those <a href="#tag--Ogmios">here</a>.
</div>

components:
parameters:
select:
Expand Down Expand Up @@ -2257,6 +2244,43 @@ components:
- f144a8264acf4bdfe2e1241170969c930d64ab6b0996a4a45237b623f1dd670e#0
- 0b8ba3bed976fa4913f19adc9f6dd9063138db5b4dd29cecde369456b5155e94#0
_extended: false
ogmios:
content:
application/json:
schema:
required:
- jsonrpc
- method
type: object
properties:
jsonrpc:
format: text
type: string
description: Identifier for JSON-RPC 2.0 standard
example: "2.0"
method:
format: text
type: string
description: The Ogmios method to be called (see more details [here](#tag--Ogmios))
enum:
- "queryNetwork/blockHeight"
- "queryNetwork/genesisConfiguration"
- "queryNetwork/startTime"
- "queryNetwork/tip"
- "queryLedgerState/epoch"
- "queryLedgerState/eraStart"
- "queryLedgerState/eraSummaries"
- "queryLedgerState/liveStakeDistribution"
- "queryLedgerState/protocolParameters"
- "queryLedgerState/proposedProtocolParameters"
- "queryLedgerState/stakePools"
- "submitTransaction"
- "evaluateTransaction"
example: "queryNetwork/tip"
params:
type: object
description: Any parameters relevant to the specific method to be called
nullable: true
securitySchemes:
bearerAuth:
type: http
Expand Down Expand Up @@ -2868,6 +2892,7 @@ components:
nullable: true
epoch_params:
type: array
description: Epoch parameters (all fields nullable for pre-Shelley/Gougen epochs except first block hash)
items:
properties:
epoch_no:
Expand Down Expand Up @@ -4152,6 +4177,31 @@ components:
$ref: "#/components/schemas/script_info/items/properties/value"
bytes:
$ref: "#/components/schemas/script_info/items/properties/bytes"
ogmiostip:
type: object
properties:
jsonrpc:
format: text
type: string
description: Identifier for JSON-RPC 2.0 standard
example: "2.0"
method:
format: text
type: string
description: The Ogmios method that was called in the request
example: "queryNetwork/tip"
result:
type: object
description: Result of the query
properties:
slot:
type: number
description: Absolute slot number on chain
example: 59886800
id:
type: string
description: Block Hash (Blake2b 32-byte hash digest, encoded in base16)
example: "df5678c9774b7bc8c60a4c83b63c3676e618640ad05f7d1ee775b68939cf77d1"
headers: {}
responses:
OK:
Expand Down Expand Up @@ -4192,5 +4242,34 @@ tags:
- name: Script
description: Query information about specific scripts (Smart Contracts)
x-tag-expanded: false
- name: Ogmios
description: |
Various stateless queries against Ogmios v6 instance. Please note that ogmios follows JSON-RPC 2.0 method, the example spec on koios.rest is *ONLY* for `queryNetwork/tip`,
but all the methods listed below are all accepted. Instead of duplicating specs, we would refer you directly to Ogmios documentation [here](https://ogmios.dev/api) for complete specs.

<br>
<div style="background-color: #222; padding: 12px 0px 12px 12px;border-left: 5px solid rgb(173, 44, 44);font-size: var(--font-size-regular);">
Note that for queries to be stateless across instances on the globe, we cannot acquire local state as successive calls will be across different instances. Also, we'd want to avoid getting an instance DDoS'd with large queries.
Thus, we will only expose the following methods from monitoring servers, instance providers can expose entire ogmios endpoints if desirable:
</div>


### Network
- [queryNetwork/blockHeight](https://ogmios.dev/api/#operation-publish-/?QueryNetworkBlockHeight)
- [queryNetwork/genesisConfiguration](https://ogmios.dev/api/#operation-publish-/?QueryNetworkGenesisConfiguration)
- [queryNetwork/startTime](https://ogmios.dev/api/#operation-publish-/?QueryNetworkStartTime)
- [queryNetwork/tip](https://ogmios.dev/api/#operation-publish-/?QueryNetworkTip)
### Ledger-State
- [queryLedgerState/epoch](https://ogmios.dev/api/#operation-publish-/?QueryLedgerStateEpoch)
- [queryLedgerState/eraStart](https://ogmios.dev/api/#operation-publish-/?QueryLedgerStateEraStart)
- [queryLedgerState/eraSummaries](https://ogmios.dev/api/#operation-publish-/?QueryLedgerStateEraSummaries)
- [queryLedgerState/liveStakeDistribution](https://ogmios.dev/api/#operation-publish-/?QueryLedgerStateLiveStakeDistribution)
- [queryLedgerState/protocolParameters](https://ogmios.dev/api/#operation-publish-/?QueryLedgerStateProtocolParameters)
- [queryLedgerState/proposedProtocolParameters](https://ogmios.dev/api/#operation-publish-/?QueryLedgerStateProposedProtocolParameters)
- [queryLedgerState/stakePools](https://ogmios.dev/api/#operation-publish-/?QueryLedgerStateStakePools)
### Transactions
- [submitTransaction](https://ogmios.dev/mini-protocols/local-tx-submission/#submitting-transactions)
- [evaluateTransaction](https://ogmios.dev/mini-protocols/local-tx-submission/#evaluating-transactions)
x-tag-expanded: true
security:
- bearerAuth: []
Loading
Loading