Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion docs/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
boost: 0.2
---

## [Unreleased]

### Added
Expand Down Expand Up @@ -29,7 +34,7 @@
- `pyproject.toml`: set `python-source = "python"` and moved the package stub tree under `python/kaspa/` (`kaspa.pyi` → `python/kaspa/__init__.pyi`).
- `Hash` accepts `str` in addition to `Hash` instances wherever it is used as an argument, and gained a `to_hex()` method.
- Added `__repr__` methods to: `Hash`, `Balance`, `Binary`, `Address`, `NetworkId`, `ScriptPublicKey`, `TransactionOutpoint`, `Transaction`, `TransactionInput`, `TransactionOutput`, `UtxoEntry`, `UtxoEntries` (consensus and generator helper), `UtxoEntryReference`, `ScriptBuilder`, `Wallet`, `Fees`, `PaymentOutput`, `Outputs`, `Generator`, `GeneratorSummary`, `PendingTransaction`, `BalanceStrings`, `UtxoProcessorEvent`, `UtxoProcessor`, `UtxoContext`, `Notification`, `Resolver`, `NotificationEvent`, `RpcClient`, `DerivationPath`, `XPub`, `PublicKey`, `XOnlyPublicKey`, `PublicKeyGenerator`.
- Documentation site reorganization
- Documentation site reorganization & search ranking

### Fixed
- `AccountDescriptor.__repr__` now correctly renders optional fields.
Expand Down
5 changes: 5 additions & 0 deletions docs/examples.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
boost: 3
---

# Examples

Runnable examples live in the SDK repository, not in these docs. Each
Expand Down
21 changes: 21 additions & 0 deletions docs/gen_ref_pages.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,23 @@
"Exceptions",
]

CLASS_BOOSTS = {
"Wallet": 10,
"RpcClient": 8,
"Address": 8,
"Transaction": 8,
"Generator": 6,
"UtxoEntry": 5,
"PublicKey": 5,
"PrivateKey": 5,
"Mnemonic": 5,
"UtxoProcessor": 5,
"UtxoContext": 5,
"Resolver": 4,
"ScriptBuilder": 4,
"NetworkId": 4,
}


