Skip to content

Commit 129bf77

Browse files
author
Sentio Bot
committed
chore: update
1 parent cd30801 commit 129bf77

File tree

4 files changed

+53
-26
lines changed

4 files changed

+53
-26
lines changed

doc/index.html

Lines changed: 29 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4720,7 +4720,10 @@ <h1>executeSQL</h1>
47204720
<div class="pull-right"></div>
47214721
<div class="clearfix"></div>
47224722
<p></p>
4723-
<p class="marked">Execute SQL in a project.
4723+
<p class="marked">Execute SQL in a project. Go to &quot;Data Studio&quot; -&gt; &quot;SQL Editor&quot;, write your query and then click &quot;Export as cURL&quot;
4724+
4725+
![screenshot](https://raw.githubusercontent.com/sentioxyz/docs/main/.gitbook/assets/image%20(102).png)
4726+
47244727
Find more: https://docs.sentio.xyz/docs/data-api#sql-api</p>
47254728
<p></p>
47264729
<br />
@@ -5221,7 +5224,10 @@ <h1>executeSQL2</h1>
52215224
<div class="pull-right"></div>
52225225
<div class="clearfix"></div>
52235226
<p></p>
5224-
<p class="marked">Execute SQL in a project.
5227+
<p class="marked">Execute SQL in a project. Go to &quot;Data Studio&quot; -&gt; &quot;SQL Editor&quot;, write your query and then click &quot;Export as cURL&quot;
5228+
5229+
![screenshot](https://raw.githubusercontent.com/sentioxyz/docs/main/.gitbook/assets/image%20(102).png)
5230+
52255231
Find more: https://docs.sentio.xyz/docs/data-api#sql-api</p>
52265232
<p></p>
52275233
<br />
@@ -7782,7 +7788,9 @@ <h1>observabilityServiceQueryRange</h1>
77827788
<div class="pull-right"></div>
77837789
<div class="clearfix"></div>
77847790
<p></p>
7785-
<p class="marked"></p>
7791+
<p class="marked">The easiest way to build query is through UI, you could first create an insight chart, and then **Export as cURL**.
7792+
7793+
![screenshot](https://raw.githubusercontent.com/sentioxyz/docs/main/.gitbook/assets/image%20(101).png)</p>
77867794
<p></p>
77877795
<br />
77887796
<pre class="prettyprint language-html prettyprinted" data-type="post"><code><span class="pln">/api/v1/metrics/{owner}/{slug}/query_range</span></code></pre>
@@ -11570,7 +11578,13 @@ <h1>getCallTrace</h1>
1157011578
<div class="pull-right"></div>
1157111579
<div class="clearfix"></div>
1157211580
<p></p>
11573-
<p class="marked"></p>
11581+
<p class="marked">API to get Sentio call trace. It takes &#x60;txId.txHash&#x60; and &#x60;networkId&#x60; arguments, where the first is transaction hash, and the second is the numeric ethereum chain ID.
11582+
11583+
The results looks very similar to the normal [Ethereum call trace](https://raw.githubusercontent.com/sentioxyz/docs/main/.gitbook/assets/image%20(2)%20(1)%20(1)%20(1).png). But we have an additional &#x60;startIndex&#x60; and &#x60;startIndex&#x60; on each trace entry even for the LOG, representing the execution order in the trace.
11584+
11585+
This allows you to build chart that marks the order of fund flow.
11586+
11587+
![screenshot](https://raw.githubusercontent.com/sentioxyz/docs/main/.gitbook/assets/image%20(2)%20(1)%20(1)%20(1).png)</p>
1157411588
<p></p>
1157511589
<br />
1157611590
<pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/api/v1/solidity/call_trace</span></code></pre>
@@ -14423,12 +14437,13 @@ <h3 id="examples-DebugAndSimulation-searchTransactions-title-200"></h3>
1442314437
<article id="api-DebugAndSimulation-simulateTransaction-0" data-group="User" data-name="simulateTransaction" data-version="0">
1442414438
<div class="pull-left">
1442514439
<h1>simulateTransaction</h1>
14426-
<p>Create a new transaction simulation</p>
14440+
<p>Single simulation</p>
1442714441
</div>
1442814442
<div class="pull-right"></div>
1442914443
<div class="clearfix"></div>
1443014444
<p></p>
14431-
<p class="marked"></p>
14445+
<p class="marked">Create a new transaction simulation. The simulation body should be included in the request body.
14446+
Your simulations will be saved, and a unique ID for each simulation is included in the response. It will be useful for fetching simulation details.</p>
1443214447
<p></p>
1443314448
<br />
1443414449
<pre class="prettyprint language-html prettyprinted" data-type="post"><code><span class="pln">/api/v1/solidity/simulate</span></code></pre>
@@ -14548,7 +14563,7 @@ <h3>Usage and SDK Samples</h3>
1454814563
DebugAndSimulationApi *apiInstance = [[DebugAndSimulationApi alloc] init];
1454914564
SolidityServiceSimulateTransactionRequest *body = ; //
1455014565

14551-
// Create a new transaction simulation
14566+
// Single simulation
1455214567
[apiInstance simulateTransactionWith:body
1455314568
completionHandler: ^(solidity_service.SimulateTransactionResponse output, NSError* error) {
1455414569
if (output) {
@@ -14612,7 +14627,7 @@ <h3>Usage and SDK Samples</h3>
1461214627
var body = new SolidityServiceSimulateTransactionRequest(); // SolidityServiceSimulateTransactionRequest |
1461314628

1461414629
try {
14615-
// Create a new transaction simulation
14630+
// Single simulation
1461614631
solidity_service.SimulateTransactionResponse result = apiInstance.simulateTransaction(body);
1461714632
Debug.WriteLine(result);
1461814633
} catch (Exception e) {
@@ -14686,7 +14701,7 @@ <h3>Usage and SDK Samples</h3>
1468614701
body = # SolidityServiceSimulateTransactionRequest |
1468714702

1468814703
try:
14689-
# Create a new transaction simulation
14704+
# Single simulation
1469014705
api_response = api_instance.simulate_transaction(body)
1469114706
pprint(api_response)
1469214707
except ApiException as e:
@@ -14848,12 +14863,12 @@ <h3 id="examples-DebugAndSimulation-simulateTransaction-title-200"></h3>
1484814863
<article id="api-DebugAndSimulation-simulateTransactionBundle-0" data-group="User" data-name="simulateTransactionBundle" data-version="0">
1484914864
<div class="pull-left">
1485014865
<h1>simulateTransactionBundle</h1>
14851-
<p>Create a new bundle simulation</p>
14866+
<p>Bundle simulation</p>
1485214867
</div>
1485314868
<div class="pull-right"></div>
1485414869
<div class="clearfix"></div>
1485514870
<p></p>
14856-
<p class="marked"></p>
14871+
<p class="marked">You could also create bundle simulations so that one transaction could be executed one after another. For &#x60;blockNumber&#x60; &#x60;transactionIndex&#x60; &#x60;networkId&#x60; &#x60;stateOverrides&#x60; and &#x60;blockOverrides&#x60; fields, only the first simulation takes effect.</p>
1485714872
<p></p>
1485814873
<br />
1485914874
<pre class="prettyprint language-html prettyprinted" data-type="post"><code><span class="pln">/api/v1/solidity/simulate_bundle</span></code></pre>
@@ -14973,7 +14988,7 @@ <h3>Usage and SDK Samples</h3>
1497314988
DebugAndSimulationApi *apiInstance = [[DebugAndSimulationApi alloc] init];
1497414989
SolidityServiceSimulateTransactionBundleRequest *body = ; //
1497514990

14976-
// Create a new bundle simulation
14991+
// Bundle simulation
1497714992
[apiInstance simulateTransactionBundleWith:body
1497814993
completionHandler: ^(solidity_service.SimulateTransactionBundleResponse output, NSError* error) {
1497914994
if (output) {
@@ -15037,7 +15052,7 @@ <h3>Usage and SDK Samples</h3>
1503715052
var body = new SolidityServiceSimulateTransactionBundleRequest(); // SolidityServiceSimulateTransactionBundleRequest |
1503815053

1503915054
try {
15040-
// Create a new bundle simulation
15055+
// Bundle simulation
1504115056
solidity_service.SimulateTransactionBundleResponse result = apiInstance.simulateTransactionBundle(body);
1504215057
Debug.WriteLine(result);
1504315058
} catch (Exception e) {
@@ -15111,7 +15126,7 @@ <h3>Usage and SDK Samples</h3>
1511115126
body = # SolidityServiceSimulateTransactionBundleRequest |
1511215127

1511315128
try:
15114-
# Create a new bundle simulation
15129+
# Bundle simulation
1511515130
api_response = api_instance.simulate_transaction_bundle(body)
1511615131
pprint(api_response)
1511715132
except ApiException as e:

openapi.json

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
"/api/v1/analytics/sql/execute": {
1616
"post": {
1717
"summary": "Execute SQL",
18-
"description": "Execute SQL in a project.\nFind more: https://docs.sentio.xyz/docs/data-api#sql-api",
18+
"description": "Execute SQL in a project. Go to \"Data Studio\" -> \"SQL Editor\", write your query and then click \"Export as cURL\"\n\n![screenshot](https://raw.githubusercontent.com/sentioxyz/docs/main/.gitbook/assets/image%20(102).png)\n\nFind more: https://docs.sentio.xyz/docs/data-api#sql-api",
1919
"operationId": "ExecuteSQL2",
2020
"responses": {
2121
"200": {
@@ -47,7 +47,7 @@
4747
"/api/v1/analytics/{owner}/{slug}/sql/execute": {
4848
"post": {
4949
"summary": "Execute SQL",
50-
"description": "Execute SQL in a project.\nFind more: https://docs.sentio.xyz/docs/data-api#sql-api",
50+
"description": "Execute SQL in a project. Go to \"Data Studio\" -> \"SQL Editor\", write your query and then click \"Export as cURL\"\n\n![screenshot](https://raw.githubusercontent.com/sentioxyz/docs/main/.gitbook/assets/image%20(102).png)\n\nFind more: https://docs.sentio.xyz/docs/data-api#sql-api",
5151
"operationId": "ExecuteSQL",
5252
"responses": {
5353
"200": {
@@ -621,6 +621,7 @@
621621
"/api/v1/metrics/{owner}/{slug}/query_range": {
622622
"post": {
623623
"summary": "Metric range queries",
624+
"description": "The easiest way to build query is through UI, you could first create an insight chart, and then **Export as cURL**.\n\n![screenshot](https://raw.githubusercontent.com/sentioxyz/docs/main/.gitbook/assets/image%20(101).png)",
624625
"operationId": "ObservabilityService_QueryRange",
625626
"responses": {
626627
"200": {
@@ -662,6 +663,7 @@
662663
"/api/v1/solidity/call_trace": {
663664
"get": {
664665
"summary": "Get indexed call trace",
666+
"description": "API to get Sentio call trace. It takes `txId.txHash` and `networkId` arguments, where the first is transaction hash, and the second is the numeric ethereum chain ID.\n\nThe results looks very similar to the normal [Ethereum call trace](https://raw.githubusercontent.com/sentioxyz/docs/main/.gitbook/assets/image%20(2)%20(1)%20(1)%20(1).png). But we have an additional `startIndex` and `startIndex` on each trace entry even for the LOG, representing the execution order in the trace.\n\nThis allows you to build chart that marks the order of fund flow.\n\n![screenshot](https://raw.githubusercontent.com/sentioxyz/docs/main/.gitbook/assets/image%20(2)%20(1)%20(1)%20(1).png)",
665667
"operationId": "GetCallTrace",
666668
"responses": {
667669
"200": {
@@ -901,7 +903,8 @@
901903
]
902904
},
903905
"post": {
904-
"summary": "Create a new transaction simulation",
906+
"summary": "Single simulation",
907+
"description": "Create a new transaction simulation. The simulation body should be included in the request body.\nYour simulations will be saved, and a unique ID for each simulation is included in the response. It will be useful for fetching simulation details.",
905908
"operationId": "SimulateTransaction",
906909
"responses": {
907910
"200": {
@@ -965,7 +968,8 @@
965968
},
966969
"/api/v1/solidity/simulate_bundle": {
967970
"post": {
968-
"summary": "Create a new bundle simulation",
971+
"summary": "Bundle simulation",
972+
"description": "You could also create bundle simulations so that one transaction could be executed one after another. For `blockNumber` `transactionIndex` `networkId` `stateOverrides` and `blockOverrides` fields, only the first simulation takes effect.",
969973
"operationId": "SimulateTransactionBundle",
970974
"responses": {
971975
"200": {

src/apis/DataApi.ts

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@ export interface Retention2Request {
172172
export class DataApi extends runtime.BaseAPI {
173173

174174
/**
175-
* Execute SQL in a project. Find more: https://docs.sentio.xyz/docs/data-api#sql-api
175+
* Execute SQL in a project. Go to \"Data Studio\" -> \"SQL Editor\", write your query and then click \"Export as cURL\" ![screenshot](https://raw.githubusercontent.com/sentioxyz/docs/main/.gitbook/assets/image%20(102).png) Find more: https://docs.sentio.xyz/docs/data-api#sql-api
176176
* Execute SQL
177177
*/
178178
async executeSQLRaw(requestParameters: ExecuteSQLRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AnalyticServiceSyncExecuteSQLResponse>> {
@@ -219,7 +219,7 @@ export class DataApi extends runtime.BaseAPI {
219219
}
220220

221221
/**
222-
* Execute SQL in a project. Find more: https://docs.sentio.xyz/docs/data-api#sql-api
222+
* Execute SQL in a project. Go to \"Data Studio\" -> \"SQL Editor\", write your query and then click \"Export as cURL\" ![screenshot](https://raw.githubusercontent.com/sentioxyz/docs/main/.gitbook/assets/image%20(102).png) Find more: https://docs.sentio.xyz/docs/data-api#sql-api
223223
* Execute SQL
224224
*/
225225
async executeSQL(requestParameters: ExecuteSQLRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AnalyticServiceSyncExecuteSQLResponse> {
@@ -228,7 +228,7 @@ export class DataApi extends runtime.BaseAPI {
228228
}
229229

230230
/**
231-
* Execute SQL in a project. Find more: https://docs.sentio.xyz/docs/data-api#sql-api
231+
* Execute SQL in a project. Go to \"Data Studio\" -> \"SQL Editor\", write your query and then click \"Export as cURL\" ![screenshot](https://raw.githubusercontent.com/sentioxyz/docs/main/.gitbook/assets/image%20(102).png) Find more: https://docs.sentio.xyz/docs/data-api#sql-api
232232
* Execute SQL
233233
*/
234234
async executeSQL2Raw(requestParameters: ExecuteSQL2Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AnalyticServiceSyncExecuteSQLResponse>> {
@@ -261,7 +261,7 @@ export class DataApi extends runtime.BaseAPI {
261261
}
262262

263263
/**
264-
* Execute SQL in a project. Find more: https://docs.sentio.xyz/docs/data-api#sql-api
264+
* Execute SQL in a project. Go to \"Data Studio\" -> \"SQL Editor\", write your query and then click \"Export as cURL\" ![screenshot](https://raw.githubusercontent.com/sentioxyz/docs/main/.gitbook/assets/image%20(102).png) Find more: https://docs.sentio.xyz/docs/data-api#sql-api
265265
* Execute SQL
266266
*/
267267
async executeSQL2(requestParameters: ExecuteSQL2Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AnalyticServiceSyncExecuteSQLResponse> {
@@ -492,6 +492,7 @@ export class DataApi extends runtime.BaseAPI {
492492
}
493493

494494
/**
495+
* The easiest way to build query is through UI, you could first create an insight chart, and then **Export as cURL**. ![screenshot](https://raw.githubusercontent.com/sentioxyz/docs/main/.gitbook/assets/image%20(101).png)
495496
* Metric range queries
496497
*/
497498
async observabilityServiceQueryRangeRaw(requestParameters: ObservabilityServiceQueryRangeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MetricsServiceMetricsQueryResponse>> {
@@ -538,6 +539,7 @@ export class DataApi extends runtime.BaseAPI {
538539
}
539540

540541
/**
542+
* The easiest way to build query is through UI, you could first create an insight chart, and then **Export as cURL**. ![screenshot](https://raw.githubusercontent.com/sentioxyz/docs/main/.gitbook/assets/image%20(101).png)
541543
* Metric range queries
542544
*/
543545
async observabilityServiceQueryRange(requestParameters: ObservabilityServiceQueryRangeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MetricsServiceMetricsQueryResponse> {

0 commit comments

Comments
 (0)