Indent Markdown lists 1 space for stand-alone lists

2 spaces only works with other prefixed text.
pull/162/head
Luke Imhoff 7 years ago
parent 840c64abca
commit 8e09990248
  1. 16
      apps/explorer/lib/explorer/chain.ex
  2. 8
      apps/explorer/lib/explorer/chain/block.ex
  3. 4
      apps/explorer/lib/explorer/chain/internal_transaction/type.ex
  4. 5
      apps/explorer/lib/explorer/chain/log.ex
  5. 3
      apps/explorer/lib/explorer/chain/statistics.ex
  6. 3
      apps/explorer/lib/explorer/chain/transaction.ex
  7. 2
      apps/explorer/lib/explorer/chain/wei.ex
  8. 4
      apps/explorer/lib/explorer/jsonrpc/block.ex
  9. 3
      apps/explorer/lib/explorer/jsonrpc/receipt.ex
  10. 3
      apps/explorer/lib/explorer/jsonrpc/transaction.ex

@ -50,13 +50,13 @@ defmodule Explorer.Chain do
## Options ## Options
* `:direction` - if specified, will filter internal transactions by address type. If `:to` is specified, only internal * `:direction` - if specified, will filter internal transactions by address type. If `:to` is specified, only
transactions where the "to" address matches will be returned. Likewise, if `:from` is specified, only internal internal transactions where the "to" address matches will be returned. Likewise, if `:from` is specified, only
transactions where the "from" address matches will be returned. If :direction is omitted, internal transactions either internal transactions where the "from" address matches will be returned. If :direction is omitted, internal
to or from the address will be returned. transactions either to or from the address will be returned.
* `:necessity_by_association` - use to load `t:association/0` as `:required` or `:optional`. If an association is * `:necessity_by_association` - use to load `t:association/0` as `:required` or `:optional`. If an association is
`:required`, and the `t:Explorer.Chain.InternalTransaction.t/0` has no associated record for that association, then `:required`, and the `t:Explorer.Chain.InternalTransaction.t/0` has no associated record for that association,
the `t:Explorer.Chain.InternalTransaction.t/0` will not be included in the page `entries`. then the `t:Explorer.Chain.InternalTransaction.t/0` will not be included in the page `entries`.
* `:pagination` - pagination params to pass to scrivener. * `:pagination` - pagination params to pass to scrivener.
""" """
@ -723,8 +723,8 @@ defmodule Explorer.Chain do
* `:insert_logs_timeout` - the timeout for inserting all logs. Defaults to `#{@insert_logs_timeout}` milliseconds. * `:insert_logs_timeout` - the timeout for inserting all logs. Defaults to `#{@insert_logs_timeout}` milliseconds.
* `:insert_receipts_timeout` - the timeout for inserting all receipts. Defaults to `#{@insert_receipts_timeout}` * `:insert_receipts_timeout` - the timeout for inserting all receipts. Defaults to `#{@insert_receipts_timeout}`
milliseconds. milliseconds.
* `:insert_transactions_timeout` - the timeout for inserting all transactions found in the params lists across all types. * `:insert_transactions_timeout` - the timeout for inserting all transactions found in the params lists across all
Defaults to `#{@insert_transactions_timeout}` milliseconds. types. Defaults to `#{@insert_transactions_timeout}` milliseconds.
""" """
def import_blocks( def import_blocks(
%{ %{

@ -26,10 +26,10 @@ defmodule Explorer.Chain.Block do
@typedoc """ @typedoc """
* `difficulty` - how hard the block was to mine. * `difficulty` - how hard the block was to mine.
* `gas_limit` - If the total number of gas used by the computation spawned by the transaction, including the original * `gas_limit` - If the total number of gas used by the computation spawned by the transaction, including the
message and any sub-messages that may be triggered, is less than or equal to the gas limit, then the transaction original message and any sub-messages that may be triggered, is less than or equal to the gas limit, then the
processes. If the total gas exceeds the gas limit, then all changes are reverted, except that the transaction is transaction processes. If the total gas exceeds the gas limit, then all changes are reverted, except that the
still valid and the fee can still be collected by the miner. transaction is still valid and the fee can still be collected by the miner.
* `gas_used` - The actual `t:gas/0` used to mine/validate the transactions in the block. * `gas_used` - The actual `t:gas/0` used to mine/validate the transactions in the block.
* `hash` - the hash of the block. * `hash` - the hash of the block.
* `miner` - the hash of the `t:Explorer.Chain.Address.t/0` of the miner. In Proof-of-Authority chains, this is the * `miner` - the hash of the `t:Explorer.Chain.Address.t/0` of the miner. In Proof-of-Authority chains, this is the

@ -8,10 +8,10 @@ defmodule Explorer.Chain.InternalTransaction.Type do
@typedoc """ @typedoc """
* `:call` * `:call`
* `:create` * `:create`
* `:suicide`
* `:reward` * `:reward`
* `:suicide`
""" """
@type t :: :call | :create | :suicide | :reward @type t :: :call | :create | :reward | :suicide
@doc """ @doc """
Casts `term` to `t:t/0` Casts `term` to `t:t/0`

@ -18,8 +18,9 @@ defmodule Explorer.Chain.Log do
* `receipt` - receipt for the `transaction` being mined in a block * `receipt` - receipt for the `transaction` being mined in a block
* `second_topic` - `topics[1]` * `second_topic` - `topics[1]`
* `transaction` - transaction for which `receipt` is * `transaction` - transaction for which `receipt` is
* `transaction_hash` - foreign key for `receipt`. **ALWAYS join throught `receipts` and not directly to `transaction` * `transaction_hash` - foreign key for `receipt`. **ALWAYS join through `receipts` and not directly to
to ensure that any `t:Explorer.Chain.Transaction.t/0` has a receipt before it has logs in that receipt.** `transaction` to ensure that any `t:Explorer.Chain.Transaction.t/0` has a receipt before it has logs in that
receipt.**
* `third_topic` - `topics[2]` * `third_topic` - `topics[2]`
* `type` - type of event * `type` - type of event
""" """

@ -74,7 +74,8 @@ defmodule Explorer.Chain.Statistics do
(`t:Explorer.Chain.Block.t/0` `timestamp`) and when it was inserted into the databasse (`t:Explorer.Chain.Block.t/0` `timestamp`) and when it was inserted into the databasse
(`t:Explorer.Chain.Block.t/0` `inserted_at`) (`t:Explorer.Chain.Block.t/0` `inserted_at`)
* `number` - the latest `t:Explorer.Chain.Block.t/0` `number` * `number` - the latest `t:Explorer.Chain.Block.t/0` `number`
* `skipped_blocks` - the number of blocks that were mined/validated, but do not exist as `t:Explorer.Chain.Block.t/0` * `skipped_blocks` - the number of blocks that were mined/validated, but do not exist as
`t:Explorer.Chain.Block.t/0`
* `timestamp` - when the last `t:Explorer.Chain.Block.t/0` was mined/validated * `timestamp` - when the last `t:Explorer.Chain.Block.t/0` was mined/validated
* `transaction_count` - the number of transactions confirmed in blocks that were mined/validated in the last day * `transaction_count` - the number of transactions confirmed in blocks that were mined/validated in the last day
* `transaction_velocity` - the number of `t:Explorer.Chain.Block.t/0` mined/validated in the last minute * `transaction_velocity` - the number of `t:Explorer.Chain.Block.t/0` mined/validated in the last minute

@ -80,7 +80,8 @@ defmodule Explorer.Chain.Transaction do
* `hash` - hash of contents of this transaction * `hash` - hash of contents of this transaction
* `index` - index of this transaction in `block`. `nil` when transaction is pending. * `index` - index of this transaction in `block`. `nil` when transaction is pending.
* `input`- data sent along with the transaction * `input`- data sent along with the transaction
* `internal_transactions` - transactions (value transfers) created while executing contract used for this transaction * `internal_transactions` - transactions (value transfers) created while executing contract used for this
transaction
* `nonce` - the number of transaction made by the sender prior to this one * `nonce` - the number of transaction made by the sender prior to this one
* `public_key` - public key of the signer of the transaction * `public_key` - public key of the signer of the transaction
* `r` - the R field of the signature. The (r, s) is the normal output of an ECDSA signature, where r is computed as * `r` - the R field of the signature. The (r, s) is the normal output of an ECDSA signature, where r is computed as

@ -89,7 +89,7 @@ defmodule Explorer.Chain.Wei do
@typedoc """ @typedoc """
Short for giga-wei Short for giga-wei
* 10<sup>9</sup> wei is one gwei 10<sup>9</sup> wei is 1 gwei.
""" """
@type gwei :: Decimal.t() @type gwei :: Decimal.t()

@ -18,8 +18,8 @@ defmodule Explorer.JSONRPC.Block do
* `"gasLimit" - maximum gas `t:Explorer.JSONRPC.quantity/0`` in this block. * `"gasLimit" - maximum gas `t:Explorer.JSONRPC.quantity/0`` in this block.
* `"gasUsed" - the total `t:Explorer.JSONRPC.quantity/0`` of gas used by all transactions in this block. * `"gasUsed" - the total `t:Explorer.JSONRPC.quantity/0`` of gas used by all transactions in this block.
* `"hash"` - the `t:Explorer.JSONRPC.hash/0` of the block. * `"hash"` - the `t:Explorer.JSONRPC.hash/0` of the block.
* `"logsBloom"` - `t:Explorer.JSONRPC.data/0`` for the [Bloom filter](https://en.wikipedia.org/wiki/Bloom_filter) for * `"logsBloom"` - `t:Explorer.JSONRPC.data/0`` for the [Bloom filter](https://en.wikipedia.org/wiki/Bloom_filter)
the logs of the block. `nil` when block is pending. for the logs of the block. `nil` when block is pending.
* `"miner"` - `t:Explorer.JSONRPC.address/0` of the beneficiary to whom the mining rewards were given. Aliased by * `"miner"` - `t:Explorer.JSONRPC.address/0` of the beneficiary to whom the mining rewards were given. Aliased by
`"author"`. `"author"`.
* `"nonce"` - `t:Explorer.JSONRPC.nonce/0`. `nil` when its pending block. * `"nonce"` - `t:Explorer.JSONRPC.nonce/0`. `nil` when its pending block.

@ -17,7 +17,8 @@ defmodule Explorer.JSONRPC.Receipt do
creation, otherwise `nil`. creation, otherwise `nil`.
* `"blockHash"` - `t:Explorer.JSONRPC.hash/0` of the block where `"transactionHash"` was in. * `"blockHash"` - `t:Explorer.JSONRPC.hash/0` of the block where `"transactionHash"` was in.
* `"blockNumber"` - The block number `t:Explorer.JSONRPC.quanity/0`. * `"blockNumber"` - The block number `t:Explorer.JSONRPC.quanity/0`.
* `"cumulativeGasUsed"` - `t:Explorer.JSONRPC.quantity/0` of gas used when this transaction was executed in the block. * `"cumulativeGasUsed"` - `t:Explorer.JSONRPC.quantity/0` of gas used when this transaction was executed in the
block.
* `"gasUsed"` - `t:Explorer.JSONRPC.quantity/0` of gas used by this specific transaction alone. * `"gasUsed"` - `t:Explorer.JSONRPC.quantity/0` of gas used by this specific transaction alone.
* `"logs"` - `t:list/0` of log objects, which this transaction generated. * `"logs"` - `t:list/0` of log objects, which this transaction generated.
* `"logsBloom"` - `t:Explorer.JSONRPC.data/0` of 256 Bytes for * `"logsBloom"` - `t:Explorer.JSONRPC.data/0` of 256 Bytes for

@ -15,7 +15,8 @@ defmodule Explorer.JSONRPC.Transaction do
@type elixir :: %{String.t() => JSONRPC.address() | JSONRPC.hash() | String.t() | non_neg_integer() | nil} @type elixir :: %{String.t() => JSONRPC.address() | JSONRPC.hash() | String.t() | non_neg_integer() | nil}
@typedoc """ @typedoc """
* `"blockHash"` - `t:Explorer.JSONRPC.hash/0` of the block this transaction is in. `nil` when transaction is pending. * `"blockHash"` - `t:Explorer.JSONRPC.hash/0` of the block this transaction is in. `nil` when transaction is
pending.
* `"blockNumber"` - `t:Explorer.JSONRPC.quantity/0` for the block number this transaction is in. `nil` when * `"blockNumber"` - `t:Explorer.JSONRPC.quantity/0` for the block number this transaction is in. `nil` when
transaction is pending. transaction is pending.
* `"chainId"` - the chain on which the transaction exists. * `"chainId"` - the chain on which the transaction exists.

Loading…
Cancel
Save