Skip to content

Commit

Permalink
docs: frontmatter
Browse files Browse the repository at this point in the history
  • Loading branch information
jxom committed Feb 26, 2023
1 parent c47a881 commit bf655d6
Show file tree
Hide file tree
Showing 138 changed files with 1,896 additions and 16 deletions.
14 changes: 14 additions & 0 deletions site/docs/actions/public/call.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,17 @@
---
head:
- - meta
- name: title
content: call
- - meta
- name: description
content: An Action for executing a new message call.
- - meta
- property: og:description
content: An Action for executing a new message call.

---

# call

Executes a new message call immediately without submitting a transaction to the network.
Expand Down
14 changes: 14 additions & 0 deletions site/docs/actions/public/createBlockFilter.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,17 @@
---
head:
- - meta
- name: title
content: createBlockFilter
- - meta
- name: description
content: An Action for creating a new Block Filter.
- - meta
- property: og:description
content: An Action for creating a new Block Filter.

---

# createBlockFilter

Creates a Filter to listen for new block hashes that can be used with [`getFilterChanges`](/TODO).
Expand Down
14 changes: 14 additions & 0 deletions site/docs/actions/public/createEventFilter.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,17 @@
---
head:
- - meta
- name: title
content: createEventFilter
- - meta
- name: description
content: An Action for creating a new Event Filter.
- - meta
- property: og:description
content: An Action for creating a new Event Filter.

---

# createEventFilter

Creates a Filter to listen for new events that can be used with [`getFilterChanges`](/docs/actions/public/getFilterChanges).
Expand Down
14 changes: 14 additions & 0 deletions site/docs/actions/public/createPendingTransactionFilter.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,17 @@
---
head:
- - meta
- name: title
content: createPendingTransactionFilter
- - meta
- name: description
content: An Action for creating a new pending transaction filter.
- - meta
- property: og:description
content: An Action for creating a new pending transaction filter.

---

# createPendingTransactionFilter

Creates a Filter to listen for new pending transaction hashes that can be used with [`getFilterChanges`](/docs/actions/public/getFilterChanges).
Expand Down
14 changes: 14 additions & 0 deletions site/docs/actions/public/estimateGas.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,17 @@
---
head:
- - meta
- name: title
content: estimateGas
- - meta
- name: description
content: An Action for estimating gas for a transaction.
- - meta
- property: og:description
content: An Action for estimating gas for a transaction.

---

# estimateGas

Estimates the gas necessary to complete a transaction without submitting it to the network.
Expand Down
14 changes: 14 additions & 0 deletions site/docs/actions/public/getBalance.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,17 @@
---
head:
- - meta
- name: title
content: getBalance
- - meta
- name: description
content: Returns the balance of an address in wei.
- - meta
- property: og:description
content: Returns the balance of an address in wei.

---

# getBalance

Returns the balance of an address in wei.
Expand Down
14 changes: 14 additions & 0 deletions site/docs/actions/public/getBlock.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,17 @@
---
head:
- - meta
- name: title
content: getBlock
- - meta
- name: description
content: Returns information about a block at a block number, hash or tag.
- - meta
- property: og:description
content: Returns information about a block at a block number, hash or tag.

---

# getBlock

Returns information about a block at a block number, hash or tag.
Expand Down
14 changes: 14 additions & 0 deletions site/docs/actions/public/getBlockNumber.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,17 @@
---
head:
- - meta
- name: title
content: getBlockNumber
- - meta
- name: description
content: Returns the number of the most recent block seen.
- - meta
- property: og:description
content: Returns the number of the most recent block seen.

---

# getBlockNumber

Returns the number of the most recent block seen.
Expand Down
14 changes: 14 additions & 0 deletions site/docs/actions/public/getBlockTransactionCount.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,17 @@
---
head:
- - meta
- name: title
content: getBlockTransactionCount
- - meta
- name: description
content: Returns the number of Transactions at a block number, hash or tag.
- - meta
- property: og:description
content: Returns the number of Transactions at a block number, hash or tag.

---

# getBlockTransactionCount

Returns the number of Transactions at a block number, hash or tag.
Expand Down
14 changes: 14 additions & 0 deletions site/docs/actions/public/getChainId.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,17 @@
---
head:
- - meta
- name: title
content: getChainId
- - meta
- name: description
content: Returns the chain ID associated with the current network
- - meta
- property: og:description
content: Returns the chain ID associated with the current network

---

# getChainId

Returns the chain ID associated with the current network
Expand Down
14 changes: 14 additions & 0 deletions site/docs/actions/public/getFeeHistory.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,17 @@
---
head:
- - meta
- name: title
content: getFeeHistory
- - meta
- name: description
content: Returns a collection of historical gas information.
- - meta
- property: og:description
content: Returns a collection of historical gas information.

---

# getFeeHistory

Returns a collection of historical gas information.
Expand Down
14 changes: 14 additions & 0 deletions site/docs/actions/public/getFilterChanges.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,17 @@
---
head:
- - meta
- name: title
content: getFilterChanges
- - meta
- name: description
content: Returns a list of logs or hashes based on a Filter.
- - meta
- property: og:description
content: Returns a list of logs or hashes based on a Filter.

---

# getFilterChanges

