Skip to content

Commit 5ec42f3

Browse files
Enhance documentation and .gitignore updates
- Added new log files to .gitignore to prevent unnecessary tracking. - Updated links and fixed formatting in various documentation files, including coinpath and examples. - Improved clarity in filtering sections across multiple schema documents by adding new lines for better readability. - Corrected minor typographical errors in documentation headings and links.
1 parent 2555fa2 commit 5ec42f3

92 files changed

Lines changed: 473 additions & 194 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.gitignore

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,4 +28,6 @@ audit.log
2828
audit2.log
2929
fix.log
3030
force.log
31-
serialize_javascript.log
31+
serialize_javascript.log
32+
docs/Schema/algorand/coinpath.md
33+
build.log

docs/Examples/coinpath/money-flow-api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ Follow the steps here to create one: [How to generate Bitquery API token ➤](ht
7373

7474
### 3. Multi-Chain Examples
7575

76-
- [Cardano Wallet Inflows](#getting-inflows--fund-moving-in-to-a-cardano-wallet-address)
76+
- [Cardano Wallet Inflows](#getting-inflows-funds-moving-in-to-a-cardano-walletaddress)
7777
- [Ethereum Multi-Hop Tracking](#get-transactions-from-multiple-addresses-to-a-final-destination-address)
7878

7979
### 4. Funding History & Bundle Detection

docs/Examples/dexTrades/dex-trading-data-api.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,12 @@ In the case of Buy/Sell Currency, we look into only 1 side of the swap.
1818
However, in the case of Base/Quote Currency, we look at both sides of the swap.
1919

2020
For example - Let's say there are 3 trades.
21-
1 - A <-> B
22-
2 - B <-> C
23-
3 - C <-> A
21+
22+
```
23+
1 - A < - > B
24+
2 - B < - > C
25+
3 - C < - > A
26+
```
2427

2528
Now when you query, give me all trades where sellCurrency is B, and we will give only 1st trade (Swap). However, if you query saying give me all trades where quoteCurrency is B, we will give both 1st and 2nd because Base/Quote currency looks at both sides of the trade.
2629

@@ -55,7 +58,7 @@ If you see this [query](https://ide.bitquery.io/Ethereum-Trades-for-specific-tim
5558
Protocols are basically rules or behavior to explain how a system will work. In the context of DEX, A DEX protocol is a set of smart contracts showing how DEX will work. When a protocol is deployed by any entity on the blockchain, it becomes an actual exchange. 
5659
For example, Uniswap is an exchange and a protocol. Uniswap protocol deployed by the Uniswap team created the Uniswap exchange. In the case of PancakeSwap, the exchange is PancakeSwap, but the protocol is still Uniswap.
5760

58-
## How to check if exchange is indexed by Bitquery?
61+
## How to check if an exchange is indexed by Bitquery?
5962

6063
If Bitquery index a protocol (ex - Uniswap v2 protocol), therefore any other exchange which is implemented this Uniswap V2, we have already indexed them. We might not be naming them, but you can get their trades using [**this API**](https://ide.bitquery.io/query/pzizr56shpq6wQrX), by simply replacing exchangeAddress with that exchange's factory address.
6164

@@ -502,7 +505,7 @@ https://ide.bitquery.io/Trades-for-a-trading-pair-on-Ethereum
502505
## Get Ethereum DEX Trades for a Liquidity Pool Contract Address
503506

504507
To get trades for pair tokens, you should use buy/sell; in the case of using Base/Quote, it will replicate the result.
505-
For example, if there is a swap A <-> B, using Base/Quote, it will give two results in one A as the base currency and in another B as the quote currency.
508+
For example, if there is a swap A < - > B, using Base/Quote, it will give two results in one A as the base currency and in another B as the quote currency.
506509

507510
[Open this query in IDE](https://ide.bitquery.io/Trades-for-a-pair-token-on-ethereum)
508511

docs/Schema/Avalanche/address.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,10 @@ query ($network: EthereumNetwork!) {
6868
}
6969
```
7070

71-
<details><summary>Filtering Address</summary>
71+
<details>
72+
73+
<summary>Filtering Address</summary>
74+
7275

7376
`limit`: The maximum number of results to return.
7477

docs/Schema/Avalanche/blocks.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,10 @@ query ($network: EthereumNetwork!, $limit: Int!, $offset: Int!, $from: ISO8601Da
7474
7575
```
7676

77-
<details><summary> Filtering Blocks</summary>
77+
<details>
78+
79+
<summary> Filtering Blocks</summary>
80+
7881

7982
- **options** : A set of options that can be used to filter the results.
8083
- **desc** or **asc** : The order of the results, either "asc" (ascending) or "desc" (descending).

docs/Schema/Avalanche/transactions.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,10 @@ query ($network: EthereumNetwork!, $from: ISO8601DateTime, $till: ISO8601DateTim
100100
}
101101
```
102102

103-
<details><summary>Filtering Transactions</summary>
103+
<details>
104+
105+
<summary>Filtering Transactions</summary>
106+
104107

105108

106109
`limit`: The maximum number of results to return.

docs/Schema/Avalanche/transfers.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,10 @@ query ($network: EthereumNetwork!, $from: ISO8601DateTime, $till: ISO8601DateTim
8888
}
8989
```
9090

91-
<details><summary>Filtering Transfers</summary>
91+
<details>
92+
93+
<summary>Filtering Transfers</summary>
94+
9295

9396
`options`: A set of options that control the behavior of the query.
9497

@@ -118,6 +121,7 @@ query ($network: EthereumNetwork!, $from: ISO8601DateTime, $till: ISO8601DateTim
118121
`txFrom`: The address of the sender of the transaction that the transfer was included in.
119122

120123
`txHash`: The hash of the transaction that the transfer was included in
124+
121125
</details>
122126

123127

docs/Schema/Cronos/address.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ query {
4545

4646
<details>
4747
<summary>Filtering Addresses</summary>
48+
4849
- `address`: Filter by a specific address or a list of addresses.
4950

5051
</details>

docs/Schema/Cronos/coinpath.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ Coinpath data can be filtered using following arguments:
2424
- `sender`: Filter by the sender's address.
2525
- `time`: Filter by the time of the transaction.
2626

27+
2728
</details>
2829

2930
The following are available fields for the `coinpath`:

docs/Schema/Cronos/references.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ References can be filtered using following arguments:
2929
- `txFrom`:
3030
- `txHash`:
3131

32+
3233
</details>
3334

3435
- `any`:

0 commit comments

Comments
 (0)