def parse_stub_file(content: str) -> dict:
"""
Expand Down Expand Up @@ -161,6 +178,10 @@ def category_to_nav_path(category: str) -> tuple:
with mkdocs_gen_files.open(doc_path, "w") as f:
if category == "Exceptions":
f.write("---\nsearch:\n boost: 0.3\n---\n\n")
elif category == "TypedDicts":
f.write("---\nsearch:\n boost: 0.6\n---\n\n")
elif name in CLASS_BOOSTS:
f.write(f"---\nsearch:\n boost: {CLASS_BOOSTS[name]}\n---\n\n")
f.write(f'# `{name}` ({type_label})\n\n')
f.write(f"::: {module}.{name}\n")
f.write(" options:\n")
Expand Down
5 changes: 5 additions & 0 deletions docs/getting-started/installation.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
boost: 3
---

# Installation

This Python package can be [installed from PyPi](#installation-via-pypi) or [built from source](#installation-from-source).
Expand Down
5 changes: 5 additions & 0 deletions docs/getting-started/security.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
boost: 3
---

# Security

The SDK gives you direct access to mnemonics, seeds, private keys, and wallet
Expand Down
5 changes: 5 additions & 0 deletions docs/learn/addresses.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
boost: 3
---

# Addresses

A Kaspa address encodes a public key or script hash, the address
Expand Down
5 changes: 5 additions & 0 deletions docs/learn/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
boost: 3
---

# Learn

The Learn section on this site is grouped into the following main categories:
Expand Down
5 changes: 5 additions & 0 deletions docs/learn/networks.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
boost: 3
---

# Networks

The Kaspa community runs various public networks: a production mainnet and a few testnets.
Expand Down
5 changes: 5 additions & 0 deletions docs/learn/rpc/calls.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
boost: 3
---

# Calls

Once connected, every RPC method is `await client.<name>(...)`. Most
Expand Down
5 changes: 5 additions & 0 deletions docs/learn/rpc/connecting.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
boost: 3
---

# Connecting

[`RpcClient.connect()`](../../reference/Classes/RpcClient.md#kaspa.RpcClient.connect)
Expand Down
5 changes: 5 additions & 0 deletions docs/learn/rpc/overview.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
boost: 5
---

# RPC

Kaspa nodes expose an RPC API. This SDK provides
Expand Down
5 changes: 5 additions & 0 deletions docs/learn/rpc/resolver.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
boost: 3
---

# Resolver

A [`Resolver`](../../reference/Classes/Resolver.md) finds a public Kaspa
Expand Down
5 changes: 5 additions & 0 deletions docs/learn/rpc/subscriptions.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
boost: 3
---

# Subscriptions

Subscriptions let
Expand Down
5 changes: 5 additions & 0 deletions docs/learn/transactions/inputs.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
boost: 3
---

# Inputs

A transaction's inputs say *which UTXOs are being spent*. Each input
Expand Down
5 changes: 5 additions & 0 deletions docs/learn/transactions/mass-and-fees.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
boost: 3
---

# Mass & fees

Kaspa uses a **mass-based fee model**. Every transaction has a *mass*
Expand Down
5 changes: 5 additions & 0 deletions docs/learn/transactions/metadata.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
boost: 3
---

# Metadata fields

Beyond inputs and outputs, a
Expand Down
5 changes: 5 additions & 0 deletions docs/learn/transactions/outputs.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
boost: 3
---

# Outputs

A transaction's outputs are the new UTXOs it creates. Each carries a
Expand Down
5 changes: 5 additions & 0 deletions docs/learn/transactions/overview.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
boost: 5
---

# Transactions

A Kaspa transaction has the same shape as on any UTXO chain: a list
Expand Down
5 changes: 5 additions & 0 deletions docs/learn/transactions/scripts.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
boost: 3
---

# Scripts

A [`ScriptPublicKey`](../../reference/Classes/ScriptPublicKey.md) is the lock on every output. Most of the time it's
Expand Down
5 changes: 5 additions & 0 deletions docs/learn/transactions/serialization.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
boost: 3
---

# Serialization

The transaction-shaped types —
Expand Down
5 changes: 5 additions & 0 deletions docs/learn/transactions/signing.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
boost: 3
---

# Signing

Signing fills each input's `signature_script` with proof that the
Expand Down
5 changes: 5 additions & 0 deletions docs/learn/transactions/submission.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
boost: 3
---

# Submission & confirmation

Submitting a signed transaction hands it to a node, which gossips it
Expand Down
5 changes: 5 additions & 0 deletions docs/learn/wallet-sdk/derivation.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
boost: 3
---

# Derivation

Once you have an [`XPrv`](../../reference/Classes/XPrv.md) (see
Expand Down
5 changes: 5 additions & 0 deletions docs/learn/wallet-sdk/key-management.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
boost: 3
---

# Key Management

Everything on this page is BIP-39 compatible. The SDK gives you
Expand Down
5 changes: 5 additions & 0 deletions docs/learn/wallet-sdk/overview.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
boost: 5
---

# Wallet SDK

The **Wallet SDK** is the set of primitives the managed
Expand Down
5 changes: 5 additions & 0 deletions docs/learn/wallet-sdk/tx-generator.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
boost: 3
---

# Transaction Generator

The [`Generator`](../../reference/Classes/Generator.md) is the SDK's
Expand Down
5 changes: 5 additions & 0 deletions docs/learn/wallet-sdk/utxo-context.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
boost: 3
---

# UTXO Context

A [`UtxoContext`](../../reference/Classes/UtxoContext.md) tracks UTXOs
Expand Down
5 changes: 5 additions & 0 deletions docs/learn/wallet-sdk/utxo-processor.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
boost: 3
---

# UTXO Processor

A [`UtxoProcessor`](../../reference/Classes/UtxoProcessor.md) is the
Expand Down
5 changes: 5 additions & 0 deletions docs/learn/wallet/accounts.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
boost: 3
---

# Accounts

A wallet can hold multiple accounts of mixed kinds, each backed by one
Expand Down
5 changes: 5 additions & 0 deletions docs/learn/wallet/addresses.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
boost: 3
---

# Addresses

A BIP32 account derives [`Address`](../../reference/Classes/Address.md) instances. The wallet records two
Expand Down
5 changes: 5 additions & 0 deletions docs/learn/wallet/architecture.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
boost: 3
---

# Architecture

The `Wallet` class is a system of cooperating components. Knowing some of the underlying mechanics is useful for development.
Expand Down
5 changes: 5 additions & 0 deletions docs/learn/wallet/errors.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
boost: 3
---

# Errors

The wallet's errors live in `kaspa.exceptions`. Most are
Expand Down
5 changes: 5 additions & 0 deletions docs/learn/wallet/events.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
boost: 3
---

# Events

The wallet emits events for every state change the node pushes
Expand Down
5 changes: 5 additions & 0 deletions docs/learn/wallet/lifecycle.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
boost: 3
---

# Lifecycle

A `Wallet` moves through five states. Each transition is async and
Expand Down
5 changes: 5 additions & 0 deletions docs/learn/wallet/overview.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
boost: 5
---

# Wallet

The [`Wallet`](../../reference/Classes/Wallet.md) class is the SDK's
Expand Down
5 changes: 5 additions & 0 deletions docs/learn/wallet/private-keys.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
boost: 3
---

# Private Keys

A *private key data* entry is the encrypted secret that backs one or
Expand Down
5 changes: 5 additions & 0 deletions docs/learn/wallet/send-transaction.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
boost: 3
---

# Send Transaction

Outgoing flows from an activated account. Every method on this page
Expand Down
5 changes: 5 additions & 0 deletions docs/learn/wallet/sweep.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
boost: 3
---

# Sweep Funds

A sweep consolidates every UTXO in an account into one address. Two
Expand Down
5 changes: 5 additions & 0 deletions docs/learn/wallet/sync-state.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
boost: 3
---

# Sync State

"Sync" in the managed wallet covers two distinct layers:
Expand Down
5 changes: 5 additions & 0 deletions docs/learn/wallet/transaction-history.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
boost: 3
---

# Transaction History

The wallet stores a record of every transaction that touched each
Expand Down
Loading
Loading