Returns a list of logs or hashes based on a [Filter](/docs/glossary/terms#TODO) since the last time it was called.
Expand Down
14 changes: 14 additions & 0 deletions site/docs/actions/public/getFilterLogs.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,17 @@
---
head:
- - meta
- name: title
content: getFilterLogs
- - meta
- name: description
content: Returns a list of event logs since the filter was created.
- - meta
- property: og:description
content: Returns a list of event logs since the filter was created.

---

# getFilterLogs

Returns a list of **event** logs since the filter was created.
Expand Down
14 changes: 14 additions & 0 deletions site/docs/actions/public/getGasPrice.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,17 @@
---
head:
- - meta
- name: title
content: getGasPrice
- - meta
- name: description
content: Returns the current price of gas (in wei).
- - meta
- property: og:description
content: Returns the current price of gas (in wei).

---

# getGasPrice

Returns the current price of gas (in wei).
Expand Down
14 changes: 14 additions & 0 deletions site/docs/actions/public/getLogs.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,17 @@
---
head:
- - meta
- name: title
content: getLogs
- - meta
- name: description
content: Returns a list of event logs matching the provided parameters.
- - meta
- property: og:description
content: Returns a list of event logs matching the provided parameters.

---

# getLogs

Returns a list of **event** logs matching the provided parameters.
Expand Down
14 changes: 14 additions & 0 deletions site/docs/actions/public/getTransaction.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,17 @@
---
head:
- - meta
- name: title
content: getTransaction
- - meta
- name: description
content: Returns information about a transaction given a hash or block identifier.
- - meta
- property: og:description
content: Returns information about a transaction given a hash or block identifier.

---

# getTransaction

Returns information about a transaction given a hash or block identifier.
Expand Down
14 changes: 14 additions & 0 deletions site/docs/actions/public/getTransactionConfirmations.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,17 @@
---
head:
- - meta
- name: title
content: getTransactionConfirmations
- - meta
- name: description
content: Returns the number of blocks passed (confirmations) since the transaction was processed on a block.
- - meta
- property: og:description
content: Returns the number of blocks passed (confirmations) since the transaction was processed on a block.

---

# getTransactionConfirmations

Returns the number of blocks passed (confirmations) since the transaction was processed on a block.
Expand Down
14 changes: 14 additions & 0 deletions site/docs/actions/public/getTransactionCount.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,17 @@
---
head:
- - meta
- name: title
content: getTransactionCount
- - meta
- name: description
content: Returns the number of Transactions an Account has broadcast / sent.
- - meta
- property: og:description
content: Returns the number of Transactions an Account has broadcast / sent.

---

# getTransactionCount

Returns the number of [Transactions](/docs/glossary/terms#TODO) an Account has broadcast / sent.
Expand Down
14 changes: 14 additions & 0 deletions site/docs/actions/public/getTransactionReceipt.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,17 @@
---
head:
- - meta
- name: title
content: getTransactionReceipt
- - meta
- name: description
content: Returns the transaction receipt given a transaction hash.
- - meta
- property: og:description
content: Returns the transaction receipt given a transaction hash.

---

# getTransactionReceipt

Returns the transaction receipt given a transaction hash.
Expand Down
20 changes: 19 additions & 1 deletion site/docs/actions/public/introduction.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,21 @@
---
head:
- - meta
- name: title
content: Introduction to Public Actions
- - meta
- name: description
content: A brief introduction on what Public Actions are in viem.
- - meta
- property: og:description
content: A brief introduction on what Public Actions are in viem.

---

# Introduction to Public Actions

TODO
A Public Action is an action that maps one-to-one with a "public" Ethereum RPC method (`eth_blockNumber`, `eth_getBalance`, etc). They are used with a [Public Client](/docs/clients/public).

Public Actions do not require any special permissions nor do they provide signing capabilities to the user. Examples of Public Actions include [getting the balance of an account](/docs/actions/public/getBalance), [retrieving the details of a specific transaction](/docs/actions/public/getTransactionReceipt), and [getting the current block number](/docs/actions/public/getBlockNumber) of the network.

Public Actions provide a simple and secure way to access public data on the Ethereum blockchain. They are widely used by dapps and other applications that need to retrieve information about transactions, accounts, blocks and other data on the network.
7 changes: 0 additions & 7 deletions site/docs/actions/public/introuction.md

This file was deleted.

16 changes: 15 additions & 1 deletion site/docs/actions/public/uninstallFilter.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,20 @@
---
head:
- - meta
- name: title
content: uninstallFilter
- - meta
- name: description
content: Destroys a Filter.
- - meta
- property: og:description
content: Destroys a Filter.

---

# uninstallFilter

Destroys a Filter that was created from one of the following actions:
Destroys a Filter that was created from one of the following Actions:

- [`createBlockFilter`](/docs/actions/public/createBlockFilter)
- [`createEventFilter`](/docs/actions/public/createEventFilter)
Expand Down

2 comments on commit bf655d6

@vercel
Copy link

@vercel vercel bot commented on bf655d6 Feb 26, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

viem-site – ./site

viem-site-git-main-wagmi-dev.vercel.app
viem-site.vercel.app
viem-site-wagmi-dev.vercel.app
www.viem.sh
viem.sh

@vercel
Copy link

@vercel vercel bot commented on bf655d6 Feb 26, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

viem-playground – ./playgrounds/browser

viem-playground-git-main-wagmi-dev.vercel.app
viem-playground-wagmi-dev.vercel.app
viem-playground.vercel.app

Please sign in to comment.