Skip to content

Commit

Permalink
Add category files
Browse files Browse the repository at this point in the history
  • Loading branch information
Juuddi committed Jun 3, 2024
1 parent 5c6273b commit eb8d201
Show file tree
Hide file tree
Showing 12 changed files with 83 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/static/abi.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: Application Binary Interface
description: 'Implement smart contracts through their Application Binary Interface (ABI).'
---
13 changes: 13 additions & 0 deletions docs/static/address.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: Addresses
description: ''
---

Addresses are a fundamental part of interacting with Quai Network. They represent the gloabal identity of Externally Owned Accounts (accounts backed by a private key), contracts, and UTXO wallets.

These functions help convert between various formats, validate addresses across the Quai and Qi address spaces, and other utilities for working with addresses.

The Quais SDK supports the following address formats:

- `quai` addresses
- `qi` addresses
4 changes: 4 additions & 0 deletions docs/static/constants.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: Constants
description: 'A collection of useful constants when interacting with Quai Network.'
---
6 changes: 6 additions & 0 deletions docs/static/crypto.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Cryptographic Functions
description: 'A set of common cryptographic functions used in Quai Network.'
---

A fundamental building block of Quai Network is the underlying cryptographic primitives.
4 changes: 4 additions & 0 deletions docs/static/encoding.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: Encoding Utilities
description: 'Utilities for common tasks involving data encoding.'
---
4 changes: 4 additions & 0 deletions docs/static/hash.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: Hashing Utilities
description: 'Utilities for common tasks involving hashing.'
---
8 changes: 8 additions & 0 deletions docs/static/provider.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: Providers
description: 'Configure and utilize a Provider to interact with Quai Network.'
---

A Provider provides a connection to the blockchain, whch can be used to query its current state, simulate execution and send transactions to update the state.

It is one of the most fundamental components of interacting with a blockchain application, and there are many ways to connect, such as over HTTP, WebSockets or injected providers such as Pelagus.
6 changes: 6 additions & 0 deletions docs/static/signer.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Signers
description: 'Configure and manage signers for Quai and Qi.'
---

A Signer can represent an account on the either the Quai or Qi ledger, and is most often backed by a private key represented by a mnemonic or residing on a Hardware Wallet.
6 changes: 6 additions & 0 deletions docs/static/transactions.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Transactions
description: 'Build and sign transactions on Quai Network.'
---

Transactions are a fundamental piece of Quai Network. Every state-changing operation within the network requires a signed transaction.
6 changes: 6 additions & 0 deletions docs/static/utils.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Utilities
description: 'Utility functions for common tasks.'
---

A collection of useful utilities for manipulating data, mathematical operations, and more.
10 changes: 10 additions & 0 deletions docs/static/wallet.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Wallets
description: 'A combination of generalized and low-level wallet tools.'
---

When interacting with either Qi or Quai, it is necessary to use a private key authenticate actions by signing a payload.

Wallets are the simplest way to expose the concept of an Externally Owner Account (EOA) or UTXO account as it wraps a private key and supports high-level methods to sign common types of interaction and send transactions.

The class most developers will want to use is Wallet, which can load a private key directly or from any common wallet format.
12 changes: 12 additions & 0 deletions docs/static/wordlists.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: Wordlists
description: 'A collection of wordlists for use in various applications.'
---

A Wordlist is a set of 2048 words used to encode private keys (or other binary data) that is easier for humans to write down, transcribe and dictate.

The BIP-39 standard includes several checksum bits, depending on the size of the mnemonic phrase.

A mnemonic phrase may be 12, 15, 18, 21 or 24 words long. For most purposes 12 word mnemonics should be used, as including additional words increases the difficulty and potential for mistakes and does not offer any effective improvement on security.

There are a variety of BIP-39 Wordlists for different languages, b

0 comments on commit eb8d201

Please sign in to comment.