Indexer
Indexer indexing rules.
Based on the brc-20 indexing rules, here’s a set of indexing requirements tailored for the suirc20 standard:
-
Numeric Field Limitations: For the numeric fields in the suirc20 protocol, the value range should be within the bounds of uint64_max. Additionally, in the JSON structure, these numeric values must be represented as strings. This approach ensures compatibility and precision in handling large numbers typically associated with blockchain transactions. By adhering to these guidelines, the suirc20 protocol maintains accuracy and consistency in its operations and data representations.
-
JSON Validation: Inscriptions must be valid JSON. They should not contain trailing commas, and leading/trailing spaces or tabs are to be stripped.
-
Required JSON Fields:
- For ‘deploy’ operations: Must include “p”, “op”, “tick”, “max”. Optional fields are “lim” and “dec”.
- For ‘mint’ and ‘transfer’ operations: Must include “p”, “op”, “tick”, “amt”.
- For ‘transfer’ operations: The JSON must include the fields “p”, “op”, “tick”, “amt”, and “to”.
-
Lower Case Requirement: All operation and field names must be in lower case.
-
String Representation: All necessary JSON fields, including numeric fields, must be strings.
-
Numeric Field Rules: Numeric fields should not be stripped or trimmed. Decimal fields must have only digits and a single dot for decimal representation.
-
Ticker Rules: The “tick” field must be 4 bytes wide in UTF-8 format. Ticker names are case-insensitive and should be processed in lower case.
-
Handling of Over-Limit and Invalid Transactions: Transactions that exceed limits or are invalid according to the suirc20 rules should be ignored.
-
Balance Tracking and Inscription Rules: Follow specific rules for tracking balances and handling inscriptions based on suirc20 operations.
-
Special Considerations:
- JavaScript indexers should use BigInt for precision.
- Careful handling of transactions sent as fees.
- Ticker length comparisons should not rely on string length due to UTF-8 character sizes.
- Numeric fields in JSON should use string representation.
- Be cautious of blockchain reorganizations as they can affect the order of transactions and hence balances.
GraphQL-API:
Testnet: https://api-testnet.suirc20.com/query/
Mainnet: https://api.suirc20.com/query/
Query-Request:
Query Tick Balance By User :
query balanceIfExist($owner: String!, $tick: String!) {
balances (where: { owner: $owner, tick: $tick}) {
edges {
node {
protocol
owner
balance
tick
}
}
}
}
Query Mint Freq Status :
query mintFreqAllowed($tick: String!) {
tokens(where: {tick: $tick}) {
edges {
node {
id
max
protocol
limit
fee
frequency
currentMinuteMintedCount
}
}
}
}
Query Operation Execution status :
query operationIfSucceed($txDigest: String!) {
operations(where: {txDigest: $txDigest}) {
edges {
node {
id
max
protocol
limit
createdAt
owner
inscription
}
}
}
}
Query tick status :
query tickIfExist($tick: String!) {
tokens(where: {tick: $tick}) {
edges {
node {
id
max
protocol
limit
fee
}
}
}
}
Query tick info by tick name :
query token_info {
tokens(where: {tick: $tick}) {
edges {
node {
id
protocol
tick
decimals
max
limit
}
}
}
}
Query user balance for all ticks :
query UserBalance($owner: String!) {
balances (where: {owner: $owner}){
edges {
node {
protocol
owner
balance
tick
}
}
}
}
Query Transfer Record By tick name
query TokenTransfer($first: Int!, $after: Cursor, $tick: String) {
operations(
first: $first, after: $after,
where: {operationIn: [transfer, transfer_from] ,and :{ tick: $tick }}
orderBy: {direction: DESC, field: CREATED_AT}
) {
totalCount
edges {
cursor
node {
id
protocol
operation
tick
decimals
max
amount
limit
fee
txDigest
owner
to
from
share
pick
status
inscription
createdAt
}
}
}
}
Query holders data by tick
query TokenHolders($first: Int!, $after: Cursor, $tick: String) {
balances(
orderBy: {field: BALANCE, direction: DESC},
where: {tick: $tick},
first: $first, after: $after
) {
edges {
node {
balance
id
owner
protocol
tick
}
cursor
}
totalCount
}
}