From 6f0f2067f0fba51d6a54102b8089b6edb3a9c0f2 Mon Sep 17 00:00:00 2001 From: Thomas Jay Rush Date: Tue, 28 May 2024 05:19:52 -0400 Subject: [PATCH] Updating auto-gen code --- content/api/openapi.yaml | 430 ++++++++++++++++--------------- content/chifra/accounts.md | 11 +- content/chifra/admin.md | 9 +- content/chifra/chaindata.md | 31 ++- content/chifra/chainstate.md | 3 + content/chifra/configs.md | 6 +- content/chifra/globals.md | 26 +- content/chifra/other.md | 37 ++- content/data-model/accounts.md | 77 +++--- content/data-model/admin.md | 27 +- content/data-model/chaindata.md | 174 +++++++------ content/data-model/chainstate.md | 60 +++-- content/data-model/other.md | 75 ++++-- 13 files changed, 524 insertions(+), 442 deletions(-) diff --git a/content/api/openapi.yaml b/content/api/openapi.yaml index 0d5810b2f..b2fbe913f 100644 --- a/content/api/openapi.yaml +++ b/content/api/openapi.yaml @@ -7,7 +7,7 @@ info: license: name: GPL 3.0 url: http://www.gnu.org/licenses/ - version: 2.5.8-release + version: 2.5.11-release description: > A REST layer over the TrueBlocks chifra command line. With `chifra daemon`, you can run this on your own machine, and make calls to `localhost`. @@ -121,7 +121,7 @@ paths: schema: type: boolean - name: unripe - description: list transactions labeled upripe (i.e. less than 28 blocks old) + description: list transactions labeled unripe (i.e. less than 28 blocks old) required: false style: form in: query @@ -144,7 +144,7 @@ paths: explode: true schema: type: number - format: blknum + format: uint64 - name: maxRecords description: the maximum number of records to process required: false @@ -153,7 +153,7 @@ paths: explode: true schema: type: number - format: blknum + format: uint64 - name: reversed description: produce results in reverse chronological order required: false @@ -212,12 +212,11 @@ paths: schema: properties: data: - description: Produces Appearance, AppearanceCount, Bounds or Monitor data. Corresponds to the chifra list command line. + description: Produces Appearance, Bounds or Monitor data. Corresponds to the chifra list command line. type: array items: oneOf: - $ref: "#/components/schemas/appearance" - - $ref: "#/components/schemas/appearanceCount" - $ref: "#/components/schemas/bounds" - $ref: "#/components/schemas/monitor" example: @@ -384,7 +383,7 @@ paths: explode: true schema: type: number - format: blknum + format: uint64 - name: maxRecords description: the maximum number of records to process required: false @@ -393,7 +392,7 @@ paths: explode: true schema: type: number - format: blknum + format: uint64 - name: relevant description: for log and accounting export only, export only logs relevant to one of the given export addresses required: false @@ -464,7 +463,7 @@ paths: schema: type: boolean - name: unripe - description: export transactions labeled upripe (i.e. less than 28 blocks old) + description: export transactions labeled unripe (i.e. less than 28 blocks old) required: false style: form in: query @@ -561,24 +560,24 @@ paths: schema: properties: data: - description: Produces Appearance, AppearanceCount, Function, Log, Monitor, Parameter, Receipt, State, Statement, Token, Trace, TraceAction, TraceResult or Transaction data. Corresponds to the chifra export command line. + description: Produces Appearance, Function, Log, Message, Monitor, Parameter, Receipt, Statement, Token, Trace, TraceAction, TraceResult, Transaction or Withdrawal data. Corresponds to the chifra export command line. type: array items: oneOf: - $ref: "#/components/schemas/appearance" - - $ref: "#/components/schemas/appearanceCount" - $ref: "#/components/schemas/function" - $ref: "#/components/schemas/log" + - $ref: "#/components/schemas/message" - $ref: "#/components/schemas/monitor" - $ref: "#/components/schemas/parameter" - $ref: "#/components/schemas/receipt" - - $ref: "#/components/schemas/state" - $ref: "#/components/schemas/statement" - $ref: "#/components/schemas/token" - $ref: "#/components/schemas/trace" - $ref: "#/components/schemas/traceAction" - $ref: "#/components/schemas/traceResult" - $ref: "#/components/schemas/transaction" + - $ref: "#/components/schemas/withdrawal" example: { "data": @@ -707,7 +706,7 @@ paths: explode: true schema: type: number - format: blknum + format: uint64 - name: sleep description: available with --watch option only, the number of seconds to sleep between runs required: false @@ -716,7 +715,7 @@ paths: explode: true schema: type: number - format: double + format: float64 - name: chain description: the chain to use required: false @@ -765,10 +764,11 @@ paths: schema: properties: data: - description: Produces Monitor or MonitorClean data. Corresponds to the chifra monitors command line. + description: Produces Message, Monitor or MonitorClean data. Corresponds to the chifra monitors command line. type: array items: oneOf: + - $ref: "#/components/schemas/message" - $ref: "#/components/schemas/monitor" - $ref: "#/components/schemas/monitorClean" "400": @@ -953,10 +953,12 @@ paths: schema: properties: data: - description: Produces Name data. Corresponds to the chifra names command line. + description: Produces Message or Name data. Corresponds to the chifra names command line. type: array items: - $ref: "#/components/schemas/name" + oneOf: + - $ref: "#/components/schemas/message" + - $ref: "#/components/schemas/name" example: [ { @@ -1241,15 +1243,6 @@ paths: explode: true schema: type: boolean - - name: bigRange - description: for the --logs option only, allow for block ranges larger than 500 - required: false - style: form - in: query - explode: true - schema: - type: number - format: blknum - name: count description: display only the count of appearances for --addrs or --uniq required: false @@ -1298,14 +1291,6 @@ paths: explode: true schema: type: boolean - - name: raw - description: report raw data directly from the source - required: false - style: form - in: query - explode: true - schema: - type: boolean - name: fmt description: export format, one of [ txt | csv | json ] required: false @@ -1322,15 +1307,16 @@ paths: schema: properties: data: - description: Produces Appearance, Block, BlockCount, Log, LogFilter, Trace, TraceAction, TraceResult or Withdrawal data. Corresponds to the chifra blocks command line. + description: Produces Appearance, Block, BlockCount, LightBlock, Log, Message, Trace, TraceAction, TraceResult or Withdrawal data. Corresponds to the chifra blocks command line. type: array items: oneOf: - $ref: "#/components/schemas/appearance" - $ref: "#/components/schemas/block" - $ref: "#/components/schemas/blockCount" + - $ref: "#/components/schemas/lightBlock" - $ref: "#/components/schemas/log" - - $ref: "#/components/schemas/logFilter" + - $ref: "#/components/schemas/message" - $ref: "#/components/schemas/trace" - $ref: "#/components/schemas/traceAction" - $ref: "#/components/schemas/traceResult" @@ -1468,14 +1454,6 @@ paths: explode: true schema: type: boolean - - name: raw - description: report raw data directly from the source - required: false - style: form - in: query - explode: true - schema: - type: boolean - name: fmt description: export format, one of [ txt | csv | json ] required: false @@ -1492,10 +1470,16 @@ paths: schema: properties: data: - description: Produces Transaction data. Corresponds to the chifra transactions command line. + description: Produces Appearance, Function, Log, Message, Parameter or Transaction data. Corresponds to the chifra transactions command line. type: array items: - $ref: "#/components/schemas/transaction" + oneOf: + - $ref: "#/components/schemas/appearance" + - $ref: "#/components/schemas/function" + - $ref: "#/components/schemas/log" + - $ref: "#/components/schemas/message" + - $ref: "#/components/schemas/parameter" + - $ref: "#/components/schemas/transaction" "400": description: bad input parameter /receipts: @@ -1557,14 +1541,6 @@ paths: explode: true schema: type: boolean - - name: raw - description: report raw data directly from the source - required: false - style: form - in: query - explode: true - schema: - type: boolean - name: fmt description: export format, one of [ txt | csv | json ] required: false @@ -1581,10 +1557,13 @@ paths: schema: properties: data: - description: Produces Receipt data. Corresponds to the chifra receipts command line. + description: Produces Function, Parameter or Receipt data. Corresponds to the chifra receipts command line. type: array items: - $ref: "#/components/schemas/receipt" + oneOf: + - $ref: "#/components/schemas/function" + - $ref: "#/components/schemas/parameter" + - $ref: "#/components/schemas/receipt" "400": description: bad input parameter /logs: @@ -1668,14 +1647,6 @@ paths: explode: true schema: type: boolean - - name: raw - description: report raw data directly from the source - required: false - style: form - in: query - explode: true - schema: - type: boolean - name: fmt description: export format, one of [ txt | csv | json ] required: false @@ -1692,12 +1663,14 @@ paths: schema: properties: data: - description: Produces Log or LogFilter data. Corresponds to the chifra logs command line. + description: Produces Function, Log, Message or Parameter data. Corresponds to the chifra logs command line. type: array items: oneOf: + - $ref: "#/components/schemas/function" - $ref: "#/components/schemas/log" - - $ref: "#/components/schemas/logFilter" + - $ref: "#/components/schemas/message" + - $ref: "#/components/schemas/parameter" "400": description: bad input parameter /traces: @@ -1783,14 +1756,6 @@ paths: explode: true schema: type: boolean - - name: raw - description: report raw data directly from the source - required: false - style: form - in: query - explode: true - schema: - type: boolean - name: fmt description: export format, one of [ txt | csv | json ] required: false @@ -1807,10 +1772,13 @@ paths: schema: properties: data: - description: Produces Trace, TraceAction, TraceCount, TraceFilter or TraceResult data. Corresponds to the chifra traces command line. + description: Produces Function, Message, Parameter, Trace, TraceAction, TraceCount, TraceFilter or TraceResult data. Corresponds to the chifra traces command line. type: array items: oneOf: + - $ref: "#/components/schemas/function" + - $ref: "#/components/schemas/message" + - $ref: "#/components/schemas/parameter" - $ref: "#/components/schemas/trace" - $ref: "#/components/schemas/traceAction" - $ref: "#/components/schemas/traceCount" @@ -1941,11 +1909,11 @@ paths: schema: properties: data: - description: Produces Block, NamedBlock, Timestamp or TimestampCount data. Corresponds to the chifra when command line. + description: Produces Message, NamedBlock, Timestamp or TimestampCount data. Corresponds to the chifra when command line. type: array items: oneOf: - - $ref: "#/components/schemas/block" + - $ref: "#/components/schemas/message" - $ref: "#/components/schemas/namedBlock" - $ref: "#/components/schemas/timestamp" - $ref: "#/components/schemas/timestampCount" @@ -2097,10 +2065,13 @@ paths: schema: properties: data: - description: Produces Result or State data. Corresponds to the chifra state command line. + description: Produces Function, Message, Parameter, Result or State data. Corresponds to the chifra state command line. type: array items: oneOf: + - $ref: "#/components/schemas/function" + - $ref: "#/components/schemas/message" + - $ref: "#/components/schemas/parameter" - $ref: "#/components/schemas/result" - $ref: "#/components/schemas/state" example: @@ -2403,7 +2374,7 @@ paths: explode: true schema: type: number - format: blknum + format: uint64 - name: maxRecords description: the maximum number of records to process required: false @@ -2412,7 +2383,7 @@ paths: explode: true schema: type: number - format: blknum + format: uint64 - name: chains description: include a list of chain configurations in the output required: false @@ -2478,7 +2449,7 @@ paths: explode: true schema: type: number - format: blknum + format: uint64 - name: sleep description: seconds to sleep between scraper passes required: false @@ -2487,7 +2458,7 @@ paths: explode: true schema: type: number - format: double + format: float64 - name: touch description: first block to visit when scraping (snapped back to most recent snap_to_grid mark) required: false @@ -2625,7 +2596,7 @@ paths: explode: true schema: type: number - format: blknum + format: uint64 - name: deep description: if true, dig more deeply during checking (manifest only) required: false @@ -2658,7 +2629,7 @@ paths: explode: true schema: type: number - format: double + format: float64 - name: chain description: the chain to use required: false @@ -2691,7 +2662,7 @@ paths: schema: properties: data: - description: Produces Appearance, AppearanceTable, ChunkAddress, ChunkBloom, ChunkIndex, ChunkPinReport, ChunkRecord, ChunkStats, IpfsPin, Manifest or ReportCheck data. Corresponds to the chifra chunks command line. + description: Produces Appearance, AppearanceTable, ChunkAddress, ChunkBloom, ChunkIndex, ChunkPin, ChunkRecord, ChunkStats, IpfsPin, Manifest, Message or ReportCheck data. Corresponds to the chifra chunks command line. type: array items: oneOf: @@ -2700,11 +2671,12 @@ paths: - $ref: "#/components/schemas/chunkAddress" - $ref: "#/components/schemas/chunkBloom" - $ref: "#/components/schemas/chunkIndex" - - $ref: "#/components/schemas/chunkPinReport" + - $ref: "#/components/schemas/chunkPin" - $ref: "#/components/schemas/chunkRecord" - $ref: "#/components/schemas/chunkStats" - $ref: "#/components/schemas/ipfsPin" - $ref: "#/components/schemas/manifest" + - $ref: "#/components/schemas/message" - $ref: "#/components/schemas/reportCheck" example: { @@ -2766,7 +2738,7 @@ paths: explode: true schema: type: number - format: double + format: float64 - name: chain description: the chain to use required: false @@ -2869,6 +2841,8 @@ paths: enum: - etherscan - key + - covalent + - alchemy - name: count description: for --appearances mode only, display only the count of records required: false @@ -2885,7 +2859,7 @@ paths: explode: true schema: type: number - format: double + format: float64 - name: chain description: the chain to use required: false @@ -2926,14 +2900,6 @@ paths: explode: true schema: type: boolean - - name: raw - description: report raw data directly from the source - required: false - style: form - in: query - explode: true - schema: - type: boolean - name: fmt description: export format, one of [ txt | csv | json ] required: false @@ -2950,12 +2916,15 @@ paths: schema: properties: data: - description: Produces Slurp or SlurpCount data. Corresponds to the chifra slurp command line. + description: Produces Appearance, Function, Monitor, Parameter or Slurp data. Corresponds to the chifra slurp command line. type: array items: oneOf: + - $ref: "#/components/schemas/appearance" + - $ref: "#/components/schemas/function" + - $ref: "#/components/schemas/monitor" + - $ref: "#/components/schemas/parameter" - $ref: "#/components/schemas/slurp" - - $ref: "#/components/schemas/slurpCount" example: [ { @@ -3095,22 +3064,6 @@ components: type: boolean format: boolean description: "`true` if the address is an ERC720, `false` otherwise" - appearanceCount: - description: "the number of records, file size, and last visited block for a given monitor" - type: object - properties: - address: - type: string - format: address - description: "the address for this count" - nRecords: - type: number - format: uint64 - description: "the number of appearances for the given address" - fileSize: - type: number - format: uint64 - description: "the size of the monitor file containing those appearances" bounds: description: "show first block and last block an address appears in along with timestamps and dates" type: object @@ -3122,7 +3075,7 @@ components: firstApp: type: object items: - $ref: "#/components/schemas/rawAppearance" + $ref: "#/components/schemas/appearance" description: "the block number and transaction id of the first appearance of this address" firstTs: type: number @@ -3135,7 +3088,7 @@ components: latestApp: type: object items: - $ref: "#/components/schemas/rawAppearance" + $ref: "#/components/schemas/appearance" description: "the block number and transaction id of the latest appearance of this address" latestTs: type: number @@ -3155,11 +3108,11 @@ components: description: "the number of the block" transactionIndex: type: number - format: blknum + format: txnum description: "the zero-indexed position of the transaction in the block" logIndex: type: number - format: blknum + format: lognum description: "the zero-indexed position the log in the block, if applicable" transactionHash: type: string @@ -3183,11 +3136,11 @@ components: description: "either ETH, WEI, or the symbol of the asset being reconciled as extracted from the chain" decimals: type: number - format: uint64 + format: value description: "the value of `decimals` from an ERC20 contract or, if ETH or WEI, then 18" spotPrice: type: number - format: double + format: float description: "the on-chain price in USD (or if a token in ETH, or zero) at the time of the transaction" priceSource: type: string @@ -3353,7 +3306,7 @@ components: description: "address of block's winning miner" difficulty: type: number - format: uint64 + format: value description: "the computational difficulty at this block" timestamp: type: number @@ -3367,10 +3320,10 @@ components: type: array items: $ref: "#/components/schemas/transaction" - description: "a possibly empty array of transactions or transaction hashes" + description: "a possibly empty array of transactions" baseFeePerGas: - type: string - format: wei + type: number + format: gas description: "the base fee for this block" uncles: type: array @@ -3400,11 +3353,11 @@ components: description: "the number of the block" transactionIndex: type: number - format: blknum + format: txnum description: "the zero-indexed position of the transaction in the block" nonce: type: number - format: uint64 + format: value description: "sequence number of the transactions sent by the sender" timestamp: type: number @@ -3426,14 +3379,18 @@ components: type: string format: wei description: "the amount of wei sent with this transactions" - gas: - type: number - format: gas - description: "the maximum number of gas allowed for this transaction" + ether: + type: string + format: ether + description: "if --ether is specified, the value in ether (calculated)" gasPrice: type: number format: gas description: "the number of wei per unit of gas the sender is willing to spend" + gas: + type: number + format: gas + description: "the maximum number of gas allowed for this transaction" input: type: string format: bytes @@ -3442,14 +3399,6 @@ components: type: object items: $ref: "#/components/schemas/receipt" - hasToken: - type: boolean - format: boolean - description: "`true` if the transaction is token related, `false` otherwise" - isError: - type: boolean - format: boolean - description: "`true` if the transaction ended in error, `false` otherwise" statements: type: array items: @@ -3459,10 +3408,18 @@ components: type: object items: $ref: "#/components/schemas/function" + hasToken: + type: boolean + format: boolean + description: "`true` if the transaction is token related, `false` otherwise" + isError: + type: boolean + format: boolean + description: "`true` if the transaction ended in error, `false` otherwise" compressedTx: type: string format: string - description: "truncated, more readable version of the articulation" + description: "truncated, more readable version of the articulation (calculated)" withdrawal: description: "withdrawal record for post-Shanghai withdrawals from the consensus layer" type: object @@ -3475,13 +3432,17 @@ components: type: string format: wei description: "a nonzero amount of ether given in gwei (1e9 wei)" + ether: + type: string + format: ether + description: "if --ether is specified, the amount in ether (calculated)" blockNumber: type: number format: blknum description: "the number of this block" index: type: number - format: uint64 + format: value description: "a monotonically increasing zero-based index that increments by 1 per withdrawal to uniquely identify each withdrawal" timestamp: type: number @@ -3493,7 +3454,7 @@ components: description: "the timestamp as a date (calculated)" validatorIndex: type: number - format: uint64 + format: value description: "the validator_index of the validator on the consensus layer the withdrawal corresponds to" receipt: description: "receipt data as returned from the RPC (with slight enhancements)" @@ -3523,14 +3484,14 @@ components: description: "a possibly empty array of logs" status: type: number - format: uint32 + format: value description: "`1` on transaction suceess, `null` if tx preceeds Byzantium, `0` otherwise" transactionHash: type: string format: hash transactionIndex: type: number - format: blknum + format: txnum log: description: "log data as returned from the RPC (with slight enhancements)" type: object @@ -3541,11 +3502,11 @@ components: description: "the number of the block" transactionIndex: type: number - format: uint64 + format: txnum description: "the zero-indexed position of the transaction in the block" logIndex: type: number - format: uint64 + format: lognum description: "the zero-indexed position of this log relative to the block" timestamp: type: number @@ -3584,37 +3545,15 @@ components: compressedLog: type: string format: string - description: "a truncated, more readable version of the articulation" - logFilter: - description: "used by the fast path log queries for various commands" + description: "a truncated, more readable version of the articulation (calculated)" + trace: + description: "trace data as returned from the RPC (with slight enhancements)" type: object properties: - fromBlock: - type: number - format: blknum - description: "the first block in the block range to query with eth_getLogs" - toBlock: - type: number - format: blknum - description: "the last block in the range to query with eth_getLogs" blockHash: type: string format: hash - description: "an alternative to blocks specification, the hash of the block to query" - emitters: - type: array - items: - $ref: "#/components/schemas/address" - description: "one or more emitting addresses from which logs were emitted" - topics: - type: array - items: - $ref: "#/components/schemas/topic" - description: "one or more topics which logs represent" - trace: - description: "trace data as returned from the RPC (with slight enhancements)" - type: object - properties: + description: "the hash of the block containing this trace" blockNumber: type: number format: blknum @@ -3623,13 +3562,17 @@ components: type: number format: timestamp description: "the timestamp of the block" + date: + type: string + format: datetime + description: "the timestamp as a date (calculated)" transactionHash: type: string format: hash description: "the transaction's hash containing this trace" transactionIndex: type: number - format: uint64 + format: txnum description: "the zero-indexed position of the transaction in the block" traceAddress: type: array @@ -3644,14 +3587,6 @@ components: type: string format: string description: "the type of the trace" - blockHash: - type: string - format: hash - description: "the hash of the block containing this trace" - date: - type: string - format: datetime - description: "the timestamp as a date (calculated)" action: type: object items: @@ -3670,7 +3605,7 @@ components: compressedTrace: type: string format: string - description: "a compressed string version of the articulated trace" + description: "a compressed string version of the articulated trace (calculated)" traceAction: description: "trace action data as returned from the RPC (with slight enhancements)" type: object @@ -3703,6 +3638,26 @@ components: type: string format: string description: "the type of reward" + value: + type: string + format: wei + description: "the value (in wei) of this trace action" + ether: + type: string + format: ether + description: "if --ether is specified, the value in ether (calculated)" + selfDestructed: + type: string + format: address + description: "`true` if the contract self-destructed, `false` otherwise" + balance: + type: string + format: wei + description: "if self-destructed, the balance of the contract at that time" + balanceEth: + type: string + format: ether + description: "if --ether is specified, the balance in ether (calculated)" traceResult: description: "trace result data as returned from the RPC (with slight enhancements)" type: object @@ -3733,7 +3688,7 @@ components: description: "the block number" transactionIndex: type: number - format: blknum + format: txnum description: "the transaction index" transactionHash: type: string @@ -3871,6 +3826,61 @@ components: type: number format: uint64 description: "the number of timestamps in the timestamps database" + lightBlock: + description: "a block containing only the hashes of the transactions" + type: object + properties: + gasLimit: + type: number + format: gas + description: "the system-wide maximum amount of gas permitted in this block" + hash: + type: string + format: hash + description: "the hash of the current block" + blockNumber: + type: number + format: blknum + description: "the number of the block" + parentHash: + type: string + format: hash + description: "hash of previous block" + miner: + type: string + format: address + description: "address of block's winning miner" + difficulty: + type: number + format: value + description: "the computational difficulty at this block" + timestamp: + type: number + format: timestamp + description: "the Unix timestamp of the object" + date: + type: string + format: datetime + description: "the timestamp as a date (calculated)" + transactions: + type: array + items: + $ref: "#/components/schemas/string" + description: "a possibly empty array of transaction hashes" + baseFeePerGas: + type: number + format: gas + description: "the base fee for this block" + uncles: + type: array + items: + $ref: "#/components/schemas/hash" + description: "a possibly empty array of uncle hashes" + withdrawals: + type: array + items: + $ref: "#/components/schemas/withdrawal" + description: "a possibly empty array of withdrawals (post Shanghai)" state: description: "the state of an Ethereum account (EOA or smart contract) on-chain" type: object @@ -3899,6 +3909,10 @@ components: type: string format: wei description: "the balance of the account at the given block" + ether: + type: string + format: ether + description: "if --ether is specified, the balance in ether (calculated)" code: type: string format: string @@ -3909,7 +3923,7 @@ components: description: "for smart contracts only, the block number at which the contract was deployed" nonce: type: number - format: uint64 + format: value description: "the nonce of the account at the given block" proxy: type: string @@ -3925,7 +3939,7 @@ components: description: "the block at which the report is made" transactionIndex: type: number - format: blknum + format: txnum description: "the transaction index (if applicable) at which the report is made" timestamp: type: number @@ -3958,7 +3972,7 @@ components: diff: type: string format: int256 - description: "the difference#&44; if any#&44; between the prior and current balance" + description: "the difference, if any, between the prior and current balance (calculated)" name: type: string format: string @@ -4294,19 +4308,19 @@ components: description: "the size of the chunks on disc in bytes" addrsPerBlock: type: number - format: double + format: float64 description: "the average number of addresses per block" appsPerBlock: type: number - format: double + format: float64 description: "the average number of appearances per block" appsPerAddr: type: number - format: double + format: float64 description: "the average number of appearances per address" ratio: type: number - format: double + format: float64 description: "the ratio of appearances to addresses" monitorClean: description: "report on cleaning dups out of monitors" @@ -4371,23 +4385,23 @@ components: description: "the result of the check" visitedCnt: type: number - format: uint32 + format: uint64 description: "the number of visited items in the cache" checkedCnt: type: number - format: uint32 + format: uint64 description: "the number of checks" skippedCnt: type: number - format: uint32 + format: uint64 description: "the number of skipped checks" passedCnt: type: number - format: uint32 + format: uint64 description: "the number of passed checks" failedCnt: type: number - format: uint32 + format: uint64 description: "the number of failed checks" msgStrings: type: array @@ -4398,7 +4412,7 @@ components: type: string format: string description: "the reason for the test" - chunkPinReport: + chunkPin: description: "a JSON object containing the results of pinning the Unchained Index" type: object properties: @@ -4544,11 +4558,11 @@ components: description: "the number of the block" transactionIndex: type: number - format: blknum + format: txnum description: "the zero-indexed position of the transaction in the block" nonce: type: number - format: uint64 + format: value description: "sequence number of the transactions sent by the sender" timestamp: type: number @@ -4570,6 +4584,10 @@ components: type: string format: wei description: "the amount of wei sent with this transactions" + ether: + type: string + format: ether + description: "if --ether is specified, the value in ether (calculated)" gas: type: number format: gas @@ -4594,23 +4612,23 @@ components: compressedTx: type: string format: string - description: "truncated, more readable version of the articulation" + description: "truncated, more readable version of the articulation (calculated)" isError: type: boolean format: boolean description: "`true` if the transaction ended in error, `false` otherwise" - slurpCount: - description: "counts of transaction data returned by remote APIs" + message: + description: "used for various responses when no real data is generated" type: object properties: - address: + msg: type: string - format: address - description: "the address used to query the API" - count: + format: string + description: "the message" + num: type: number - format: uint64 - description: "the number of records known by the API for this address" + format: int64 + description: "a number if needed" response: required: - result diff --git a/content/chifra/accounts.md b/content/chifra/accounts.md index 2140de558..375b5dff6 100644 --- a/content/chifra/accounts.md +++ b/content/chifra/accounts.md @@ -52,7 +52,7 @@ Flags: -U, --count display only the count of records for each monitor -z, --no_zero for the --count option only, suppress the display of zero appearance accounts -b, --bounds report first and last block this address appears - -u, --unripe list transactions labeled upripe (i.e. less than 28 blocks old) + -u, --unripe list transactions labeled unripe (i.e. less than 28 blocks old) -s, --silent freshen the monitor only (no reporting) -c, --first_record uint the first record to process -e, --max_records uint the maximum number of records to process (default 250) @@ -71,7 +71,6 @@ Notes: Data models produced by this tool: - [appearance](/data-model/accounts/#appearance) -- [appearancecount](/data-model/accounts/#appearancecount) - [bounds](/data-model/accounts/#bounds) - [monitor](/data-model/accounts/#monitor) @@ -132,7 +131,7 @@ Flags: -f, --flow string for the accounting options only, export statements with incoming, outgoing, or zero value One of [ in | out | zero ] -y, --factory for --traces only, report addresses created by (or self-destructed by) the given address(es) - -u, --unripe export transactions labeled upripe (i.e. less than 28 blocks old) + -u, --unripe export transactions labeled unripe (i.e. less than 28 blocks old) -E, --reversed produce results in reverse chronological order -z, --no_zero for the --count option only, suppress the display of zero appearance accounts -F, --first_block uint first block to process (inclusive) @@ -161,19 +160,19 @@ Notes: Data models produced by this tool: - [appearance](/data-model/accounts/#appearance) -- [appearancecount](/data-model/accounts/#appearancecount) - [function](/data-model/other/#function) - [log](/data-model/chaindata/#log) +- [message](/data-model/other/#message) - [monitor](/data-model/accounts/#monitor) - [parameter](/data-model/other/#parameter) - [receipt](/data-model/chaindata/#receipt) -- [state](/data-model/chainstate/#state) - [statement](/data-model/accounts/#statement) - [token](/data-model/chainstate/#token) - [trace](/data-model/chaindata/#trace) - [traceaction](/data-model/chaindata/#traceaction) - [traceresult](/data-model/chaindata/#traceresult) - [transaction](/data-model/chaindata/#transaction) +- [withdrawal](/data-model/chaindata/#withdrawal) Links: @@ -260,6 +259,7 @@ Notes: Data models produced by this tool: +- [message](/data-model/other/#message) - [monitor](/data-model/accounts/#monitor) - [monitorclean](/data-model/admin/#monitorclean) @@ -317,6 +317,7 @@ Notes: Data models produced by this tool: +- [message](/data-model/other/#message) - [name](/data-model/accounts/#name) Links: diff --git a/content/chifra/admin.md b/content/chifra/admin.md index b6a00661f..299df33c3 100644 --- a/content/chifra/admin.md +++ b/content/chifra/admin.md @@ -236,9 +236,9 @@ Each of the following additional configurable command line options are available | Item | Type | Default | Description / Default | | ------------ | ------ | ------- | ------------------------------------------------------------------------------------------------------------------------ | | appsPerChunk | uint64 | 2000000 | the number of appearances to build into a chunk before consolidating it | -| snapToGrid | uint64 | 250000 | an override to apps_per_chunk to snap-to-grid at every modulo of this value, this allows easier corrections to the index | -| firstSnap | uint64 | 2000000 | the first block at which snap_to_grid is enabled | -| unripeDist | uint64 | 28 | the distance (in blocks) from the front of the chain under which (inclusive) a block is considered unripe | +| snapToGrid | blknum | 250000 | an override to apps_per_chunk to snap-to-grid at every modulo of this value, this allows easier corrections to the index | +| firstSnap | blknum | 2000000 | the first block at which snap_to_grid is enabled | +| unripeDist | blknum | 28 | the distance (in blocks) from the front of the chain under which (inclusive) a block is considered unripe | | channelCount | uint64 | 20 | number of concurrent processing channels | | allowMissing | bool | false | do not report errors for blockchains that contain blocks with zero addresses | @@ -343,11 +343,12 @@ Data models produced by this tool: - [chunkaddress](/data-model/admin/#chunkaddress) - [chunkbloom](/data-model/admin/#chunkbloom) - [chunkindex](/data-model/admin/#chunkindex) -- [chunkpinreport](/data-model/admin/#chunkpinreport) +- [chunkpin](/data-model/admin/#chunkpin) - [chunkrecord](/data-model/admin/#chunkrecord) - [chunkstats](/data-model/admin/#chunkstats) - [ipfspin](/data-model/admin/#ipfspin) - [manifest](/data-model/admin/#manifest) +- [message](/data-model/other/#message) - [reportcheck](/data-model/admin/#reportcheck) Links: diff --git a/content/chifra/chaindata.md b/content/chifra/chaindata.md index b43c5e934..243e4ede2 100644 --- a/content/chifra/chaindata.md +++ b/content/chifra/chaindata.md @@ -16,7 +16,7 @@ weight: 21000 toc: true --- -The Chain Data group of tools extract raw blockchain data directly from the node. You may extract +The Chain Data group of tools extract blockchain data directly from the node. You may extract block data, transactional data, receipts, logs, traces, and other information. Each tool has it own set of options, allowing you to get exactly the data you need. @@ -57,10 +57,8 @@ Flags: -B, --topic strings for the --logs option only, filter logs to show only those with this topic(s) -i, --withdrawals export the withdrawals from the block as opposed to the block data -a, --articulate for the --logs option only, articulate the retrieved data if ABIs can be found - -r, --big_range uint for the --logs option only, allow for block ranges larger than 500 (default 500) -U, --count display only the count of appearances for --addrs or --uniq -H, --ether specify value in ether - -w, --raw report JSON data from the source with minimal processing -o, --cache force the results of the query into the cache -D, --decache removes related items from the cache -x, --fmt string export format, one of [none|json*|txt|csv] @@ -74,7 +72,6 @@ Notes: - With the --logs option, optionally specify one or more --emitter, one or more --topics, either or both. - The --logs option is significantly faster if you provide an --emitter and/or a --topic. - Multiple topics match on topic0, topic1, and so on, not on different topic0's. - - For the --logs option, large block ranges may crash the node, use --big_range to specify a larger range. - The --decache option removes the block(s), all transactions in those block(s), and all traces in those transactions from the cache. - The --withdrawals option is only available on certain chains. It is ignored otherwise. ``` @@ -84,8 +81,9 @@ Data models produced by this tool: - [appearance](/data-model/accounts/#appearance) - [block](/data-model/chaindata/#block) - [blockcount](/data-model/chaindata/#blockcount) +- [lightblock](/data-model/chaindata/#lightblock) - [log](/data-model/chaindata/#log) -- [logfilter](/data-model/chaindata/#logfilter) +- [message](/data-model/other/#message) - [trace](/data-model/chaindata/#trace) - [traceaction](/data-model/chaindata/#traceaction) - [traceresult](/data-model/chaindata/#traceresult) @@ -98,8 +96,7 @@ Links: ## chifra transactions -The `chifra transactions` tool retrieves transactions directly from the Ethereum node (using the `--raw` -option) or from the TrueBlocks cache (if present). You may specify multiple transaction identifiers +The `chifra transactions` tool retrieves transactions directly from the Ethereum node or from the TrueBlocks cache (if present). You may specify multiple transaction identifiers per invocation. Unlike the Ethereum RPC, the reported transactions include the transaction's receipt and generated logs. @@ -130,7 +127,6 @@ Flags: -m, --emitter strings for the --logs option only, filter logs to show only those logs emitted by the given address(es) -B, --topic strings for the --logs option only, filter logs to show only those with this topic(s) -H, --ether specify value in ether - -w, --raw report JSON data from the source with minimal processing -o, --cache force the results of the query into the cache -D, --decache removes related items from the cache -x, --fmt string export format, one of [none|json*|txt|csv] @@ -146,6 +142,11 @@ Notes: Data models produced by this tool: +- [appearance](/data-model/accounts/#appearance) +- [function](/data-model/other/#function) +- [log](/data-model/chaindata/#log) +- [message](/data-model/other/#message) +- [parameter](/data-model/other/#parameter) - [transaction](/data-model/chaindata/#transaction) Links: @@ -177,7 +178,6 @@ Arguments: Flags: -a, --articulate articulate the retrieved data if ABIs can be found - -w, --raw report JSON data from the source with minimal processing -o, --cache force the results of the query into the cache -D, --decache removes related items from the cache -x, --fmt string export format, one of [none|json*|txt|csv] @@ -192,6 +192,8 @@ Notes: Data models produced by this tool: +- [function](/data-model/other/#function) +- [parameter](/data-model/other/#parameter) - [receipt](/data-model/chaindata/#receipt) Links: @@ -221,7 +223,6 @@ Flags: -m, --emitter strings filter logs to show only those logs emitted by the given address(es) -B, --topic strings filter logs to show only those with this topic(s) -a, --articulate articulate the retrieved data if ABIs can be found - -w, --raw report JSON data from the source with minimal processing -o, --cache force the results of the query into the cache -D, --decache removes related items from the cache -x, --fmt string export format, one of [none|json*|txt|csv] @@ -237,8 +238,10 @@ Notes: Data models produced by this tool: +- [function](/data-model/other/#function) - [log](/data-model/chaindata/#log) -- [logfilter](/data-model/chaindata/#logfilter) +- [message](/data-model/other/#message) +- [parameter](/data-model/other/#parameter) Links: @@ -271,7 +274,6 @@ Flags: -f, --filter string call the node's trace_filter routine with bang-separated filter -U, --count display only the number of traces for the transaction (fast) -H, --ether specify value in ether - -w, --raw report JSON data from the source with minimal processing -o, --cache force the results of the query into the cache -D, --decache removes related items from the cache -x, --fmt string export format, one of [none|json*|txt|csv] @@ -287,6 +289,9 @@ Notes: Data models produced by this tool: +- [function](/data-model/other/#function) +- [message](/data-model/other/#message) +- [parameter](/data-model/other/#parameter) - [trace](/data-model/chaindata/#trace) - [traceaction](/data-model/chaindata/#traceaction) - [tracecount](/data-model/chaindata/#tracecount) @@ -344,7 +349,7 @@ Notes: Data models produced by this tool: -- [block](/data-model/chaindata/#block) +- [message](/data-model/other/#message) - [namedblock](/data-model/chaindata/#namedblock) - [timestamp](/data-model/chaindata/#timestamp) - [timestampcount](/data-model/chaindata/#timestampcount) diff --git a/content/chifra/chainstate.md b/content/chifra/chainstate.md index 103b7ea21..02191793e 100644 --- a/content/chifra/chainstate.md +++ b/content/chifra/chainstate.md @@ -77,6 +77,9 @@ Notes: Data models produced by this tool: +- [function](/data-model/other/#function) +- [message](/data-model/other/#message) +- [parameter](/data-model/other/#parameter) - [result](/data-model/chainstate/#result) - [state](/data-model/chainstate/#state) diff --git a/content/chifra/configs.md b/content/chifra/configs.md index 4c192385e..f48b25b2a 100644 --- a/content/chifra/configs.md +++ b/content/chifra/configs.md @@ -134,9 +134,9 @@ configuration per chain. | | | | [settings] | | | apps_per_chunk | uint64 | 200000 | the number of appearances to build into a chunk before consolidating it | -| snap_to_grid | uint64 | 100000 | an override to apps_per_chunk to snap-to-grid at every modulo of this value, this allows easier corrections to the index | -| first_snap | uint64 | 0 | the first block at which snap_to_grid is enabled | -| unripe_dist | uint64 | 28 | the distance (in blocks) from the front of the chain under which (inclusive) a block is considered unripe | +| snap_to_grid | blknum | 100000 | an override to apps_per_chunk to snap-to-grid at every modulo of this value, this allows easier corrections to the index | +| first_snap | blknum | 0 | the first block at which snap_to_grid is enabled | +| unripe_dist | blknum | 28 | the distance (in blocks) from the front of the chain under which (inclusive) a block is considered unripe | | channel_count | uint64 | 20 | number of concurrent processing channels | | allow_missing | bool | false | do not report errors for blockchains that contain blocks with zero addresses | diff --git a/content/chifra/globals.md b/content/chifra/globals.md index c53f6f2f8..ed135365a 100644 --- a/content/chifra/globals.md +++ b/content/chifra/globals.md @@ -78,20 +78,18 @@ Where: ### Group 4 -The tools in this group have all of the above options, but have an additional option, `--raw`, which shows the underlying data queried directly from the node (or API provider in the case of `slurp`). - -| Group | Cmd | Enabled | Disabled | -| ---------- | ------------ | -------------------------- | -------- | -| chain_data | blocks | Cache, Decache, Ether, Raw | | -| chain_data | transactions | Cache, Decache, Ether, Raw | | -| chain_data | receipts | Cache, Decache, Ether, Raw | | -| chain_data | logs | Cache, Decache, Ether, Raw | | -| chain_data | traces | Cache, Decache, Ether, Raw | | -| other | slurp | Cache, Decache, Ether, Raw | | - -Where: - - --raw passes the data queried from the node directly to the display +**As of version 2.6.0, the `--raw` option has been removed in its entirity. +Prior to that version, the following tools had this option which would pass +the data received directly from the node without modification.** + +```[bash] +chifra blocks +chifra transactions +chifra receipts +chifra logs +chifra traces +chifra slurp +``` ### Group 5 diff --git a/content/chifra/other.md b/content/chifra/other.md index b2c0e8d8c..a4709b38a 100644 --- a/content/chifra/other.md +++ b/content/chifra/other.md @@ -62,13 +62,19 @@ Links: While it's useful, it has two shortcomings. First, it is fully centralized, pulling its data from [http://etherscan.io](http://etherscan.io). Second, is that it does not report every transaction -for a given account. This is actually a shortcoming with Etherscan. It's too complicated to explain +for a given account. This is actually a shortcoming with API providers. It's too complicated to explain here, but see our blog. While `chifra slurp` has its shortcomings, it does provides some nice features. You may use it to pull any transaction initiated by an EOA for example or to explore mining rewards. Visit the above referenced website for more information. +Currently supported API providers: +- [TrueBlocks Key](https://key.trueblocks.io) +- Etherscan +- Covalent +- Alchemy + ```[plaintext] Purpose: Fetch data from Etherscan and other APIs for any address. @@ -86,11 +92,10 @@ Flags: -p, --appearances show only the blocknumber.tx_id appearances of the exported transactions -a, --articulate articulate the retrieved data if ABIs can be found -S, --source string the source of the slurped data - One of [ etherscan | key ] (default "etherscan") + One of [ etherscan | key | covalent | alchemy ] (default "etherscan") -U, --count for --appearances mode only, display only the count of records -s, --sleep float seconds to sleep between requests (default 0.25) -H, --ether specify value in ether - -w, --raw report JSON data from the source with minimal processing -o, --cache force the results of the query into the cache -D, --decache removes related items from the cache -x, --fmt string export format, one of [none|json*|txt|csv] @@ -99,19 +104,39 @@ Flags: Notes: - An address must be either an ENS name or start with '0x' and be forty-two characters long. - - Portions of this software are Powered by Etherscan.io APIs. + - Portions of this software are Powered by Etherscan.io, Covalent, Alchemy, TrueBlocks Key APIs. + - See slurp/README on how to configure keys for API providers - The withdrawals option is only available on certain chains. It is ignored otherwise. - - If the value of --source is key, --types is ignored and only appearances or counts are returned. + - If the value of --source is key, --types is ignored. ``` Data models produced by this tool: +- [appearance](/data-model/accounts/#appearance) +- [function](/data-model/other/#function) +- [monitor](/data-model/accounts/#monitor) +- [parameter](/data-model/other/#parameter) - [slurp](/data-model/other/#slurp) -- [slurpcount](/data-model/other/#slurpcount) Links: - [api docs](/api/#operation/other-slurp) - [source code](https://github.com/TrueBlocks/trueblocks-core/tree/master/src/apps/chifra/internal/slurp) +### Adding provider API key +Call `chifra config edit` to edit the configuration file. + +For TrueBlocks Key, add `keyEndpoint = "your-key-endpoint-url"` to `chains.mainnet` section. + +For all other providers add an entry to `keys` section like this: +```toml +[keys] + [keys.etherscan] + apiKey = "etherscan-apikey" + [keys.covalent] + apiKey = "covalent-apikey" + [keys.alchemy] + apiKey = "alchemy-apikey" +``` + *Copyright (c) 2024, TrueBlocks, LLC. All rights reserved. Generated with goMaker.* diff --git a/content/data-model/accounts.md b/content/data-model/accounts.md index af4bd8349..d7e89b730 100644 --- a/content/data-model/accounts.md +++ b/content/data-model/accounts.md @@ -45,6 +45,8 @@ The following commands produce and manage Appearances: - [chifra export](/chifra/accounts/#chifra-export) - [chifra blocks](/chifra/chaindata/#chifra-blocks) - [chifra chunks](/chifra/admin/#chifra-chunks) +- [chifra slurp](/chifra/other/#chifra-slurp) +- [chifra transactions](/chifra/chaindata/#chifra-transactions) Appearances consist of the following fields: @@ -75,6 +77,7 @@ The following commands produce and manage Monitors: - [chifra monitors](/chifra/accounts/#chifra-monitors) - [chifra list](/chifra/accounts/#chifra-list) - [chifra export](/chifra/accounts/#chifra-export) +- [chifra slurp](/chifra/other/#chifra-slurp) Monitors consist of the following fields: @@ -125,24 +128,6 @@ Names consist of the following fields: | isErc20 | `true` if the address is an ERC20, `false` otherwise | bool | | isErc721 | `true` if the address is an ERC720, `false` otherwise | bool | -## AppearanceCount - -The `appearanceCount` data model is used mostly by the frontend explorer application. It carries -various information about the monitor data for an address. - -The following commands produce and manage AppearanceCounts: - -- [chifra list](/chifra/accounts/#chifra-list) -- [chifra export](/chifra/accounts/#chifra-export) - -AppearanceCounts consist of the following fields: - -| Field | Description | Type | -| -------- | --------------------------------------------------------- | ------- | -| address | the address for this count | address | -| nRecords | the number of appearances for the given address | uint64 | -| fileSize | the size of the monitor file containing those appearances | uint64 | - ## Bounds The Bounds data model displays information about a given address including how many times it's appeared on the chain and when the first and most recent blocks, timestamps, and dates are. @@ -153,15 +138,15 @@ The following commands produce and manage Bounds: Bounds consist of the following fields: -| Field | Description | Type | -| ---------- | ---------------------------------------------------------------------------- | ------------- | -| count | the number of appearances for this address | uint64 | -| firstApp | the block number and transaction id of the first appearance of this address | RawAppearance | -| firstTs | the timestamp of the first appearance of this address | timestamp | -| firstDate | the first appearance timestamp as a date (calculated) | datetime | -| latestApp | the block number and transaction id of the latest appearance of this address | RawAppearance | -| latestTs | the timestamp of the latest appearance of this address | timestamp | -| latestDate | the latest appearance timestamp as a date (calculated) | datetime | +| Field | Description | Type | +| ---------- | ---------------------------------------------------------------------------- | ---------------------------------------------- | +| count | the number of appearances for this address | uint64 | +| firstApp | the block number and transaction id of the first appearance of this address | [Appearance](/data-model/accounts/#appearance) | +| firstTs | the timestamp of the first appearance of this address | timestamp | +| firstDate | the first appearance timestamp as a date (calculated) | datetime | +| latestApp | the block number and transaction id of the latest appearance of this address | [Appearance](/data-model/accounts/#appearance) | +| latestTs | the timestamp of the latest appearance of this address | timestamp | +| latestDate | the latest appearance timestamp as a date (calculated) | datetime | ## Statement @@ -189,15 +174,15 @@ Statements consist of the following fields: | Field | Description | Type | | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | --------- | | blockNumber | the number of the block | blknum | -| transactionIndex | the zero-indexed position of the transaction in the block | blknum | -| logIndex | the zero-indexed position the log in the block, if applicable | blknum | +| transactionIndex | the zero-indexed position of the transaction in the block | txnum | +| logIndex | the zero-indexed position the log in the block, if applicable | lognum | | transactionHash | the hash of the transaction that triggered this reconciliation | hash | | timestamp | the Unix timestamp of the object | timestamp | | date | the timestamp as a date (calculated) | datetime | | assetAddr | 0xeeee...eeee for ETH reconciliations, the token address otherwise | address | | assetSymbol | either ETH, WEI, or the symbol of the asset being reconciled as extracted from the chain | string | -| decimals | the value of `decimals` from an ERC20 contract or, if ETH or WEI, then 18 | uint64 | -| spotPrice | the on-chain price in USD (or if a token in ETH, or zero) at the time of the transaction | double | +| decimals | the value of `decimals` from an ERC20 contract or, if ETH or WEI, then 18 | value | +| spotPrice | the on-chain price in USD (or if a token in ETH, or zero) at the time of the transaction | float | | priceSource | the on-chain source from which the spot price was taken | string | | accountedFor | the address being accounted for in this reconciliation | address | | sender | the initiator of the transfer (the sender) | address | @@ -249,19 +234,21 @@ AppearanceTables consist of the following fields: This documentation mentions the following basic data types. -| Type | Description | Notes | -| --------- | ----------------------------------- | -------------- | -| address | an '0x'-prefixed 20-byte hex string | lowercase | -| blknum | an alias for a uint64 | | -| bool | either `true`, `false`, `1`, or `0` | | -| datetime | a JSON formatted date | as a string | -| double | a double precision float | 64 bits | -| hash | an '0x'-prefixed 32-byte hex string | lowercase | -| int64 | a 64-bit signed integer | | -| int256 | a signed big number | as a string | -| string | a normal character string | | -| timestamp | a 64-bit unsigned integer | Unix timestamp | -| uint32 | a 32-bit unsigned integer | | -| uint64 | a 64-bit unsigned integer | | +| Type | Description | Notes | +| --------- | -------------------------------------- | -------------- | +| address | an '0x'-prefixed 20-byte hex string | lowercase | +| blknum | an alias for a uint64 | | +| bool | either `true`, `false`, `1`, or `0` | | +| datetime | a JSON formatted date | as a string | +| hash | an '0x'-prefixed 32-byte hex string | lowercase | +| int256 | a signed big number | as a string | +| int64 | a 64-bit signed integer | | +| lognum | an alias for a uint64 | | +| string | a normal character string | | +| timestamp | a 64-bit unsigned integer | Unix timestamp | +| txnum | an alias for a uint64 | | +| uint32 | a 32-bit unsigned integer | | +| uint64 | a 64-bit unsigned integer | | +| value | an alias for a 64-bit unsigned integer | | *Copyright (c) 2024, TrueBlocks, LLC. All rights reserved. Generated with goMaker.* diff --git a/content/data-model/admin.md b/content/data-model/admin.md index 4f63f33f7..b4009976e 100644 --- a/content/data-model/admin.md +++ b/content/data-model/admin.md @@ -204,10 +204,10 @@ ChunkStats consist of the following fields: | recWid | the record width of a single bloom filter | uint64 | | bloomSz | the size of the bloom filters on disc in bytes | uint64 | | chunkSz | the size of the chunks on disc in bytes | uint64 | -| addrsPerBlock | the average number of addresses per block | double | -| appsPerBlock | the average number of appearances per block | double | -| appsPerAddr | the average number of appearances per address | double | -| ratio | the ratio of appearances to addresses | double | +| addrsPerBlock | the average number of addresses per block | float64 | +| appsPerBlock | the average number of appearances per block | float64 | +| appsPerAddr | the average number of appearances per address | float64 | +| ratio | the ratio of appearances to addresses | float64 | ## MonitorClean @@ -260,23 +260,23 @@ ReportChecks consist of the following fields: | Field | Description | Type | | ---------- | --------------------------------------------- | -------- | | result | the result of the check | string | -| visitedCnt | the number of visited items in the cache | uint32 | -| checkedCnt | the number of checks | uint32 | -| skippedCnt | the number of skipped checks | uint32 | -| passedCnt | the number of passed checks | uint32 | -| failedCnt | the number of failed checks | uint32 | +| visitedCnt | the number of visited items in the cache | uint64 | +| checkedCnt | the number of checks | uint64 | +| skippedCnt | the number of skipped checks | uint64 | +| passedCnt | the number of passed checks | uint64 | +| failedCnt | the number of failed checks | uint64 | | msgStrings | an array of messages explaining failed checks | string[] | | reason | the reason for the test | string | -## ChunkPinReport +## ChunkPin Reports on the result of the command `chifra chunks manifest --pin [--deep]`. -The following commands produce and manage ChunkPinReports: +The following commands produce and manage ChunkPins: - [chifra chunks](/chifra/admin/#chifra-chunks) -ChunkPinReports consist of the following fields: +ChunkPins consist of the following fields: | Field | Description | Type | | ------------- | ------------------------------------------------------- | -------- | @@ -318,12 +318,11 @@ This documentation mentions the following basic data types. | blkrange | a pair of nine-digit block numbers | zero padded | | bool | either `true`, `false`, `1`, or `0` | | | datetime | a JSON formatted date | as a string | -| double | a double precision float | 64 bits | +| float64 | a double precision float | 64 bits | | hash | an '0x'-prefixed 32-byte hex string | lowercase | | int64 | a 64-bit signed integer | | | ipfshash | a multi-hash produced by IPFS | mixed-case | | string | a normal character string | | -| uint32 | a 32-bit unsigned integer | | | uint64 | a 64-bit unsigned integer | | *Copyright (c) 2024, TrueBlocks, LLC. All rights reserved. Generated with goMaker.* diff --git a/content/data-model/chaindata.md b/content/data-model/chaindata.md index c88ba9a5f..e13947517 100644 --- a/content/data-model/chaindata.md +++ b/content/data-model/chaindata.md @@ -27,7 +27,6 @@ blocks' transactions. The following commands produce and manage Blocks: - [chifra blocks](/chifra/chaindata/#chifra-blocks) -- [chifra when](/chifra/chaindata/#chifra-when) Blocks consist of the following fields: @@ -38,11 +37,11 @@ Blocks consist of the following fields: | blockNumber | the number of the block | blknum | | parentHash | hash of previous block | hash | | miner | address of block's winning miner | address | -| difficulty | the computational difficulty at this block | uint64 | +| difficulty | the computational difficulty at this block | value | | timestamp | the Unix timestamp of the object | timestamp | | date | the timestamp as a date (calculated) | datetime | -| transactions | a possibly empty array of transactions or transaction hashes | [Transaction[]](/data-model/chaindata/#transaction) | -| baseFeePerGas | the base fee for this block | wei | +| transactions | a possibly empty array of transactions | [Transaction[]](/data-model/chaindata/#transaction) | +| baseFeePerGas | the base fee for this block | gas | | uncles | a possibly empty array of uncle hashes | hash[] | | withdrawals | a possibly empty array of withdrawals (post Shanghai) | [Withdrawal[]](/data-model/chaindata/#withdrawal) | @@ -67,22 +66,23 @@ Transactions consist of the following fields: | hash | the hash of the transaction | hash | | blockHash | the hash of the block containing this transaction | hash | | blockNumber | the number of the block | blknum | -| transactionIndex | the zero-indexed position of the transaction in the block | blknum | -| nonce | sequence number of the transactions sent by the sender | uint64 | +| transactionIndex | the zero-indexed position of the transaction in the block | txnum | +| nonce | sequence number of the transactions sent by the sender | value | | timestamp | the Unix timestamp of the object | timestamp | | date | the timestamp as a date (calculated) | datetime | | from | address from which the transaction was sent | address | | to | address to which the transaction was sent | address | | value | the amount of wei sent with this transactions | wei | +| ether | if --ether is specified, the value in ether (calculated) | ether | | gas | the maximum number of gas allowed for this transaction | gas | | gasPrice | the number of wei per unit of gas the sender is willing to spend | gas | | input | byte data either containing a message or funcational data for a smart contracts. See the --articulate | bytes | | receipt | | [Receipt](/data-model/chaindata/#receipt) | | statements | array of reconciliations (calculated) | [Statement[]](/data-model/accounts/#statement) | | articulatedTx | | [Function](/data-model/other/#function) | -| hasToken | `true` if the transaction is token related, `false` otherwise | uint8 | -| isError | `true` if the transaction ended in error, `false` otherwise | uint8 | -| compressedTx | truncated, more readable version of the articulation | string | +| hasToken | `true` if the transaction is token related, `false` otherwise | bool | +| isError | `true` if the transaction ended in error, `false` otherwise | bool | +| compressedTx | truncated, more readable version of the articulation (calculated) | string | ## Withdrawal @@ -91,6 +91,7 @@ Transactions consist of the following fields: The following commands produce and manage Withdrawals: - [chifra blocks](/chifra/chaindata/#chifra-blocks) +- [chifra export](/chifra/accounts/#chifra-export) Withdrawals consist of the following fields: @@ -98,11 +99,12 @@ Withdrawals consist of the following fields: | -------------- | -------------------------------------------------------------------------------------------------------------------- | --------- | | address | the recipient for the withdrawn ether | address | | amount | a nonzero amount of ether given in gwei (1e9 wei) | wei | +| ether | if --ether is specified, the amount in ether (calculated) | ether | | blockNumber | the number of this block | blknum | -| index | a monotonically increasing zero-based index that increments by 1 per withdrawal to uniquely identify each withdrawal | uint64 | +| index | a monotonically increasing zero-based index that increments by 1 per withdrawal to uniquely identify each withdrawal | value | | timestamp | the timestamp for this block | timestamp | | date | the timestamp as a date (calculated) | datetime | -| validatorIndex | the validator_index of the validator on the consensus layer the withdrawal corresponds to | uint64 | +| validatorIndex | the validator_index of the validator on the consensus layer the withdrawal corresponds to | value | ## Receipt @@ -128,9 +130,9 @@ Receipts consist of the following fields: | gasUsed | the amount of gas actually used by the transaction | gas | | isError | | bool | | logs | a possibly empty array of logs | [Log[]](/data-model/chaindata/#log) | -| status | `1` on transaction suceess, `null` if tx preceeds Byzantium, `0` otherwise | uint32 | +| status | `1` on transaction suceess, `null` if tx preceeds Byzantium, `0` otherwise | value | | transactionHash | | hash | -| transactionIndex | | blknum | +| transactionIndex | | txnum | ## Log @@ -144,14 +146,15 @@ The following commands produce and manage Logs: - [chifra logs](/chifra/chaindata/#chifra-logs) - [chifra export](/chifra/accounts/#chifra-export) - [chifra blocks](/chifra/chaindata/#chifra-blocks) +- [chifra transactions](/chifra/chaindata/#chifra-transactions) Logs consist of the following fields: | Field | Description | Type | | ---------------- | ------------------------------------------------------------------------------------------------- | --------------------------------------- | | blockNumber | the number of the block | blknum | -| transactionIndex | the zero-indexed position of the transaction in the block | uint64 | -| logIndex | the zero-indexed position of this log relative to the block | uint64 | +| transactionIndex | the zero-indexed position of the transaction in the block | txnum | +| logIndex | the zero-indexed position of this log relative to the block | lognum | | timestamp | the timestamp of the block this log appears in | timestamp | | date | the timestamp as a date (calculated) | datetime | | address | the smart contract that emitted this log | address | @@ -160,26 +163,7 @@ Logs consist of the following fields: | transactionHash | the hash of the transction | hash | | blockHash | the hash of the block | hash | | articulatedLog | a human-readable version of the topic and data fields | [Function](/data-model/other/#function) | -| compressedLog | a truncated, more readable version of the articulation | string | - -## LogFilter - -Log filters are used to speed up querying of the node when searching for logs. - -The following commands produce and manage LogFilters: - -- [chifra blocks](/chifra/chaindata/#chifra-blocks) -- [chifra logs](/chifra/chaindata/#chifra-logs) - -LogFilters consist of the following fields: - -| Field | Description | Type | -| --------- | ---------------------------------------------------------------------- | --------- | -| fromBlock | the first block in the block range to query with eth_getLogs | blknum | -| toBlock | the last block in the range to query with eth_getLogs | blknum | -| blockHash | an alternative to blocks specification, the hash of the block to query | hash | -| emitters | one or more emitting addresses from which logs were emitted | address[] | -| topics | one or more topics which logs represent | topic[] | +| compressedLog | a truncated, more readable version of the articulation (calculated) | string | ## Trace @@ -200,26 +184,24 @@ The following commands produce and manage Traces: Traces consist of the following fields: -| Field | Description | Type | -| ---------------- | --------------------------------------------------------- | ------------------------------------------------- | -| blockHash | the hash of the block containing this trace | hash | -| blockNumber | the number of the block | blknum | -| timestamp | the timestamp of the block | timestamp | -| date | the timestamp as a date (calculated) | datetime | -| transactionHash | the transaction's hash containing this trace | hash | -| transactionIndex | the zero-indexed position of the transaction in the block | uint64 | -| traceAddress | a particular trace's address in the trace tree | uint64[] | -| subtraces | the number of children traces that the trace hash | uint64 | -| type | the type of the trace | string | -| action | the trace action for this trace | [TraceAction](/data-model/chaindata/#traceaction) | -| result | the trace result of this trace | [TraceResult](/data-model/chaindata/#traceresult) | -| articulatedTrace | human readable version of the trace action input data | [Function](/data-model/other/#function) | -| compressedTrace | a compressed string version of the articulated trace | string | +| Field | Description | Type | +| ---------------- | ----------------------------------------------------------------- | ------------------------------------------------- | +| blockHash | the hash of the block containing this trace | hash | +| blockNumber | the number of the block | blknum | +| timestamp | the timestamp of the block | timestamp | +| date | the timestamp as a date (calculated) | datetime | +| transactionHash | the transaction's hash containing this trace | hash | +| transactionIndex | the zero-indexed position of the transaction in the block | txnum | +| traceAddress | a particular trace's address in the trace tree | uint64[] | +| subtraces | the number of children traces that the trace hash | uint64 | +| type | the type of the trace | string | +| action | the trace action for this trace | [TraceAction](/data-model/chaindata/#traceaction) | +| result | the trace result of this trace | [TraceResult](/data-model/chaindata/#traceresult) | +| articulatedTrace | human readable version of the trace action input data | [Function](/data-model/other/#function) | +| compressedTrace | a compressed string version of the articulated trace (calculated) | string | ### Notes -When produced using the `--raw` option to `chifra traces`, this data model actually produces `transactionPosition` instead of `transactionIndex`. When produced without the `--raw` option, the model uses `transactionIndex` to be consistent with other data models such as the `transaction`. - Traces and TraceActions, when produced during a self-destruct, export different fields when rendered in JSON. In CSV and TXT output, these fields change thier meaning while retaining the header of the original fields. The following table describes these differences: Fields that change during self-destruct transaction: @@ -246,15 +228,20 @@ The following commands produce and manage TraceActions: TraceActions consist of the following fields: -| Field | Description | Type | -| ------------- | -------------------------------------------------------------------------- | ------- | -| from | address from which the trace was sent | address | -| to | address to which the trace was sent | address | -| gas | the maximum number of gas allowed for this trace | gas | -| input | an encoded version of the function call | bytes | -| callType | the type of call | string | -| refundAddress | if the call type is self-destruct, the address to which the refund is sent | address | -| rewardType | the type of reward | string | +| Field | Description | Type | +| -------------- | -------------------------------------------------------------------------- | ------- | +| from | address from which the trace was sent | address | +| to | address to which the trace was sent | address | +| gas | the maximum number of gas allowed for this trace | gas | +| input | an encoded version of the function call | bytes | +| callType | the type of call | string | +| refundAddress | if the call type is self-destruct, the address to which the refund is sent | address | +| rewardType | the type of reward | string | +| value | the value (in wei) of this trace action | wei | +| ether | if --ether is specified, the value in ether (calculated) | ether | +| selfDestructed | `true` if the contract self-destructed, `false` otherwise | address | +| balance | if self-destructed, the balance of the contract at that time | wei | +| balanceEth | if --ether is specified, the balance in ether (calculated) | ether | ## TraceResult @@ -289,7 +276,7 @@ TraceCounts consist of the following fields: | Field | Description | Type | | ---------------- | --------------------------------------- | --------- | | blockNumber | the block number | blknum | -| transactionIndex | the transaction index | blknum | +| transactionIndex | the transaction index | txnum | | transactionHash | the transaction's hash | hash | | timestamp | the timestamp of the block | timestamp | | date | the timestamp as a date (calculated) | datetime | @@ -390,26 +377,55 @@ TimestampCounts consist of the following fields: | ----- | --------------------------------------------------- | ------ | | count | the number of timestamps in the timestamps database | uint64 | +## LightBlock + +`chifra blocks --hashes` returns top level data specified block with only +the hashes of the block's transactions. + +The following commands produce and manage LightBlocks: + +- [chifra blocks](/chifra/chaindata/#chifra-blocks) + +LightBlocks consist of the following fields: + +| Field | Description | Type | +| ------------- | ------------------------------------------------------------- | ------------------------------------------------- | +| gasLimit | the system-wide maximum amount of gas permitted in this block | gas | +| hash | the hash of the current block | hash | +| blockNumber | the number of the block | blknum | +| parentHash | hash of previous block | hash | +| miner | address of block's winning miner | address | +| difficulty | the computational difficulty at this block | value | +| timestamp | the Unix timestamp of the object | timestamp | +| date | the timestamp as a date (calculated) | datetime | +| transactions | a possibly empty array of transaction hashes | string[] | +| baseFeePerGas | the base fee for this block | gas | +| uncles | a possibly empty array of uncle hashes | hash[] | +| withdrawals | a possibly empty array of withdrawals (post Shanghai) | [Withdrawal[]](/data-model/chaindata/#withdrawal) | + ## Base types This documentation mentions the following basic data types. -| Type | Description | Notes | -| --------- | ----------------------------------- | -------------- | -| address | an '0x'-prefixed 20-byte hex string | lowercase | -| blknum | an alias for a uint64 | | -| bool | either `true`, `false`, `1`, or `0` | | -| bytes | an arbitrarily long string of bytes | | -| datetime | a JSON formatted date | as a string | -| gas | an unsigned big number | as a string | -| hash | an '0x'-prefixed 32-byte hex string | lowercase | -| int64 | a 64-bit signed integer | | -| string | a normal character string | | -| timestamp | a 64-bit unsigned integer | Unix timestamp | -| topic | an '0x'-prefixed 32-byte hex string | lowercase | -| uint32 | a 32-bit unsigned integer | | -| uint64 | a 64-bit unsigned integer | | -| uint8 | an alias for the boolean type | | -| wei | an unsigned big number | as a string | +| Type | Description | Notes | +| --------- | -------------------------------------- | -------------- | +| address | an '0x'-prefixed 20-byte hex string | lowercase | +| blknum | an alias for a uint64 | | +| bool | either `true`, `false`, `1`, or `0` | | +| bytes | an arbitrarily long string of bytes | | +| datetime | a JSON formatted date | as a string | +| ether | a big number float | as a string | +| gas | a 64-bit unsigned integer | | +| hash | an '0x'-prefixed 32-byte hex string | lowercase | +| int64 | a 64-bit signed integer | | +| lognum | an alias for a uint64 | | +| string | a normal character string | | +| timestamp | a 64-bit unsigned integer | Unix timestamp | +| topic | an '0x'-prefixed 32-byte hex string | lowercase | +| txnum | an alias for a uint64 | | +| uint256 | a 256-bit unsigned integer | | +| uint64 | a 64-bit unsigned integer | | +| value | an alias for a 64-bit unsigned integer | | +| wei | an unsigned big number | as a string | *Copyright (c) 2024, TrueBlocks, LLC. All rights reserved. Generated with goMaker.* diff --git a/content/data-model/chainstate.md b/content/data-model/chainstate.md index 719ca66ad..9f6ef581a 100644 --- a/content/data-model/chainstate.md +++ b/content/data-model/chainstate.md @@ -28,7 +28,6 @@ contract. This is the decoded `output` value of the smart contract call. The following commands produce and manage States: -- [chifra export](/chifra/accounts/#chifra-export) - [chifra state](/chifra/chainstate/#chifra-state) States consist of the following fields: @@ -41,9 +40,10 @@ States consist of the following fields: | address | the address of contract being called | address | | accountType | the type of account at the given block | string | | balance | the balance of the account at the given block | wei | +| ether | if --ether is specified, the balance in ether (calculated) | ether | | code | the code of the account | string | | deployed | for smart contracts only, the block number at which the contract was deployed | blknum | -| nonce | the nonce of the account at the given block | uint64 | +| nonce | the nonce of the account at the given block | value | | proxy | the proxy address of the account at the given block | address | ## Token @@ -58,22 +58,23 @@ The following commands produce and manage Tokens: Tokens consist of the following fields: -| Field | Description | Type | -| ---------------- | --------------------------------------------------------------------- | --------- | -| blockNumber | the block at which the report is made | blknum | -| transactionIndex | the transaction index (if applicable) at which the report is made | blknum | -| timestamp | the timestamp of the block | timestamp | -| date | the timestamp as a date (calculated) | datetime | -| totalSupply | the total supply of the token contract | int256 | -| address | the address of the token contract | address | -| holder | the holder address for which we are reporting | address | -| priorBalance | the holder's asset balance at its prior appearance | int256 | -| balance | the holder's asset balance at the given block height | int256 | -| diff | the difference#&44; if any#&44; between the prior and current balance | int256 | -| name | the name of the token contract, if available | string | -| symbol | the symbol of the token contract | string | -| decimals | the number of decimals for the token contract | uint64 | -| type | the type of token (ERC20 or ERC721) or none | TokenType | +| Field | Description | Type | +| ---------------- | -------------------------------------------------------------------------- | --------- | +| blockNumber | the block at which the report is made | blknum | +| transactionIndex | the transaction index (if applicable) at which the report is made | txnum | +| timestamp | the timestamp of the block | timestamp | +| date | the timestamp as a date (calculated) | datetime | +| totalSupply | the total supply of the token contract | int256 | +| address | the address of the token contract | address | +| holder | the holder address for which we are reporting | address | +| priorBalance | the holder's asset balance at its prior appearance | int256 | +| balance | the holder's asset balance at the given block height | int256 | +| diff | the difference, if any, between the prior and current balance (calculated) | int256 | +| name | the name of the token contract, if available | string | +| symbol | the symbol of the token contract | string | +| decimals | the number of decimals for the token contract | uint64 | +| type | the type of token (ERC20 or ERC721) or none | TokenType | +What about balanceDec? ## Result @@ -102,15 +103,18 @@ Results consist of the following fields: This documentation mentions the following basic data types. -| Type | Description | Notes | -| --------- | ----------------------------------- | -------------- | -| address | an '0x'-prefixed 20-byte hex string | lowercase | -| blknum | an alias for a uint64 | | -| datetime | a JSON formatted date | as a string | -| int256 | a signed big number | as a string | -| string | a normal character string | | -| timestamp | a 64-bit unsigned integer | Unix timestamp | -| uint64 | a 64-bit unsigned integer | | -| wei | an unsigned big number | as a string | +| Type | Description | Notes | +| --------- | -------------------------------------- | -------------- | +| address | an '0x'-prefixed 20-byte hex string | lowercase | +| blknum | an alias for a uint64 | | +| datetime | a JSON formatted date | as a string | +| ether | a big number float | as a string | +| int256 | a signed big number | as a string | +| string | a normal character string | | +| timestamp | a 64-bit unsigned integer | Unix timestamp | +| txnum | an alias for a uint64 | | +| uint64 | a 64-bit unsigned integer | | +| value | an alias for a 64-bit unsigned integer | | +| wei | an unsigned big number | as a string | *Copyright (c) 2024, TrueBlocks, LLC. All rights reserved. Generated with goMaker.* diff --git a/content/data-model/other.md b/content/data-model/other.md index 88d9ed9cf..fc0c54a10 100644 --- a/content/data-model/other.md +++ b/content/data-model/other.md @@ -64,6 +64,12 @@ The following commands produce and manage Functions: - [chifra abis](/chifra/accounts/#chifra-abis) - [chifra export](/chifra/accounts/#chifra-export) +- [chifra transactions](/chifra/chaindata/#chifra-transactions) +- [chifra receipts](/chifra/chaindata/#chifra-receipts) +- [chifra logs](/chifra/chaindata/#chifra-logs) +- [chifra traces](/chifra/chaindata/#chifra-traces) +- [chifra state](/chifra/chainstate/#chifra-state) +- [chifra slurp](/chifra/other/#chifra-slurp) Functions consist of the following fields: @@ -89,6 +95,12 @@ The following commands produce and manage Parameters: - [chifra abis](/chifra/accounts/#chifra-abis) - [chifra export](/chifra/accounts/#chifra-export) +- [chifra transactions](/chifra/chaindata/#chifra-transactions) +- [chifra receipts](/chifra/chaindata/#chifra-receipts) +- [chifra logs](/chifra/chaindata/#chifra-logs) +- [chifra traces](/chifra/chaindata/#chifra-traces) +- [chifra state](/chifra/chainstate/#chifra-state) +- [chifra slurp](/chifra/other/#chifra-slurp) Parameters consist of the following fields: @@ -117,52 +129,65 @@ Slurps consist of the following fields: | hash | the hash of the transaction | hash | | blockHash | the hash of the block containing this transaction | hash | | blockNumber | the number of the block | blknum | -| transactionIndex | the zero-indexed position of the transaction in the block | blknum | -| nonce | sequence number of the transactions sent by the sender | uint64 | +| transactionIndex | the zero-indexed position of the transaction in the block | txnum | +| nonce | sequence number of the transactions sent by the sender | value | | timestamp | the Unix timestamp of the object | timestamp | | date | the timestamp as a date (calculated) | datetime | | from | address from which the transaction was sent | address | | to | address to which the transaction was sent | address | | value | the amount of wei sent with this transactions | wei | +| ether | if --ether is specified, the value in ether (calculated) | ether | | gas | the maximum number of gas allowed for this transaction | gas | | gasPrice | the number of wei per unit of gas the sender is willing to spend | gas | | input | byte data either containing a message or funcational data for a smart contracts. See the --articulate | bytes | | hasToken | `true` if the transaction is token related, `false` otherwise | bool | | articulatedTx | if present, the function that was called in the transaction | [Function](/data-model/other/#function) | -| compressedTx | truncated, more readable version of the articulation | string | +| compressedTx | truncated, more readable version of the articulation (calculated) | string | | isError | `true` if the transaction ended in error, `false` otherwise | bool | -## SlurpCount +## Message -The `slurpCount` carries information about the counts returned by remote APIs. +The Message type is used in various places to return information about a command. For example, when using the `chifra names --autoname` feature in the SDK, a Message type is returned. -The following commands produce and manage SlurpCounts: +The following commands produce and manage Messages: -- [chifra slurp](/chifra/other/#chifra-slurp) +- [chifra blocks](/chifra/chaindata/#chifra-blocks) +- [chifra chunks](/chifra/admin/#chifra-chunks) +- [chifra export](/chifra/accounts/#chifra-export) +- [chifra logs](/chifra/chaindata/#chifra-logs) +- [chifra monitors](/chifra/accounts/#chifra-monitors) +- [chifra names](/chifra/accounts/#chifra-names) +- [chifra state](/chifra/chainstate/#chifra-state) +- [chifra traces](/chifra/chaindata/#chifra-traces) +- [chifra transactions](/chifra/chaindata/#chifra-transactions) +- [chifra when](/chifra/chaindata/#chifra-when) -SlurpCounts consist of the following fields: +Messages consist of the following fields: -| Field | Description | Type | -| ------- | ------------------------------------------------------- | ------- | -| address | the address used to query the API | address | -| count | the number of records known by the API for this address | uint64 | +| Field | Description | Type | +| ----- | ------------------ | ------ | +| msg | the message | string | +| num | a number if needed | int64 | ## Base types This documentation mentions the following basic data types. -| Type | Description | Notes | -| --------- | ----------------------------------- | -------------- | -| address | an '0x'-prefixed 20-byte hex string | lowercase | -| blknum | an alias for a uint64 | | -| bool | either `true`, `false`, `1`, or `0` | | -| bytes | an arbitrarily long string of bytes | | -| datetime | a JSON formatted date | as a string | -| gas | an unsigned big number | as a string | -| hash | an '0x'-prefixed 32-byte hex string | lowercase | -| string | a normal character string | | -| timestamp | a 64-bit unsigned integer | Unix timestamp | -| uint64 | a 64-bit unsigned integer | | -| wei | an unsigned big number | as a string | +| Type | Description | Notes | +| --------- | -------------------------------------- | -------------- | +| address | an '0x'-prefixed 20-byte hex string | lowercase | +| blknum | an alias for a uint64 | | +| bool | either `true`, `false`, `1`, or `0` | | +| bytes | an arbitrarily long string of bytes | | +| datetime | a JSON formatted date | as a string | +| ether | a big number float | as a string | +| gas | a 64-bit unsigned integer | | +| hash | an '0x'-prefixed 32-byte hex string | lowercase | +| int64 | a 64-bit signed integer | | +| string | a normal character string | | +| timestamp | a 64-bit unsigned integer | Unix timestamp | +| txnum | an alias for a uint64 | | +| value | an alias for a 64-bit unsigned integer | | +| wei | an unsigned big number | as a string | *Copyright (c) 2024, TrueBlocks, LLC. All rights reserved. Generated with goMaker.*