From 187f9d81858914e263397f805d22ae98eef45b3f Mon Sep 17 00:00:00 2001 From: Chia Automation Date: Sun, 15 Dec 2024 00:15:51 +0000 Subject: [PATCH] New Crowdin translations by GitHub Action --- .../academy/academy-intro/academy-overview.md | 8 +- .../academy/chialisp/chialisp-inner-puzzle.md | 4 +- .../academy/chialisp/chialisp-intro.md | 4 +- .../academy/chialisp/chialisp-signatures.md | 4 +- .../academy/chialisp/chialisp-smart-coin.md | 4 +- .../architecture/architecture-overview.md | 2 +- .../current/architecture/farmers.md | 2 +- .../current/architecture/full-nodes.md | 2 +- .../current/architecture/harvesters.md | 2 +- .../current/architecture/mempool.md | 2 +- .../current/block-validation/block-format.md | 2 +- .../current/block-validation/block-rewards.md | 12 +- .../current/cli-reference/asic-hwvdf.md | 22 +- .../current/cli-reference/cat-admin.md | 6 +- .../current/cli-reference/clawback.md | 12 +- .../current/cli-reference/custody-tool.md | 130 +- .../current/cli-reference/daos.md | 390 ++--- .../current/cli-reference/datalayer.md | 176 +- .../current/cli-reference/dids.md | 32 +- .../current/cli-reference/nfts.md | 18 +- .../current/cli-reference/offers.md | 10 +- .../current/cli-reference/plotters.md | 112 +- .../current/cli-reference/simulator.md | 14 +- .../current/cli-reference/vcs.md | 41 +- .../current/cli-reference/wallet.md | 196 ++- .../current/coin-set-model/clvm-vs-evm.md | 20 +- .../current/coin-set-model/conditions.md | 645 +------ .../current/coin-set-model/costs.md | 30 +- .../consensus/attacks-and-countermeasures.md | 4 +- .../current/consensus/forks.md | 20 +- .../consensus/signage-and-infusion-points.md | 12 +- .../farming/dual-farming-testnet-mainnet.md | 16 +- .../current/farming/farming-basics.md | 2 +- .../current/farming/farming-many-machines.md | 18 +- .../current/farming/pool-farming.md | 6 +- .../getting-started/cloud-wallet/faq.md | 199 +++ .../cloud-wallet/getting-started.md | 146 ++ .../cloud-wallet/known-issues.md | 42 + .../getting-started/cloud-wallet/tooltips.md | 41 + .../cloud-wallet/unfinished.md | 45 + .../current/getting-started/farming-guide.md | 61 +- .../current/getting-started/installation.md | 419 ++++- .../current/getting-started/timelords.md | 55 +- .../current/getting-started/wallet-guide.md | 1 + .../constants-variables-notation.md | 32 +- .../green-paper/green-paper-abstract.md | 2 + .../green-paper/green-paper-appendix.md | 71 +- .../green-paper/green-paper-introduction.md | 2 +- .../green-paper/green-paper-references.md | 12 +- .../green-paper/hash-and-vdf-chains.md | 30 +- .../current/green-paper/rational-attackers.md | 6 +- .../recovering-from-51-percent-attacks.md | 75 +- .../green-paper/the-chia-blockchain.md | 108 +- .../guides/cat/cat-creation-tutorial.md | 104 +- .../guides/cat/cat2-upgrade/cat2-issuance.md | 7 +- .../guides/cat/cat2-upgrade/cat2-snapshot.md | 30 +- .../current/guides/cat/cr-cat-tutorial.md | 39 + .../clawback/clawback-primitive-guide.md | 2 + .../guides/clawback/clawback-user-guide.md | 2 +- .../guides/crash-course/cats-offers-nfts.md | 62 +- .../current/guides/crash-course/chialisp.md | 2 +- .../guides/crash-course/intro-to-chialisp.md | 2 +- .../custody/custody-tool-description.md | 26 +- .../guides/custody/custody-tool-user-guide.md | 71 +- .../current/guides/custody/prefarm-audit.md | 10 +- .../guides/datalayer/datalayer-permissions.md | 24 +- .../guides/datalayer/datalayer-user-guide.md | 2 +- .../current/guides/nft/nft-bulk-mint.md | 29 +- .../current/guides/nft/nft-intro.md | 2 +- .../current/guides/seeder-user-guide.md | 14 +- .../current/guides/tutorials/offers-cli.md | 2 +- .../walletconnect-developer-guide.md | 86 +- .../walletconnect/walletconnect-user-guide.md | 2 +- .../current/keys/keys-and-signatures.md | 2 +- .../current/new-proof-format/new-proof-faq.md | 157 ++ .../new-proof-farming-requirements.md | 53 + .../new-proof-introduction.md | 35 + .../new-proof-plotting-requirements.md | 74 + .../new-proof-technical-details.md | 127 ++ .../new-proof-technical-overview.md | 37 + .../new-proof-format/new-proof-timeline.md | 24 + .../current/plotting/plotting-basics.md | 2 + .../current/plotting/plotting-compression.md | 20 +- .../current/plotting/plotting-faq.md | 8 + .../current/plotting/plotting-hardware.md | 24 +- .../current/plotting/plotting-how-to.md | 4 +- .../current/plotting/plotting-setup.md | 20 +- .../current/plotting/ssd-endurance.md | 16 +- .../current/protocol/networking-protocol.md | 2 +- .../pool/pool-protocol-specification.md | 4 +- .../reference-client/key-management.md | 2 +- .../resources/chia-farming-workload.md | 16 +- .../current/resources/faq.md | 12 +- .../current/resources/glossary.md | 113 ++ .../current/resources/k-sizes.md | 40 +- .../current/rpc-reference/daemon.md | 122 +- .../current/rpc-reference/daos.md | 136 +- .../current/rpc-reference/datalayer.md | 186 +- .../current/rpc-reference/dids.md | 112 +- .../current/rpc-reference/farmer.md | 54 +- .../current/rpc-reference/full-node.md | 126 +- .../current/rpc-reference/harvester.md | 20 +- .../current/rpc-reference/nfts.md | 106 +- .../current/rpc-reference/offers.md | 74 +- .../current/rpc-reference/simulator.md | 46 +- .../current/rpc-reference/vcs.md | 46 +- .../current/rpc-reference/wallet.md | 1559 +++++++++++++---- .../troubleshooting/checking-farm-health.md | 165 ++ .../current/troubleshooting/farming-faq.md | 64 + .../troubleshooting/logging-reference.md | 270 ++- .../current/troubleshooting/node-syncing.md | 50 +- .../current/walletconnect/general.md | 40 +- .../current/walletconnect/nfts.md | 62 +- .../current/walletconnect/offers.md | 6 +- 114 files changed, 5005 insertions(+), 2876 deletions(-) create mode 100644 i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting-started/cloud-wallet/faq.md create mode 100644 i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting-started/cloud-wallet/getting-started.md create mode 100644 i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting-started/cloud-wallet/known-issues.md create mode 100644 i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting-started/cloud-wallet/tooltips.md create mode 100644 i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting-started/cloud-wallet/unfinished.md create mode 100644 i18n/zh-Hans/docusaurus-plugin-content-docs/current/new-proof-format/new-proof-faq.md create mode 100644 i18n/zh-Hans/docusaurus-plugin-content-docs/current/new-proof-format/new-proof-farming-requirements.md create mode 100644 i18n/zh-Hans/docusaurus-plugin-content-docs/current/new-proof-format/new-proof-introduction.md create mode 100644 i18n/zh-Hans/docusaurus-plugin-content-docs/current/new-proof-format/new-proof-plotting-requirements.md create mode 100644 i18n/zh-Hans/docusaurus-plugin-content-docs/current/new-proof-format/new-proof-technical-details.md create mode 100644 i18n/zh-Hans/docusaurus-plugin-content-docs/current/new-proof-format/new-proof-technical-overview.md create mode 100644 i18n/zh-Hans/docusaurus-plugin-content-docs/current/new-proof-format/new-proof-timeline.md create mode 100644 i18n/zh-Hans/docusaurus-plugin-content-docs/current/resources/glossary.md create mode 100644 i18n/zh-Hans/docusaurus-plugin-content-docs/current/troubleshooting/checking-farm-health.md create mode 100644 i18n/zh-Hans/docusaurus-plugin-content-docs/current/troubleshooting/farming-faq.md diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/academy/academy-intro/academy-overview.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/academy/academy-intro/academy-overview.md index e8a8ff4060..724739abfb 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/academy/academy-intro/academy-overview.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/academy/academy-intro/academy-overview.md @@ -132,10 +132,10 @@ Chia学院的课程页面经过精心设计，以增强学生的学习体验。 所有适用的课程都提供了Chialisp和clvm的可运行插件。 花些时间熟悉这些工具，并学习如何在整个课程中最好地利用它们。 每个插件都有一系列组件： -**语言：** 插件的语言（Chialisp或clvm）位于右上角。 -**解决方案(Solution)：** 顶部部分是输入或解决方案。 -**谜题(Puzzle)：** 底部部分是谜题。 -**运行：** 每个插件在语言标识符右侧都有一个播放/运行按钮。 +**语言：** 插件的语言（Chialisp或clvm）位于右上角。 +**解决方案(Solution)：** 顶部部分是输入或解决方案。 +**谜题(Puzzle)：** 底部部分是谜题。 +**运行：** 每个插件在语言标识符右侧都有一个播放/运行按钮。 **结果：** 单击运行后，谜题的结果将出现在谜题下方。 :::info diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/academy/chialisp/chialisp-inner-puzzle.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/academy/chialisp/chialisp-inner-puzzle.md index e0a2f9fb04..d7154d6793 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/academy/chialisp/chialisp-inner-puzzle.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/academy/chialisp/chialisp-inner-puzzle.md @@ -123,7 +123,7 @@ import Runnable from '@site/src/components/Runnable.tsx'; ### 可运行的Chialisp和clvm插件 -有关使用这些插件的信息，请参阅[学院概述](/academy-overview#可运行的chialisp和clvm插件)。 +有关使用这些插件的信息，请参阅[学院概述](/academy-overview#runnable-chialisp-and-clvm-plugins)。 #### Chialisp 插件 @@ -149,7 +149,7 @@ import Runnable from '@site/src/components/Runnable.tsx'; ### 链接 -- [Chialisp基本概念](https://chialisp.com/chialisp-concepts/)：包括柯里化（currying）、内部谜题（inner puzzles）和条件变换（morphing conditions）的概述。 +- General [chialisp concepts](https://chialisp.com/chialisp-concepts/): overviews of currying, inner puzzles, and morphing conditions. - 指导性的[Chialisp演练](https://docs.chia.net/guides/)：安装、创建智能币和使用BLS签名的指南。 - Chialisp[详细文档](https://chialisp.com/)：提供有关Chialisp各个方面的详细信息。 - Support [in discord](https://discord.gg/chia): for further support join our discord server and ask in the #chialisp or #support channels. diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/academy/chialisp/chialisp-intro.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/academy/chialisp/chialisp-intro.md index 1aeacb7250..24cb016278 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/academy/chialisp/chialisp-intro.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/academy/chialisp/chialisp-intro.md @@ -78,7 +78,7 @@ So let's get started, the first thing you'll want to do is make sure you have th ## 常见问题 - **run vs brun:** `run` 用于序列化并运行 Chialisp 谜题，而 `brun` 用于运行 clvm 序列化的谜题，通常用于传递参数。 -- **括号（Parentheses）：**Chialisp 是完全括号前缀表示法编程语言家族的一部分，可以[追溯]()到上世纪 50 年代的 LISP 1。 这些语言的一个显而易见的特点是它们使用括号来表示列表（lists）。 建议在编写这些语言时使用具有适当语法高亮功能的集成开发环境，以确保所有括号都处于正确的位置。 为了帮助解决这个问题，这里有一个适用于 Visual Studio 的 [Chialisp 语言服务器扩展](https://marketplace.visualstudio.com/items?itemName=ChiaNetwork.chialisp)。 +- **括号（Parentheses）：**Chialisp 是完全括号前缀表示法编程语言家族的一部分，可以[追溯](https://en.wikipedia.org/wiki/Lisp_(programming_language))到上世纪 50 年代的 LISP 1。 这些语言的一个显而易见的特点是它们使用括号来表示列表（lists）。 建议在编写这些语言时使用具有适当语法高亮功能的集成开发环境，以确保所有括号都处于正确的位置。 为了帮助解决这个问题，这里有一个适用于 Visual Studio 的 [Chialisp 语言服务器扩展](https://marketplace.visualstudio.com/items?itemName=ChiaNetwork.chialisp)。 - **前缀表示法：**Chialisp 作为 LISP 家族的一部分，使用前缀表示法。 这意味着函数或运算符首先出现，其参数紧随其后。 --- @@ -180,7 +180,7 @@ So let's get started, the first thing you'll want to do is make sure you have th ### 可运行的Chialisp和clvm插件 -有关如何使用这些插件的信息，请参阅[学院概述](/academy-overview#可运行的chialisp和clvm插件) +有关如何使用这些插件的信息，请参阅[学院概述](/academy-overview#runnable-chialisp-and-clvm-plugins) #### Chialisp 插件 diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/academy/chialisp/chialisp-signatures.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/academy/chialisp/chialisp-signatures.md index 4fd799a9bf..f474bec662 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/academy/chialisp/chialisp-signatures.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/academy/chialisp/chialisp-signatures.md @@ -142,7 +142,7 @@ import Runnable from '@site/src/components/Runnable.tsx'; ### 可运行的Chialisp和clvm插件 -有关使用这些插件的信息，请参阅[学院概述](/academy-overview#可运行的chialisp和clvm插件)。 +有关使用这些插件的信息，请参阅[学院概述](/academy-overview#runnable-chialisp-and-clvm-plugins)。 #### Chialisp 插件 @@ -168,7 +168,7 @@ import Runnable from '@site/src/components/Runnable.tsx'; ### 链接 -- [Chialisp基本概念](https://chialisp.com/chialisp-concepts/)：包括柯里化（currying）、内部谜题（inner puzzles）和条件变换（morphing conditions）的概述。 +- General [chialisp concepts](https://chialisp.com/chialisp-concepts/): overviews of currying, inner puzzles, and morphing conditions. - 指导性的[Chialisp演练](https://docs.chia.net/guides/)：安装、创建智能币和使用BLS签名的指南。 - Chialisp[详细文档](https://chialisp.com/)：提供有关Chialisp各个方面的详细信息。 - Support [in discord](https://discord.gg/chia): for further support join our discord server and ask in the #chialisp or #support channels. diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/academy/chialisp/chialisp-smart-coin.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/academy/chialisp/chialisp-smart-coin.md index eb8030dc68..52c5a781b9 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/academy/chialisp/chialisp-smart-coin.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/academy/chialisp/chialisp-smart-coin.md @@ -195,7 +195,7 @@ True ### 可运行的Chialisp和clvm插件 -有关使用这些插件的信息，请参阅[学院概述](/academy-overview#可运行的chialisp和clvm插件)。 +有关使用这些插件的信息，请参阅[学院概述](/academy-overview#runnable-chialisp-and-clvm-plugins)。 #### Chialisp 插件 @@ -221,7 +221,7 @@ True ### 链接 -- [Chialisp基本概念](https://chialisp.com/chialisp-concepts/)：包括柯里化（currying）、内部谜题（inner puzzles）和条件变换（morphing conditions）的概述。 +- General [chialisp concepts](https://chialisp.com/chialisp-concepts/): overviews of currying, inner puzzles, and morphing conditions. - 指导性的[Chialisp演练](https://docs.chia.net/guides/)：安装、创建智能币和使用BLS签名的指南。 - Chialisp[详细文档](https://chialisp.com/)：提供有关Chialisp各个方面的详细信息。 - Support [in discord](https://discord.gg/chia): for further support join our discord server and ask in the #chialisp or #support channels. diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/architecture/architecture-overview.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/architecture/architecture-overview.md index f8338c3c13..1c76be1a45 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/architecture/architecture-overview.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/architecture/architecture-overview.md @@ -1,6 +1,6 @@ --- title: 架构概览 -slug: /architecture-overview +slug: 架构概览 --- ![chia架构](/img/chia-network-architecture.png) diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/architecture/farmers.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/architecture/farmers.md index 7bfa2a7422..52082be761 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/architecture/farmers.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/architecture/farmers.md @@ -1,6 +1,6 @@ --- title: 耕种 -slug: /farmer-architecture +slug: 耕种架构 --- Chia的农民与比特币矿工相似。 他们通过在其储存的地块中找到有效的空间证明来获得区块奖励和费用。 耕种进程并不会保留一个区块链的副本，而由他们信任的一个完整节点来提供更新。 完整节点和耕种进程使用耕种协议相互沟通。 diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/architecture/full-nodes.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/architecture/full-nodes.md index 89e247aef1..6d4110c10b 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/architecture/full-nodes.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/architecture/full-nodes.md @@ -1,6 +1,6 @@ --- title: 全节点 -slug: /full-node-architecture +slug: /全节点架构 --- Chia点对点系统的核心由全节点组成。 全节点有以下几项责任： diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/architecture/harvesters.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/architecture/harvesters.md index 88cbdca06d..1fbb019373 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/architecture/harvesters.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/architecture/harvesters.md @@ -1,6 +1,6 @@ --- title: 收割机 -slug: /harvester-architecture +slug: 收割机架构 --- 收割机是一些独立的机器，由农民控制。 在大规模耕作活动中，农民可能与许多收割机连接在一起。 diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/architecture/mempool.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/architecture/mempool.md index 74853dcd98..b1bda0dd83 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/architecture/mempool.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/architecture/mempool.md @@ -7,7 +7,7 @@ The mempool (or memory pool) is a collection of transactions stored by full node The mempool is a required facet of Chia due to the decentralized nature of the blockchain. Transaction blocks occur approximately every 52 seconds, and it's impossible to predict who will win a block. Therefore, all transactions must be broadcast to the whole network and stored locally until they are confirmed. Additionally, it is normal to have more pending transactions than can fit in a single block, so the mempool also acts as a queue for inclusion into the blockchain. -For more information about the mempool, see our [blog post](https://www.chia.net/2024/01/11/getting-to-know-the-mempool-and-transaction-fees/) on this subject. +For more information about the mempool, see our [blog post](https://www.chia.net/2024/01/12/getting-to-know-the-mempool-and-transaction-fees/) on this subject. :::info How many transactions can fit into a block? Due to the varying size of transactions, and the different definitions of what even counts as a "transaction," there is not an exact number. But just for a bit of rough guidance, approximately 1000 transactions with two inputs and two outputs, or 2000 transactions with one input and one output can fit into a single block. diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/block-validation/block-format.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/block-validation/block-format.md index 7d2e5509c1..ebb6018ea2 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/block-validation/block-format.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/block-validation/block-format.md @@ -1,6 +1,6 @@ --- title: 区块格式 -slug: /block-format +slug: /区块格式 --- ## 完整块 diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/block-validation/block-rewards.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/block-validation/block-rewards.md index 5b0bdd8932..720f2c288a 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/block-validation/block-rewards.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/block-validation/block-rewards.md @@ -48,11 +48,11 @@ The second coin, with 7/8 of the value, is called the _pool coin_. This coin can As detailed in the [Business white paper](https://www.chia.net/whitepaper), the network's emissions schedule is as follows: | Years | Final
Block | Final Month
(Approx.) | Block Reward
(total) | Pool
Reward | Farmer
Reward | -| ------: | --------------: | ------------------------: | -----------------------: | --------------: | ----------------: | -| 1 - 3 | `5 045 760` | March 2024 | 2 XCH | 1.75 XCH | 0.25 XCH | -| 4 - 6 | `10 091 520` | March 2027 | 1 XCH | 0.785 XCH | 0.125 XCH | -| 7 - 9 | `15 137 280` | March 2030 | 0.5 XCH | 0.4375 XCH | 0.0625 XCH | -| 10 - 12 | `20 183 040` | March 2033 | 0.25 XCH | 0.21875 XCH | 0.03125 XCH | -| 13 - ∞ | ∞ | ∞ | 0.125 XCH | 0.109375 XCH | 0.015625 XCH | +| -------:| ---------------------:| -------------------------------:| ------------------------------:| ---------------------:| -----------------------:| +| 1 - 3 | `5 045 760` | March 2024 | 2 XCH | 1.75 XCH | 0.25 XCH | +| 4 - 6 | `10 091 520` | March 2027 | 1 XCH | 0.785 XCH | 0.125 XCH | +| 7 - 9 | `15 137 280` | March 2030 | 0.5 XCH | 0.4375 XCH | 0.0625 XCH | +| 10 - 12 | `20 183 040` | March 2033 | 0.25 XCH | 0.21875 XCH | 0.03125 XCH | +| 13 - ∞ | ∞ | ∞ | 0.125 XCH | 0.109375 XCH | 0.015625 XCH | Note that the rewards are adjusted according to a block height, not a timestamp. Note that the rewards are adjusted according to a block height, not a timestamp. The `Final Block` column is therefore accurate as the last block before the rewards are modified. The months and years are only estimates based on when the block heights are likely to be reached. The months and years are only estimates based on when the block heights are likely to be reached. diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cli-reference/asic-hwvdf.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cli-reference/asic-hwvdf.md index ea897999ee..dde1107ab6 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cli-reference/asic-hwvdf.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cli-reference/asic-hwvdf.md @@ -17,17 +17,17 @@ Usage: hw_vdf_client [OPTIONS] PORT [N_VDFS] Options: -| Long Command | Type | Required | Description | -| :----------------- | :------ | :------- | :---------------------------------------------------- | -| --freq | INTEGER | False | set ASIC frequency [%d, 200 - 2200] | -| --voltage | INTEGER | False | set board voltage [.88, 0.7 - 1.0] | -| --ip | TEXT | False | timelord IP address [localhost] | -| --vdfs-mask | TEXT | False | mask for enabling VDF engines [7, 1 - 7] | -| --vdf-threads | TEXT | False | number of software threads per VDF engine [4, 2 - 64] | -| --proof-threads | TEXT | False | number of proof threads per VDF engine [3, 1 - 63] | -| --auto-freq-period | TEXT | False | auto-adjust frequency every N seconds [0, 10 - inf] | -| --list | TEXT | False | list available devices and exit | -| --help | None | False | Show a help message and exit | +| Long Command | Type | Required | Description | +| :----------------- | :------ | :------- | :------------------------------------------------------------------------------------------------------------------------------------- | +| --freq | INTEGER | False | set ASIC frequency [%d, 200 - 2200] | +| --voltage | INTEGER | False | set board voltage [.88, 0.7 - 1.0] | +| --ip | TEXT | False | timelord IP address [localhost] | +| --vdfs-mask | TEXT | False | mask for enabling VDF engines [7, 1 - 7] | +| --vdf-threads | TEXT | False | number of software threads per VDF engine [4, 2 - 64] | +| --proof-threads | TEXT | False | number of proof threads per VDF engine [3, 1 - 63] | +| --auto-freq-period | TEXT | False | auto-adjust frequency every N seconds [0, 10 - inf] | +| --list | TEXT | False | list available devices and exit | +| --help | None | False | Show a help message and exit |
Example 1 - Run the ASIC software with defaults diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cli-reference/cat-admin.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cli-reference/cat-admin.md index acb336d582..34bce54639 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cli-reference/cat-admin.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cli-reference/cat-admin.md @@ -24,7 +24,7 @@ Usage: cats [OPTIONS] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :-------------------- | :------ | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +|:------------- |:--------------------- |:------- |:-------- |:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | -l | --tail | TEXT | True | The TAIL program to launch this CAT with | | -c | --curry | TEXT | False | An argument to curry into the TAIL | | -s | --solution | TEXT | False | The solution to the TAIL program [default: ()] | @@ -186,7 +186,7 @@ Usage: secure_the_bag [OPTIONS] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :---------------------------- | :------ | :------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +|:------------- |:----------------------------- |:------- |:-------- |:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | -c | --curry | TEXT | False | An argument to curry into the TAIL | | -a | --amount | INTEGER | True | The amount to issue in mojos (regular XCH will be used to fund this) | | -stbtp | --secure-the-bag-targets-path | TEXT | True | Path to CSV file containing targets of secure the bag (inner puzzle hash + amount). The total value of the coins in this file must match the value of the `amount` flag. If they don't match, an error will be thrown. | @@ -222,7 +222,7 @@ Usage: secure_the_bag [OPTIONS] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :---------------------------- | :------ | :------- | :---------------------------------------------------------------------------------------------------- | +|:------------- |:----------------------------- |:------- |:-------- |:----------------------------------------------------------------------------------------------------- | | -ecid | --eve-coin-id | TEXT | True | ID of coin that was spent to create secured bag | | -th | --tail-hash | TEXT | True | TAIL hash / Asset ID of CAT to unwind from secured bag of CATs | | -stbtp | --secure-the-bag-targets-path | TEXT | True | Path to CSV file containing targets of secure the bag (inner puzzle hash + amount) | diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cli-reference/clawback.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cli-reference/clawback.md index 84ebeaa53a..99791ba0d8 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cli-reference/clawback.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cli-reference/clawback.md @@ -36,14 +36,14 @@ Usage: `clawback [OPTIONS] COMMAND [ARGS]` Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :--- | :------- | :--------------------------- | +|:------------- |:------------ |:---- |:-------- |:---------------------------- | | | --version | None | False | Show the version and exit | | -h | --help | None | False | Show a help message and exit | Commands: | Name | Description | -| :----- | :-------------------------------------------------- | +|:------ |:--------------------------------------------------- | | claim | Claim a clawback coin after the timelock has passed | | claw | Clawback an unclaimed coin | | create | Send xch to a clawback coin | @@ -60,7 +60,7 @@ Usage: `clawback claim [OPTIONS]` Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :---------------- | :------ | :------- | :------------------------------------------------------------------------------------------------------- | +|:------------- |:----------------- |:------- |:-------- |:-------------------------------------------------------------------------------------------------------- | | -c | --coin-id | TEXT | True | The coin ID you want to claim | | -m | --fee | FLOAT | False | The fee in XCH for this transaction | | -w | --wallet-id | INTEGER | False | The wallet id for fees. If no target address given the clawback will go to this wallet id | @@ -245,7 +245,7 @@ Usage: `clawback claw [OPTIONS]` Options: Clawback an unclaimed coin | Short Command | Long Command | Type | Required | Description | -| :------------ | :---------------- | :------ | :------- | :------------------------------------------------------------------------------------------------------- | +|:------------- |:----------------- |:------- |:-------- |:-------------------------------------------------------------------------------------------------------- | | -c | --coin-id | TEXT | True | The coin ID for the clawback coin to inspect | | -m | --fee | FLOAT | False | The fee in XCH for this transaction | | -w | --wallet-id | INTEGER | False | The wallet id for fees. If no target address given the clawback will go to this wallet id | @@ -317,7 +317,7 @@ Usage: `clawback create [OPTIONS]` Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :---------------- | :------ | :------- | :------------------------------------------------------------------------------------------------------- | +|:------------- |:----------------- |:------- |:-------- |:-------------------------------------------------------------------------------------------------------- | | -t | --to | TEXT | True | The recipient's address | | -l | --timelock | INTEGER | False | The timelock to use for the clawback coin you're creating, in seconds. Default is two weeks | | -a | --amount | INTEGER | True | The amount to fund (in XCH) | @@ -410,7 +410,7 @@ Usage: `clawback show [OPTIONS]` Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :---------------- | :------ | :------- | :------------------------------------------------------------------------------------------------------- | +|:------------- |:----------------- |:------- |:-------- |:-------------------------------------------------------------------------------------------------------- | | -c | --coin-id | TEXT | False | The coin ID for the clawback coin to inspect | | -np | --node-rpc-port | INTEGER | False | Set the port where the Node is hosting the RPC interface | | -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which wallet to use | diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cli-reference/custody-tool.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cli-reference/custody-tool.md index 4050333a87..5cc8e3fe18 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cli-reference/custody-tool.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cli-reference/custody-tool.md @@ -25,12 +25,12 @@ Usage: `cic audit [OPTIONS]` Options: -| Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :--- | :------- | :------------------------------------------------------------------- | +| Short Command | Long Command | Type | Required | Description | +|:------------- |:------------ |:---- |:-------- |:-------------------------------------------------------------------------------- | | -db | --db-path | TEXT | True | The file path to the sync DB (default: ./sync (\*\*\*\*\*\*).sqlite) | -| -f | --filepath | TEXT | False | The file path the dump the audit log | -| -d | --diff | TEXT | False | A previous audit log to diff against this one | -| -h | --help | None | False | Show a help message and exit | +| -f | --filepath | TEXT | False | The file path the dump the audit log | +| -d | --diff | TEXT | False | A previous audit log to diff against this one | +| -h | --help | None | False | Show a help message and exit |
Example @@ -102,12 +102,12 @@ Usage: `cic clawback [OPTIONS]` Options: -| Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :--- | :------- | :------------------------------------------------------------------- | +| Short Command | Long Command | Type | Required | Description | +|:------------- |:------------ |:---- |:-------- |:-------------------------------------------------------------------------------- | | -db | --db-path | TEXT | True | The file path to the sync DB (default: ./sync (\*\*\*\*\*\*).sqlite) | -| -f | --filename | TEXT | False | The filepath to dump the spend bundle into | -| -pks | --pubkeys | TEXT | True | A comma separated list of pubkeys that will be signing this spend | -| -h | --help | None | False | Show a help message and exit | +| -f | --filename | TEXT | False | The filepath to dump the spend bundle into | +| -pks | --pubkeys | TEXT | True | A comma separated list of pubkeys that will be signing this spend | +| -h | --help | None | False | Show a help message and exit |
Example @@ -134,11 +134,11 @@ Usage: `cic complete [OPTIONS]` Options: -| Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :--- | :------- | :------------------------------------------------------------------- | +| Short Command | Long Command | Type | Required | Description | +|:------------- |:------------ |:---- |:-------- |:-------------------------------------------------------------------------------- | | -db | --db-path | TEXT | True | The file path to the sync DB (default: ./sync (\*\*\*\*\*\*).sqlite) | -| -f | --filename | TEXT | False | The filepath to dump the spend bundle into | -| -h | --help | None | False | Show a help message and exit | +| -f | --filename | TEXT | False | The filepath to dump the spend bundle into | +| -h | --help | None | False | Show a help message and exit |
Example -- complete a withdrawal @@ -172,7 +172,7 @@ Usage: `cic derive_root [OPTIONS]` Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :------------------- | :------ | :------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------- | +|:------------- |:-------------------- |:------- |:-------- |:----------------------------------------------------------------------------------------------------------------------------------------------------------- | | -c | --configuration | TEXT | False | The configuration file with which to derive the root (or the filepath to create it at if using --db-path) [default: ./Configuration (needs derivation).txt] | | -db | --db-path | TEXT | False | Optionally specify a DB path to find the configuration from | | -pks | --pubkeys | TEXT | True | A comma separated list of pubkey files that will control this money | @@ -210,7 +210,7 @@ Usage: `cic examine_spend [OPTIONS] SPEND_FILE` Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------------- | :------ | :------- | :--------------------------------------------------------------- | +|:------------- |:------------------ |:------- |:-------- |:---------------------------------------------------------------- | | | --qr-density | INTEGER | False | The amount of bytes to pack into a single QR code [default: 250] | | -va | --validate-against | TEXT | False | A new configuration file to check against requests for rekeys | | -h | --help | None | False | Show a help message and exit | @@ -249,12 +249,12 @@ Usage: `cic export_config [OPTIONS]` Options: -| Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :--- | :------- | :-------------------------------------------------------------------------------------------- | +| Short Command | Long Command | Type | Required | Description | +|:------------- |:------------ |:---- |:-------- |:--------------------------------------------------------------------------------------------------------- | | -f | --filename | TEXT | False | The file path to export the config to (default: ./Configuration Export (\*\*\*\*\*\*).sqlite) | | -db | --db-path | TEXT | True | The file path to initialize/find the sync database at (default: ./sync (\*\*\*\*\*\*).sqlite) | -| -p | --public | None | False | Enable to export the public information only (default: disabled) | -| -h | --help | None | False | Show a help message and exit | +| -p | --public | None | False | Enable to export the public information only (default: disabled) | +| -h | --help | None | False | Show a help message and exit |
Example -- export the config to export.bin @@ -283,12 +283,12 @@ Usage: `cic increase_security_level [OPTIONS]` Options: -| Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :--- | :------- | :------------------------------------------------------------------- | +| Short Command | Long Command | Type | Required | Description | +|:------------- |:------------ |:---- |:-------- |:-------------------------------------------------------------------------------- | | -db | --db-path | TEXT | True | The file path to the sync DB (default: ./sync (\*\*\*\*\*\*).sqlite) | -| -pks | --pubkeys | TEXT | True | A comma separated list of pubkeys that will be signing this spend | -| -f | --filename | TEXT | False | The filepath to dump the spend bundle into | -| -h | --help | None | False | Show a help message and exit | +| -pks | --pubkeys | TEXT | True | A comma separated list of pubkeys that will be signing this spend | +| -f | --filename | TEXT | False | The filepath to dump the spend bundle into | +| -h | --help | None | False | Show a help message and exit |
Example -- move to a 4-of-5 config @@ -318,7 +318,7 @@ Usage: `cic init [OPTIONS]` Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :-------------------- | :--- | :------- | :-------------------------------------------------------------------------------------------------- | +|:------------- |:--------------------- |:---- |:-------- |:--------------------------------------------------------------------------------------------------- | | -d | --directory | TEXT | False | The directory in which to create the configuration file [default: .] | | -wt | --withdrawal-timelock | TEXT | True | The amount of time where nothing has happened before a withdrawal can be made (in seconds) | | -pc | --payment-clawback | TEXT | True | The amount of time to clawback a payment before it's completed (in seconds) | @@ -354,15 +354,15 @@ Usage: `cic launch_singleton [OPTIONS]` Options: -| Short Command | Long Command | Type | Required | Description | -| :------------ | :---------------- | :------ | :------- | :-------------------------------------------------------------------------------------------------------- | -| -c | --configuration | TEXT | True | The configuration file with which to launch the singleton | -| -db | --db-path | TEXT | True | The file path to initialize the sync database at | -| -wp | --wallet-rpc-port | INTEGER | False | Set the port where the Wallet is hosting the RPC interface. See the rpc_port under wallet in config.yaml | -| -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which wallet to use | +| Short Command | Long Command | Type | Required | Description | +|:------------- |:----------------- |:------- |:-------- |:----------------------------------------------------------------------------------------------------------- | +| -c | --configuration | TEXT | True | The configuration file with which to launch the singleton | +| -db | --db-path | TEXT | True | The file path to initialize the sync database at | +| -wp | --wallet-rpc-port | INTEGER | False | Set the port where the Wallet is hosting the RPC interface. See the rpc_port under wallet in config.yaml | +| -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which wallet to use | | -np | --node-rpc-port | INTEGER | False | Set the port where the Node is hosting the RPC interface. See the rpc_port under full_node in config.yaml | -| | --fee | INTEGER | False | Fee to use for the launch transaction (in mojos) [default: 0] | -| -h | --help | None | False | Show a help message and exit | +| | --fee | INTEGER | False | Fee to use for the launch transaction (in mojos) [default: 0] | +| -h | --help | None | False | Show a help message and exit |
Example @@ -391,11 +391,11 @@ Usage: `cic p2_address [OPTIONS]` Options: -| Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :--- | :------- | :------------------------------------------------------------------- | +| Short Command | Long Command | Type | Required | Description | +|:------------- |:------------ |:---- |:-------- |:-------------------------------------------------------------------------------- | | -db | --db-path | TEXT | True | The file path to the sync DB (default: ./sync (\*\*\*\*\*\*).sqlite) | -| -p | --prefix | TEXT | False | The prefix to use when encoding the address (default: xch) | -| -h | --help | None | False | Show a help message and exit | +| -p | --prefix | TEXT | False | The prefix to use when encoding the address (default: xch) | +| -h | --help | None | False | Show a help message and exit |
Example @@ -423,8 +423,8 @@ Usage: `cic payment [OPTIONS]` Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :-------------------------- | :------ | :------- | :----------------------------------------------------------------------------------------------------------------------------------------- | -| -db | --db-path | TEXT | True | The file path to the sync DB (default: ./sync (\*\*\*\*\*\*).sqlite) | +|:------------- |:--------------------------- |:------- |:-------- |:------------------------------------------------------------------------------------------------------------------------------------------ | +| -db | --db-path | TEXT | True | The file path to the sync DB (default: ./sync (\*\*\*\*\*\*).sqlite) | | -f | --filename | TEXT | False | The filepath to dump the spend bundle into | | -pks | --pubkeys | TEXT | True | A comma separated list of pubkeys that will be signing this spend | | -a | --amount | INTEGER | False | The outgoing amount (in mojos) to pay [default: 0] | @@ -463,14 +463,14 @@ Usage: `cic push_tx [OPTIONS]` Options: -| Short Command | Long Command | Type | Required | Description | -| :------------ | :---------------- | :------ | :------- | :-------------------------------------------------------------------------------------------------------- | -| -b | --spend-bundle | TEXT | True | The signed spend bundle | -| -wp | --wallet-rpc-port | INTEGER | False | Set the port where the Wallet is hosting the RPC interface. See the rpc_port under wallet in config.yaml | -| -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which wallet to use | +| Short Command | Long Command | Type | Required | Description | +|:------------- |:----------------- |:------- |:-------- |:----------------------------------------------------------------------------------------------------------- | +| -b | --spend-bundle | TEXT | True | The signed spend bundle | +| -wp | --wallet-rpc-port | INTEGER | False | Set the port where the Wallet is hosting the RPC interface. See the rpc_port under wallet in config.yaml | +| -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which wallet to use | | -np | --node-rpc-port | INTEGER | False | Set the port where the Node is hosting the RPC interface. See the rpc_port under full_node in config.yaml | -| -m | --fee | INTEGER | False | The fee to attach to this spend (in mojos) | -| -h | --help | None | False | Show a help message and exit | +| -m | --fee | INTEGER | False | The fee to attach to this spend (in mojos) | +| -h | --help | None | False | Show a help message and exit |
Example @@ -500,8 +500,8 @@ Usage: `cic show [OPTIONS]` Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :--- | :------- | :------------------------------------------------------------------------------ | -| -db | --db-path | TEXT | True | The file path to the sync DB (default: ./sync (**\*\***).sqlite) [required] | +|:------------- |:------------ |:---- |:-------- |:------------------------------------------------------------------------------- | +| -db | --db-path | TEXT | True | The file path to the sync DB (default: ./sync (**\*\***).sqlite) [required] | | -c | --config | None | False | Enable to display the details of the public config (default: disabled) | | -d | --derivation | None | False | Enable to display the private details of the private config (default: disabled) | | -h | --help | None | False | Show a help message and exit | @@ -561,13 +561,13 @@ Usage: `cic start_rekey [OPTIONS]` Options: -| Short Command | Long Command | Type | Required | Description | -| :------------ | :------------------ | :--- | :------- | :------------------------------------------------------------------- | +| Short Command | Long Command | Type | Required | Description | +|:------------- |:------------------- |:---- |:-------- |:-------------------------------------------------------------------------------- | | -db | --db-path | TEXT | True | The file path to the sync DB (default: ./sync (\*\*\*\*\*\*).sqlite) | -| -f | --filename | TEXT | False | The filepath to dump the spend bundle into | -| -pks | --pubkeys | TEXT | True | A comma separated list of pubkeys that will be signing this spend | -| -new | --new-configuration | TEXT | True | The configuration you would like to rekey the singleton to | -| -h | --help | None | False | Show a help message and exit | +| -f | --filename | TEXT | False | The filepath to dump the spend bundle into | +| -pks | --pubkeys | TEXT | True | A comma separated list of pubkeys that will be signing this spend | +| -new | --new-configuration | TEXT | True | The configuration you would like to rekey the singleton to | +| -h | --help | None | False | Show a help message and exit |
Example @@ -596,13 +596,13 @@ Usage: `cic sync [OPTIONS]` Options: -| Short Command | Long Command | Type | Required | Description | -| :------------ | :-------------- | :------ | :------- | :------------------------------------------------------------------------------------------------------------ | +| Short Command | Long Command | Type | Required | Description | +|:------------- |:--------------- |:------- |:-------- |:------------------------------------------------------------------------------------------------------------------------- | | -c | --configuration | TEXT | False | The configuration file with which to initialize a sync database (default: ./Configuration (\*\*\*\*\*\*).txt) | | -db | --db-path | TEXT | True | The file path to initialize/find the sync database at (default: ./sync (\*\*\*\*\*\*).sqlite) | -| -np | --node-rpc-port | INTEGER | False | Set the port where the Node is hosting the RPC interface. See the rpc_port under full_node in config.yaml | -| -s | --show | None | False | Enable to show a summary of the singleton after sync is complete (default: disabled) | -| -h | --help | None | False | Show a help message and exit | +| -np | --node-rpc-port | INTEGER | False | Set the port where the Node is hosting the RPC interface. See the rpc_port under full_node in config.yaml | +| -s | --show | None | False | Enable to show a summary of the singleton after sync is complete (default: disabled) | +| -h | --help | None | False | Show a help message and exit |
Example -- sync and show the config @@ -642,11 +642,11 @@ Usage: `cic update_config [OPTIONS]` Options: -| Short Command | Long Command | Type | Required | Description | -| :------------ | :-------------- | :--- | :------- | :------------------------------------------------------------------------------------------------------------ | +| Short Command | Long Command | Type | Required | Description | +|:------------- |:--------------- |:---- |:-------- |:------------------------------------------------------------------------------------------------------------------------- | | -c | --configuration | TEXT | False | The configuration file with which to initialize a sync database (default: ./Configuration (\*\*\*\*\*\*).txt) | | -db | --db-path | TEXT | True | The file path to initialize/find the sync database at (default: ./sync (\*\*\*\*\*\*).sqlite) | -| -h | --help | None | False | Show a help message and exit | +| -h | --help | None | False | Show a help message and exit |
Example -- update config after rekey @@ -676,7 +676,7 @@ Usage: `cic which_pubkeys [OPTIONS] AGGREGATE_PUBKEY` Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :------------ | :------ | :------- | :------------------------------------------------------------------ | +|:------------- |:------------- |:------- |:-------- |:------------------------------------------------------------------- | | -pks | --pubkeys | TEXT | True | A comma separated list of pubkey files that may be in the aggregate | | -m | --num-pubkeys | INTEGER | False | Check only combinations of a specific number of pubkeys | | | --no-offset | None | False | Do not try the synthetic versions of the pubkeys | @@ -789,7 +789,7 @@ Positional arguments: Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :------------------- | :--- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------- | +|:------------- |:-------------------- |:---- |:-------- |:--------------------------------------------------------------------------------------------------------------------------------------- | | -y | --yes | None | False | Enable to skip confirmations (default: disabled) | | | --qr | None | False | Enable to show signature as QR code (default: disabled) | | | --nochunks | None | False | Enable to read the spend in its entirety rather than as chunks (testing only) argument to pass to gpg (besides -d). (default: disabled) | diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cli-reference/daos.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cli-reference/daos.md index 1006d8ada3..be63d1e0be 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cli-reference/daos.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cli-reference/daos.md @@ -27,14 +27,14 @@ Usage: chia dao add \[OPTIONS] Options: -| Short Command | Long Command | Type | Required | Description | -| :------------ | :---------------- | :------ | :------- | :------------------------------------------------------------------------------------------------------- | -| -wp | --wallet-rpc-port | INTEGER | False | Set the port where the Wallet is hosting the RPC interface. See the rpc_port under wallet in config.yaml | -| -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which key to use | -| -n | --name | TEXT | False | Set the DAO wallet name | -| -t | --treasury-id | TEXT | True | The Treasury ID of the DAO you want to track | -| -a | --filter-amount | INTEGER | False | The minimum number of votes a proposal needs before the wallet will recognise it \[default: 1] | -| -h | --help | None | False | Show a help message and exit | +| Short Command | Long Command | Type | Required | Description | +| :------------ | :---------------- | :------ | :------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| -wp | --wallet-rpc-port | INTEGER | False | Set the port where the Wallet is hosting the RPC interface. See the rpc_port under wallet in config.yaml | +| -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which key to use | +| -n | --name | TEXT | False | Set the DAO wallet name | +| -t | --treasury-id | TEXT | True | The Treasury ID of the DAO you want to track | +| -a | --filter-amount | INTEGER | False | The minimum number of votes a proposal needs before the wallet will recognise it \[default: 1] | +| -h | --help | None | False | Show a help message and exit |
Example @@ -136,21 +136,21 @@ Usage: chia dao add_funds \[OPTIONS] Options: -| Short Command | Long Command | Type | Required | Description | -| :------------ | :------------------------------------ | :------ | :------- | :------------------------------------------------------------------------------------------------------- | -| -wp | --wallet-rpc-port | INTEGER | False | Set the port where the Wallet is hosting the RPC interface. See the rpc_port under wallet in config.yaml | -| -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which key to use | -| -i | --wallet-id | INTEGER | True | ID of the DAO Treasury Wallet | -| -w | --funding-wallet-id | INTEGER | True | The ID of the wallet to send funds from (must be of type `STANDARD_WALLET`) | -| -a | --amount | TEXT | True | The amount of funds to send, in XCH | -| -m | --fee | TEXT | False | Set the fees per transaction, in XCH [default: 0] | -| | --reuse, --reuse-puzhash | None | False | Set either of these flags to reuse the existing address for the change \[default: not set] | -| | --new-address, --generate-new-puzhash | None | False | Set either of these flags to generate a new puzzle hash / address for the change \[default: not set] | -| -ma | --min-coin-amount, --min-amount | TEXT | False | Ignore coins worth less then this much XCH or CAT units | -| -l | --max-coin-amount, --max-amount | TEXT | False | Ignore coins worth more then this much XCH or CAT units | -| | --exclude-coin | TEXT | False | Exclude the coin with this ID from being spent | -| | --exclude-amount | TEXT | False | Exclude any coins with this XCH or CAT amount from being included | -| -h | --help | None | False | Show a help message and exit | +| Short Command | Long Command | Type | Required | Description | +| :------------ | :------------------------------------ | :------ | :------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| -wp | --wallet-rpc-port | INTEGER | False | Set the port where the Wallet is hosting the RPC interface. See the rpc_port under wallet in config.yaml | +| -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which key to use | +| -i | --wallet-id | INTEGER | True | ID of the DAO Treasury Wallet | +| -w | --funding-wallet-id | INTEGER | True | The ID of the wallet to send funds from (must be of type `STANDARD_WALLET`) | +| -a | --amount | TEXT | True | The amount of funds to send, in XCH or CATs | +| -m | --fee | TEXT | False | Set the fees per transaction, in XCH [default: 0] | +| | --reuse, --reuse-puzhash | None | False | Set either of these flags to reuse the existing address for the change \[default: not set] | +| | --new-address, --generate-new-puzhash | None | False | Set either of these flags to generate a new puzzle hash / address for the change \[default: not set] | +| -ma | --min-coin-amount, --min-amount | TEXT | False | Ignore coins worth less then this much XCH or CAT units | +| -l | --max-coin-amount, --max-amount | TEXT | False | Ignore coins worth more then this much XCH or CAT units | +| | --exclude-coin | TEXT | False | Exclude the coin with this ID from being spent | +| | --exclude-amount | TEXT | False | Exclude any coins with this XCH or CAT amount from being included | +| -h | --help | None | False | Show a help message and exit |
Example @@ -251,12 +251,12 @@ Usage: chia dao balance \[OPTIONS] Options: -| Short Command | Long Command | Type | Required | Description | -| :------------ | :---------------- | :------ | :------- | :------------------------------------------------------------------------------------------------------- | +| Short Command | Long Command | Type | Required | Description | +| :------------ | :---------------- | :------ | :------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------ | | -wp | --wallet-rpc-port | INTEGER | False | Set the port where the Wallet is hosting the RPC interface. See the rpc_port under wallet in config.yaml | -| -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which key to use | -| -i | --wallet-id | INTEGER | True | ID of the wallet to use | -| -h | --help | None | False | Show a help message and exit | +| -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which key to use | +| -i | --wallet-id | INTEGER | True | ID of the wallet to use | +| -h | --help | None | False | Show a help message and exit |
Example @@ -283,21 +283,21 @@ Usage: chia dao close_proposal \[OPTIONS] Options: -| Short Command | Long Command | Type | Required | Description | -| :------------ | :------------------------------------ | :------ | :------- | :------------------------------------------------------------------------------------------------------------------ | -| -wp | --wallet-rpc-port | INTEGER | False | Set the port where the Wallet is hosting the RPC interface. See the rpc_port under wallet in config.yaml | -| -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which key to use | -| -i | --wallet-id | INTEGER | True | ID of the wallet to use | -| -p | --proposal-id | TEXT | True | The ID of the proposal you are voting on | +| Short Command | Long Command | Type | Required | Description | +| :------------ | :------------------------------------ | :------ | :------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| -wp | --wallet-rpc-port | INTEGER | False | Set the port where the Wallet is hosting the RPC interface. See the rpc_port under wallet in config.yaml | +| -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which key to use | +| -i | --wallet-id | INTEGER | True | ID of the wallet to use | +| -p | --proposal-id | TEXT | True | The ID of the proposal you are voting on | | -d | --self-destruct | None | False | If this flag is set, it will self-destruct a broken proposal, thus forcing to force it to close \[default: not set] | -| -m | --fee | TEXT | False | Set the fees per transaction, in XCH [default: 0] | +| -m | --fee | TEXT | False | Set the fees per transaction, in XCH [default: 0] | | | --reuse, --reuse-puzhash | None | False | Set either of these flags to reuse the existing address for the change \[default: not set] | | | --new-address, --generate-new-puzhash | None | False | Set either of these flags to generate a new puzzle hash / address for the change \[default: not set] | -| -ma | --min-coin-amount, --min-amount | TEXT | False | Ignore coins worth less then this much XCH or CAT units | -| -l | --max-coin-amount, --max-amount | TEXT | False | Ignore coins worth more then this much XCH or CAT units | -| | --exclude-coin | TEXT | False | Exclude the coin with this ID from being spent | -| | --exclude-amount | TEXT | False | Exclude any coins with this XCH or CAT amount from being included | -| -h | --help | None | False | Show a help message and exit | +| -ma | --min-coin-amount, --min-amount | TEXT | False | Ignore coins worth less then this much XCH or CAT units | +| -l | --max-coin-amount, --max-amount | TEXT | False | Ignore coins worth more then this much XCH or CAT units | +| | --exclude-coin | TEXT | False | Exclude the coin with this ID from being spent | +| | --exclude-amount | TEXT | False | Exclude any coins with this XCH or CAT amount from being included | +| -h | --help | None | False | Show a help message and exit |
Example @@ -410,29 +410,29 @@ Usage: chia dao create \[OPTIONS] Options: -| Short Command | Long Command | Type | Required | Description | -| :------------ | :------------------------------------ | :------ | :------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| -wp | --wallet-rpc-port | INTEGER | False | Set the port where the Wallet is hosting the RPC interface. See the rpc_port under wallet in config.yaml | -| -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which key to use | -| -n | --name | TEXT | False | Set the DAO wallet name | -| | --proposal-timelock | INTEGER | False | The minimum number of blocks before a proposal can close \[default: 1000] | -| | --soft-close | INTEGER | False | The number of blocks a proposal must remain unspent before closing \[default: 20] | -| | --attendance-required | INTEGER | True | The minimum number of votes a proposal must receive to be accepted | -| | --pass-percentage | INTEGER | False | The percentage of 'yes' votes in basis points a proposal must receive to be accepted. 100% = 10000 \[default: 5000] | -| | --self-destruct | INTEGER | False | The number of blocks required before a proposal can be automatically removed \[default: 10000] | -| | --oracle-delay | INTEGER | False | The number of blocks required between oracle spends of the treasury \[default: 50] | +| Short Command | Long Command | Type | Required | Description | +| :------------ | :------------------------------------ | :------ | :------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| -wp | --wallet-rpc-port | INTEGER | False | Set the port where the Wallet is hosting the RPC interface. See the rpc_port under wallet in config.yaml | +| -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which key to use | +| -n | --name | TEXT | False | Set the DAO wallet name | +| | --proposal-timelock | INTEGER | False | The minimum number of blocks before a proposal can close \[default: 1000] | +| | --soft-close | INTEGER | False | The number of blocks a proposal must remain unspent before closing \[default: 20] | +| | --attendance-required | INTEGER | True | The minimum number of votes a proposal must receive to be accepted | +| | --pass-percentage | INTEGER | False | The percentage of 'yes' votes in basis points a proposal must receive to be accepted. 100% = 10000 \[default: 5000] | +| | --self-destruct | INTEGER | False | The number of blocks required before a proposal can be automatically removed \[default: 10000] | +| | --oracle-delay | INTEGER | False | The number of blocks required between oracle spends of the treasury \[default: 50] | | | --proposal-minimum | INTEGER | False | The minimum amount (in xch) that a proposal must use to be created (this is a spam-prevention measure; it will be donated to the treasury when the proposal is closed) \[default: 0.000000000001] | -| | --filter-amount | INTEGER | False | The minimum number of votes a proposal needs before the wallet will recognise it \[default: 1] | -| | --cat-amount | INTEGER | True | The number of DAO CATs (in mojos) to create when initializing the DAO | -| -m | --fee | TEXT | False | Set the fees per transaction, in XCH [default: 0] | -| | --fee-for-cat | TEXT | False | Set the fees for the CAT creation transaction, in XCH \[default: 0] | -| | --reuse, --reuse-puzhash | None | False | Set either of these flags to reuse the existing address for the change \[default: not set] | -| | --new-address, --generate-new-puzhash | None | False | Set either of these flags to generate a new puzzle hash / address for the change \[default: not set] | -| -ma | --min-coin-amount, --min-amount | TEXT | False | Ignore coins worth less then this much XCH or CAT units | -| -l | --max-coin-amount, --max-amount | TEXT | False | Ignore coins worth more then this much XCH or CAT units | -| | --exclude-coin | TEXT | False | Exclude the coin with this ID from being spent | -| | --exclude-amount | TEXT | False | Exclude any coins with this XCH or CAT amount from being included | -| -h | --help | None | False | Show a help message and exit | +| | --filter-amount | INTEGER | False | The minimum number of votes a proposal needs before the wallet will recognise it \[default: 1] | +| | --cat-amount | INTEGER | True | The number of DAO CATs (in mojos) to create when initializing the DAO | +| -m | --fee | TEXT | False | Set the fees per transaction, in XCH [default: 0] | +| | --fee-for-cat | TEXT | False | Set the fees for the CAT creation transaction, in XCH \[default: 0] | +| | --reuse, --reuse-puzhash | None | False | Set either of these flags to reuse the existing address for the change \[default: not set] | +| | --new-address, --generate-new-puzhash | None | False | Set either of these flags to generate a new puzzle hash / address for the change \[default: not set] | +| -ma | --min-coin-amount, --min-amount | TEXT | False | Ignore coins worth less then this much XCH or CAT units | +| -l | --max-coin-amount, --max-amount | TEXT | False | Ignore coins worth more then this much XCH or CAT units | +| | --exclude-coin | TEXT | False | Exclude the coin with this ID from being spent | +| | --exclude-amount | TEXT | False | Exclude any coins with this XCH or CAT amount from being included | +| -h | --help | None | False | Show a help message and exit | :::info @@ -563,22 +563,22 @@ Usage: chia dao create_proposal \[OPTIONS] Options: -| Short Command | Long Command | Type | Required | Description | -| :------------ | :------------------------------------ | :------ | :------- | :------------------------------------------------------------------------------------------------------- | -| -wp | --wallet-rpc-port | INTEGER | False | Set the port where the Wallet is hosting the RPC interface. See the rpc_port under wallet in config.yaml | -| -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which key to use | -| -i | --wallet-id | INTEGER | True | ID of the DAO wallet to use | -| -a | --amount | INTEGER | True | The amount of new cats the proposal will mint (in mojos) | -| -t | --to-address | TEXT | True | The address new cats will be minted to | -| -v | --vote-amount | INTEGER | True | The number of votes to add | -| -m | --fee | TEXT | False | Set the fees per transaction, in XCH [default: 0] | -| | --reuse, --reuse-puzhash | None | False | Set either of these flags to reuse the existing address for the change \[default: not set] | -| | --new-address, --generate-new-puzhash | None | False | Set either of these flags to generate a new puzzle hash / address for the change \[default: not set] | -| -ma | --min-coin-amount, --min-amount | TEXT | False | Ignore coins worth less then this much XCH or CAT units | -| -l | --max-coin-amount, --max-amount | TEXT | False | Ignore coins worth more then this much XCH or CAT units | -| | --exclude-coin | TEXT | False | Exclude the coin with this ID from being spent | -| | --exclude-amount | TEXT | False | Exclude any coins with this XCH or CAT amount from being included | -| -h | --help | None | False | Show a help message and exit | +| Short Command | Long Command | Type | Required | Description | +| :------------ | :------------------------------------ | :------ | :------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| -wp | --wallet-rpc-port | INTEGER | False | Set the port where the Wallet is hosting the RPC interface. See the rpc_port under wallet in config.yaml | +| -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which key to use | +| -i | --wallet-id | INTEGER | True | ID of the DAO wallet to use | +| -a | --amount | INTEGER | True | The amount of new cats the proposal will mint (in mojos) | +| -t | --to-address | TEXT | True | The address new cats will be minted to | +| -v | --vote-amount | INTEGER | True | The number of votes to add | +| -m | --fee | TEXT | False | Set the fees per transaction, in XCH [default: 0] | +| | --reuse, --reuse-puzhash | None | False | Set either of these flags to reuse the existing address for the change \[default: not set] | +| | --new-address, --generate-new-puzhash | None | False | Set either of these flags to generate a new puzzle hash / address for the change \[default: not set] | +| -ma | --min-coin-amount, --min-amount | TEXT | False | Ignore coins worth less then this much XCH or CAT units | +| -l | --max-coin-amount, --max-amount | TEXT | False | Ignore coins worth more then this much XCH or CAT units | +| | --exclude-coin | TEXT | False | Exclude the coin with this ID from being spent | +| | --exclude-amount | TEXT | False | Exclude any coins with this XCH or CAT amount from being included | +| -h | --help | None | False | Show a help message and exit | :::warning @@ -682,24 +682,24 @@ Usage: chia dao create_proposal \[OPTIONS] Options: -| Short Command | Long Command | Type | Required | Description | -| :------------ | :------------------------------------ | :------ | :------- | :------------------------------------------------------------------------------------------------------- | -| -wp | --wallet-rpc-port | INTEGER | False | Set the port where the Wallet is hosting the RPC interface. See the rpc_port under wallet in config.yaml | -| -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which key to use | -| -i | --wallet-id | INTEGER | True | ID of the wallet to use | -| -t | --to-address | TEXT | False | The address the proposal will send funds to | -| -a | --amount | FLOAT | False | The amount of funds the proposal will send (in mojos) | -| -v | --vote-amount | INTEGER | True | The number of votes to add | -| | --asset-id | TEXT | False | The asset id of the funds the proposal will send. Leave blank for xch | -| -j | --from-json | TEXT | False | Path to a json file containing a list of additions, for use in proposals with multiple spends | -| -m | --fee | TEXT | False | Set the fees per transaction, in XCH [default: 0] | -| | --reuse, --reuse-puzhash | None | False | Set either of these flags to reuse the existing address for the change \[default: not set] | -| | --new-address, --generate-new-puzhash | None | False | Set either of these flags to generate a new puzzle hash / address for the change \[default: not set] | -| -ma | --min-coin-amount, --min-amount | TEXT | False | Ignore coins worth less then this much XCH or CAT units | -| -l | --max-coin-amount, --max-amount | TEXT | False | Ignore coins worth more then this much XCH or CAT units | -| | --exclude-coin | TEXT | False | Exclude the coin with this ID from being spent | -| | --exclude-amount | TEXT | False | Exclude any coins with this XCH or CAT amount from being included | -| -h | --help | None | False | Show a help message and exit | +| Short Command | Long Command | Type | Required | Description | +| :------------ | :------------------------------------ | :------ | :------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| -wp | --wallet-rpc-port | INTEGER | False | Set the port where the Wallet is hosting the RPC interface. See the rpc_port under wallet in config.yaml | +| -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which key to use | +| -i | --wallet-id | INTEGER | True | ID of the wallet to use | +| -t | --to-address | TEXT | False | The address the proposal will send funds to | +| -a | --amount | FLOAT | False | The amount of funds the proposal will send (in mojos) | +| -v | --vote-amount | INTEGER | True | The number of votes to add | +| | --asset-id | TEXT | False | The asset id of the funds the proposal will send. Leave blank for xch | +| -j | --from-json | TEXT | False | Path to a json file containing a list of additions, for use in proposals with multiple spends | +| -m | --fee | TEXT | False | Set the fees per transaction, in XCH [default: 0] | +| | --reuse, --reuse-puzhash | None | False | Set either of these flags to reuse the existing address for the change \[default: not set] | +| | --new-address, --generate-new-puzhash | None | False | Set either of these flags to generate a new puzzle hash / address for the change \[default: not set] | +| -ma | --min-coin-amount, --min-amount | TEXT | False | Ignore coins worth less then this much XCH or CAT units | +| -l | --max-coin-amount, --max-amount | TEXT | False | Ignore coins worth more then this much XCH or CAT units | +| | --exclude-coin | TEXT | False | Exclude the coin with this ID from being spent | +| | --exclude-amount | TEXT | False | Exclude any coins with this XCH or CAT amount from being included | +| -h | --help | None | False | Show a help message and exit |
Example @@ -818,26 +818,26 @@ Usage: chia dao create_proposal \[OPTIONS] Options: -| Short Command | Long Command | Type | Required | Description | -| :------------ | :------------------------------------ | :------ | :------- | :------------------------------------------------------------------------------------------------------- | -| -wp | --wallet-rpc-port | INTEGER | False | Set the port where the Wallet is hosting the RPC interface. See the rpc_port under wallet in config.yaml | -| -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which key to use | -| -i | --wallet-id | INTEGER | True | ID of the wallet to use | -| -v | --vote-amount | INTEGER | True | The number of votes to add | -| | --proposal-timelock | INTEGER | False | The new minimum number of blocks before a proposal can close | -| | --soft-close | INTEGER | False | The number of blocks a proposal must remain unspent before closing | -| | --attendance-required | INTEGER | False | The minimum number of votes a proposal must receive to be accepted | -| | --pass-percentage | INTEGER | False | The percentage of 'yes' votes in basis points a proposal must receive to be accepted. 100% = 10000 | -| | --self-destruct | INTEGER | False | The number of blocks required before a proposal can be automatically removed | -| | --oracle-delay | INTEGER | False | The number of blocks required between oracle spends of the treasury | -| -m | --fee | TEXT | False | Set the fees per transaction, in XCH [default: 0] | -| | --reuse, --reuse-puzhash | None | False | Set either of these flags to reuse the existing address for the change \[default: not set] | -| | --new-address, --generate-new-puzhash | None | False | Set either of these flags to generate a new puzzle hash / address for the change \[default: not set] | -| -ma | --min-coin-amount, --min-amount | TEXT | False | Ignore coins worth less then this much XCH or CAT units | -| -l | --max-coin-amount, --max-amount | TEXT | False | Ignore coins worth more then this much XCH or CAT units | -| | --exclude-coin | TEXT | False | Exclude the coin with this ID from being spent | -| | --exclude-amount | TEXT | False | Exclude any coins with this XCH or CAT amount from being included | -| -h | --help | None | False | Show a help message and exit | +| Short Command | Long Command | Type | Required | Description | +| :------------ | :------------------------------------ | :------ | :------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| -wp | --wallet-rpc-port | INTEGER | False | Set the port where the Wallet is hosting the RPC interface. See the rpc_port under wallet in config.yaml | +| -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which key to use | +| -i | --wallet-id | INTEGER | True | ID of the wallet to use | +| -v | --vote-amount | INTEGER | True | The number of votes to add | +| | --proposal-timelock | INTEGER | False | The new minimum number of blocks before a proposal can close | +| | --soft-close | INTEGER | False | The number of blocks a proposal must remain unspent before closing | +| | --attendance-required | INTEGER | False | The minimum number of votes a proposal must receive to be accepted | +| | --pass-percentage | INTEGER | False | The percentage of 'yes' votes in basis points a proposal must receive to be accepted. 100% = 10000 | +| | --self-destruct | INTEGER | False | The number of blocks required before a proposal can be automatically removed | +| | --oracle-delay | INTEGER | False | The number of blocks required between oracle spends of the treasury | +| -m | --fee | TEXT | False | Set the fees per transaction, in XCH [default: 0] | +| | --reuse, --reuse-puzhash | None | False | Set either of these flags to reuse the existing address for the change \[default: not set] | +| | --new-address, --generate-new-puzhash | None | False | Set either of these flags to generate a new puzzle hash / address for the change \[default: not set] | +| -ma | --min-coin-amount, --min-amount | TEXT | False | Ignore coins worth less then this much XCH or CAT units | +| -l | --max-coin-amount, --max-amount | TEXT | False | Ignore coins worth more then this much XCH or CAT units | +| | --exclude-coin | TEXT | False | Exclude the coin with this ID from being spent | +| | --exclude-amount | TEXT | False | Exclude any coins with this XCH or CAT amount from being included | +| -h | --help | None | False | Show a help message and exit |
Example @@ -908,19 +908,19 @@ Usage: chia dao exit_lockup \[OPTIONS] Options: -| Short Command | Long Command | Type | Required | Description | -| :------------ | :------------------------------------ | :------ | :------- | :------------------------------------------------------------------------------------------------------- | -| -wp | --wallet-rpc-port | INTEGER | False | Set the port where the Wallet is hosting the RPC interface. See the rpc_port under wallet in config.yaml | -| -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which key to use | -| -i | --wallet-id | INTEGER | True | ID of the DAO wallet from which to exit the lockup | -| -m | --fee | TEXT | False | Set the fees per transaction, in XCH [default: 0] | -| | --reuse, --reuse-puzhash | None | False | Set either of these flags to reuse the existing address for the change \[default: not set] | -| | --new-address, --generate-new-puzhash | None | False | Set either of these flags to generate a new puzzle hash / address for the change \[default: not set] | -| -ma | --min-coin-amount, --min-amount | TEXT | False | Ignore coins worth less then this much XCH or CAT units | -| -l | --max-coin-amount, --max-amount | TEXT | False | Ignore coins worth more then this much XCH or CAT units | -| | --exclude-coin | TEXT | False | Exclude the coin with this ID from being spent | -| | --exclude-amount | TEXT | False | Exclude any coins with this XCH or CAT amount from being included | -| -h | --help | None | False | Show a help message and exit | +| Short Command | Long Command | Type | Required | Description | +| :------------ | :------------------------------------ | :------ | :------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| -wp | --wallet-rpc-port | INTEGER | False | Set the port where the Wallet is hosting the RPC interface. See the rpc_port under wallet in config.yaml | +| -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which key to use | +| -i | --wallet-id | INTEGER | True | ID of the DAO wallet from which to exit the lockup | +| -m | --fee | TEXT | False | Set the fees per transaction, in XCH [default: 0] | +| | --reuse, --reuse-puzhash | None | False | Set either of these flags to reuse the existing address for the change \[default: not set] | +| | --new-address, --generate-new-puzhash | None | False | Set either of these flags to generate a new puzzle hash / address for the change \[default: not set] | +| -ma | --min-coin-amount, --min-amount | TEXT | False | Ignore coins worth less then this much XCH or CAT units | +| -l | --max-coin-amount, --max-amount | TEXT | False | Ignore coins worth more then this much XCH or CAT units | +| | --exclude-coin | TEXT | False | Exclude the coin with this ID from being spent | +| | --exclude-amount | TEXT | False | Exclude any coins with this XCH or CAT amount from being included | +| -h | --help | None | False | Show a help message and exit | This command will unlock tokens that have been locked for voting, provided that there are no active proposals that these CATs have voted on. This command will automatically determine which CATs are available to be unlocked. @@ -1005,12 +1005,12 @@ Usage: chia dao get_id \[OPTIONS] Options: -| Short Command | Long Command | Type | Required | Description | -| :------------ | :---------------- | :------ | :------- | :------------------------------------------------------------------------------------------------------- | +| Short Command | Long Command | Type | Required | Description | +| :------------ | :---------------- | :------ | :------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------ | | -wp | --wallet-rpc-port | INTEGER | False | Set the port where the Wallet is hosting the RPC interface. See the rpc_port under wallet in config.yaml | -| -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which key to use | -| -i | --wallet-id | INTEGER | True | ID of the DAO wallet which will receive the funds | -| -h | --help | None | False | Show a help message and exit | +| -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which key to use | +| -i | --wallet-id | INTEGER | True | ID of the DAO wallet which will receive the funds | +| -h | --help | None | False | Show a help message and exit |
Example @@ -1039,13 +1039,13 @@ Usage: chia dao list_proposals \[OPTIONS] Options: -| Short Command | Long Command | Type | Required | Description | -| :------------ | :---------------- | :------ | :------- | :------------------------------------------------------------------------------------------------------- | +| Short Command | Long Command | Type | Required | Description | +| :------------ | :---------------- | :------ | :------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------ | | -wp | --wallet-rpc-port | INTEGER | False | Set the port where the Wallet is hosting the RPC interface. See the rpc_port under wallet in config.yaml | -| -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which key to use | -| -i | --wallet-id | INTEGER | True | ID of the wallet to use | -| -c | --include-closed | None | False | Set to include previously closed proposals \[Default: not set] | -| -h | --help | None | False | Show a help message and exit | +| -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which key to use | +| -i | --wallet-id | INTEGER | True | ID of the wallet to use | +| -c | --include-closed | None | False | Set to include previously closed proposals \[Default: not set] | +| -h | --help | None | False | Show a help message and exit | This command will list all open proposals by default. If the `-c` flag is included, then all open _and_ closed proposals will be listed. @@ -1083,20 +1083,20 @@ Usage: chia dao lockup_coins \[OPTIONS] Options: -| Short Command | Long Command | Type | Required | Description | -| :------------ | :------------------------------------ | :------ | :------- | :------------------------------------------------------------------------------------------------------- | -| -wp | --wallet-rpc-port | INTEGER | False | Set the port where the Wallet is hosting the RPC interface. See the rpc_port under wallet in config.yaml | -| -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which key to use | -| -i | --wallet-id | INTEGER | True | ID of the DAO wallet to use | -| -a | --amount | TEXT | True | The amount of CATs (not mojos) to lock in voting mode | -| -m | --fee | TEXT | False | Set the fees per transaction, in XCH [default: 0] | -| | --reuse, --reuse-puzhash | None | False | Set either of these flags to reuse the existing address for the change \[default: not set] | -| | --new-address, --generate-new-puzhash | None | False | Set either of these flags to generate a new puzzle hash / address for the change \[default: not set] | -| -ma | --min-coin-amount, --min-amount | TEXT | False | Ignore coins worth less then this much XCH or CAT units | -| -l | --max-coin-amount, --max-amount | TEXT | False | Ignore coins worth more then this much XCH or CAT units | -| | --exclude-coin | TEXT | False | Exclude the coin with this ID from being spent | -| | --exclude-amount | TEXT | False | Exclude any coins with this XCH or CAT amount from being included | -| -h | --help | None | False | Show a help message and exit | +| Short Command | Long Command | Type | Required | Description | +| :------------ | :------------------------------------ | :------ | :------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| -wp | --wallet-rpc-port | INTEGER | False | Set the port where the Wallet is hosting the RPC interface. See the rpc_port under wallet in config.yaml | +| -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which key to use | +| -i | --wallet-id | INTEGER | True | ID of the DAO wallet to use | +| -a | --amount | TEXT | True | The amount of CATs (not mojos) to lock in voting mode | +| -m | --fee | TEXT | False | Set the fees per transaction, in XCH [default: 0] | +| | --reuse, --reuse-puzhash | None | False | Set either of these flags to reuse the existing address for the change \[default: not set] | +| | --new-address, --generate-new-puzhash | None | False | Set either of these flags to generate a new puzzle hash / address for the change \[default: not set] | +| -ma | --min-coin-amount, --min-amount | TEXT | False | Ignore coins worth less then this much XCH or CAT units | +| -l | --max-coin-amount, --max-amount | TEXT | False | Ignore coins worth more then this much XCH or CAT units | +| | --exclude-coin | TEXT | False | Exclude the coin with this ID from being spent | +| | --exclude-amount | TEXT | False | Exclude any coins with this XCH or CAT amount from being included | +| -h | --help | None | False | Show a help message and exit | This command will lock the specified number of tokens, thereby making them available for voting. @@ -1215,19 +1215,19 @@ Usage: chia dao release_coins \[OPTIONS] Options: -| Short Command | Long Command | Type | Required | Description | -| :------------ | :------------------------------------ | :------ | :------- | :------------------------------------------------------------------------------------------------------- | -| -wp | --wallet-rpc-port | INTEGER | False | Set the port where the Wallet is hosting the RPC interface. See the rpc_port under wallet in config.yaml | -| -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which key to use | -| -i | --wallet-id | INTEGER | True | ID of the wallet to use | -| -m | --fee | TEXT | False | Set the fees per transaction, in XCH [default: 0] | -| | --reuse, --reuse-puzhash | None | False | Set either of these flags to reuse the existing address for the change \[default: not set] | -| | --new-address, --generate-new-puzhash | None | False | Set either of these flags to generate a new puzzle hash / address for the change \[default: not set] | -| -ma | --min-coin-amount, --min-amount | TEXT | False | Ignore coins worth less then this much XCH or CAT units | -| -l | --max-coin-amount, --max-amount | TEXT | False | Ignore coins worth more then this much XCH or CAT units | -| | --exclude-coin | TEXT | False | Exclude the coin with this ID from being spent | -| | --exclude-amount | TEXT | False | Exclude any coins with this XCH or CAT amount from being included | -| -h | --help | None | False | Show a help message and exit | +| Short Command | Long Command | Type | Required | Description | +| :------------ | :------------------------------------ | :------ | :------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| -wp | --wallet-rpc-port | INTEGER | False | Set the port where the Wallet is hosting the RPC interface. See the rpc_port under wallet in config.yaml | +| -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which key to use | +| -i | --wallet-id | INTEGER | True | ID of the wallet to use | +| -m | --fee | TEXT | False | Set the fees per transaction, in XCH [default: 0] | +| | --reuse, --reuse-puzhash | None | False | Set either of these flags to reuse the existing address for the change \[default: not set] | +| | --new-address, --generate-new-puzhash | None | False | Set either of these flags to generate a new puzzle hash / address for the change \[default: not set] | +| -ma | --min-coin-amount, --min-amount | TEXT | False | Ignore coins worth less then this much XCH or CAT units | +| -l | --max-coin-amount, --max-amount | TEXT | False | Ignore coins worth more then this much XCH or CAT units | +| | --exclude-coin | TEXT | False | Exclude the coin with this ID from being spent | +| | --exclude-amount | TEXT | False | Exclude any coins with this XCH or CAT amount from being included | +| -h | --help | None | False | Show a help message and exit |
Example @@ -1308,12 +1308,12 @@ Usage: chia dao rules \[OPTIONS] Options: -| Short Command | Long Command | Type | Required | Description | -| :------------ | :---------------- | :------ | :------- | :------------------------------------------------------------------------------------------------------- | +| Short Command | Long Command | Type | Required | Description | +| :------------ | :---------------- | :------ | :------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------ | | -wp | --wallet-rpc-port | INTEGER | False | Set the port where the Wallet is hosting the RPC interface. See the rpc_port under wallet in config.yaml | -| -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which key to use | -| -i | --wallet-id | INTEGER | True | ID of the wallet to use | -| -h | --help | None | False | Show a help message and exit | +| -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which key to use | +| -i | --wallet-id | INTEGER | True | ID of the wallet to use | +| -h | --help | None | False | Show a help message and exit |
Example @@ -1346,13 +1346,13 @@ Usage: chia dao show_proposal \[OPTIONS] Options: -| Short Command | Long Command | Type | Required | Description | -| :------------ | :---------------- | :------ | :------- | :------------------------------------------------------------------------------------------------------- | -| -wp | --wallet-rpc-port | INTEGER | False | Set the port where the Wallet is hosting the RPC interface. See the rpc_port under wallet in config.yaml | -| -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which key to use | -| -i | --wallet-id | INTEGER | True | ID of the wallet to use | -| -p | --proposal_id | TEXT | True | The ID of the proposal to fetch, obtainable by running the [list_proposals](#list_proposals) command | -| -h | --help | None | False | Show a help message and exit | +| Short Command | Long Command | Type | Required | Description | +| :------------ | :--------------------------------- | :------ | :------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| -wp | --wallet-rpc-port | INTEGER | False | Set the port where the Wallet is hosting the RPC interface. See the rpc_port under wallet in config.yaml | +| -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which key to use | +| -i | --wallet-id | INTEGER | True | ID of the wallet to use | +| -p | --proposal_id | TEXT | True | The ID of the proposal to fetch, obtainable by running the [list_proposals](#list_proposals) command | +| -h | --help | None | False | Show a help message and exit |
Example @@ -1391,22 +1391,22 @@ Usage: chia dao vote \[OPTIONS] Options: -| Short Command | Long Command | Type | Required | Description | -| :------------ | :------------------------------------ | :------ | :------- | :------------------------------------------------------------------------------------------------------- | -| -wp | --wallet-rpc-port | INTEGER | False | Set the port where the Wallet is hosting the RPC interface. See the rpc_port under wallet in config.yaml | -| -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which key to use | -| -i | --wallet-id | INTEGER | True | ID of the wallet to use | -| -p | --proposal-id | TEXT | True | The ID of the proposal you are voting on | -| -a | --vote-amount | INTEGER | True | The number of votes you want to cast | -| -n | --vote-no | None | False | Use this option to vote against a proposal. If not present then the vote is for the proposal | -| -m | --fee | TEXT | False | Set the fees per transaction, in XCH [default: 0] | -| | --reuse, --reuse-puzhash | None | False | Set either of these flags to reuse the existing address for the change \[default: not set] | -| | --new-address, --generate-new-puzhash | None | False | Set either of these flags to generate a new puzzle hash / address for the change \[default: not set] | -| -ma | --min-coin-amount, --min-amount | TEXT | False | Ignore coins worth less then this much XCH or CAT units | -| -l | --max-coin-amount, --max-amount | TEXT | False | Ignore coins worth more then this much XCH or CAT units | -| | --exclude-coin | TEXT | False | Exclude the coin with this ID from being spent | -| | --exclude-amount | TEXT | False | Exclude any coins with this XCH or CAT amount from being included | -| -h | --help | None | False | Show a help message and exit | +| Short Command | Long Command | Type | Required | Description | +| :------------ | :------------------------------------ | :------ | :------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| -wp | --wallet-rpc-port | INTEGER | False | Set the port where the Wallet is hosting the RPC interface. See the rpc_port under wallet in config.yaml | +| -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which key to use | +| -i | --wallet-id | INTEGER | True | ID of the wallet to use | +| -p | --proposal-id | TEXT | True | The ID of the proposal you are voting on | +| -a | --vote-amount | INTEGER | True | The number of votes you want to cast | +| -n | --vote-no | None | False | Use this option to vote against a proposal. If not present then the vote is for the proposal | +| -m | --fee | TEXT | False | Set the fees per transaction, in XCH [default: 0] | +| | --reuse, --reuse-puzhash | None | False | Set either of these flags to reuse the existing address for the change \[default: not set] | +| | --new-address, --generate-new-puzhash | None | False | Set either of these flags to generate a new puzzle hash / address for the change \[default: not set] | +| -ma | --min-coin-amount, --min-amount | TEXT | False | Ignore coins worth less then this much XCH or CAT units | +| -l | --max-coin-amount, --max-amount | TEXT | False | Ignore coins worth more then this much XCH or CAT units | +| | --exclude-coin | TEXT | False | Exclude the coin with this ID from being spent | +| | --exclude-amount | TEXT | False | Exclude any coins with this XCH or CAT amount from being included | +| -h | --help | None | False | Show a help message and exit |
Example diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cli-reference/datalayer.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cli-reference/datalayer.md index 261279b11b..db33a5c504 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cli-reference/datalayer.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cli-reference/datalayer.md @@ -40,7 +40,7 @@ Usage: `chia data add_mirror [OPTIONS]` Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :-------------- | :------ | :------- | :---------------------------------------------------------------------------------------------------------------------------------------- | +|:------------- |:--------------- |:------- |:-------- |:----------------------------------------------------------------------------------------------------------------------------------------- | | -i | --id | TEXT | True | The hexadecimal ID of the store to mirror | | -a | --amount | INTEGER | True | The amount (in mojos) to spend to create the mirror. In theory, mirrors with a higher `amount` will be prioritized. Minimum `amount` is 0 | | -u | --url | TEXT | False | A URL where the mirror will reside. Can be repeated to add multiple URLs in the same command | @@ -76,15 +76,15 @@ Usage: `chia data add_missing_files [OPTIONS]` Options: -| Short Command | Long Command | Type | Required | Description | -| :------------ | :-------------- | :------ | :------- | :-------------------------------------------------------------------------------------------------------------------------------------- | -| -i | --ids | TEXT | True | The hexadecimal store id(s) | -| -o | --override | None | False | If set, will overwrite files that already exist (default: not set) | -| -n | --no-override | None | False | If set, will not overwrite files that already exist (default: set) | +| Short Command | Long Command | Type | Required | Description | +|:------------- |:--------------- |:------- |:-------- |:--------------------------------------------------------------------------------------------------------------------------------------------- | +| -i | --ids | TEXT | True | The hexadecimal store id(s) | +| -o | --override | None | False | If set, will overwrite files that already exist (default: not set) | +| -n | --no-override | None | False | If set, will not overwrite files that already exist (default: set) | | -d | --directory | TEXT | False | If specified, use a non-default directory to write the files (default: `~/.chia/mainnet/data_layer/db/server_files_location_`) | -| -dp | --data-rpc-port | INTEGER | False | Set the port where the DataLayer is hosting the RPC interface. See rpc_port under data_layer in config.yaml | -| -f | --fingerprint | INTEGER | False | Fingerprint of the wallet to use | -| -h | --help | None | False | Show a help message and exit | +| -dp | --data-rpc-port | INTEGER | False | Set the port where the DataLayer is hosting the RPC interface. See rpc_port under data_layer in config.yaml | +| -f | --fingerprint | INTEGER | False | Fingerprint of the wallet to use | +| -h | --help | None | False | Show a help message and exit |
Example @@ -158,13 +158,13 @@ Usage: `chia data clear_pending_roots [OPTIONS]` Options: -| Short Command | Long Command | Type | Required | Description | -| :------------ | :-------------- | :------ | :------- | :---------------------------------------------------------------------------------------------------------- | -| -i | --id | TEXT | True | The ID of the store from which to clear the pending roots | -| | --yes | None | False | Set to confirm the action without prompting [Default: not set / prompt to confirm] | +| Short Command | Long Command | Type | Required | Description | +|:------------- |:--------------- |:------- |:-------- |:------------------------------------------------------------------------------------------------------------- | +| -i | --id | TEXT | True | The ID of the store from which to clear the pending roots | +| | --yes | None | False | Set to confirm the action without prompting [Default: not set / prompt to confirm] | | -dp | --data-rpc-port | INTEGER | False | Set the port where the DataLayer is hosting the RPC interface. See rpc_port under data_layer in config.yaml | -| -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which wallet to use | -| -h | --help | None | False | Show a help message and exit | +| -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which wallet to use | +| -h | --help | None | False | Show a help message and exit |
Example @@ -201,13 +201,13 @@ Usage: `chia data create_data_store [OPTIONS]` Options: -| Short Command | Long Command | Type | Required | Description | -| :------------ | :-------------- | :------ | :------: | :---------------------------------------------------------------------------------------------------------- | +| Short Command | Long Command | Type | Required | Description | +|:------------- |:--------------- |:------- |:--------:|:------------------------------------------------------------------------------------------------------------- | | -dp | --data-rpc-port | INTEGER | False | Set the port where the DataLayer is hosting the RPC interface. See rpc_port under data_layer in config.yaml | -| -m | --fee | TEXT | False | Set the fees for the transaction, in XCH | -| | --verbose | None | False | Set to enable verbose output | -| -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which wallet to use | -| -h | --help | None | False | Show a help message and exit | +| -m | --fee | TEXT | False | Set the fees for the transaction, in XCH | +| | --verbose | None | False | Set to enable verbose output | +| -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which wallet to use | +| -h | --help | None | False | Show a help message and exit |
Example @@ -352,13 +352,13 @@ Usage: `chia data delete_mirror [OPTIONS]` Options: -| Short Command | Long Command | Type | Required | Description | -| :------------ | :-------------- | :------ | :------- | :---------------------------------------------------------------------------------------------------------- | -| -c | --coin_id | TEXT | True | The coin_id of the mirror to delete (obtainable from the [get_mirrors](#get_mirrors) command) | -| -m | --fee | TEXT | False | Set the fees for the transaction, in XCH | +| Short Command | Long Command | Type | Required | Description | +|:------------- |:--------------- |:------- |:-------- |:------------------------------------------------------------------------------------------------------------- | +| -c | --coin_id | TEXT | True | The coin_id of the mirror to delete (obtainable from the [get_mirrors](#get_mirrors) command) | +| -m | --fee | TEXT | False | Set the fees for the transaction, in XCH | | -dp | --data-rpc-port | INTEGER | False | Set the port where the DataLayer is hosting the RPC interface. See rpc_port under data_layer in config.yaml | -| -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which wallet to use | -| -h | --help | None | False | Show a help message and exit | +| -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which wallet to use | +| -h | --help | None | False | Show a help message and exit |
Example @@ -385,15 +385,15 @@ Usage: `chia data get_keys [OPTIONS]` Options: -| Short Command | Long Command | Type | Required | Description | -| :------------ | :-------------- | :------ | :------- | :---------------------------------------------------------------------------------------------------------- | -| -store | --id | TEXT | True | The hexadecimal store id | -| -r | --root_hash | TEXT | False | The hexadecimal root hash | +| Short Command | Long Command | Type | Required | Description | +|:------------- |:--------------- |:------- |:-------- |:------------------------------------------------------------------------------------------------------------- | +| -store | --id | TEXT | True | The hexadecimal store id | +| -r | --root_hash | TEXT | False | The hexadecimal root hash | | -dp | --data-rpc-port | INTEGER | False | Set the port where the DataLayer is hosting the RPC interface. See rpc_port under data_layer in config.yaml | -| -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which wallet to use | -| -p | --page | INTEGER | False | Enables pagination of the output and requests a specific page | -| | --max-page-size | INTEGER | False | Set how many bytes to be included in a page, if pagination is enabled [Default: 40 MB] | -| -h | --help | None | False | Show a help message and exit | +| -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which wallet to use | +| -p | --page | INTEGER | False | Enables pagination of the output and requests a specific page | +| | --max-page-size | INTEGER | False | Set how many bytes to be included in a page, if pagination is enabled [Default: 40 MB] | +| -h | --help | None | False | Show a help message and exit | :::info @@ -434,15 +434,15 @@ Usage: `chia data get_keys_values [OPTIONS]` Options: -| Short Command | Long Command | Type | Required | Description | -| :------------ | :-------------- | :------ | :------- | :---------------------------------------------------------------------------------------------------------- | -| -store | --id | TEXT | True | The hexadecimal store id | -| -r | --root_hash | TEXT | False | The hexadecimal root hash | +| Short Command | Long Command | Type | Required | Description | +|:------------- |:--------------- |:------- |:-------- |:------------------------------------------------------------------------------------------------------------- | +| -store | --id | TEXT | True | The hexadecimal store id | +| -r | --root_hash | TEXT | False | The hexadecimal root hash | | -dp | --data-rpc-port | INTEGER | False | Set the port where the DataLayer is hosting the RPC interface. See rpc_port under data_layer in config.yaml | -| -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which wallet to use | -| -p | --page | INTEGER | False | Enables pagination of the output and requests a specific page | -| | --max-page-size | INTEGER | False | Set how many bytes to be included in a page, if pagination is enabled [Default: 40 MB] | -| -h | --help | None | False | Show a help message and exit | +| -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which wallet to use | +| -p | --page | INTEGER | False | Enables pagination of the output and requests a specific page | +| | --max-page-size | INTEGER | False | Set how many bytes to be included in a page, if pagination is enabled [Default: 40 MB] | +| -h | --help | None | False | Show a help message and exit | :::info @@ -493,16 +493,16 @@ Usage: `chia data get_kv_diff [OPTIONS]` Options: -| Short Command | Long Command | Type | Required | Description | -| :------------ | :-------------- | :------ | :------- | :---------------------------------------------------------------------------------------------------------- | -| -store | --id | TEXT | True | The hexadecimal store ID | -| -hash_1 | --hash_1 | TEXT | True | The first hash to compare | -| -hash_2 | --hash_2 | TEXT | True | The second hash to compare | +| Short Command | Long Command | Type | Required | Description | +|:------------- |:--------------- |:------- |:-------- |:------------------------------------------------------------------------------------------------------------- | +| -store | --id | TEXT | True | The hexadecimal store ID | +| -hash_1 | --hash_1 | TEXT | True | The first hash to compare | +| -hash_2 | --hash_2 | TEXT | True | The second hash to compare | | -dp | --data-rpc-port | INTEGER | False | Set the port where the DataLayer is hosting the RPC interface. See rpc_port under data_layer in config.yaml | -| -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which wallet to use | -| -p | --page | INTEGER | False | Enables pagination of the output and requests a specific page | -| | --max-page-size | INTEGER | False | Set how many bytes to be included in a page, if pagination is enabled [Default: 40 MB] | -| -h | --help | None | False | Show a help message and exit | +| -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which wallet to use | +| -p | --page | INTEGER | False | Enables pagination of the output and requests a specific page | +| | --max-page-size | INTEGER | False | Set how many bytes to be included in a page, if pagination is enabled [Default: 40 MB] | +| -h | --help | None | False | Show a help message and exit | :::info @@ -552,7 +552,7 @@ Usage: `chia data get_mirrors [OPTIONS]` Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :-------------- | :------ | :------- | :------------------------------------------------------------------------------------------------------ | +|:------------- |:--------------- |:------- |:-------- |:------------------------------------------------------------------------------------------------------- | | -i | --id | TEXT | True | The hexadecimal ID of the store for which to get mirrors | | -dp | --data-rpc-port | INTEGER | False | Set the port where the DataLayer is hosting the RPC interface. See rpc_port under wallet in config.yaml | | -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which wallet to use | @@ -598,7 +598,7 @@ Usage: `chia data get_owned_stores [OPTIONS]` Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :-------------- | :------ | :------- | :------------------------------------------------------------------------------------------------------ | +|:------------- |:--------------- |:------- |:-------- |:------------------------------------------------------------------------------------------------------- | | -dp | --data-rpc-port | INTEGER | False | Set the port where the DataLayer is hosting the RPC interface. See rpc_port under wallet in config.yaml | | -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which wallet to use | | -h | --help | None | False | Show a help message and exit | @@ -637,7 +637,7 @@ Usage: `chia data get_proof [OPTIONS]` Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :-------------- | :------ | :------- | :------------------------------------------------------------------------------------------------------ | +|:------------- |:--------------- |:------- |:-------- |:------------------------------------------------------------------------------------------------------- | | -store | --id | TEXT | True | The hexadecimal store id | | -dp | --data-rpc-port | INTEGER | False | Set the port where the DataLayer is hosting the RPC interface. See rpc_port under wallet in config.yaml | | -k | --key | TEXT | True | The hexadecimal key | @@ -690,12 +690,12 @@ Usage: `chia data get_root [OPTIONS]` Options: -| Short Command | Long Command | Type | Required | Description | -| :------------ | :-------------- | :------ | :------- | :---------------------------------------------------------------------------------------------------------- | -| -store | --id | TEXT | True | The hexadecimal store id | +| Short Command | Long Command | Type | Required | Description | +|:------------- |:--------------- |:------- |:-------- |:------------------------------------------------------------------------------------------------------------- | +| -store | --id | TEXT | True | The hexadecimal store id | | -dp | --data-rpc-port | INTEGER | False | Set the port where the DataLayer is hosting the RPC interface. See rpc_port under data_layer in config.yaml | -| -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which wallet to use | -| -h | --help | None | False | Show a help message and exit | +| -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which wallet to use | +| -h | --help | None | False | Show a help message and exit |
Example @@ -727,12 +727,12 @@ Usage: `chia data get_root_history [OPTIONS]` Options: -| Short Command | Long Command | Type | Required | Description | -| :------------ | :-------------- | :------ | :------- | :---------------------------------------------------------------------------------------------------------- | -| -store | --id | TEXT | True | The hexadecimal store id | +| Short Command | Long Command | Type | Required | Description | +|:------------- |:--------------- |:------- |:-------- |:------------------------------------------------------------------------------------------------------------- | +| -store | --id | TEXT | True | The hexadecimal store id | | -dp | --data-rpc-port | INTEGER | False | Set the port where the DataLayer is hosting the RPC interface. See rpc_port under data_layer in config.yaml | -| -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which wallet to use | -| -h | --help | None | False | Show a help message and exit | +| -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which wallet to use | +| -h | --help | None | False | Show a help message and exit |
Example @@ -788,11 +788,11 @@ Usage: `chia data get_subscriptions [OPTIONS]` Options: -| Short Command | Long Command | Type | Required | Description | -| :------------ | :-------------- | :------ | :------- | :---------------------------------------------------------------------------------------------------------- | +| Short Command | Long Command | Type | Required | Description | +|:------------- |:--------------- |:------- |:-------- |:------------------------------------------------------------------------------------------------------------- | | -dp | --data-rpc-port | INTEGER | False | Set the port where the DataLayer is hosting the RPC interface. See rpc_port under data_layer in config.yaml | -| -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which wallet to use | -| -h | --help | None | False | Show a help message and exit | +| -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which wallet to use | +| -h | --help | None | False | Show a help message and exit |
Example @@ -830,12 +830,12 @@ Usage: `chia data get_sync_status [OPTIONS]` Options: -| Short Command | Long Command | Type | Required | Description | -| :------------ | :-------------- | :------ | :------- | :---------------------------------------------------------------------------------------------------------- | -| -store | --id | TEXT | True | The hexadecimal store id | +| Short Command | Long Command | Type | Required | Description | +|:------------- |:--------------- |:------- |:-------- |:------------------------------------------------------------------------------------------------------------- | +| -store | --id | TEXT | True | The hexadecimal store id | | -dp | --data-rpc-port | INTEGER | False | Set the port where the DataLayer is hosting the RPC interface. See rpc_port under data_layer in config.yaml | -| -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which wallet to use | -| -h | --help | None | False | Show a help message and exit | +| -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which wallet to use | +| -h | --help | None | False | Show a help message and exit | If the `root_hash` matches the `target_root_hash`, then the store is synced. @@ -872,14 +872,14 @@ Usage: `chia data get_value [OPTIONS]` Options: -| Short Command | Long Command | Type | Required | Description | -| :------------ | :-------------- | :------ | :------- | :---------------------------------------------------------------------------------------------------------- | -| -store | --id | TEXT | True | The hexadecimal store id | -| -k | --key | TEXT | True | The hexadecimal key | -| -r | --root_hash | TEXT | False | The hexadecimal root hash | +| Short Command | Long Command | Type | Required | Description | +|:------------- |:--------------- |:------- |:-------- |:------------------------------------------------------------------------------------------------------------- | +| -store | --id | TEXT | True | The hexadecimal store id | +| -k | --key | TEXT | True | The hexadecimal key | +| -r | --root_hash | TEXT | False | The hexadecimal root hash | | -dp | --data-rpc-port | INTEGER | False | Set the port where the DataLayer is hosting the RPC interface. See rpc_port under data_layer in config.yaml | -| -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which wallet to use | -| | --help | None | False | Show a help message and exit | +| -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which wallet to use | +| | --help | None | False | Show a help message and exit |
Example @@ -912,7 +912,7 @@ Commands: `check` (Calls the plugin_info endpoint on all configured plugins) Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :--- | :------- | :--------------------------- | +|:------------- |:------------ |:---- |:-------- |:---------------------------- | | -h | --help | None | False | Show a help message and exit | Note that currently `check` is the only sub-command under the `plugins` command. This command is shown in the example. @@ -949,7 +949,7 @@ Usage: `chia data remove_subscription [OPTIONS]` Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :-------------- | :------ | :------- | :------------------------------------------------------------------------------------------------------ | +|:------------- |:--------------- |:------- |:-------- |:------------------------------------------------------------------------------------------------------- | | -store | --id | TEXT | True | The hexadecimal ID of the store to which you would like to subscribe | | -u | --url | TEXT | False | A URL where the data store resides. This argument can be used multiple times in the same command | | -dp | --data-rpc-port | INTEGER | False | Set the port where the DataLayer is hosting the RPC interface. See rpc_port under wallet in config.yaml | @@ -982,7 +982,7 @@ Usage: `chia data subscribe [OPTIONS]` Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :-------------- | :------ | :------- | :------------------------------------------------------------------------------------------------------ | +|:------------- |:--------------- |:------- |:-------- |:------------------------------------------------------------------------------------------------------- | | -store | --id | TEXT | True | The hexadecimal ID of the store to which you would like to subscribe | | -u | --url | TEXT | False | A URL where the data store resides. This argument can be used multiple times in the same command | | -dp | --data-rpc-port | INTEGER | False | Set the port where the DataLayer is hosting the RPC interface. See rpc_port under wallet in config.yaml | @@ -1070,7 +1070,7 @@ Usage: `chia data unsubscribe [OPTIONS]` Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :-------------- | :------ | :------- | :------------------------------------------------------------------------------------------------------ | +|:------------- |:--------------- |:------- |:-------- |:------------------------------------------------------------------------------------------------------- | | -store | --id | TEXT | True | The hexadecimal ID of the store to which you would like to unsubscribe | | -dp | --data-rpc-port | INTEGER | False | Set the port where the DataLayer is hosting the RPC interface. See rpc_port under wallet in config.yaml | | -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which wallet to use | @@ -1115,7 +1115,7 @@ Usage: `chia data update_data_store [OPTIONS]` Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :-------------- | :------ | :------- | :------------------------------------------------------------------------------------------------------ | +|:------------- |:--------------- |:------- |:-------- |:------------------------------------------------------------------------------------------------------- | | -store | --id | TEXT | True | The hexadecimal store ID | | -d | --changelist | TEXT | True | A JSON object representing the changelist | | -dp | --data-rpc-port | INTEGER | False | Set the port where the DataLayer is hosting the RPC interface. See rpc_port under wallet in config.yaml | @@ -1316,7 +1316,7 @@ Usage: `chia data verify_proof [OPTIONS]` Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :-------------- | :------ | :------- | :------------------------------------------------------------------------------------------------------ | +|:------------- |:--------------- |:------- |:-------- |:------------------------------------------------------------------------------------------------------- | | -p | --proof | TEXT | True | Proof to validate in JSON format | | -dp | --data-rpc-port | INTEGER | False | Set the port where the DataLayer is hosting the RPC interface. See rpc_port under wallet in config.yaml | | -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which wallet to use | @@ -1383,7 +1383,7 @@ Usage: `chia data wallet_log_in [OPTIONS]` Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :-------------- | :------ | :------- | :------------------------------------------------------------------------------------------------------ | +|:------------- |:--------------- |:------- |:-------- |:------------------------------------------------------------------------------------------------------- | | -dp | --data-rpc-port | INTEGER | False | Set the port where the DataLayer is hosting the RPC interface. See rpc_port under wallet in config.yaml | | -f | --fingerprint | INTEGER | True | Fingerprint of the wallet to use | | -h | --help | None | False | Show a help message and exit | diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cli-reference/dids.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cli-reference/dids.md index 352b5c260c..438376e431 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cli-reference/dids.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cli-reference/dids.md @@ -20,7 +20,7 @@ Usage: chia wallet did create [OPTIONS] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :---------------- | :------ | :------- | :------------------------------------------------------------------------------------------------------- | +|:------------- |:----------------- |:------- |:-------- |:-------------------------------------------------------------------------------------------------------- | | -wp | --wallet-rpc-port | INTEGER | False | Set the port where the Wallet is hosting the RPC interface. See the rpc_port under wallet in config.yaml | | -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which wallet to use | | -n | --name | TEXT | False | Set the DID wallet name [default: None] | @@ -85,15 +85,15 @@ Usage: chia wallet did find_lost [OPTIONS] Options: -| Short Command | Long Command | Type | Required | Description | -| :------------ | :------------------- | :------ | :------- | :---------------------------------------------------------------------------------------------------------------------------------- | -| -wp | --wallet-rpc-port | INTEGER | False | Set the port where the Wallet is hosting the RPC interface. See the rpc_port under wallet in config.yaml | -| -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which key to use | -| -id | --coin_id | TEXT | True | The DID ID, launcher ID, or latest coin ID of the DID you want to recover. The most time-efficient of these is the latest coin ID | -| -m | --metadata | TEXT | False | The new whole metadata in json format | +| Short Command | Long Command | Type | Required | Description | +|:------------- |:---------------------- |:------- |:-------- |:----------------------------------------------------------------------------------------------------------------------------------- | +| -wp | --wallet-rpc-port | INTEGER | False | Set the port where the Wallet is hosting the RPC interface. See the rpc_port under wallet in config.yaml | +| -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which key to use | +| -id | --coin_id | TEXT | True | The DID ID, launcher ID, or latest coin ID of the DID you want to recover. The most time-efficient of these is the latest coin ID | +| -m | --metadata | TEXT | False | The new whole metadata in json format | | -r | --recovery_list_hash | TEXT | False | Override the recovery list hash of the DID. Only set this if your last DID spend updated the recovery list | -| -n | --num_verification | INTEGER | False | Override the required verification number of the DID. Only set this if your last DID spend updated the required verification number | -| -h | --help | None | False | Show a help message and exit. | +| -n | --num_verification | INTEGER | False | Override the required verification number of the DID. Only set this if your last DID spend updated the required verification number | +| -h | --help | None | False | Show a help message and exit. |
Example @@ -123,7 +123,7 @@ Usage: chia wallet did get_details [OPTIONS] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :---------------- | :------ | :------- | :------------------------------------------------------------------------------------------------------------------------------------------------------- | +|:------------- |:----------------- |:------- |:-------- |:-------------------------------------------------------------------------------------------------------------------------------------------------------- | | -wp | --wallet-rpc-port | INTEGER | False | Set the port where the Wallet is hosting the RPC interface. See the rpc_port under wallet in config.yaml | | -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which key to use | | -id | --coin_id | TEXT | True | The DID ID, launcher ID, or latest coin ID of the DID you want to recover. The most time-efficient of these is the latest coin ID | @@ -170,7 +170,7 @@ Usage: chia wallet did get_did [OPTIONS] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :---------------- | :------ | :------- | :------------------------------------------------------------------------------------------------------- | +|:------------- |:----------------- |:------- |:-------- |:-------------------------------------------------------------------------------------------------------- | | -wp | --wallet-rpc-port | INTEGER | False | Set the port where the Wallet is hosting the RPC interface. See the rpc_port under wallet in config.yaml | | -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which wallet to use | | -i | --id | INTEGER | True | ID of the wallet to use | @@ -205,7 +205,7 @@ Usage: chia wallet did message_spend [OPTIONS] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :--------------------- | :------ | :------- | :------------------------------------------------------------------------------------------------------- | +|:------------- |:---------------------- |:------- |:-------- |:-------------------------------------------------------------------------------------------------------- | | -wp | --wallet-rpc-port | INTEGER | False | Set the port where the Wallet is hosting the RPC interface. See the rpc_port under wallet in config.yaml | | -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which wallet to use | | -i | --id | INTEGER | True | ID of the wallet to use | @@ -254,7 +254,7 @@ Usage: chia wallet did get_did [OPTIONS] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :---------------- | :------ | :------- | :------------------------------------------------------------------------------------------------------- | +|:------------- |:----------------- |:------- |:-------- |:-------------------------------------------------------------------------------------------------------- | | -wp | --wallet-rpc-port | INTEGER | False | Set the port where the Wallet is hosting the RPC interface. See the rpc_port under wallet in config.yaml | | -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which wallet to use | | -i | --id | INTEGER | True | ID of the wallet to use | @@ -323,7 +323,7 @@ Usage: chia wallet did sign_message [OPTIONS] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :---------------- | :------ | :------- | :------------------------------------------------------------------------------------------------------- | +|:------------- |:----------------- |:------- |:-------- |:-------------------------------------------------------------------------------------------------------- | | -wp | --wallet-rpc-port | INTEGER | False | Set the port where the Wallet is hosting the RPC interface. See the rpc_port under wallet in config.yaml | | -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which wallet to use | | -i | --did_id | TEXT | True | DID ID you want to use for signing | @@ -358,7 +358,7 @@ Usage: chia wallet did transfer [OPTIONS] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :---------------- | :------ | :------- | :------------------------------------------------------------------------------------------------------- | +|:------------- |:----------------- |:------- |:-------- |:-------------------------------------------------------------------------------------------------------- | | -wp | --wallet-rpc-port | INTEGER | False | Set the port where the Wallet is hosting the RPC interface. See the rpc_port under wallet in config.yaml | | -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which wallet to use | | -i | --id | INTEGER | True | ID of the DID wallet to transfer | @@ -435,7 +435,7 @@ Usage: chia wallet did update_metadata [OPTIONS] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :---------------- | :------ | :------- | :------------------------------------------------------------------------------------------------------- | +|:------------- |:----------------- |:------- |:-------- |:-------------------------------------------------------------------------------------------------------- | | -wp | --wallet-rpc-port | INTEGER | False | Set the port where the Wallet is hosting the RPC interface. See the rpc_port under wallet in config.yaml | | -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which wallet to use | | -i | --id | INTEGER | True | ID of the DID wallet to use | diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cli-reference/nfts.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cli-reference/nfts.md index 9e659d3a53..26f3a28f4f 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cli-reference/nfts.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cli-reference/nfts.md @@ -18,7 +18,7 @@ Usage: chia wallet nft create [OPTIONS] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :---------------- | :------ | :------- | :------------------------------------------------------------------------------------------------------- | +|:------------- |:----------------- |:------- |:-------- |:-------------------------------------------------------------------------------------------------------- | | -wp | --wallet-rpc-port | INTEGER | False | Set the port where the Wallet is hosting the RPC interface. See the rpc_port under wallet in config.yaml | | -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which wallet to use | | -di | --did-id | TEXT | False | DID Id to use | @@ -113,7 +113,7 @@ Usage: chia wallet nft mint [OPTIONS] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :---------------------------- | :------ | :------- | :------------------------------------------------------------------------------------------------------- | +|:------------- |:----------------------------- |:------- |:-------- |:-------------------------------------------------------------------------------------------------------- | | -wp | --wallet-rpc-port | INTEGER | False | Set the port where the Wallet is hosting the RPC interface. See the rpc_port under wallet in config.yaml | | -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which wallet to use | | -i | --id | INTEGER | True | Id of the NFT wallet to use | @@ -309,7 +309,7 @@ Usage: chia wallet nft set_did [OPTIONS] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :---------------- | :------ | :------- | :------------------------------------------------------------------------------------------------------- | +|:------------- |:----------------- |:------- |:-------- |:-------------------------------------------------------------------------------------------------------- | | -wp | --wallet-rpc-port | INTEGER | False | Set the port where the Wallet is hosting the RPC interface. See the rpc_port under wallet in config.yaml | | -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which wallet to use | | -i | --id | INTEGER | True | Id of the NFT wallet to use | @@ -346,7 +346,7 @@ Usage: chia wallet nft sign_message [OPTIONS] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :---------------- | :------ | :------- | :------------------------------------------------------------------------------------------------------- | +|:------------- |:----------------- |:------- |:-------- |:-------------------------------------------------------------------------------------------------------- | | -wp | --wallet-rpc-port | INTEGER | False | Set the port where the Wallet is hosting the RPC interface. See the rpc_port under wallet in config.yaml | | -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which wallet to use | | -i | --nft_id | TEXT | True | NFT ID you want to use for signing | @@ -478,7 +478,7 @@ Usage: chia wallet nft list [OPTIONS] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :---------------- | :------ | :------- | :------------------------------------------------------------------------------------------------------- | +|:------------- |:----------------- |:------- |:-------- |:-------------------------------------------------------------------------------------------------------- | | -wp | --wallet-rpc-port | INTEGER | False | Set the port where the Wallet is hosting the RPC interface. See the rpc_port under wallet in config.yaml | | -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which wallet to use | | -i | --id | INTEGER | True | Id of the NFT wallet to use | @@ -577,7 +577,7 @@ Usage: chia wallet nft get_info [OPTIONS] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :---------------- | :------ | :------- | :------------------------------------------------------------------------------------------------------- | +|:------------- |:----------------- |:------- |:-------- |:-------------------------------------------------------------------------------------------------------- | | -wp | --wallet-rpc-port | INTEGER | False | Set the port where the Wallet is hosting the RPC interface. See the rpc_port under wallet in config.yaml | | -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which wallet to use | | -ni | --nft-coin-id | TEXT | True | Id of the NFT coin for which to show info | @@ -634,7 +634,7 @@ Usage: chia wallet nft transfer [OPTIONS] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :---------------- | :------ | :------- | :------------------------------------------------------------------------------------------------------- | +|:------------- |:----------------- |:------- |:-------- |:-------------------------------------------------------------------------------------------------------- | | -wp | --wallet-rpc-port | INTEGER | False | Set the port where the Wallet is hosting the RPC interface. See the rpc_port under wallet in config.yaml | | -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which wallet to use | | -i | --id | INTEGER | True | Id of the NFT wallet to use | @@ -712,7 +712,7 @@ Usage: chia wallet nft add_uri [OPTIONS] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :---------------- | :------ | :-------------- | :------------------------------------------------------------------------------------------------------- | +|:------------- |:----------------- |:------- |:--------------- |:-------------------------------------------------------------------------------------------------------- | | -wp | --wallet-rpc-port | INTEGER | False | Set the port where the Wallet is hosting the RPC interface. See the rpc_port under wallet in config.yaml | | -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which wallet to use | | -i | --id | INTEGER | True | Id of the NFT wallet to use | @@ -779,7 +779,7 @@ Usage: chia wallet nft set_did [OPTIONS] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :---------------- | :------ | :------- | :------------------------------------------------------------------------------------------------------- | +|:------------- |:----------------- |:------- |:-------- |:-------------------------------------------------------------------------------------------------------- | | -wp | --wallet-rpc-port | INTEGER | False | Set the port where the Wallet is hosting the RPC interface. See the rpc_port under wallet in config.yaml | | -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which wallet to use | | -i | --id | INTEGER | True | Id of the NFT wallet to use | diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cli-reference/offers.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cli-reference/offers.md index f64afda0cd..d341a80236 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cli-reference/offers.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cli-reference/offers.md @@ -37,7 +37,7 @@ Usage: `chia wallet make_offer [OPTIONS]` Options: | Short Command | Long Command | Type | Required | Description | -| :-----------: | :---------------: | :-----: | :------: | :------------------------------------------------------------------------------------------------------- | +|:-------------:|:-----------------:|:-------:|:--------:|:-------------------------------------------------------------------------------------------------------- | | -wp | --wallet-rpc-port | INTEGER | False | Set the port where the Wallet is hosting the RPC interface. See the rpc_port under wallet in config.yaml | | -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which wallet to use | | -o | --offer | TEXT | True | A wallet id to offer and the amount to offer (formatted like wallet_id:amount) | @@ -46,6 +46,8 @@ Options: | -m | --fee | TEXT | False | A fee to add to the offer when it gets taken | | | --reuse | None | False | Set this flag to reuse an existing address for the offer [Default: generate a new address] | | | --override | None | False | Creates offer without checking for unusual values | +| | --valid-at | INTEGER | False | UNIX timestamp at which the associated transactions become valid | +| | --expires-at | INTEGER | False | UNIX timestamp at which the associated transactions expire | | -h | --help | None | False | Show a help message and exit | --- @@ -59,7 +61,7 @@ Usage: `chia wallet take_offer [OPTIONS] PATH_OR_HEX` Options: | Short Command | Long Command | Type | Required | Description | -| :-----------: | :---------------: | :-----: | :------: | :------------------------------------------------------------------------------------------------------- | +|:-------------:|:-----------------:|:-------:|:--------:|:-------------------------------------------------------------------------------------------------------- | | -wp | --wallet-rpc-port | INTEGER | False | Set the port where the Wallet is hosting the RPC interface. See the rpc_port under wallet in config.yaml | | -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which wallet to use | | -e | --examine-only | None | False | Print the summary of the offer file but do not take it | @@ -78,7 +80,7 @@ Usage: `chia wallet cancel_offer [OPTIONS]` Options: | Short Command | Long Command | Type | Required | Description | -| :-----------: | :---------------: | :-----: | :------: | :----------------------------------------------------------------------------------------------------------------------- | +|:-------------:|:-----------------:|:-------:|:--------:|:------------------------------------------------------------------------------------------------------------------------ | | -wp | --wallet-rpc-port | INTEGER | False | Set the port where the Wallet is hosting the RPC interface. See the rpc_port under wallet in config.yaml | | -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which wallet to use | | -id | --id | TEXT | True | The offer ID that you wish to cancel | @@ -97,7 +99,7 @@ Usage: `chia wallet get_offers [OPTIONS]` Options: | Short Command | Long Command | Type | Required | Description | -| :-----------: | :--------------------: | :-----: | :------: | :------------------------------------------------------------------------------------------------------- | +|:-------------:|:----------------------:|:-------:|:--------:|:-------------------------------------------------------------------------------------------------------- | | -wp | --wallet-rpc-port | INTEGER | False | Set the port where the Wallet is hosting the RPC interface. See the rpc_port under wallet in config.yaml | | -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which wallet to use | | -id | --id | TEXT | False | The ID of the offer that you wish to examine | diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cli-reference/plotters.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cli-reference/plotters.md index 2c82ccf3c2..d50c1a8bf0 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cli-reference/plotters.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cli-reference/plotters.md @@ -19,28 +19,28 @@ Usage: chia plotters chiapos [OPTIONS] Options: -| Short Command | Long Command | Type | Required | Description | -| :------------ | :------------------ | :------ | :------- | :---------------------------------------------------------------------------------------- | -| -t | --tmp_dir | TEXT | True | Temporary directory 1 (where most of the plots temp data will be stored) | -| -2 | --tmp_dir2 | TEXT | False | Temporary directory 2 [Default: same as `tmp_dir`] | -| -k | --size | INTEGER | False | K value [Default: 32] | -| -m | --memo | TEXT | False | Memo variable | -| -i | --id | TEXT | False | Plot ID [Default: generate a random ID] | -| -b | --buffer | INTEGER | False | Size of the buffer, in MB [Default: 4608] | -| -u | --buckets | INTEGER | False | Number of buckets [Default: 64] | -| -s | --stripes | INTEGER | False | Stripe size [Default: 65536] | -| -r | --threads | INTEGER | False | Num threads [Default: 2] | -| -e | --nobitfield | None | False | Disable bitfield [Default: bitfield is enabled] | -| | --override-k | None | False | Force size smaller than 32 (only needed where `-k` is less than 32 [Default: disabled] | -| -a | --alt_fingerprint | INTEGER | False | Enter the alternative fingerprint of the key you want to use | -| -c | --contract | TEXT | False | Pool Contract Address (64 chars) [Default: none] | -| -f | --farmerkey | TEXT | False | Farmer Public Key (48 bytes) [Default: use the key from the current wallet] | -| -p | --pool-key | TEXT | False | Pool Public Key (48 bytes) [Default: use the key from the current wallet (self-pooling)] | -| -n | --count | INTEGER | False | Number of plots to create [Default: 1] | +| Short Command | Long Command | Type | Required | Description | +|:------------- |:--------------------- |:------- |:-------- |:----------------------------------------------------------------------------------------- | +| -t | --tmp_dir | TEXT | True | Temporary directory 1 (where most of the plots temp data will be stored) | +| -2 | --tmp_dir2 | TEXT | False | Temporary directory 2 [Default: same as `tmp_dir`] | +| -k | --size | INTEGER | False | K value [Default: 32] | +| -m | --memo | TEXT | False | Memo variable | +| -i | --id | TEXT | False | Plot ID [Default: generate a random ID] | +| -b | --buffer | INTEGER | False | Size of the buffer, in MB [Default: 4608] | +| -u | --buckets | INTEGER | False | Number of buckets [Default: 64] | +| -s | --stripes | INTEGER | False | Stripe size [Default: 65536] | +| -r | --threads | INTEGER | False | Num threads [Default: 2] | +| -e | --nobitfield | None | False | Disable bitfield [Default: bitfield is enabled] | +| | --override-k | None | False | Force size smaller than 32 (only needed where `-k` is less than 32 [Default: disabled] | +| -a | --alt_fingerprint | INTEGER | False | Enter the alternative fingerprint of the key you want to use | +| -c | --contract | TEXT | False | Pool Contract Address (64 chars) [Default: none] | +| -f | --farmerkey | TEXT | False | Farmer Public Key (48 bytes) [Default: use the key from the current wallet] | +| -p | --pool-key | TEXT | False | Pool Public Key (48 bytes) [Default: use the key from the current wallet (self-pooling)] | +| -n | --count | INTEGER | False | Number of plots to create [Default: 1] | | -x | --exclude_final_dir | None | False | Skips adding [final dir] to harvester for farming [Default: copy to final dir is enabled] | -| -d | --final_dir | TEXT | True | Final directory after plot has been created | -| | --compress | INTEGER | False | Compression level [Default: 0 (not compressed)] | -| -h | --help | None | False | Show a help message and exit | +| -d | --final_dir | TEXT | True | Final directory after plot has been created | +| | --compress | INTEGER | False | Compression level [Default: 0 (not compressed)] | +| -h | --help | None | False | Show a help message and exit | ### `madmax` @@ -51,7 +51,7 @@ Usage: chia plotters madmax [OPTIONS] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :------------ | :------ | :------- | :--------------------------------------------------------------------------------------- | +|:------------- |:------------- |:------- |:-------- |:---------------------------------------------------------------------------------------- | | -k | --size | INTEGER | False | K value [Default: 32] | | -n | --count | INTEGER | False | Number of plots to create [Default: 1] | | -r | --threads | INTEGER | False | Num threads [Default: 4] | @@ -84,26 +84,26 @@ Usage: chia plotters bladebit cudaplot [OPTIONS] Options: -| Short Command | Long Command | Type | Required | Description | -| :------------ | :---------------- | :------ | :------- | :------------------------------------------------------------------------------------------------------------- | -| -r | --threads | INTEGER | False | Num threads [Default: 12] | -| -n | --count | INTEGER | False | Number of plots to create [Default: 1] | -| -f | --farmerkey | TEXT | False | Farmer Public Key (48 bytes) [Default: use the key from the current wallet] | -| -p | --pool-key | TEXT | False | Pool Public Key (48 bytes) [Default: use the key from the current wallet (self-pooling)] | -| -c | --contract | TEXT | False | Pool Contract Address (64 chars) [Default: none] | -| -t | --tmp_dir | TEXT | False | Temporary directory 1 (where most of the plot's temp data will be stored) [Default: in memory] | -| -2 | --tmp_dir2 | TEXT | False | Temporary directory 2 [Default: same as `tmp_dir`] | -| -i | --id | TEXT | False | Plot ID [Default: generate a random ID] | -| -w | --warmstart | None | False | Set to enable warm start [Default: disabled] | -| | --nonuma | None | False | Set to disable numa [Default: enabled] | -| | --no-cpu-affinity | None | False | Set to disable assigning automatic thread affinity [Default: enabled] | -| -v | --verbose | None | False | Set to enable verbose output [Default: disabled] | -| -d | --final_dir | TEXT | True | Final directory after plot has been created | -| | --compress | INTEGER | False | Compression level, 0-9 are accepted [Default: 1] | -| | --device | INTEGER | False | The CUDA device index (typically 0 or 1), set if more than one GPU is installed [Default: 0] | -| | --disk-128 | None | False | Enable hybrid disk plotting, requires 128 GB of system RAM [Default: disabled] | -| | --disk-16\* | None | False | Enable hybrid disk plotting, requires at least 16 GB of system RAM [Default: disabled] **\*SEE WARNING BELOW** | -| -h | --help | None | False | Show a help message and exit | +| Short Command | Long Command | Type | Required | Description | +|:------------- |:----------------- |:------- |:-------- |:---------------------------------------------------------------------------------------------------------------- | +| -r | --threads | INTEGER | False | Num threads [Default: 12] | +| -n | --count | INTEGER | False | Number of plots to create [Default: 1] | +| -f | --farmerkey | TEXT | False | Farmer Public Key (48 bytes) [Default: use the key from the current wallet] | +| -p | --pool-key | TEXT | False | Pool Public Key (48 bytes) [Default: use the key from the current wallet (self-pooling)] | +| -c | --contract | TEXT | False | Pool Contract Address (64 chars) [Default: none] | +| -t | --tmp_dir | TEXT | False | Temporary directory 1 (where most of the plot's temp data will be stored) [Default: in memory] | +| -2 | --tmp_dir2 | TEXT | False | Temporary directory 2 [Default: same as `tmp_dir`] | +| -i | --id | TEXT | False | Plot ID [Default: generate a random ID] | +| -w | --warmstart | None | False | Set to enable warm start [Default: disabled] | +| | --nonuma | None | False | Set to disable numa [Default: enabled] | +| | --no-cpu-affinity | None | False | Set to disable assigning automatic thread affinity [Default: enabled] | +| -v | --verbose | None | False | Set to enable verbose output [Default: disabled] | +| -d | --final_dir | TEXT | True | Final directory after plot has been created | +| | --compress | INTEGER | False | Compression level, 0-9 are accepted [Default: 1] | +| | --device | INTEGER | False | The CUDA device index (typically 0 or 1), set if more than one GPU is installed [Default: 0] | +| | --disk-128 | None | False | Enable hybrid disk plotting, requires 128 GB of system RAM [Default: disabled] | +| | --disk-16\* | None | False | Enable hybrid disk plotting, requires at least 16 GB of system RAM [Default: disabled] **\*SEE WARNING BELOW** | +| -h | --help | None | False | Show a help message and exit | :::warning warning @@ -136,7 +136,7 @@ Usage: chia plotters bladebit ramplot [OPTIONS] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :---------------- | :------ | :------- | :--------------------------------------------------------------------------------------- | +|:------------- |:----------------- |:------- |:-------- |:---------------------------------------------------------------------------------------- | | -r | --threads | INTEGER | False | Num threads [Default: 12] | | -n | --count | INTEGER | False | Number of plots to create [Default: 1] | | -f | --farmerkey | TEXT | False | Farmer Public Key (48 bytes) [Default: use the key from the current wallet] | @@ -160,7 +160,7 @@ Usage: chia plotters bladebit diskplot [OPTIONS] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :---------------- | :------ | :------- | :-------------------------------------------------------------------------------------------------- | +|:------------- |:----------------- |:------- |:-------- |:--------------------------------------------------------------------------------------------------- | | -r | --threads | INTEGER | False | Num threads [Default: 12] | | -n | --count | INTEGER | False | Number of plots to create [Default: 1] | | -f | --farmerkey | TEXT | False | Farmer Public Key (48 bytes) [Default: use the key from the current wallet] | @@ -197,7 +197,7 @@ Usage: bladebit simulate [OPTIONS] \ Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :--------- | :------- | :------------------------------------------------------------------------------------------------------------------- | +|:------------- |:------------ |:---------- |:-------- |:-------------------------------------------------------------------------------------------------------------------- | | -n | --iterations | INTEGER | False | The number of iterations to run [Default: 100] | | -p | --parallel | INTEGER | False | The number of instances to run in parallel [Default: 1] | | -l | --lookup | FLOAT | False | Maximum allowed time per proof lookup, in seconds [Default: 8.00] | @@ -226,14 +226,14 @@ Usage: drplotter plot [OPTIONS] Options: -| Short Command | Long Command | Type | Required | Description | -| :------------ | :----------------- | :------ | :------- | :------------------------------------------------------------------------------------------------------------ | -| -h | --help | None | False | Show a help message and exit | -| -f | --farmerkey | TEXT | True | Farmer Public Key (48 bytes, hex encoded) | -| -c | --contractkey | TEXT | True | Pool Contract Address (64 chars, hex encoded) | -| -d | --outputDirectory | TEXT | True | Final directory after plot has been created | -| | --compression | TEXT | False | Set compression mode. Choose between eco3x (68 bits per proof), or pro4x (49 bits per proof) [Default: eco3x] | -| -i | --gpu_id | INTEGER | False | GPU ID to use [Default: 0] | +| Short Command | Long Command | Type | Required | Description | +|:------------- |:-------------------- |:------- |:-------- |:------------------------------------------------------------------------------------------------------------- | +| -h | --help | None | False | Show a help message and exit | +| -f | --farmerkey | TEXT | True | Farmer Public Key (48 bytes, hex encoded) | +| -c | --contractkey | TEXT | True | Pool Contract Address (64 chars, hex encoded) | +| -d | --outputDirectory | TEXT | True | Final directory after plot has been created | +| | --compression | TEXT | False | Set compression mode. Choose between eco3x (68 bits per proof), or pro4x (49 bits per proof) [Default: eco3x] | +| -i | --gpu_id | INTEGER | False | GPU ID to use [Default: 0] | | -n | --n_to_plot | INTEGER | False | Number of plots to create [Default: 0, fills directory] | | -L | --gpu_memory_limit | INTEGER | False | GPU memory limit in MB [Default: 0 (disabled)] | | | --min_gpu_ram | None | False | Use min gpu ram | @@ -247,7 +247,7 @@ Usage: drplotter verify [OPTIONS] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :--- | :------- | :--------------------------- | +|:------------- |:------------ |:---- |:-------- |:---------------------------- | | -h | --help | None | False | Show a help message and exit | | -f | --file | TEXT | False | File to read from | | -d | --directory | TEXT | False | Check all files in directory | @@ -263,7 +263,7 @@ Usage: drsolver [OPTIONS] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :--------------- | :------ | :------- | :--------------------------------------------------- | +|:------------- |:---------------- |:------- |:-------- |:---------------------------------------------------- | | -h | --help | None | False | Show a help message and exit | | -g | --gpu | INTEGER | True | GPU ID to use for solving | | -v | --verbose | None | False | Verbose output | @@ -283,7 +283,7 @@ Usage: drserver [OPTIONS] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------ | :------- | :--------------------------- | +|:------------- |:------------ |:------- |:-------- |:---------------------------- | | -h | --help | None | False | Show a help message and exit | | -p | --port | INTEGER | True | Server port | | -t | --token | TEXT | True | Server token | diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cli-reference/simulator.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cli-reference/simulator.md index 21dfff1d95..9347dc37b0 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cli-reference/simulator.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cli-reference/simulator.md @@ -31,7 +31,7 @@ Usage: `chia dev sim create [OPTIONS]` Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :--------------- | :------ | :------- | :---------------------------------------------------------------------------- | +|:------------- |:---------------- |:------- |:-------- |:----------------------------------------------------------------------------- | | -f | --fingerprint | INTEGER | False | Use your fingerprint to skip the key prompt | | -r | --reward_address | TEXT | False | Use this address instead of the default farming address | | -p | --plot-directory | TEXT | False | Set the directory in which to create/store plots (Default: 'simulator/plots') | @@ -305,7 +305,7 @@ Usage: `chia dev sim autofarm [OPTIONS] [on|off]` Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :--- | :------- | :--------------------------- | +|:------------- |:------------ |:---- |:-------- |:---------------------------- | | -h | --help | None | False | Show a help message and exit | Auto farming is enabled by default. The examples will show you how to disable/enable it. @@ -355,7 +355,7 @@ Usage: `chia dev sim farm [OPTIONS]` Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :---------------- | :------ | :------- | :----------------------------------------------------------------------- | +|:------------- |:----------------- |:------- |:-------- |:------------------------------------------------------------------------ | | -b | --blocks | INTEGER | False | Number of blocks to create (Default: 1) | | -n | --non-transaction | None | False | Enable to allow non-transaction blocks (Default: disabled) | | -a | --target-address | TEXT | False | Block reward address. If not specified, the default address will be used | @@ -490,7 +490,7 @@ Usage: `chia dev sim revert [OPTIONS]` Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :--------------- | :------ | :------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +|:------------- |:---------------- |:------- |:-------- |:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | -b | --blocks | INTEGER | False | Number of blocks to go back (Default: 1) | | -n | --new_blocks | INTEGER | False | Number of new blocks to add during a reorg (Default: 1) | | -r | --reset | None | False | Enable to revert all transactions to the genesis block (Default: disabled) | @@ -563,7 +563,7 @@ Usage: `chia dev sim start [OPTIONS]` Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :--- | :------- | :----------------------------------------------------- | +|:------------- |:------------ |:---- |:-------- |:------------------------------------------------------ | | -r | --restart | None | False | Enable to restart running services (Default: disabled) | | -w | --wallet | None | False | Enable to start wallet (Default: disabled) | | -h | --help | None | False | Show a help message and exit | @@ -619,7 +619,7 @@ Usage: `chia dev sim status [OPTIONS]` Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :---------------- | :------ | :------- | :--------------------------------------------------------------------------------------------------------------------------------------- | +|:------------- |:----------------- |:------- |:-------- |:---------------------------------------------------------------------------------------------------------------------------------------- | | -f | --fingerprint | INTEGER | False | Get detailed information on this fingerprint. | | -k | --show_key | None | False | Enable to show detailed key information, including seed phrase (Default: disabled) | | -c | --show_coins | None | False | Enable to show all unspent coins (Default: disabled). When enabled, this does not show reward coins unless used in conjunction with `-i` | @@ -841,7 +841,7 @@ Usage: `chia dev sim stop [OPTIONS]` Options: Stop running services | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :--- | :------- | :-------------------------------------------- | +|:------------- |:------------ |:---- |:-------- |:--------------------------------------------- | | -d | --daemon | None | False | Enable to stop the daemon (Default: disabled) | | -w | --wallet | None | False | Enable to stop the wallet (Default: disabled) | | -h | --help | None | False | Show a help message and exit | diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cli-reference/vcs.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cli-reference/vcs.md index 7b070d0932..c7bf6b6d11 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cli-reference/vcs.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cli-reference/vcs.md @@ -20,10 +20,10 @@ Usage: chia wallet vcs add_proof_reveal [OPTIONS] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :---------------- | :------ | :------- | :---------------------------------------------------------------------------------------------------------------------- | +|:------------- |:----------------- |:------- |:-------- |:----------------------------------------------------------------------------------------------------------------------- | | -wp | --wallet-rpc-port | INTEGER | False | Set the port where the Wallet is hosting the RPC interface. See the rpc_port under wallet in config.yaml | | -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which key to use | -| -p | --proof | TEXT | True\* | A flag to add as a proof | +| -p | --proof | TEXT | True\* | A flag to add as a proof | | -r | --root-only | None | False | If this flag is set, do not add the proofs to the DB, just output the root from the specified proofs [Default: not set] | | -h | --help | None | False | Show a help message and exit | @@ -72,7 +72,7 @@ Usage: chia wallet vcs get [OPTIONS] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :---------------- | :------ | :------- | :------------------------------------------------------------------------------------------------------- | +|:------------- |:----------------- |:------- |:-------- |:-------------------------------------------------------------------------------------------------------- | | -wp | --wallet-rpc-port | INTEGER | False | Set the port where the Wallet is hosting the RPC interface. See the rpc_port under wallet in config.yaml | | -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which key to use | | -s | --start | INTEGER | False | The index to start the list at [default: 0] | @@ -109,7 +109,7 @@ Usage: chia wallet vcs get_proofs_for_root [OPTIONS] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :---------------- | :------ | :------- | :------------------------------------------------------------------------------------------------------- | +|:------------- |:----------------- |:------- |:-------- |:-------------------------------------------------------------------------------------------------------- | | -wp | --wallet-rpc-port | INTEGER | False | Set the port where the Wallet is hosting the RPC interface. See the rpc_port under wallet in config.yaml | | -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which key to use | | -r | --proof-hash | TEXT | True | The root to search for | @@ -146,14 +146,17 @@ Usage: chia wallet vcs mint [OPTIONS] Options: -| Short Command | Long Command | Type | Required | Description | -| :------------ | :---------------- | :------ | :------- | :---------------------------------------------------------------------------------------------------------- | -| -wp | --wallet-rpc-port | INTEGER | False | Set the port where the Wallet is hosting the RPC interface. See the rpc_port under wallet in config.yaml | -| -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which key to use as the issuing wallet | -| -d | --did | TEXT | True | The DID of the VC's proof provider. Must be owned by the issuing wallet Must be owned by the issuing wallet | -| -t | --target-address | TEXT | False | The address to send the VC to once it's minted [Default: send to minting wallet] | -| -m | --fee | TEXT | False | Blockchain fee for mint transaction, in XCH | -| -h | --help | None | False | Show a help message and exit | +| Short Command | Long Command | Type | Required | Description | +|:------------- |:------------------ |:------- |:-------- |:----------------------------------------------------------------------------------------------------------- | +| -wp | --wallet-rpc-port | INTEGER | False | Set the port where the Wallet is hosting the RPC interface. See the rpc_port under wallet in config.yaml | +| -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which key to use as the issuing wallet | +| -d | --did | TEXT | True | The DID of the VC's proof provider. Must be owned by the issuing wallet Must be owned by the issuing wallet | +| -t | --target-address | TEXT | False | The address to send the VC to once it's minted [Default: send to minting wallet] | +| -m | --fee | TEXT | False | Blockchain fee for mint transaction, in XCH | +| | --push | None | False | Push the transaction to the network [Default: True] | +| | --no-push | None | False | Do not push the transaction to the network [Default: False] | +| | --transaction-file | TEXT | False | A file to write relevant transactions to | +| -h | --help | None | False | Show a help message and exit |
Example @@ -223,14 +226,17 @@ Usage: chia wallet vcs revoke [OPTIONS] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :--------------------- | :------ | :------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +|:------------- |:---------------------- |:------- |:-------- |:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | -wp | --wallet-rpc-port | INTEGER | False | Set the port where the Wallet is hosting the RPC interface. See the rpc_port under wallet in config.yaml | | -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which key to use | -| -p | --parent-coin-id | TEXT | True\* | The ID of the parent coin of the VC (\*optional if VC ID is used) | -| -l | --vc-id TEXT | TEXT | True\* | The launcher ID of the VC to revoke (must be tracked by wallet) (\*optional if Parent ID is used) | +| -p | --parent-coin-id | TEXT | True\* | The ID of the parent coin of the VC (\*optional if VC ID is used) | +| -l | --vc-id TEXT | TEXT | True\* | The launcher ID of the VC to revoke (must be tracked by wallet) (\*optional if Parent ID is used) | | -m | --fee | TEXT | False | Blockchain fee for revocation transaction, in XCH | | | --reuse-puzhash | None | False | If this flag is set, then send the VC back to the same puzzle hash it came from (ignored if `--generate-new-puzhash` is also specified) [Default: generate new puzzle hash] | | | --generate-new-puzhash | None | False | If this flag is set, then send the VC to a new puzzle hash. This is the default behavior, and setting this flag will override the `--reuse-puzhash` flag if it is also set This is the default behavior, and setting this flag will override the `--reuse-puzhash` flag if it is also set | +| | --push | None | False | Push the transaction to the network [Default: True] | +| | --no-push | None | False | Do not push the transaction to the network [Default: False] | +| | --transaction-file | TEXT | False | A file to write relevant transactions to | | -h | --help | None | False | Show a help message and exit |
@@ -289,7 +295,7 @@ Usage: chia wallet vcs update_proofs [OPTIONS] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :--------------------- | :------ | :------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +|:------------- |:---------------------- |:------- |:-------- |:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | -wp | --wallet-rpc-port | INTEGER | False | Set the port where the Wallet is hosting the RPC interface. See the rpc_port under wallet in config.yaml | | -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which key to use | | -l | --vc-id | TEXT | True | The launcher ID of the VC whose proofs should be updated | @@ -298,6 +304,9 @@ Options: | -m | --fee | TEXT | False | Blockchain fee for update transaction, in XCH | | | --reuse-puzhash | None | False | If this flag is set, then send the VC back to the same puzzle hash it came from (ignored if `--generate-new-puzhash` is also specified) [Default: generate new puzzle hash] | | | --generate-new-puzhash | None | False | If this flag is set, then send the VC to a new puzzle hash. This is the default behavior, and setting this flag will override the `--reuse-puzhash` flag if it is also set This is the default behavior, and setting this flag will override the `--reuse-puzhash` flag if it is also set | +| | --push | None | False | Push the transaction to the network [Default: True] | +| | --no-push | None | False | Do not push the transaction to the network [Default: False] | +| | --transaction-file | TEXT | False | A file to write relevant transactions to | | -h | --help | None | False | Show a help message and exit |
diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cli-reference/wallet.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cli-reference/wallet.md index e0649ea275..bb45bf3bec 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cli-reference/wallet.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cli-reference/wallet.md @@ -24,7 +24,7 @@ Usage: chia wallet add_token [OPTIONS] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :---------------- | :------ | :------- | :----------------------------------------------------------------------------------------------------------- | +|:------------- |:----------------- |:------- |:-------- |:------------------------------------------------------------------------------------------------------------ | | -wp | --wallet-rpc-port | INTEGER | False | Set the port where the Wallet is hosting the RPC interface. See the `rpc_port` under `wallet` in config.yaml | | -id | --asset-id | TEXT | True | The Asset ID of the coin you wish to add/rename (the treehash of the TAIL program) | | -n | --token-name | TEXT | False | The name you wish to designate to the token | @@ -63,7 +63,7 @@ Usage: chia wallet coins list [OPTIONS] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------------- | :------ | :------- | :---------------------------------------------------------------------------------------------------------------- | +|:------------- |:------------------ |:------- |:-------- |:----------------------------------------------------------------------------------------------------------------- | | -p | --wallet-rpc-port | INTEGER | False | Set the port where the Wallet is hosting the RPC interface. See the `rpc_port` under `wallet` in config.yaml | | -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which wallet to use | | -i | --id | INTEGER | False | Id of the wallet to use [default: 1] | @@ -298,6 +298,75 @@ Coin ID: 0x1c51b470e3fc7f97e155fd72e464f2192426d35857d78777a2a9c08358252eeb
+
+Example 7: list a CAT + +First, list all assets in the wallet: + +```bash +chia wallet show +``` + +Response: + +```bash +Chia Wallet: + -Total Balance: 1.0 txch (1000000000000 mojo) + -Pending Total Balance: 1.0 txch (1000000000000 mojo) + -Spendable: 1.0 txch (1000000000000 mojo) + -Type: STANDARD_WALLET + -Wallet ID: 1 + +CAT 91bfdb4a750308c2...: + -Total Balance: 0.0 (0 mojo) + -Pending Total Balance: 0.0 (0 mojo) + -Spendable: 0.0 (0 mojo) + -Type: CAT + -Asset ID: 91bfdb4a750308c25b12d0f787309df590a4cad80e7466accdd99b1d1759d9e4 + -Wallet ID: 2 + +CAT for Chris: + -Total Balance: 0.0 (0 mojo) + -Pending Total Balance: 0.0 (0 mojo) + -Spendable: 0.0 (0 mojo) + -Type: CAT + -Asset ID: 7ff763080ccdb75b5858f9c1570a213d70e9f363b2ce21736e1fd66a87c5b09a + -Wallet ID: 3 + +Test CAT: + -Total Balance: 1000000.0 (1000000000 mojo) + -Pending Total Balance: 1000000.0 (1000000000 mojo) + -Spendable: 1000000.0 (1000000000 mojo) + -Type: CAT + -Asset ID: 242fe92390a22bcdcb213a30af7fe230fda4e36820aeede81d64c65094b10dc1 + -Wallet ID: 4 +``` + +In this case, we want to list the `Test CAT` coins, which are in `Wallet ID: 4`. + +```bash +chia wallet coins list -i 4 +``` + +Response: + +```bash +There are a total of 2 coins in wallet 4. +2 confirmed coins. +0 unconfirmed additions. +0 unconfirmed removals. +Confirmed coins: +Coin ID: 0xe733a3d5b1549ad9a1dbac7436e037a2d9c4e05c44ad1853d8449649dce4c377 + Address: txch1r9vxnelmmwa3s9kxntrx6nmpcf6ckgkc87gegxx235ylgdk0wcqqkyrm8h Amount: 999999.000000000000 (999999000 mojo), Confirmed in block: 1181995 + +Coin ID: 0xd04e594bcb117238afc335347dfa9bbe1c6917c008685266601ca182520a05b1 + Address: txch173nuz5pvajxaek2lu2726kcjn5gdjmv643x7t8dr44x7tzsgvhdsl3m6wy Amount: 1.000000000000 (1000 mojo), Confirmed in block: 1231837 +``` + +Note that each CAT consists of 1000 mojos. In this case, the larger coin is worth `999 999`, or `999 999 000` mojos. + +
+ --- ### `combine` @@ -309,7 +378,7 @@ Usage: chia wallet coins combine [OPTIONS] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :---------------- | :------ | :------- | :----------------------------------------------------------------------------------------------------------------------------------------------------- | +|:------------- |:----------------- |:------- |:-------- |:------------------------------------------------------------------------------------------------------------------------------------------------------ | | -p | --wallet-rpc-port | INTEGER | False | Set the port where the Wallet is hosting the RPC interface. See the `rpc_port` under `wallet` in config.yaml | | -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which wallet to use | | -i | --id | INTEGER | False | ID of the wallet to use [default: 1] | @@ -801,7 +870,7 @@ Usage: chia wallet coins split [OPTIONS] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :---------------- | :------ | :------- | :----------------------------------------------------------------------------------------------------------- | +|:------------- |:----------------- |:------- |:-------- |:------------------------------------------------------------------------------------------------------------ | | -p | --wallet-rpc-port | INTEGER | False | Set the port where the Wallet is hosting the RPC interface. See the `rpc_port` under `wallet` in config.yaml | | -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which wallet to use | | -i | --id | INTEGER | False | ID of the wallet to use [default: 1] | @@ -813,12 +882,16 @@ Options: This command requires a single coin to be specified for splitting. The maximum number of new coins is 500. These coins will be of equal value, and the original coin must contain sufficient funds for the splitting to occur. If any value remains after splitting, this will be stored in a new coin. +For example, if you split a coin worth 10 XCH, using `--number-of-coins 3` and `--amount-per-coin 1`, then you will end up with three new coins worth 1 XCH each, along with another coin (the remainder of the original coin) worth 7 XCH. + +When splitting a CAT, `--amount-per-coin` refers to the CAT value, where 1 CAT is 1000 mojos. + Keep in mind that (by default) the [dust filter](/faq#what-is-the-dust-filter) will be activated if you have over 200 coins worth one million mojos in your wallet. Therefore, if you split a coin into more than 200 coins worth less than one million mojos, not all of them will show up in your wallet unless you modify or disable the dust filter (see the above link for instructions). The minimum number of new coins is 1. "Splitting" one coin into one new coin could be useful because a second new coin will be created with the remaining value.
-Example +Example 1 First, list the coins available: @@ -902,6 +975,77 @@ Coin ID: 0x27049c58aad594bdb83a0f191098f438218cbd7066700342034709afb2470c0d
+
+Example 2: split a CAT + +Start by listing the CATs in `Wallet ID: 4`: + +```bash +chia wallet coins list -i 4 +``` + +Response: + +```bash +There are a total of 2 coins in wallet 4. +2 confirmed coins. +0 unconfirmed additions. +0 unconfirmed removals. +Confirmed coins: +Coin ID: 0xe733a3d5b1549ad9a1dbac7436e037a2d9c4e05c44ad1853d8449649dce4c377 + Address: txch1r9vxnelmmwa3s9kxntrx6nmpcf6ckgkc87gegxx235ylgdk0wcqqkyrm8h Amount: 999999.000000000000 (999999000 mojo), Confirmed in block: 1181995 + +Coin ID: 0xd04e594bcb117238afc335347dfa9bbe1c6917c008685266601ca182520a05b1 + Address: txch173nuz5pvajxaek2lu2726kcjn5gdjmv643x7t8dr44x7tzsgvhdsl3m6wy Amount: 1.000000000000 (1000 mojo), Confirmed in block: 1231837 +``` + +We will split the larger coin. In this case, we'll create three new coins of equal value, and the remainder will be held in a larger coin. + +```bash +chia wallet coins split -i 4 -n 3 -m 0.0001 -a 100 -t 0xe733a3d5b1549ad9a1dbac7436e037a2d9c4e05c44ad1853d8449649dce4c377 +``` + +Response: + +```bash +Transaction sent: 9b1e2122d641dc72ada458bb03076525cadb4e23a3f61dc685bca09bf61e5eec +To get status, use command: chia wallet get_transaction -f 3179192453 -tx 0x9b1e2122d641dc72ada458bb03076525cadb4e23a3f61dc685bca09bf61e5eec +``` + +Splitting requires an on-chain transaction. After this transaction has completed, list the existing CATs again: + +```bash +chia wallet coins list -i 4 +``` + +Response: + +```bash +There are a total of 5 coins in wallet 4. +5 confirmed coins. +0 unconfirmed additions. +0 unconfirmed removals. +Confirmed coins: +Coin ID: 0x5c244b3595199c358a944a4456bcf4c35e7bcd19eee1c2a2697a17321f35c608 + Address: txch1w5q3yhucsukk65kgzndr2scyjafunjwn2yk8aeea4hfpzpes557qxktxlv Amount: 999699.000000000000 (999699000 mojo), Confirmed in block: 1251072 + +Coin ID: 0x91699526de75d68bc9b7b39e1db4967c0562d49a9a3a4a644a09443c2f30df15 + Address: txch1767d5rq2hqdr0d40ku8wqf47gxnrpegz4zay0fsv45vlthjjvv7spxqnyx Amount: 100.000000000000 (100000 mojo), Confirmed in block: 1251072 + +Coin ID: 0x57b6a932ddaedde1c3bcdf80d37be6e721042bc2e065207f7e192a68c8b2b775 + Address: txch1w3tq64f9dz44enl63yar0scqpqph2lr7hegnsg8zsvq7kmgxd6fq52pfg2 Amount: 100.000000000000 (100000 mojo), Confirmed in block: 1251072 + +Coin ID: 0xd04e594bcb117238afc335347dfa9bbe1c6917c008685266601ca182520a05b1 + Address: txch173nuz5pvajxaek2lu2726kcjn5gdjmv643x7t8dr44x7tzsgvhdsl3m6wy Amount: 1.000000000000 (1000 mojo), Confirmed in block: 1231837 + +Coin ID: 0xc7699ff3bde093aae6d3ce53b77362fa1beee155d438f0f8f35de700f0861469 + Address: txch17hzqs0qvvru86xzfqvy9206sww2ack3x4kpaj8ar2r3t9254f93qjv0fsp Amount: 100.000000000000 (100000 mojo), Confirmed in block: 1251072 +``` + +There are three new coins, each worth 100. The original coin worth 1 remains intact, and the larger coin has been reduced in value by 300. + +
+ --- ## `clawback` @@ -913,7 +1057,7 @@ Usage: chia wallet delete_unconfirmed_transactions [OPTIONS] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :---------------- | :------ | :------- | :---------------------------------------------------------------------------------------------------------------------------------- | +|:------------- |:----------------- |:------- |:-------- |:----------------------------------------------------------------------------------------------------------------------------------- | | -wp | --wallet-rpc-port | INTEGER | False | Set the port where the Wallet is hosting the RPC interface. See the `rpc_port` under `wallet` in config.yaml | | -i | --id | INTEGER | False | ID of the wallet to use [default: 1] | | -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which wallet to use | @@ -1062,7 +1206,7 @@ Usage: chia wallet delete_unconfirmed_transactions [OPTIONS] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :---------------- | :------ | :------- | :----------------------------------------------------------------------------------------------------------- | +|:------------- |:----------------- |:------- |:-------- |:------------------------------------------------------------------------------------------------------------ | | -wp | --wallet-rpc-port | INTEGER | False | Set the port where the Wallet is hosting the RPC interface. See the `rpc_port` under `wallet` in config.yaml | | -i | --id | INTEGER | False | ID of the wallet to use [default: 1] | | -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which wallet to use | @@ -1094,7 +1238,7 @@ Usage: chia wallet get_address [OPTIONS] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :---------------- | :------ | :------- | :----------------------------------------------------------------------------------------------------------- | +|:------------- |:----------------- |:------- |:-------- |:------------------------------------------------------------------------------------------------------------ | | -wp | --wallet-rpc-port | INTEGER | False | Set the port where the Wallet is hosting the RPC interface. See the `rpc_port` under `wallet` in config.yaml | | -i | --id | INTEGER | False | ID of the wallet to use [default: 1] | | -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which wallet to use | @@ -1130,7 +1274,7 @@ Usage: chia wallet get_derivation_index [OPTIONS] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :---------------- | :------ | :------- | :----------------------------------------------------------------------------------------------------------- | +|:------------- |:----------------- |:------- |:-------- |:------------------------------------------------------------------------------------------------------------ | | -wp | --wallet-rpc-port | INTEGER | False | Set the port where the Wallet is hosting the RPC interface. See the `rpc_port` under `wallet` in config.yaml | | -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which wallet to use | | -h | --help | None | False | Show a help message and exit | @@ -1161,7 +1305,7 @@ Usage: chia wallet get_transaction [OPTIONS] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :---------------- | :------ | :------- | :----------------------------------------------------------------------------------------------------------- | +|:------------- |:----------------- |:------- |:-------- |:------------------------------------------------------------------------------------------------------------ | | -wp | --wallet-rpc-port | INTEGER | False | Set the port where the Wallet is hosting the RPC interface. See the `rpc_port` under `wallet` in config.yaml | | -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which wallet to use | | -i, | --id | INTEGER | False | ID of the wallet to use [default: 1] | @@ -1199,7 +1343,7 @@ Usage: chia wallet get_transactions [OPTIONS] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :------------------ | :------ | :------- | :---------------------------------------------------------------------------------------------------------------- | +|:------------- |:------------------- |:------- |:-------- |:----------------------------------------------------------------------------------------------------------------- | | -wp | --wallet-rpc-port | INTEGER | False | Set the port where the Wallet is hosting the RPC interface. See the `rpc_port` under `wallet` in config.yaml | | -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which wallet to use | | -i | --id | INTEGER | False | ID of the wallet to use [default: 1] | @@ -1209,7 +1353,7 @@ Options: | | --paginate | None | False | Prompt for each page of data. Defaults to enabled for interactive consoles, otherwise defaults to disabled | | | --no-paginate | None | False | Do not prompt for each page of data. Defaults to disabled for interactive consoles, otherwise defaults to enabled | | | --sort-by-height | None | False | Sort transactions by height [default: disabled] | -| | --sort-by-relevance | None | False | Sort transactions by \{confirmed \| height \| time\} [default: disabled] | +| | --sort-by-relevance | None | False | Sort transactions by \{confirmed \| height \| time\} [default: disabled] | | | --reverse | None | False | Reverse the transaction ordering [default: disabled] | | | --clawback | None | False | Only show clawback transactions [default: disabled] | | -h | --help | None | False | Show a help message and exit | @@ -1376,7 +1520,7 @@ Usage: chia wallet notifications delete [OPTIONS] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :---------------- | :------ | :------- | :----------------------------------------------------------------------------------------------------------- | +|:------------- |:----------------- |:------- |:-------- |:------------------------------------------------------------------------------------------------------------ | | -wp | --wallet-rpc-port | INTEGER | False | Set the port where the Wallet is hosting the RPC interface. See the `rpc_port` under `wallet` in config.yaml | | -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which wallet to use | | -i | --id | TEXT | False | A specific notification ID to delete | @@ -1411,7 +1555,7 @@ Usage: chia wallet notifications get [OPTIONS] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :---------------- | :------ | :------- | :----------------------------------------------------------------------------------------------------------- | +|:------------- |:----------------- |:------- |:-------- |:------------------------------------------------------------------------------------------------------------ | | -wp | --wallet-rpc-port | INTEGER | False | Set the port where the Wallet is hosting the RPC interface. See the `rpc_port` under `wallet` in config.yaml | | -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which wallet to use | | -i | --id | TEXT | False | The specific notification ID to show | @@ -1453,11 +1597,11 @@ Usage: chia wallet notifications send [OPTIONS] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :---------------- | :------ | :------- | :----------------------------------------------------------------------------------------------------------- | +|:------------- |:----------------- |:------- |:-------- |:------------------------------------------------------------------------------------------------------------ | | -wp | --wallet-rpc-port | INTEGER | False | Set the port where the Wallet is hosting the RPC interface. See the `rpc_port` under `wallet` in config.yaml | | -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which wallet to use | | -t | --to-address | TEXT | True | The address to send the notification to | -| -a | --amount | TEXT | False | The amount to send to get the notification past the recipient's spam filter [default: 0.00001] | +| -a | --amount | TEXT | False | The amount (in XCH) to send to get the notification past the recipient's spam filter [default: 0.00001] | | -n | --message | TEXT | True | The message of the notification | | -m | --fee | TEXT | False | The fee for the transaction | | -h | --help | None | False | Show a help message and exit | @@ -1483,18 +1627,18 @@ Notification sent successfully. ## `send` -Functionality: Send chia to another wallet +Functionality: Send chia or other assets to another wallet Usage: chia wallet send [OPTIONS] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :---------------- | :------ | :------- | :---------------------------------------------------------------------------------------------------------------------------------------------------- | +|:------------- |:----------------- |:------- |:-------- |:----------------------------------------------------------------------------------------------------------------------------------------------------- | | -wp | --wallet-rpc-port | INTEGER | False | Set the port where the Wallet is hosting the RPC interface. See the `rpc_port` under `wallet` in config.yaml | | -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which wallet to use | | -i | --id | INTEGER | False | ID of the wallet to use [default: 1] | -| -a | --amount | TEXT | True | How much chia to send, in XCH | +| -a | --amount | TEXT | True | How much chia to send, in XCH or CAT units | | -e | --memo | TEXT | False | Additional memo for the transaction | | -m | --fee | TEXT | False | Set the fees for the transaction, in XCH [default: 0] | | -t | --address | TEXT | True | Address to send the XCH | @@ -1590,12 +1734,12 @@ Usage: chia wallet show [OPTIONS] Options: -| Short Command | Long Command | Type | Required | Description | -| :------------ | :---------------- | :------ | :------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| -wp | --wallet-rpc-port | INTEGER | False | Set the port where the Wallet is hosting the RPC interface. See the `rpc_port` under `wallet` in config.yaml | -| -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which wallet to use | +| Short Command | Long Command | Type | Required | Description | +|:------------- |:----------------- |:------- |:-------- |:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| -wp | --wallet-rpc-port | INTEGER | False | Set the port where the Wallet is hosting the RPC interface. See the `rpc_port` under `wallet` in config.yaml | +| -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which wallet to use | | -w | --wallet_type | TEXT | False | Choose a specific wallet type to return, choose from the following: [standard_wallet \| atomic_swap \| authorized_payee \| multi_sig \| custody \| cat \| recoverable \| decentralized_id \| pooling_wallet \| nft \| data_layer \| data_layer_offer] | -| -h | --help | None | False | Show a help message and exit | +| -h | --help | None | False | Show a help message and exit |
Example @@ -1654,7 +1798,7 @@ Usage: chia wallet sign_message [OPTIONS] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :---------------- | :------ | :------- | :----------------------------------------------------------------------------------------------------------- | +|:------------- |:----------------- |:------- |:-------- |:------------------------------------------------------------------------------------------------------------ | | -wp | --wallet-rpc-port | INTEGER | False | Set the port where the Wallet is hosting the RPC interface. See the `rpc_port` under `wallet` in config.yaml | | -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which wallet to use | | -a | --address | TEXT | True | The address you want to use for signing | @@ -1689,7 +1833,7 @@ Usage: chia wallet update_derivation_index [OPTIONS] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :---------------- | :------ | :------- | :----------------------------------------------------------------------------------------------------------- | +|:------------- |:----------------- |:------- |:-------- |:------------------------------------------------------------------------------------------------------------ | | -wp | --wallet-rpc-port | INTEGER | False | Set the port where the Wallet is hosting the RPC interface. See the `rpc_port` under `wallet` in config.yaml | | -f | --fingerprint | INTEGER | False | Set the fingerprint to specify which wallet to use | | -i | --index | INTEGER | True | Index to set. Must be greater than the current derivation index | diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/coin-set-model/clvm-vs-evm.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/coin-set-model/clvm-vs-evm.md index 744f65daca..95d23c163c 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/coin-set-model/clvm-vs-evm.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/coin-set-model/clvm-vs-evm.md @@ -12,17 +12,17 @@ We'll start with a brief description of CLVM. For details on the inner workings ## Comparison -| Design decision | EVM (Solidity) | CLVM (Chialisp) | -| -------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| The blockchain contains... | Smart contracts (compiled programs) as well as accounts. | The root hash of a binary tree, not source code. | -| Money | Smart contracts _contain_ money. | Standard Chia coins don't _contain_ money. They _are_ money. That said, more complex functionality is possible, allowing coins to contain state, such as money. | -| Determinism | Less deterministic because multiple people can execute code within the same contract. Depending on the order of execution, the result won't always be the same. | More deterministic because coins can only be spent once. However, it's possible to have a coin that multiple people can spend, which would reduce determinism. | -| Centralization | Multiple people interact with the same contract. Centralized by design. | Only the owner interacts with a smart coin. Decentralized by design. | -| Sandboxing | No sandboxing. If a contract is hacked, all users can lose their money. | Strong sandboxing. Spending is the only action allowed on an unspent coin, and only by the owner(s). If a coin is hacked, only that coin's owner(s) lose(s) their money. | +| Design decision | EVM (Solidity) | CLVM (Chialisp) | +| -------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| The blockchain contains... | Smart contracts (compiled programs) as well as accounts. | The root hash of a binary tree, not source code. | +| Money | Smart contracts _contain_ money. | Standard Chia coins don't _contain_ money. They _are_ money. That said, more complex functionality is possible, allowing coins to contain state, such as money. | +| Determinism | Less deterministic because multiple people can execute code within the same contract. Depending on the order of execution, the result won't always be the same. | More deterministic because coins can only be spent once. However, it's possible to have a coin that multiple people can spend, which would reduce determinism. | +| Centralization | Multiple people interact with the same contract. Centralized by design. | Only the owner interacts with a smart coin. Decentralized by design. | +| Sandboxing | No sandboxing. If a contract is hacked, all users can lose their money. | Strong sandboxing. Spending is the only action allowed on an unspent coin, and only by the owner(s). If a coin is hacked, only that coin's owner(s) lose(s) their money. | | Composability | Composition is supported, so it is possible to set rules temporarily governing how money may be spent. However, if money is moved outside of the contract, it will follow different rules.

(Note that it is possible to create a contract that “traps” ETH inside of it by only allowing money to be sent from the contract to specific types of addresses. However, by definition this limits the functionality of that money to whatever is contained within the contract.) | Composition is handled through inner puzzles. A puzzle's creator could say, “As long as these rules are followed, an inner puzzle can add any functionality.” Thus, it is possible to set rules that are intrinsic to the money itself, which must be followed _forever_. | -| MEV | Changing transaction order is both profitable and common. MEV is high. | Transactions all occur simultaneously in a block. MEV is low. | -| Reentrancy | Contracts can call functions on other contracts. Withdrawals can happen multiple times. Reentrancy is possible and must be carefully guarded against. | Coins interact with each other through announcements. They cannot call functions on other coins. Spends are atomic. Reentrancy is not possible. | -| Auditability/Security | Weak. Multiple points of failure. Numerous hacks prove this. | Strong. If an attacker changes a coin's puzzle, the hash also changes. The attacker is thus attempting to spend a coin that does not exist. The attacker can modify the solution, but the programmer can counter this by using assertions, which will make any such modifications fail. | +| MEV | Changing transaction order is both profitable and common. MEV is high. | Transactions all occur simultaneously in a block. MEV is low. | +| Reentrancy | Contracts can call functions on other contracts. Withdrawals can happen multiple times. Reentrancy is possible and must be carefully guarded against. | Coins interact with each other through announcements. They cannot call functions on other coins. Spends are atomic. Reentrancy is not possible. | +| Auditability/Security | Weak. Multiple points of failure. Numerous hacks prove this. | Strong. If an attacker changes a coin's puzzle, the hash also changes. The attacker is thus attempting to spend a coin that does not exist. The attacker can modify the solution, but the programmer can counter this by using assertions, which will make any such modifications fail. | --- diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/coin-set-model/conditions.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/coin-set-model/conditions.md index 2103dfcf71..2cdaa10b37 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/coin-set-model/conditions.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/coin-set-model/conditions.md @@ -3,647 +3,4 @@ slug: /conditions title: Conditions --- -When a coin is spent, its puzzle is executed on the Chialisp Virtual Machine (CLVM). If the program does not fail, it returns a list of conditions. These conditions determine what the outcome of the spend is, and whether or not the spend is valid. - -Puzzles have no access to the outside world, or even to blockchain parameters like block height. Therefore, to interact with the outside environment, they return a list of conditions, each of which must be valid in order for the spend itself to be valid. - -There are two kinds of conditions. Some require something to be true (such as time passing) in order for the spend to be valid. And others cause something to happen if the spend is valid (such as the creation of new coins). - -## Condition List {#list} - -:::warning - -Be vigilant when using `ASSERT_MY_COIN_ID` as a shortcut for validating the parent coin ID, puzzle hash, and amount. If they are passed into the solution separately, then validated all at once by hashing them together, it is possible to shift the bytes to the left or right and manipulate the values. If they are passed into the solution separately, then validated all at once by hashing them together, it is possible to shift the bytes to the left or right and manipulate the values. - -You are recommended to use the `coinid` operator when computing coin IDs. This operator was introduced with [CHIP-11](https://github.com/Chia-Network/chips/blob/main/CHIPs/chip-0011.md). It verifies that hashes are indeed 32 bytes in length, at no extra CLVM cost versus verifying the parent ID, puzzle hash, and amount individually. The `coinid` operator, as well as the other CHIP-11 operators, are described on the Chialisp [operators page](https://chialisp.com/operators#chip-0011-operators). This operator was introduced with [CHIP-11](https://github.com/Chia-Network/chips/blob/main/CHIPs/chip-0011.md). It verifies that hashes are indeed 32 bytes in length, at no extra CLVM cost versus verifying the parent ID, puzzle hash, and amount individually. The `coinid` operator, as well as the other CHIP-11 operators, are described on the Chialisp [operators page](https://chialisp.com/operators#chip-0011-operators). - -::: - -:::warning - -`ASSERT_COIN_ANNOUNCEMENT` and `ASSERT_PUZZLE_ANNOUNCEMENT` should typically only be used in a puzzle's _solution_, and not in the puzzle itself. This is especially important when using `ASSERT_COIN_ANNOUNCEMENT`, because it refers to a specific coin. This is especially important when using `ASSERT_COIN_ANNOUNCEMENT`, because it refers to a specific coin. - -To illustrate the danger, let's say `coin A` uses this condition in its puzzle, and it asserts a coin announcement from `coin B`. In this case, `coin A` requires `coin B` to be spent in the same block as it is spent. If `coin B` is spent before `coin A`, then `coin A` can _never_ be spent. - -However, if this condition is instead used in the _solution_ for `coin A`, and `coin B` has already been spent, then `coin A` can still be spent later, albeit with a different solution. - -It is somewhat less dangerous to use `ASSERT_PUZZLE_ANNOUNCEMENT` in a coin's puzzle because it only relies on a coin with a specific puzzle, and many such coins might exist. However, it is still best practice to only use this condition in a coin's solution. - -::: - -### 1 `REMARK` {#remark} - -Format: `(1)` - -This condition is always considered valid by the mempool. - -This condition has no parameters. - ---- - -### 43 `AGG_SIG_PARENT` {#agg-sig-parent} - -:::info -This condition is part of [CHIP-0011](https://github.com/Chia-Network/chips/blob/main/CHIPs/chip-0011.md), and will be available at block height 5,496,000. -::: -::: - -:::note -This condition adds an additional [CLVM cost](/coin-set-costs/) of 1,200,000. -::: -::: - -Format: `(43 public_key message)` - -Verifies a signature for a given message which is concatenated with the following values: - -- The parent coin id of the coin being spent. -- The domain string, `sha256(genesis_id + 43)`. - -The following parameters are expected: - -| Name | Type | -| ------------ | --------- | -| `public_key` | G1Element | -| `message` | Bytes | - ---- - -### 44 `AGG_SIG_PUZZLE` {#agg-sig-puzzle} - -:::info -This condition is part of [CHIP-0011](https://github.com/Chia-Network/chips/blob/main/CHIPs/chip-0011.md), and will be available at block height 5,496,000. -::: -::: - -:::note -This condition adds an additional [CLVM cost](/coin-set-costs/) of 1,200,000. -::: -::: - -Format: `(44 public_key message)` - -Verifies a signature for a given message which is concatenated with the following values: - -- The puzzle hash of the coin being spent. -- The domain string, `sha256(genesis_id + 44)`. - -The following parameters are expected: - -| Name | Type | -| ------------ | --------- | -| `public_key` | G1Element | -| `message` | Bytes | - ---- - -### 45 `AGG_SIG_AMOUNT` {#agg-sig-amount} - -:::info -This condition is part of [CHIP-0011](https://github.com/Chia-Network/chips/blob/main/CHIPs/chip-0011.md), and will be available at block height 5,496,000. -::: -::: - -:::note -This condition adds an additional [CLVM cost](/coin-set-costs/) of 1,200,000. -::: -::: - -Format: `(45 public_key message)` - -Verifies a signature for a given message which is concatenated with the following values: - -- The amount of the coin being spent. -- The domain string, `sha256(genesis_id + 45)`. - -The following parameters are expected: - -| Name | Type | -| ------------ | --------- | -| `public_key` | G1Element | -| `message` | Bytes | - ---- - -### 46 `AGG_SIG_PUZZLE_AMOUNT` {#agg-sig-puzzle-amount} - -:::info -This condition is part of [CHIP-0011](https://github.com/Chia-Network/chips/blob/main/CHIPs/chip-0011.md), and will be available at block height 5,496,000. -::: -::: - -:::note -This condition adds an additional [CLVM cost](/coin-set-costs/) of 1,200,000. -::: -::: - -Format: `(46 public_key message)` - -Verifies a signature for a given message which is concatenated with the following values: - -- The puzzle hash of the coin being spent. -- The amount of the coin being spent. -- The domain string, `sha256(genesis_id + 46)`. - -The following parameters are expected: - -| Name | Type | -| ------------ | --------- | -| `public_key` | G1Element | -| `message` | Bytes | - ---- - -### 47 `AGG_SIG_PARENT_AMOUNT` {#agg-sig-parent-amount} - -:::info -This condition is part of [CHIP-0011](https://github.com/Chia-Network/chips/blob/main/CHIPs/chip-0011.md), and will be available at block height 5,496,000. -::: -::: - -:::note -This condition adds an additional [CLVM cost](/coin-set-costs/) of 1,200,000. -::: -::: - -Format: `(47 public_key message)` - -Verifies a signature for a given message which is concatenated with the following values: - -- The parent coin id of the coin being spent. -- The amount of the coin being spent. -- The domain string, `sha256(genesis_id + 47)`. - -The following parameters are expected: - -| Name | Type | -| ------------ | --------- | -| `public_key` | G1Element | -| `message` | Bytes | - ---- - -### 48 `AGG_SIG_PARENT_PUZZLE` {#agg-sig-parent-puzzle} - -:::info -This condition is part of [CHIP-0011](https://github.com/Chia-Network/chips/blob/main/CHIPs/chip-0011.md), and will be available at block height 5,496,000. -::: -::: - -:::note -This condition adds an additional [CLVM cost](/coin-set-costs/) of 1,200,000. -::: -::: - -Format: `(48 public_key message)` - -Verifies a signature for a given message which is concatenated with the following values: - -- The parent coin id of the coin being spent. -- The puzzle hash of the coin being spent. -- The domain string, `sha256(genesis_id + 48)`. - -The following parameters are expected: - -| Name | Type | -| ------------ | --------- | -| `public_key` | G1Element | -| `message` | Bytes | - ---- - -### 49 `AGG_SIG_UNSAFE` {#agg-sig-unsafe} - -:::note -This condition adds an additional [CLVM cost](/coin-set-costs/) of 1,200,000. -::: -::: - -Format: `(49 public_key message)` - -Verifies a signature for a given message. Verifies a signature for a given message. For [security reasons](https://github.com/Chia-Network/post-mortem/blob/main/2023-05/2023-05-08-AGG_SIG_UNSAFE-can-mimic-AGG_SIG_ME-condition.md), domain strings are not permitted at the end of `AGG_SIG_UNSAFE` messages. - -The following parameters are expected: - -| Name | Type | -| ------------ | --------- | -| `public_key` | G1Element | -| `message` | Bytes | - ---- - -### 50 `AGG_SIG_ME` {#agg-sig-me} - -:::tip -In most cases, `AGG_SIG_ME` is the recommended condition for requiring signatures. Signatures created for a specific coin spend will only be valid for that exact coin, which prevents an attacker from reusing the signature for other spends. ::: Signatures created for a specific coin spend will only be valid for that exact coin, which prevents an attacker from reusing the signature for other spends. -::: - -:::note -This condition adds an additional [CLVM cost](/coin-set-costs/) of 1,200,000. -::: -::: - -Format: `(50 public_key message)` - -Verifies a signature for a given message which is concatenated with the following values: - -- The id of the coin being spent. -- The domain string, `genesis_id`. - -The following parameters are expected: - -| Name | Type | -| ------------ | --------- | -| `public_key` | G1Element | -| `message` | Bytes | - ---- - -### 51 `CREATE_COIN` {#create-coin} - -:::note -This condition adds an additional [CLVM cost](/coin-set-costs/) of 1,800,000. -::: -::: - -Format: `(51 puzzle_hash amount (...memos)?)` - -Creates a new coin output with a given puzzle hash and amount. This coin is its parent. This coin is its parent. - -For more information on the `memos` parameter, see the section on [Memos and Hinting](#memos). - -The following parameters are expected: - -| Name | Type | -| -------------------- | ------------ | -| `puzzle_hash` | Bytes32 | -| `amount` | Unsigned Int | -| `memos` _(optional)_ | Bytes32 List | - ---- - -### 52 `RESERVE_FEE` {#reserve-fee} - -Format: `(52 amount)` - -Requires that the total amount remaining in the transaction after all outputs have been created is no less than the reserved fee amount. - -The following parameters are expected: - -| Name | Type | -| -------- | ------------ | -| `amount` | Unsigned Int | - ---- - -### 60 `CREATE_COIN_ANNOUNCEMENT` {#create-coin-announcement} - -Format: `(60 message)` - -Creates an announcement of a given message, tied to this coin's id. For more details, see the section on [Announcements](#announcements). For more details, see the section on [Announcements](#announcements). - -The following parameters are expected: - -| Name | Type | -| --------- | ----- | -| `message` | Bytes | - ---- - -### 61 `ASSERT_COIN_ANNOUNCEMENT` {#assert-coin-announcement} - -Format: `(61 announcement_id)` - -Asserts an announcement with a given id, which is calculated as `sha256(coin_id + message)`. For more details, see the section on [Announcements](#announcements). For more details, see the section on [Announcements](#announcements). - -The following parameters are expected: - -| Name | Type | -| ----------------- | ------- | -| `announcement_id` | Bytes32 | - ---- - -### 62 `CREATE_PUZZLE_ANNOUNCEMENT` {#create-puzzle-announcement} - -Format: `(62 message)` - -Creates an announcement of a given message, tied to this coin's puzzle hash. For more details, see the section on [Announcements](#announcements). For more details, see the section on [Announcements](#announcements). - -The following parameters are expected: - -| Name | Type | -| --------- | ----- | -| `message` | Bytes | - ---- - -### 63 `ASSERT_PUZZLE_ANNOUNCEMENT` {#assert-puzzle-announcement} - -Format: `(63 announcement_id)` - -Asserts an announcement with a given id, which is calculated as `sha256(puzzle_hash + message)`. For more details, see the section on [Announcements](#announcements). For more details, see the section on [Announcements](#announcements). - -The following parameters are expected: - -| Name | Type | -| ----------------- | ------- | -| `announcement_id` | Bytes32 | - ---- - -### 64 `ASSERT_CONCURRENT_SPEND` {#assert-concurrent-spend} - -Format: `(64 coin_id)` - -Asserts that this coin is spent within the same block as the spend of a given coin. - -The following parameters are expected: - -| Name | Type | -| --------- | ------- | -| `coin_id` | Bytes32 | - ---- - -### 65 `ASSERT_CONCURRENT_PUZZLE` {#assert-concurrent-puzzle} - -Format: `(65 puzzle_hash)` - -Asserts that this coin is in the same block as the spend of another coin with a given puzzle hash. - -The following parameters are expected: - -| Name | Type | -| ------------- | ------- | -| `puzzle_hash` | Bytes32 | - ---- - -### 70 `ASSERT_MY_COIN_ID` {#assert-my-coin-id} - -Format: `(70 coin_id)` - -Asserts that id of this coin matches a given value. - -The following parameters are expected: - -| Name | Type | -| --------- | ------- | -| `coin_id` | Bytes32 | - ---- - -### 71 `ASSERT_MY_PARENT_ID` {#assert-my-parent-id} - -Format: `(71 parent_id)` - -Asserts that the parent id of this coin matches a given value. - -The following parameters are expected: - -| Name | Type | -| ----------- | ------- | -| `parent_id` | Bytes32 | - ---- - -### 72 `ASSERT_MY_PUZZLE_HASH` {#assert-my-puzzle-hash} - -Format: `(72 puzzle_hash)` - -Asserts that the puzzle hash of this coin matches a given value. - -The following parameters are expected: - -| Name | Type | -| ------------- | ------- | -| `puzzle_hash` | Bytes32 | - ---- - -### 73 `ASSERT_MY_AMOUNT` {#assert-my-amount} - -Format: `(73 amount)` - -Asserts that the amount of this coin matches a given value. - -The following parameters are expected: - -| Name | Type | -| -------- | ------------ | -| `amount` | Unsigned Int | - ---- - -### 74 `ASSERT_MY_BIRTH_SECONDS` {#assert-my-birth-seconds} - -Format: `(74 seconds)` - -Asserts that this coin was created at a given timestamp. - -The following parameters are expected: - -| Name | Type | -| --------- | ------------ | -| `seconds` | Unsigned Int | - ---- - -### 75 `ASSERT_MY_BIRTH_HEIGHT` {#assert-my-birth-height} - -Format: `(75 block_height)` - -Asserts that this coin was created at a given block height. - -The following parameters are expected: - -| Name | Type | -| -------------- | ------------ | -| `block_height` | Unsigned Int | - ---- - -### 76 `ASSERT_EPHEMERAL` {#assert-ephemeral} - -Format: `(76)` - -Asserts that this coin was created within the current block. - -This condition has no parameters. - ---- - -### 80 `ASSERT_SECONDS_RELATIVE` {#assert-seconds-relative} - -Format: `(80 seconds_passed)` - -Asserts that the previous transaction block was created at least a given number of seconds after this coin was created. - -The following parameters are expected: - -| Name | Type | -| ---------------- | ------------ | -| `seconds_passed` | Unsigned Int | - ---- - -### 81 `ASSERT_SECONDS_ABSOLUTE` {#assert-seconds-absolute} - -Format: `(81 seconds)` - -Asserts that the previous transaction block was created at at least a given timestamp, in seconds. - -The following parameters are expected: - -| Name | Type | -| --------- | ------------ | -| `seconds` | Unsigned Int | - ---- - -### 82 `ASSERT_HEIGHT_RELATIVE` {#assert-height-relative} - -Format: `(82 block_height_passed)` - -Asserts that the previous transaction block was created at least a given number of blocks after this coin was created. - -The following parameters are expected: - -| Name | Type | -| --------------------- | ------------ | -| `block_height_passed` | Unsigned Int | - ---- - -### 83 `ASSERT_HEIGHT_ABSOLUTE` {#assert-height-absolute} - -Format: `(83 block_height)` - -Asserts that the previous transaction block was created at at least a given height. - -The following parameters are expected: - -| Name | Type | -| -------------- | ------------ | -| `block_height` | Unsigned Int | - ---- - -### 84 `ASSERT_BEFORE_SECONDS_RELATIVE` {#assert-before-seconds-relative} - -Format: `(84 seconds_passed)` - -Asserts that the previous transaction block was created before a given number of seconds after this coin was created. - -The following parameters are expected: - -| Name | Type | -| ---------------- | ------------ | -| `seconds_passed` | Unsigned Int | - ---- - -### 85 `ASSERT_BEFORE_SECONDS_ABSOLUTE` {#assert-before-seconds-absolute} - -Format: `(85 seconds)` - -Asserts that the previous transaction block was created before a given timestamp, in seconds. - -The following parameters are expected: - -| Name | Type | -| --------- | ------------ | -| `seconds` | Unsigned Int | - ---- - -### 86 `ASSERT_BEFORE_HEIGHT_RELATIVE` {#assert-before-height-relative} - -Format: `(86 block_height_passed)` - -Asserts that the previous transaction block was created before a given number of blocks after this coin was created. - -The following parameters are expected: - -| Name | Type | -| --------------------- | ------------ | -| `block_height_passed` | Unsigned Int | - ---- - -### 87 `ASSERT_BEFORE_HEIGHT_ABSOLUTE` {#assert-before-height-absolute} - -Format: `(87 block_height)` - -Asserts that the previous transaction block was created before a given height. - -The following parameters are expected: - -| Name | Type | -| -------------- | ------------ | -| `block_height` | Unsigned Int | - ---- - -### 90 `SOFTFORK` {#softfork} - -:::info -This condition is part of [CHIP-0011](https://github.com/Chia-Network/chips/blob/main/CHIPs/chip-0011.md), and will be available at block height 5,496,000. -::: -::: - -:::note -This condition adds an additional [CLVM cost](/coin-set-costs/) equal to whatever the value of the first argument is. -::: -::: - -Format: `(90 cost ...args)` - -Allows future conditions with non-zero CLVM costs to be added as soft forks. This functionality was previously only possible as a hard fork. This functionality was previously only possible as a hard fork. - -The cost of the condition is specified in ten-thousands, and further arguments are not specified (the soft-forked condition defines these). The cost of the condition is specified in ten-thousands, and further arguments are not specified (the soft-forked condition defines these). The reason to scale the cost by 10,000 is to make the argument smaller. For example, a cost of 100 in this condition would equate to an actual cost of 1 million (1,000,000). The cost argument is two bytes, with a maximum size of 65,535 (an actual cost of 655,350,000). For example, a cost of 100 in this condition would equate to an actual cost of 1 million (1,000,000). The cost argument is two bytes, with a maximum size of 65,535 (an actual cost of 655,350,000). - -The following parameters are expected: - -| Name | Type | -| --------- | ------------ | -| `cost` | Unsigned Int | -| `...args` | Any | - -## Memos and Hinting {#memos} - -When a coin uses one or more outer puzzles that change their puzzle hash, it's challenging for wallets to know which coins they have the ability to spend. When a coin uses one or more outer puzzles that change their puzzle hash, it's challenging for wallets to know which coins they have the ability to spend. The memos field allows you to hint the inner puzzle hash of created coins, which consequently lets the wallet know that the coin belongs to it. Coins can be looked up by the inner puzzle hash rather than the outer puzzle hash. Coins can be looked up by the inner puzzle hash rather than the outer puzzle hash. - -The `CREATE_COIN` condition is defined as a list containing the opcode `51` and the following arguments: - -```chialisp -; The third parameter is optional. -(51 puzzle_hash amount (...memos)) -``` - -The `memos` parameter is an optional list, which must be null terminated. - -If `memos` is present, and the first memo is exactly 32 bytes long, it's used as the hint and the rest of the list are memos. Otherwise, values in the entire list are memos. Otherwise, values in the entire list are memos. - -As an example, the following inner solution for the [standard transaction](https://chialisp.com/standard-transactions) would create an unhinted coin: - -```chialisp -(() (q . (() (q . ((51 target_puzzle_hash amount))) ()) -``` - -The following solution would instead create a coin with the hint matching the inner puzzle hash: - -```chialisp -(() (q . (() (q . ((51 target_puzzle_hash amount (target_puzzle_hash)))) ()) -``` - -This `CREATE_COIN` condition creates the same coin as before, but now it specifies the hint with which the receiving wallet can look up to find this coin. - -Hints are only necessary for outer puzzles, of which the inner puzzle hash matches the hint. Hints are only necessary for outer puzzles, of which the inner puzzle hash matches the hint. For example, coins using the standard transaction itself with no outer puzzle do not need a hint. - -## Announcements - -Announcements are ephemeral, meaning that they don't last forever. They can only be asserted within the block they are created. Their purpose is to ensure multiple coins are spent together, either for fees, verification, or as a security measure. - -For coin announcements, the id is the `coin_id` and `message` sha256 hashed together. For coin announcements, the id is the `coin_id` and `message` sha256 hashed together. Likewise, for puzzle announcements, it's the `puzzle_hash` and `message` sha256 hashed together. +This page has been moved. A comprehensive list of Chialisp conditions is now available on our site dedicated to Chialisp: https://chialisp.com/conditions/ diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/coin-set-model/costs.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/coin-set-model/costs.md index c920ab516a..9edf603b62 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/coin-set-model/costs.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/coin-set-model/costs.md @@ -15,7 +15,7 @@ It is important to keep the cost usage of programs on the Chia blockchain as low Cost has several components. First, every CLVM program uses a certain amount of cost during execution, based on the operators and the values they are called on. You can refer to the [Cost page](https://chialisp.com/costs) on the Chialisp website to learn more about the cost of various CLVM operators. -Additionally, certain conditions in a coin spend have a cost associated with them as well. Additionally, certain conditions in a coin spend have a cost associated with them as well. A few common examples are [`CREATE_COIN`](https://chialisp.com/conditions#create-coin) and [`AGG_SIG_ME`](/conditions#agg-sig-me), which are expensive operations. +Additionally, certain conditions in a coin spend have a cost associated with them as well. A few common examples are [`CREATE_COIN`](https://chialisp.com/conditions#create-coin) and [`AGG_SIG_ME`](https://chialisp.com/conditions#agg-sig-me), which are expensive operations. Finally, each byte of data that gets added to the blockchain has a cost of 12,000. Spend bundles are created using a serialized format of CLVM programs, calculated by running [opc](https://chialisp.com/commands#serialize) on the original CLVM program. Each two-digit pair of this format is equivalent to one byte, which costs 12,000 to store on the blockchain. @@ -148,20 +148,20 @@ The [minimum effective](/mempool/#fee-required-for-inclusion) fee represents 5 x Please note that the costs and fees listed are for vanilla versions of these transactions, they can vary based on the number of input and output coins needed so consider these the bare minimum. Transactions with a '\*' are listed with a fee of 3 x the minimum effective fee. This is to ensure the fees are more realistic for how coins are distributed in users wallets but note that vanilla versions of these would be 1/3 that which is listed. ::: -| Transaction Type | clvm Cost | Minimum Effective Fee | -| --------------------------------- | ------------- | --------------------------------- | -| **Full Block (with 50% cap)** | 5,500,000,000 | 27,500,000,000 mojo (0.0275 xch) | +| Transaction Type | clvm Cost | Minimum Effective Fee | +| --------------------------------- | ------------- | ----------------------------------- | +| **Full Block (with 50% cap)** | 5,500,000,000 | 27,500,000,000 mojo (0.0275 xch) | | **Standard Transaction** | 6,000,000 | 90,000,000 mojo (0.00009 xch) \* | -| **PlotNFT Creation** | 18,000,000 | 90,000,000 mojo (0.00009 xch) | -| **Minting NFT with DID** | 123,000,000 | 615,000,000 mojo (0.000615 xch) | -| **Minting NFT without DID** | 53,000,000 | 265,000,000 mojo (0.000265 xch) | -| **Adding URI to NFT with DID** | 71,000,000 | 355,000,000 mojo (0.000355 xch) | -| **Adding URI to NFT without DID** | 41,000,000 | 205,000,000 mojo (0.000205 xch) | -| **Transfer NFT with DID** | 67,000,000 | 335,000,000 mojo (0.000335 xch) | -| **Assign DID to NFT** | 107,000,000 | 535,000,000 mojo (0.000535 xch) | +| **PlotNFT Creation** | 18,000,000 | 90,000,000 mojo (0.00009 xch) | +| **Minting NFT with DID** | 123,000,000 | 615,000,000 mojo (0.000615 xch) | +| **Minting NFT without DID** | 53,000,000 | 265,000,000 mojo (0.000265 xch) | +| **Adding URI to NFT with DID** | 71,000,000 | 355,000,000 mojo (0.000355 xch) | +| **Adding URI to NFT without DID** | 41,000,000 | 205,000,000 mojo (0.000205 xch) | +| **Transfer NFT with DID** | 67,000,000 | 335,000,000 mojo (0.000335 xch) | +| **Assign DID to NFT** | 107,000,000 | 535,000,000 mojo (0.000535 xch) | | **Send Clawback Transaction** | 10,000,000 | 150,000,000 mojo (0.00015 xch) \* | -| **Claim Clawback Transaction** | 1,400,000 | 7,000,000 mojo (.000007 xch) | -| **Clawback Clawback Transaction** | 15,600,000 | 75,800,000 mojo (.0000758 xch) | -| **Combine 500 Farming Rewards** | 3,100,000,000 | 15,500,000,000 mojo (.0155 xch) | -| **Split 1 Coin into 2** | 11,000,000 | 55,000,000 mojo (.000055 xch) | +| **Claim Clawback Transaction** | 1,400,000 | 7,000,000 mojo (.000007 xch) | +| **Clawback Clawback Transaction** | 15,600,000 | 75,800,000 mojo (.0000758 xch) | +| **Combine 500 Farming Rewards** | 3,100,000,000 | 15,500,000,000 mojo (.0155 xch) | +| **Split 1 Coin into 2** | 11,000,000 | 55,000,000 mojo (.000055 xch) | | **Cat Transaction** | 37,000,000 | 555,000,000 mojo (.000555 xch) \* | diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/consensus/attacks-and-countermeasures.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/consensus/attacks-and-countermeasures.md index 1252d5259f..a163222fa7 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/consensus/attacks-and-countermeasures.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/consensus/attacks-and-countermeasures.md @@ -79,7 +79,7 @@ Finally, the formula to calculate the minimum netspace percentage required for t The following table shows the minimum required proportion of the total netspace an attacker must have in order to succeed in a majority attack. This table is valid for attacks lasting any amount of time, though sometimes it's overly conservative for attacks lasting more than one epoch. It uses fixed values for the first two columns. | Number of Timelords | VA (relative to VH) | DD | SA | Percent of netspace required | Comment | -| :-----------------: | :-----------------: | :-----: | :---: | :--------------------------: | :------------------------------------------------------------------------------------------------------------------------------------------------------------- | +|:-------------------:|:-------------------:|:-------:|:-----:|:----------------------------:|:-------------------------------------------------------------------------------------------------------------------------------------------------------------- | | 0 | N/A | 1 | ∞ | N/A | Without a timelord, the attack is not possible. | | 1 | 0.5 | 1 | 2 | 66.7% | With a 0.5x timelord, the attacker must control twice as much space as the rest of the network combined. | | ∞ | 0.5 | 1.34313 | 1.489 | 59.8% | With infinite 0.5x timelords, the attacker gains a double-dip advantage, so less space is required versus having a single timelord of the same speed. | @@ -91,7 +91,7 @@ The following table shows the minimum required proportion of the total netspace For attacks lasting longer than one epoch, `DD` will not exceed 1.34313. In such an attack, the final row from the preceding table will change to the following: | Number of Timelords | VA (relative to VH) | DD | SA | Percent of netspace required | Comment | -| :-----------------: | :-----------------: | :-----: | :---: | :--------------------------: | :------------------------------------------------------------------------------- | +|:-------------------:|:-------------------:|:-------:|:-----:|:----------------------------:|:-------------------------------------------------------------------------------- | | ∞ | 2 | 1.34313 | 0.372 | 27.1% | If the attack longer than one epoch, the double-dip advantage will be minimized. | Note that if we continue to increase `VA`, `DD` will always remain at 1.4678 for the first table, and 1.34313 for the second table. The percent of netspace required will decrease linearly. diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/consensus/forks.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/consensus/forks.md index 0105ad3c0a..d549079817 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/consensus/forks.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/consensus/forks.md @@ -3,14 +3,14 @@ title: Forks slug: /consensus-forks --- -The following table is a comprehensive list of all forks (planned and activated) on Chia's blockchain. It was last updated on 2023-09-10. It was last updated on 2023-09-10. +The following table is a comprehensive list of all forks (planned and activated) on Chia's blockchain. It was last updated on 2023-09-10. It was last updated on 2024-09-23. -| Activation Block | Activation Date | Type | Build | Status | Description | -| :--------------- | :-------------- | :--- | :---- | :---------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `2 300 000` | 2022-07-22 | Soft | 1.3.0 | Activated | [Disallow negative division](https://www.chia.net/2022/03/04/divided-we-fork/) | -| `3 630 000` | 2023-05-07 | Soft | 1.7.0 | Activated | [Restrict `AGG_SIG_UNSAFE` message](https://github.com/Chia-Network/post-mortem/blob/main/2023-05/2023-05-08-AGG_SIG_UNSAFE-can-mimic-AGG_SIG_ME-condition.md) | -| `3 886 635` | 2023-07-01 | Soft | 1.8.0 | Activated | [CHIP-14](https://github.com/Chia-Network/chips/blob/main/CHIPs/chip-0014.md) -- `ASSERT_BEFORE_*` conditions | -| `4 510 000` | 2023-11-12 | Soft | 2.0.0 | Activated | [CHIP-11](https://github.com/Chia-Network/chips/blob/main/CHIPs/chip-0011.md) -- BLS/SECP CLVM Operators | -| `5 496 000` | 2024-06-13 | Hard | 2.1.0 | Activated | [CHIP-12](https://github.com/Chia-Network/chips/blob/main/CHIPs/chip-0012.md) -- Decrease plot filter | -| `5 716 000` | 2024-07 | Soft | 2.3.0 | Released,
Not Activated | [CHIP-25](https://github.com/Chia-Network/chips/pull/98) -- Chialisp Message Conditions | -| `5 940 000` | 2024-09 | Soft | 2.4.0 | Released,
Not Activated | Disallow infinity G1 points | +| Activation Block | Activation Date | Type | Build | Status | Description | +|:---------------- |:--------------- |:---- |:----- |:--------- |:-------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `2 300 000` | 2022-07-22 | Soft | 1.3.0 | Activated | [Disallow negative division](https://www.chia.net/2022/03/04/divided-we-fork/) | +| `3 630 000` | 2023-05-07 | Soft | 1.7.0 | Activated | [Restrict `AGG_SIG_UNSAFE` message](https://github.com/Chia-Network/post-mortem/blob/main/2023-05/2023-05-08-AGG_SIG_UNSAFE-can-mimic-AGG_SIG_ME-condition.md) | +| `3 886 635` | 2023-07-01 | Soft | 1.8.0 | Activated | [CHIP-14](https://github.com/Chia-Network/chips/blob/main/CHIPs/chip-0014.md) -- `ASSERT_BEFORE_*` conditions | +| `4 510 000` | 2023-11-12 | Soft | 2.0.0 | Activated | [CHIP-11](https://github.com/Chia-Network/chips/blob/main/CHIPs/chip-0011.md) -- BLS/SECP CLVM Operators | +| `5 496 000` | 2024-06-13 | Hard | 2.1.0 | Activated | [CHIP-12](https://github.com/Chia-Network/chips/blob/main/CHIPs/chip-0012.md) -- Decrease plot filter | +| `5 716 000` | 2024-07-30 | Soft | 2.3.0 | Activated | [CHIP-25](https://github.com/Chia-Network/chips/blob/main/CHIPs/chip-0025.md) -- Chialisp Message Conditions | +| `5 940 000` | 2024-09-17 | Soft | 2.4.0 | Activated | Disallow infinity G1 points | diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/consensus/signage-and-infusion-points.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/consensus/signage-and-infusion-points.md index 29b3338426..7c603d5b39 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/consensus/signage-and-infusion-points.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/consensus/signage-and-infusion-points.md @@ -38,7 +38,7 @@ For both of our [previous example](/consensus-challenges), as well as the next e - _sub-slot_iterations = 100,000,000_ - _sp_interval_iterations = `sub-slot_iterations` / 64 = 1,562,500_ -The farmer computes the **required_iterations** for each proof of space. If the required*iterations < sp_interval_iterations, the proof of space is eligible for inclusion into the blockchain. At this point, the farmer fetches the entire proof of space from disk (which requires 64 disk seeks, or 640 ms on a slow HDD), creates an unfinished block, and broadcasts it to the network. If the \_required_iterations < sp_interval_iterations*, the proof of space is eligible for inclusion into the blockchain. At this point, the farmer fetches the entire proof of space from disk (which requires 64 disk seeks, or 640 ms on a slow HDD), creates an unfinished block, and broadcasts it to the network. +The farmer computes the **required_iterations** for each proof of space. If the required_iterations < sp_interval_iterations, the proof of space is eligible for inclusion into the blockchain. At this point, the farmer fetches the entire proof of space from disk (which requires 64 disk seeks, or 640 ms on a slow HDD), creates an unfinished block, and broadcasts it to the network. If the _required_iterations < sp_interval_iterations_, the proof of space is eligible for inclusion into the blockchain. At this point, the farmer fetches the entire proof of space from disk (which requires 64 disk seeks, or 640 ms on a slow HDD), creates an unfinished block, and broadcasts it to the network. :::info For the vast majority of eligible plots, _required_iterations_ will be far too high, since on average 32 will qualify for the whole network for each 10-minute sub-slot. This is a random process so it's possible (though unlikely) for a large number of proofs to qualify. Any plot that does meet the _required_iterations_ for a signage point will qualify as there is no rivalry between winning plots. @@ -93,9 +93,9 @@ Recall that in this example, - _sub-slot_iterations = 100,000,000_ - _= (signage \* point \* sp \* interval_iterations) + (3 \* sp_interval_iterations) + required_iterations_ -For each of the 64 signage points, as they are released to the network every 9.375 seconds, or every 1.5625M iterations, the farmer computes the plot filter and sees how many plots pass. For each passing plot, the farmer calculates required*iterations. For each passing plot, the farmer calculates \_required_iterations*. +For each of the 64 signage points, as they are released to the network every 9.375 seconds, or every 1.5625M iterations, the farmer computes the plot filter and sees how many plots pass. For each passing plot, the farmer calculates required_iterations. For each passing plot, the farmer calculates _required_iterations_. -Let's say the farmer calculates required*iterations < 1.5625M once in the sub-slot. (We'll assume the exact required_iterations = 0.7828M in this instance.) Figure 5 shows this happening at the 20th signage point. (We'll assume the exact \_required_iterations = 782,800* in this instance.) Figure 5 shows this happening at the 20th signage point. +Let's say the farmer calculates required_iterations < 1.5625M once in the sub-slot. (We'll assume the exact required_iterations = 0.7828M in this instance.) Figure 5 shows this happening at the 20th signage point. (We'll assume the exact _required_iterations = 782,800_ in this instance.) Figure 5 shows this happening at the 20th signage point. infusion_iterations is then computed as: @@ -125,14 +125,14 @@ This begs the question: why not use even more signage points in the consensus? T **Quality string**: A small part of the proof of space, 2 _x values_ out of the total 64 _x values_, which can be retrieved efficiently from disk, and which values_to_fetch is determined by the signage point. -**sp_quality_string**: A hash of the quality string concatenated with the challenge chain's signage point. This hash is what ultimately decides the "luck" of a certain proof, using the size of required*iterations. This hash is what ultimately decides the "luck" of a certain proof, using the size of \_required_iterations* +**sp_quality_string**: A hash of the quality string concatenated with the challenge chain's signage point. This hash is what ultimately decides the "luck" of a certain proof, using the size of required_iterations. This hash is what ultimately decides the "luck" of a certain proof, using the size of _required_iterations_ **sp_interval_iterations**: Defined as floor(sub-slot_iterations / 64). **Signage points**: 64 intermediary points in time within a sub-slot in both the challenge and reward chains, for which VDFs are periodically released. At each signage point, a VDF output is created and broadcast through the network. The first signage point in the sub-slot is the challenge itself. Each block has a signage point such that the proof of space in the block must be eligible for that signage point. -**required_iterations**: A number computed using the quality string, used to choose proofs of space which are eligible to make blocks. The vast majority of proofs of space will have required*iterations which are too high, and thus not eligible for inclusion into the chain. This number is used to compute the infusion point. The vast majority of proofs of space will have \_required_iterations* which are too high, and thus not eligible for inclusion into the chain. This number is used to compute the infusion point. +**required_iterations**: A number computed using the quality string, used to choose proofs of space which are eligible to make blocks. The vast majority of proofs of space will have required_iterations which are too high, and thus not eligible for inclusion into the chain. This number is used to compute the infusion point. The vast majority of proofs of space will have _required_iterations_ which are too high, and thus not eligible for inclusion into the chain. This number is used to compute the infusion point. -**Infusion point**: The point in time at infusion*iterations from the challenge point, for a proof of space with a certain challenge and infusion_iterations. At this point, the farmer's block gets infused into the reward chain VDF. The infusion point of a block is always between 3 and 4 signage points after the signage point of that block. Computed as signage_point_iterations + 3 \* sp_interval_iterations + required_iterations. At this point, the farmer's block gets infused into the reward chain VDF. The infusion point of a block is always between 3 and 4 signage points after the signage point of that block. Computed as \_signage_point_iterations + 3 \* sp_interval_iterations + required_iterations*. +**Infusion point**: The point in time at infusion_iterations from the challenge point, for a proof of space with a certain challenge and infusion_iterations. At this point, the farmer's block gets infused into the reward chain VDF. The infusion point of a block is always between 3 and 4 signage points after the signage point of that block. Computed as signage_point_iterations + 3 \* sp_interval_iterations + required_iterations. At this point, the farmer's block gets infused into the reward chain VDF. The infusion point of a block is always between 3 and 4 signage points after the signage point of that block. Computed as _signage_point_iterations + 3 \* sp_interval_iterations + required_iterations_. The delay between the signage point and infusion point has many benefits, including defense against orphaning and selfish farming, decreased forks, and no VDF pauses. This delay of around 28 seconds is given so that farmers have enough time to sign without delaying the slot VDF. Well-behaving farmers sign only one signage point with each proof of space, meaning that attackers cannot easily reorg the chain. diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/farming/dual-farming-testnet-mainnet.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/farming/dual-farming-testnet-mainnet.md index 9343d3cbf7..fcda74b8eb 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/farming/dual-farming-testnet-mainnet.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/farming/dual-farming-testnet-mainnet.md @@ -47,27 +47,25 @@ chia configure --testnet true ```bash yq -i '.daemon_port = 55401' ./config.yaml yq -i '."*".log_syslog_port = 1514' ./config.yaml -yq -i '.data_layer.port = 10561' ./config.yaml + yq -i '.data_layer.rpc_port = 10562' ./config.yaml yq -i '.data_layer.wallet_peer.port = 11256' ./config.yaml -yq -i '.data_layer.host_port = 10565' ./config.yaml +yq -i '.data_layer.host_port = 10575' ./config.yaml yq -i '.farmer.port = 10447' ./config.yaml yq -i '.farmer.rpc_port = 10559' ./config.yaml -yq -i '.farmer.harvester_peer.port = 10448' ./config.yaml -yq -i '.harvester.port = 10448' ./config.yaml yq -i '.harvester.rpc_port = 10560' ./config.yaml -yq -i '.harvester.farmer_peer.port = 10447' ./config.yaml +yq -i '.harvester.farmer_peers.port = 10447' ./config.yaml -yq -i '.wallet.port = 10449' ./config.yaml yq -i '.wallet.rpc_port = 11256' ./config.yaml yq -i '.full_node.rpc_port = 10555' ./config.yaml -yq -i '.full_node.wallet_peer.port = 10449' ./config.yaml -yq -i '.full_node.farmer_peer.port = 10447' ./config.yaml -yq -i '.ui.port = 10222' ./config.yaml +yq -i '.timelord.rpc_port = 10557' ./config.yaml +yq -i '.timelord.vdf_server.port = 10000' ./config.yaml +yq -i '.timelord_launcher.port = 10000' ./config.yaml + yq -i '.ui.rpc_port = 10555' ./config.yaml yq -i '.ui.daemon_port = 55401' ./config.yaml ``` diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/farming/farming-basics.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/farming/farming-basics.md index bba5e90650..425c3ad176 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/farming/farming-basics.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/farming/farming-basics.md @@ -35,7 +35,7 @@ Every three years, there is a scheduled halving of the block reward. Every three 以下是完整的区块奖励计划： -| 年份 | 区块奖励 | XCH / 10 mins | +| 年份 | 区块奖励 | XCH / 10 mins | | ----- | --------- | ------------- | | 1-3 | 2.0 XCH | 64 | | 4-6 | 1.0 XCH | 32 | diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/farming/farming-many-machines.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/farming/farming-many-machines.md index e51cb519dd..dc29076982 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/farming/farming-many-machines.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/farming/farming-many-machines.md @@ -38,19 +38,7 @@ If you are more of a visual learner, JM made a video outlining the steps from th chia init ``` -- When creating plots on the harvesters, run: - - ```bash - chia plots create -f -p - ``` - - Where `` and `` can be obtained by running the following command on your main machine: - - ```bash - chia keys show - ``` - - 在生成地块后，请运行`chia plots check`命令确保一切正常运行。 +- When creating plots on the harvesters, run the correct command based on which plotter you want to use. More information about the plotters available and their usage can be found here: https://docs.chia.net/plotting-software/ - A copy of your **main** machine CA directory needs to be accessible by your harvester machines. This directory is located in: This directory is located in: @@ -187,7 +175,7 @@ chia start -r farmer #### 在多台机器上生成地块 -As stated [above](/farming-on-many-machines#先决条件), run the following command when creating plots: +As stated [above](/farming-on-many-machines#prerequisites), run the following command when creating plots: ```bash chia plots create -f -p @@ -197,7 +185,7 @@ When you use the `-f` and `-p` parameters, you do not need to copy the keys to t #### 在多台机器上进行收割 -Rather than maintaining a copy of your farmer's certificates on each harvester, follow the [above](/farming-on-many-machines#先决条件) steps to keep them in one place while farming. +Rather than maintaining a copy of your farmer's certificates on each harvester, follow the [above](/farming-on-many-machines#prerequisites) steps to keep them in one place while farming. ### 钱包保持独立(Separate) diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/farming/pool-farming.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/farming/pool-farming.md index b3697c8046..0572af6973 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/farming/pool-farming.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/farming/pool-farming.md @@ -15,7 +15,7 @@ Chia的联合耕种协议（pooling protocol）允许将地块分配给“联合 :::note -The official pooling protocol was introduced in version 1.2 in mid-2021. All plots created before this point, as well as newer plots created with following the pooling protocol, are not eligible for pooling. The official pooling protocol was introduced in version 1.2 in mid-2021. All plots created before this point, as well as newer plots created with following the pooling protocol, are not eligible for pooling. If you have any of these "OG" plots, you can either recreate them using a plot NFT, or co-farm them on the same machine as your official pool plots. +The official pooling protocol was introduced in verion 1.2 in mid-2021. All plots created before this point, as well as newer plots created with following the pooling protocol, are not eligible for pooling. The official pooling protocol was introduced in verion 1.2 in mid-2021. All plots created before this point, as well as newer plots created with following the pooling protocol, are not eligible for pooling. If you have any of these "OG" plots, you can either recreate them using a plot NFT, or co-farm them on the same machine as your official pool plots. ::: @@ -59,7 +59,7 @@ chia plotnft create -s local chia plotnft create -s pool -u https://bar.examplepool.org ``` -请注意，即便选择的是选项1，以后仍然可以加入联合耕种池，并且可以随时切换到其它池。 如果决定加入一个联合耕种池，请输入网址 (必须以 *https://*开头)，然后查看描述。 如果同意, 则开始创建联合耕种农田, 并等待它被确认 (只点击一次)。 这可能需要几分钟的时间才能得到确认，然后出现在“联合耕种”选项卡中。 您只需要 1 个联合耕种农田。 +请注意，即便选择的是选项1，以后仍然可以加入联合耕种池，并且可以随时切换到其它池。 如果决定加入一个联合耕种池，请输入网址 (必须以 _https://_开头)，然后查看描述。 如果同意, 则开始创建联合耕种农田, 并等待它被确认 (只点击一次)。 这可能需要几分钟的时间才能得到确认，然后出现在“联合耕种”选项卡中。 您只需要 1 个联合耕种农田。 #### 使用图形用户界面（GUI） @@ -112,7 +112,7 @@ You can now start creating plots for this Plot NFT, which means these plots will Detailed instructions can be found in the "How to Plot" page: - Plotting from the [CLI](/plotting-how-to#cli-plotting) -- Plotting from the [GUI](/plotting-how-to#图形用户界面gui生成地块) +- Plotting from the [GUI](/plotting-how-to#gui-plotting) ### 第五步：管理联合耕种农田。 diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting-started/cloud-wallet/faq.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting-started/cloud-wallet/faq.md new file mode 100644 index 0000000000..61c472e232 --- /dev/null +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting-started/cloud-wallet/faq.md @@ -0,0 +1,199 @@ +--- +slug: /getting-started/cloud-wallet/faq +title: FAQ +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +## Cloud Wallet + +### What is the Chia Cloud Wallet? + +The Cloud Wallet is a new platform for interacting with the Chia blockchain. Assets are stored in vaults, in an app that is always synced with the blockchain. This makes it easy for newcomers to get started with Chia; it also provides a secure custody solution. In addition, it will eventually include an API for developers in Chia's ecosystem to make dApps that use the Chia blockchain. + +### Is the Chia Cloud Wallet available for mainnet? + +Not yet. It is currently in beta on testnet11. + +### How can I obtain some TXCH for testnet11? + +Visit either our [official faucet site](https://testnet11-faucet.chia.net) or a [community-run faucet](https://txchfaucet.com), and enter your txch address. You should receive some funds for testing within a few minutes. + +### How do I get started with the Cloud Wallet? + +Visit the [Cloud Wallet website](https://vault.chiatest.net) and sign up for a free account. + +### How is the Cloud Wallet different from other wallets? + +The Cloud Wallet comes with several advantages versus existing wallets that support Chia assets: +CNI runs several dedicated nodes to support the wallet. This means that the wallet is always synced. +Cloud Wallet assets are secured in a vault instead of with a single BLS key. Vaults are described in detail below, but their primary advantage is that they use multiple keys, which makes them more secure than single-key wallets. + +Cloud Wallet vaults can be secured with either a passkey or with the Chia Signer app, which is described in detail below. + +### Will the Cloud Wallet replace the reference wallet? + +It depends on your use case. The Cloud Wallet will not be used for Chia farming, so farmers will continue to use the reference wallet for creating plots, as well as for farming. Other users might want to migrate to the Cloud Wallet at some point. + +### What if I don't want my Cloud Wallet to connect to Chia's nodes? + +For maximum trustless usage, we will eventually support syncing your Cloud Wallet against a node of your choosing. However, we haven't implemented this feature yet. + +### What is a passkey? + +A passkey provides a way to log onto websites and apps without a username and password. It also can be used for signing digital transactions. There are many locations and devices where you can save a passkey, for example in a hardware key such as a [Yubico](https://www.yubico.com) Yubikey, in a password manager such as [1Password](https://1password.com), or in your OS keychain. [This article](https://www.pcmag.com/explainers/passwordless-authentication-what-it-is-and-why-you-need-it-asap) gives a good overview of what passkeys are and how you can use them. + +### How does the Cloud Wallet use passkeys? + +Two ways – as a replacement for logging in with your email and password, and as a vault signer. + +### What is a vault? + +A vault is a new way to custody your assets on Chia's blockchain. Instead of securing your XCH, CATs, NFTs, etc with a single key, a vault uses multiple keys and more advanced custody rules. The current iteration of Chia vaults have two keys – one for signing transactions (either a passkey or a hardware key from the Chia Signer app), and one for recovery purposes (a BLS key). + +### What is the advantage of using a vault instead of a wallet? + +Standard wallets on Chia as well as other blockchains only have one key. If this key is lost or stolen, then all of the funds custodied in the wallet will also be lost or stolen. The security assumptions surrounding standard wallets are disconcerting to retail and enterprise users alike. By using Chia vaults, users can feel confident that their funds will remain secure even if one of their keys is lost, and often (as discussed below) if it is stolen. + +### Why do I see “Your vault is being minted, the address will be available soon.” after I create a vault? + +A vault needs to be created on the blockchain after you click the “Create” button. We have set up a faucet to handle this automatically. However, it does take a few minutes for the on-chain transaction to be processed. You should receive an address within five minutes. + +### Can I import an existing wallet into the Cloud Wallet by entering a seed phrase? + +Not at the moment. Currently the Cloud Wallet only supports vaults. We may add support for standard BLS wallets, but we haven't made that decision yet. + +### How is signing different with the Chia vault than with the reference wallet? + +In the reference wallet, the key used for signing transactions is located on the same device as the wallet. While this setup is still possible when using vaults, it is also possible to keep your signer on a separate device. By separating your vault from its signer, the Cloud Wallet presents a more secure self-custody solution than existing Chia-based wallets. + +### What plans will exist for the Cloud Wallet, and how much will they cost? + +We plan to release three tiers with the Cloud Wallet: + +- Free Tier – currently available, albeit in beta form. It includes one vault, with a single custody key and a single recovery key. The free tier will provide easy onboarding for new users, and will offer a more secure solution than what exists in most of the industry. +- Prosumer Tier (coming soon) – will include support for multisig vaults, as well as some advanced trading tools. This will be the perfect solution for individuals and small groups who want to share custody, as well as for high-frequency traders. It will be available for a monthly fee. +- Enterprise Tier (coming soon) – will provide custody, management, and support solutions for large enterprises. + +### Are you planning to improve upon the existing vault technology? + +是的。 The current vaults are 1-of-1 for signing, and 2-of-2 for loss of funds. The next step is to introduce m-of-n multisig vaults for both signing and recovery. Longer term, we plan to introduce vaults with significantly more flexibility, which will be useful for end users and large enterprises alike. Stay tuned… + +### Where can I go for support? + +Feel free to ask questions in the #support channel of [our Discord](https://discord.gg/chia). + +### Where can I report a bug? + +If you find any bugs, feel free to fill out a [bug report](https://docs.google.com/forms/d/e/1FAIpQLSeIAZAxSwTwZPGUVLs7_XKseoPgOmtBa0qhtWNQwBeoo9adRA/viewform). However, please keep in mind that this is beta software. We are aware of several existing bugs, which we are tracking in a [list](/getting-started/cloud-wallet/known-issues/). + +If you discover any security issues, you can file a report on our [bug bounty site](https://hackerone.com/chia_network). Thanks for your help! + +## Recovery + +### What happens if I lose my custody key? + +You can use your recovery key to swap out the lost key for a new one. + +### What happens if my custody key is stolen? Will all of my funds be stolen? + +It depends. For example, the Chia Signer app recommends using biometric authentication such as a fingerprint or face ID. With this setup, if a thief steals your phone, they will not be able to access the Chia Signer app, and thus your funds will remain secure. You can procure a new smartphone and initiate the recovery process in order to restore your funds. + +However, the current setup is not secure against wrench attacks, where the thief forces you to use your biometrics to sign a transaction to steal all of your funds. Our upcoming multisig solution will be secure against such attacks, as will our longer-term custody solution. + +### What happens if I lose my recovery key? + +You can use your custody key to send your funds to a new vault. + +### What happens if my recovery key is stolen? Will all of my funds be stolen? + +A recovery key can only be used for recovering a vault. If this key is stolen, the thief will not immediately be able to steal your funds. However, they will likely attempt to recover your vault. In this case, the watchtower will send you an email notifying you that your vault is now in recovery mode. The recovery can only be completed after a preset timer has expired. Until this time, you can cancel the recovery and move your funds to a new vault. + +## Watchtowers + +### What is a watchtower? + +In a Web3 context, a watchtower is a program that monitors a blockchain for events, and takes action when they occur. The first Chia watchtower will look for attempted vault recoveries. When such a recovery is initiated, the watchtower will email the owner of the vault that is being recovered. If the recovery attempt is legitimate, the owner doesn't need to take any action. However, if the recovery is malicious, then the owner can cancel it. + +### What other types of watchtower will you develop? + +We plan to deploy watchtowers to notify users of incoming offers, incoming transactions, and transactions that were affected by a blockchain re-org. We may implement watchtowers for further events in the future. + +### Can I develop my own watchtower? + +Yes! The Chia blockchain is a public ledger, so anyone can build software to monitor it. We may open-source some of our watchtower code as well, which would make it easier for community members to create custom watchtowers for their own needs. + +## Chia Signer + +### What is the Chia Signer app? + +The Chia Signer app turns your smartphone into a hardware wallet. The app uses your phone's Secure Enclave to create a vault custody key. This key cannot be removed from the device, so a thief would need to gain physical access to your phone in order to steal it. You can download it from the [iOS App Store](https://apps.apple.com/app/chia-signer/id6504493785). + +:::info + +Currently, in order to use the Chia Signer app, you will need two separate devices: + +1. A computer or phone to access your vault +2. An iOS device on which the Chia Signer app is installed + +You cannot use both the Cloud Wallet and the Chia Signer app on the same device yet. However, we do intend to enable this functionality in a future release. + +::: + +### Is the Chia Signer app available for both Android and iOS? + +It is currently only available for iOS. We will build an Android version in the future. + +### On which iOS devices is the Chia Signer app supported? + +The app has two requirements for iOS devices: + +1. The device must run iOS 15 or later +2. The device must have a Secure Enclave + +The following devices meet both of these requirements: + +- iPhone models beginning with the iPhone 6 +- iPad models beginning with the iPad mini 4 + +Be sure to double check that your device is running at least iOS 15 prior to installing the Chia Signer app. + +### Is it safe to install the Chia Signer app on a second-hand device? + +Yes -- just be sure to do a factory reset of the device first. See [Apple's support site](https://support.apple.com/guide/iphone/iph7a2a9399b/ios) for instructions. + +### Does the Chia Signer app use blind signing? + +No, but it doesn't use clear signing yet, either. The user is shown the details of the transaction before signing it. This info is significantly more detailed than what can be seen on the small screens of most hardware wallets. However, the end user needs to trust that CNI's servers have not been compromised, so it also isn't clear signing. The light amount of trust required should be sufficient for most users. However, for users who want to sign large transfers with the Chia Signer app, we plan to develop true clear signing in the future. + +### Can I use the Chia Signer app to sign into my Cloud Wallet account? + +No, the Chia Signer app is only for signing transactions. You will need to use either a password or a passkey to sign into your Cloud Wallet account. + +## Security and privacy + +### Will CNI be able to freeze and/or confiscate my assets? + +No. CNI won't custody any of your assets, so it won't have the ability to freeze or confiscate them. If the Cloud Wallet website were forcibly shut down, you would still have the ability to spend your assets because you would still be in control of the keys associated with your vault. However, the infrastructure to accomplish this would need to be rebuilt. + +### What risks do end users take regarding CNI's control of the Cloud Wallet website? + +One of the advantages of using vaults is that their custody keys are not directly accessible to the website or its APIs. + +The two risks for Cloud Wallet end users are: + +1. CNI can be forced to turn over metadata to various law enforcement. However, we don't save much metadata beyond what is already available on the blockchain. +2. An attacker could set up a man-in-the-middle attack when you are signing a transaction. The amount of trust required when using the Signer app is already minimal. In the future, we will enable full clear signing, as well as the ability to run the Cloud Wallet against your own full node in order to mitigate this attack vector. + +### Do vaults always use the same address? + +Yes, and this is a departure from the reference wallet, which uses a new address for each transaction. The reason vaults always use the same address is because they are singletons -- the vault itself authorizes the spend of coins under its control, as opposed to standard wallets which are derived from BLS keys. + +Users must carefully consider the privacy (and therefore security) implications of reusing an address. When the address doesn't change, it becomes easier to put together a historical record of transactions. Vaults that hold significant value could therefore be targeted with physical attacks, as explained in [a Bitcoin wiki](https://en.bitcoin.it/wiki/Address_reuse). + +Future versions of vaults will have additional security such as multisigs and time locks to mitigate the risk of physical attacks. + +### Will the Chia Signer app be open source? + +Yes diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting-started/cloud-wallet/getting-started.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting-started/cloud-wallet/getting-started.md new file mode 100644 index 0000000000..ccf87d6341 --- /dev/null +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting-started/cloud-wallet/getting-started.md @@ -0,0 +1,146 @@ +--- +slug: /getting-started/cloud-wallet/getting-started +title: Getting Started +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Welcome to the Chia Cloud Wallet, a new platform for interacting with the Chia blockchain. Assets are stored in vaults, in an app that is always synced with the blockchain. The Cloud Wallet is currently in beta, running on testnet11. + +This guide will show you how to create your first Cloud Wallet vault in a few easy steps. + +1. Browse to the [Cloud Wallet website](https://vault.chiatest.net). + +2. Click the `Sign Up` button: + +
+ Welcome to the Cloud Wallet +
+ +3. Enter your email address and click `Continue`. + +4. Within a few minutes, you should receive an email with the subject "Chia cloud wallet email verification link". Click the link in the email. + +5. Enter your name and click `Set new Passkey`: + +
+ Set a new passkey +
+ +6. You will be given a variety of options for adding a new passkey, for example in a hardware key, a password manager, or the OS keychain. This passkey will be your primary method for signing into the Cloud Wallet. It can also be used for signing Chia transactions. + +Congratulations, you're all set to create your first vault! + +## Create a vault + +:::info + +Currently, in order to use the Chia Signer app, you will need two separate devices: + +1. A computer or phone to access your vault +2. An iOS device on which the Chia Signer app is installed + +You cannot use both the Cloud Wallet and the Chia Signer app on the same device yet. However, we do intend to enable this functionality in a future release. + +::: + +1. The free tier of the Cloud Wallet only allows you to create a single vault, so you will need to choose from one of the two options. Let's create a vault using the Chia Signer app: + +
+ Create vault with signer app +
+ +2. Give your vault a name, for example `My Signer Vault`. + +3. You will need to scan the QR code using your Chia Signer app. If you don't have the app yet, you can download it from the [iOS App Store](https://apps.apple.com/app/chia-signer/id6504493785). + + Note: The Chia Signer app currently is only built for iOS devices. We will build an Android version of the app in the future. + +
+ Create vault with signer app +
+ +4. From the Chia Signer app, tap the `+` button in the upper-right corner to add a new key: + +
+ Create a new key +
+ +5. Give your new key a name, for example `My Key`. Currently, the only option is to create a hardware key directly in your device's Secure Enclave. Tap `Generate Key`: + +
+ Generate a hardware key +
+ +6. Your new key will show up in the app's main screen. Tap the button in the lower-middle part of the app and scan the QR code: + +
+ Tap the scan button +
+ +7. Tap `Choose a key`: + +
+ Tap the Choose a key button +
+ +8. Tap your new key: + +
+ Tap your new key +
+ +9. Tap the `Link key` button: + +
+ Link your key to your vault +
+ +10. If a green check box appears over the QR code, then your signer app was successfully linked to your vault: + +
+ Signer successfully linked +
+ +11. Next, copy the 24 words to a safe location. You will need to recall these words in order to recover your vault, so don't lose them. + +12. You can also set a custom time for your vault's recovery clawback. This is the amount of time you will need to wait in order to recover your vault. If your 24-word recovery phrase is stolen, then you will have this long to cancel the recovery. + +Note that for the testnet beta version of the Cloud Wallet, the default timer is 15 minutes. If this were a real vault running on mainnet, then you would likely want to set the timer to a day or more. + +13. Click the `Create` button to create your vault. A "vault faucet" will mint a new vault for you. Your vault's receive address will appear after this process is complete (typically a minute or two). + +You are now ready to receive funds in your new vault. Testnet11 uses a test currency called TXCH. To obtain some TXCH, you can visit either our [official faucet site](https://testnet11-faucet.chia.net) or a [community-run faucet](https://txchfaucet.com), and enter your vault's address. You should receive some funds for testing within a few minutes. + +
+ Vault with 1 txch +
+ +## Sending funds + +Your vault uses the Chia Signer app to sign transactions. Click the `Send` button to begin the process of sending funds. + +1. Enter a destination address, amount to send, and an optional blockchain fee, then click `Send`: + +
+ Enter info and click Send +
+ +2. You will be shown the details of the transaction: + +
+ View transaction details +
+ +3. Simultaneously, your device with the Chia Signer app should receive a push notification with a signature request. This notification will contain the details of the transaction. Scroll through this request to ensure that everything matches what you see from the Cloud Wallet, and tap `Sign transaction`: + +
+ Signature request +
+ +4. You should see a "success" message on both the Chia Signer app and the Cloud Wallet: + +
+ Successfully signed +
diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting-started/cloud-wallet/known-issues.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting-started/cloud-wallet/known-issues.md new file mode 100644 index 0000000000..ef1f17ffff --- /dev/null +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting-started/cloud-wallet/known-issues.md @@ -0,0 +1,42 @@ +--- +slug: /getting-started/cloud-wallet/known-issues +title: Known Issues +--- + +This list was last updated on 2024-12-09. Although there are many items in this list, most of them are minor issues or issues that occur rarely. In addition, while we will attempt to keep this list up to date, it may fall behind on occasion. This is not meant to be a comprehensive list. + +- Recovery is not yet enabled for vaults that use the Chia Signer app +- The fee field doesn’t work yet for recovery operations (initiate, cancel, complete) +- Long vault names are truncated; this is a display issue only +- Vaults currently can be named with all whitespace (space/tab) characters; this will be disallowed in the future +- The Chia Signer app is only for signing transactions; the current signup process doesn't make it completely clear that the app cannot be used for logging into the Cloud Wallet. We will make this clearer in the future. +- The transaction history may not show all incoming transactions, even when the balance is accurate +- The error message that appears when you enter an invalid Send address is not very descriptive +- When setting up a vault on an iPhone, the fields for inputting up the clawback timer might not show any numbers +- If you attempt to add a passkey, but then click the X to close out of the window, it will give you an error +- If you send funds to your own vault, the transaction will show an amount of 0 +- In rare occurrences, when creating an account, you might see "Internal Server Error" +- You may see "User not found for this passkey" when attempting to create an account with a passkey +- We are in the process of updating the mobile UI, so certain buttons and labels may look bad on a mobile device for now +- Some users have reported seeing "vault.chiatest.net's DNS address could not be found...." when using the Brave browser +- Upon cancelling a recovery, an extra signature dialog is displayed +- You may receive two identical copies of the same watchtower email upon successfully completing a recovery +- The previous view of the home screen will briefly flash after a new vault is created; this lasts less than one second until the correct view is displayed +- After successfully cancelling a recovery, you may see a "Something went wrong" message; refresh your browser window to workaround this issue +- The initial timer displayed for cancelling a recovery is hardcoded to 15 minutes; however, the actual timer is correct +- You might receive two copies of the same email upon successfully completing a recovery +- The recovery timer will show "0 minutes" remaining when, in fact, there is less than one minute remaining; this is a simple rounding error which will be resolved when the timer actually reaches 0 +- After a successful recovery, the first transaction in the vault’s history shows an extra mojo +- The signing modal dialog occasionally takes over 30 seconds to be displayed +- When sending CATs, the "amount" field is missing a label, and the "fee" field is labeled as "unknown CATs"; these are display issues only +- CATs sent to the same vault as where they originated are listed as "0 Unknown CATS" +- An unsigned spend will get `Settled` Status when the next spend succeeds and is settled +- If the Cloud Wallet is left inactive for a long time, "Something went wrong" might be displayed; refreshing the browser tab will work around this issue +- For now, in order to paste a seed phrase when initiating a recovery, you must paste the phrase into the first word field +- Coins might be locked if certain transactions fail, and it’s not obvious how to unlock them; however, this is an uncommon occurrence +- On rare occasions, selecting a custody key will result in it not being possible to return to the main screen. \* Log out and log back in to work around this issue for now +- If a "Fee too low" error is encountered (a rare occurrence), a transaction may enter a "signed" state, but it is not submitted to the mempool +- Unrecognized CATs (which includes all CATs for now) are each listed as "Unknown CAT2" without an obvious way to differentiate them +- The balance and transaction count can be out of sync in vaults with hundreds of transactions +- When creating a vault with a bitwarden passkey, it’s possible to receive a "Memory access out of bounds" error +- You can’t create a new vault with the same name as a deleted vault diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting-started/cloud-wallet/tooltips.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting-started/cloud-wallet/tooltips.md new file mode 100644 index 0000000000..7f44beaf49 --- /dev/null +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting-started/cloud-wallet/tooltips.md @@ -0,0 +1,41 @@ +--- +slug: /getting-started/cloud-wallet/tooltips +title: Tooltips +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +This page contains tooltip links from the Cloud Wallet. It provides some basic info about the various components. + +## Recovery + +This is the process of rekeying a vault. If your custody key is lost or stolen, you can swap it out for a new one. For example, if someone steals your smartphone where your Chia Signer app is installed, you can obtain a new phone, install the Chia Signer app, and create a new hardware key. You can then instruct your vault to replace the stolen key with the new one. The recovery process also allows you to change your recovery key if desired. + +## Custody Key + +This is a vault’s primary key used for signing transactions. It can be either a passkey or a hardware key from the Chia Signer app. + +## Recovery Key + +This key can only be used for recovering a vault. It cannot be used for signing transactions. Currently it must be a BLS key. In the future, we will also enable passkeys, as well as hardware and software keys from the Chia Signer app. + +## Transaction Fee + +A fee for speeding up your transaction’s confirmation time if the network is busy. Testnet11 is often being dusted with small transactions, so we recommend including a fee whenever possible. Typically 0.001 TXCH is sufficient for fast confirmation on testnet11. + +## Recovery Clawback + +When you create a new vault, you need to input the amount of time to wait before a recovery can be completed. This is the "recovery clawback" time. During this time window, you can cancel the recovery if it was initiated maliciously. Note that the default recovery clawback time for the beta is 15 minutes. On mainnet, most people will want to set this to something like 48-72 hours in order to provide ample time to cancel the recovery if necessary. + +## Recovery Phrase + +If you use a BLS key as the recovery key, you will be given a series of 24 words to copy. This is the recovery phrase. You will need to enter this phrase upon initiating a vault recovery. Be sure to copy this phrase carefully, and don’t show it to anyone. We don’t store a copy of this phrase, so we can only show it to you when you create your vault. + +## Recovery Timer + +This is the amount of time you must wait before a recovery operation can be completed. The timer is set upon the vault’s creation, and it can only be modified during a recovery. For example, when you create a vault, if you set this timer to 3 days, then after you initiate a recovery, you will need to wait for 3 days to complete it. During that time, you can cancel the recovery. The reason this timer exists is so that if someone steals your recovery key, you can cancel any recovery attempts, and send your assets to a new vault. + +## Signer App + +A smartphone app initially available for iPhones made after 2013. The app stores a spend key in its Secure Enclave. This key cannot be copied or removed from the phone, so the only way to steal it is to gain physical access to the device. For this reason, we strongly recommend that you secure the Signer app using your phone’s biometrics. diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting-started/cloud-wallet/unfinished.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting-started/cloud-wallet/unfinished.md new file mode 100644 index 0000000000..16525b5ca6 --- /dev/null +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting-started/cloud-wallet/unfinished.md @@ -0,0 +1,45 @@ +--- +slug: /getting-started/cloud-wallet/unfinished +title: Unfinished Components +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +While the Cloud Wallet public beta has most of its planned features in place, it is currently missing a few things that will be included in the production release. + +## Recovery for Chia Signer Vaults + +Vaults that use the Chia Signer app as their signer cannot yet perform a recovery. While the APIs for recovering these vaults are working, the GUI is not yet ready. We are actively working on finishing this. + +## Recovery for Unlisted Vaults + +Currently, if you lose access to your Cloud Wallet and signer passkey (for example, if you are accessing your account from a smartphone, and this phone is stolen), the app does not have a method for recovering your vault. We are working on implementing this. + +## CAT Naming + +Sending and receiving CATs does currently work. However, the Cloud Wallet does not yet map CATs to their TAILs. This results in all CATs being labeled as “Unknown”. This is only a local labeling issue, which does not affect the assets themselves. + +## Address Book + +We plan to add an address book in order to make it easier to send assets to known addresses. + +## Offers + +We plan to include basic offers, similar to what exists in the reference wallet. + +## Swaps + +We plan to integrate support for TibetSwap in the Cloud Wallet app. + +## NFTs + +We plan to support NFTs, similar to what exists in the reference wallet. + +## Clawback + +We plan to support basic clawback transactions, similar to what exists in the reference wallet. + +## Separate Passkeys + +Currently, all Cloud Wallet passkeys are used for both signing into the app and for signing vault transactions. We plan to separate these functionalities to allow separate passkeys to be used. diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting-started/farming-guide.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting-started/farming-guide.md index 043ac74a80..b169488e45 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting-started/farming-guide.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting-started/farming-guide.md @@ -6,9 +6,6 @@ slug: /farming-guide import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -import WalletKeyDetails from '@site/static/img/troubleshooting/wallet_key_details.png'; -import WalletKeysPublic from '@site/static/img/faq/wallet_keys_public_key.png'; -import WalletLogout from '@site/static/img/troubleshooting/wallet_logout.png'; So you want to be a Chia farmer? You've come to the right place! @@ -66,8 +63,7 @@ In order to store the blockchain database, an SSD with at least 520 MB/s read/wr :::info -Let's say you have a computer without much free space. If you add a 1024-GB external SSD, it will be sufficient to create and store a plot, as well as to store the blockchain database. This will not be an ideal setup for -creating a larger farm. But if you already have this equipment, you can set up a small farm without spending any money. +Let's say you have a computer without much free space. If you add a 1024-GB external SSD, it will be sufficient to create and store a plot, as well as to store the blockchain database. This will not be an ideal setup for creating a larger farm. But if you already have this equipment, you can set up a small farm without spending any money. ::: @@ -82,6 +78,7 @@ Two check boxes will be shown on the last screen after the install has completed
Check both boxes
+
## Run and configure Chia @@ -91,6 +88,7 @@ The first time Chia starts, you will be given the option to run in either Wallet
Choose farming mode
+
### Create a wallet @@ -100,21 +98,23 @@ Assuming you don't have a wallet yet, click `CREATE A NEW WALLET KEY` (If you al
Create a new wallet key
+
-You will be presented with a list of twenty-four words. This is your wallet's recovery phrase. These words are all that are needed to recover your wallet on a new computer. Write them down and store them in a safe place. The order of the words is also important. +You will be presented with a list of twenty-four words. This is your wallet's recovery phrase. These words are all that are needed to recover your wallet on a new computer. Write them down and store them in a safe place. The order of the words is important. This is your wallet's recovery phrase. These words are all that are needed to recover your wallet on a new computer. Write them down and store them in a safe place. The order of the words is also important. -You can also choose a custom name for your wallet. Click `NEXT` when you are finished. +You can also choose a custom name for your wallet. Click `NEXT` when you are finished. Click `NEXT` when you are finished. :::warning -If someone obtains a copy of these words, they can steal your entire wallet, including all of its funds. Be sure to store your recovery phrase in a safe place. +If someone obtains a copy of these words, they can steal your entire wallet, including all of its funds. Be sure to store your recovery phrase in a safe place. Be sure to store your recovery phrase in a safe place. -::: +:::
Wallet seed phrase
+
You will be taken to your wallet, which will show a zero-XCH balance. There will be two round icons in the upper-right corner, one for the full node and one for the wallet: @@ -125,14 +125,14 @@ You will be taken to your wallet, which will show a zero-XCH balance. There will
Zero wallet balance
+
### Fund your wallet If you think you will ever want to join a pool (recommended for small and medium farms), you will need at least one mojo (one trillionth of an XCH). To help with this, we have set up an online faucet at [faucet.chia.net](https://faucet.chia.net/). -To use the faucet you will need to identify your **Master Public Key** (also referred to as the **Public Key**). -You can use either the GUI or CLI to identify the Master Public Key by following these steps: +To use the faucet you will need to identify your **Master Public Key** (also referred to as the **Public Key**). You can use either the GUI or CLI to identify the Master Public Key by following these steps: #### GUI @@ -191,7 +191,7 @@ For more security best practices please review the [Securing Your Chia – How t :::info -You can continue with this guide while waiting for your faucet payment to arrive. +You can continue with this guide while waiting for your 100 mojos to arrive. ::: @@ -202,6 +202,7 @@ Click the `Full Node` icon on the left side of your wallet:
Syncing from genesis
+
This screen shows your node's syncing status. In order to farm Chia, your node needs to be fully synced. You have two options to achieve this: @@ -252,11 +253,12 @@ Click the `Pooling` icon on the left side of your wallet, and click `JOIN A POOL
Join a pool
+
Before you can join a pool, you will need to create a plot NFT. This will allow you to easily change pools later. -Select `Connect to pool`. You will need to enter a valid pool URL. We will use OpenChia for this example, but there are many great pools to choose from. For a list of reputable pools, see [Chialinks.com](https://chialinks.com/pools/). (Chia Network Inc. does not run a pool, and is not affiliated with OpenChia or Chialinks). +Select `Connect to pool`. You will need to enter a valid pool URL. We will use OpenChia for this example, but there are many great pools to choose from. `Connect to pool` -- You will need to enter a valid pool URL. We will use OpenChia for this example, but there are many great pools to choose from. For a list of reputable pools, see [Chialinks.com](https://chialinks.com/pools/). (Chia Network, Inc. does not run a pool, and is not affiliated with OpenChia or Chialinks). (Chia Network Inc. does not run a pool, and is not affiliated with OpenChia or Chialinks). :::info @@ -264,11 +266,12 @@ If you don't want to join a pool, select `Self pool`. This will assign you to a ::: -Creating a plot NFT requires an on-chain transaction that will cost one mojo. You are also recommended to enter a blockchain fee. If you used the faucet, you will now have 100 mojos. Depending on how busy the network is, a one-mojo fee is typically enough to complete your transaction within a few minutes. +Creating a plot NFT requires an on-chain transaction that will cost one mojo. You are also recommended to enter a blockchain fee. Depending on how busy the network is, a one-mojo fee is typically enough to complete your transaction within a few minutes. You are also recommended to enter a blockchain fee. If you used the faucet, you will now have 100 mojos. Depending on how busy the network is, a one-mojo fee is typically enough to complete your transaction within a few minutes.
Create a plot NFT
+
:::info @@ -279,18 +282,20 @@ If your faucet payout has not arrived after more than 10 minutes, someone on [Di ::: -If you entered a valid pool URL, the details will pop up. For example, this pool has a fee of 1%. If everything looks acceptable, click `CREATE`: +If you entered a valid pool URL, the details will pop up. For example, this pool has a fee of 1%. If everything looks acceptable, click `CREATE`: For example, this pool has a fee of 1%. If everything looks acceptable, click `CREATE`:
Pool details
+
-Your transaction will be pushed to the blockchain. While it is pending, a new screen will appear: +Your transaction will be pushed to the blockchain. While it is pending, a new screen will appear: While it is pending, a new screen will appear:
Plot NFT pending
+
After the transaction has been finalized (typically 1-3 minutes), the details of your plot NFT will appear: @@ -298,6 +303,7 @@ After the transaction has been finalized (typically 1-3 minutes), the details of
Plot NFT details
+
A two-word name will automatically be assigned to your plot NFT, in this case "Harlequin Koala". In order to determine how much space you are contributing, your pool will periodically send you challenges. If you want to change pools later, simply return to this screen and click `CHANGE POOL`. @@ -310,7 +316,7 @@ Pools typically require you to wait for 30 minutes before leaving. This is to pr :::info -Chia's pooling protocol has several significant advantages over pools on other blockchains. Read more about these advantages, as well as the technical details of how the protocol works, in our [pooling section](/introduction#矿池pooling). +Chia's pooling protocol has several significant advantages over pools on other blockchains. Read more about these advantages, as well as the technical details of how the protocol works, in our [pooling section](/introduction#pooling). ::: @@ -325,6 +331,7 @@ From the Chia application, click the `Farm` icon and click `ADD A PLOT`:
Add a plot
+
If you previously created a plot NFT, it will show up now. The plots you create will be associated with this NFT. It is important that you associate all of your plots to the same NFT in order to farm to a pool, as well as to be able to change pools easily if desired. As long as your plot NFT shows up here, there is no need to change it: @@ -332,6 +339,7 @@ If you previously created a plot NFT, it will show up now. The plots you create
Plot NFT
+
Next, you will need to choose a plotter. When creating a single plot, `Chia Proof of Space` and `madMAx` both will work on almost all hardware. The plot from this example was created with `madMAx` because it requires the smallest amount of temporary disk space. @@ -340,18 +348,20 @@ Next, you will need to choose a plotter. When creating a single plot, `Chia Proo When building a larger farm, the plotter you choose will depend greatly on your available hardware. It may help to experiment with multiple plotters to get a feel for which ones work best for your setup. For details on each of the available plotters, see our [Plotting Software](/plotting-software) section. -::: +:::
Choose plotter
+
For the `Keys` section, you typically won't need to change anything.
- Keys + 密钥
+
Next, you will need to choose a `k` value, and possibly a compression level. @@ -371,6 +381,7 @@ Certain plotters are also capable of creating compressed plots, which are discus
Choose K value
+
Next, you need to select the temporary and final directories for your plot. The medium for temporary storage will greatly affect the speed at which your plot is created: @@ -379,7 +390,7 @@ Next, you need to select the temporary and final directories for your plot. The - **SSD** -- Most farmers choose to use an enterprise NVMe SSD for the temporary storage. These SSDs can handle large amounts of reads and writes in their lifetimes. - **HDD** -- If you don't mind plotting slowly, you can choose a directory located on an HDD. -The final directory is where the plot will be copied after it has been created. Most farmers will choose to use an HDD as the final directory. However, for this tutorial an NVMe SSD was used for both the temporary and final directories. +The final directory is where the plot will be copied after it has been created. The final directory is where the plot will be copied after it has been created. Most farmers will choose to use an HDD as the final directory. However, for this tutorial an NVMe SSD was used for both the temporary and final directories. :::warning @@ -392,13 +403,15 @@ You will also need to choose how many plots to create. Certain plotters can be o
Temporary and final directories
+
-After you have gone through all of these settings, click `CREATE`. You will be taken to a progress panel: +After you have gone through all of these settings, click `CREATE`. You will be taken to a progress panel: You will be taken to a progress panel:
Plot creation progress
+
The amount of time required to create this plot is highly dependent on your hardware. The world record time to create a k32 plot is around 30 seconds. The plot for this tutorial was created on a laptop in around 3 hours. @@ -418,6 +431,7 @@ Before you can begin farming, you need to be running a synced full node. Earlier
Synced node
+
Your node is now synced. If your plot has finished being created, you are also farming. To verify this, click the `Farm` icon: @@ -425,6 +439,7 @@ Your node is now synced. If your plot has finished being created, you are also f
Farm health
+
You will be shown a number of details about your farm. As long as the `Farm Health` section has all green icons, everything is working as expected. @@ -445,7 +460,7 @@ Once you have a small farm up and running, you can decide whether to expand, and - [Notes about SSD encurance](/ssd-endurance) - [How to move plots](/moving-plots) to their final destinations -## How to Get Help +## 如何获得帮助 - Get help on CNI's official [Discord](https://discord.gg/chia), in the `#farming-and-plotting` and `#support` channels. -- Get more questions answered in the [plotting FAQ](/plotting-faq). +- 在[生成地块问答](/plotting-faq)中获取更多问题的解答。 diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting-started/installation.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting-started/installation.md index 70e3d5fed9..0550d1faf3 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting-started/installation.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting-started/installation.md @@ -8,13 +8,13 @@ import TabItem from '@theme/TabItem'; :::info -This page will go into the details of the various different ways to install Chia. If you already installed Chia as part of the Farming Guide, then feel free to skip ahead to the [Plotting Basics](/plotting-basics) page. +This page will go into the details of the various different ways to install Chia. This page will go into the details of the various different ways to install Chia. If you already installed Chia as part of the Farming Guide, then feel free to skip ahead to the [Plotting Basics](/plotting-basics) page. ::: There are various ways to install Chia, with the best method depending on what you intend to do: -- If you simply wish to use the Chia wallet, or to run a farm on a single personal computer, then we recommend installing the GUI from our [official downloads page](https://www.chia.net/downloads) for Windows and MacOS, and for Linux users to install the package [as described below](#using-the-cli). The GUI is the simplest way to interact with the Chia client and ideal for most non-developer use cases. +- If you simply wish to use the Chia wallet, or to run a farm on a single personal computer, then we recommend installing the GUI from our [official downloads page](https://www.chia.net/downloads) for Windows and MacOS, and for Linux users to install the package [as described below](#using-the-cli). The GUI is the simplest way to interact with the Chia client and ideal for most non-developer use cases. The GUI is the simplest way to interact with the Chia client and ideal for most non-developer use cases. - If you intend to run a dedicated Chia full node on a server and connect to it programmatically using the [RPC interface](/rpc), the best method would be to install and run Chia via the command line on a proper server environment. @@ -38,7 +38,7 @@ Chia plot files are at least 108GB in size (for K32). To plot successfully requi ### Sleep kills plots -If the computer or hard drives go to sleep during the plotting process, it will fail, and you will need to start over. Please ensure all sleep, hibernate and power saving modes for your computer and hard drives are disabled before starting the Chia plotting process. In the future, Chia will have a resume plot feature. In the meantime, if you do get a failed plot, delete all `*.tmp` files before starting a new plot. +If the computer or hard drives go to sleep during the plotting process, it will fail, and you will need to start over. Please ensure all sleep, hibernate and power saving modes for your computer and hard drives are disabled before starting the Chia plotting process. In the future, Chia will have a resume plot feature. In the meantime, if you do get a failed plot, delete all `*.tmp` files before starting a new plot. Please ensure all sleep, hibernate and power saving modes for your computer and hard drives are disabled before starting the Chia plotting process. In the future, Chia will have a resume plot feature. In the meantime, if you do get a failed plot, delete all `*.tmp` files before starting a new plot. --- @@ -110,7 +110,7 @@ sudo dnf install chia-blockchain :::note Make sure you have [Python 3.10](https://www.python.org/downloads/release/python-3109) and [Git](https://git-scm.com/downloads) installed. -::: +::: ```bash # Create virtual environment @@ -146,7 +146,7 @@ values={[ :::note Make sure you have [Python 3.10](https://www.python.org/downloads/release/python-3109) and [Git](https://git-scm.com/downloads) installed. -::: +::: ```bash # Download chia-blockchain @@ -180,8 +180,10 @@ chia stop -d all # Deactivate the virtual environment deactivate -# Remove the current virtual environment +# Remove the current virtual environments rm -r venv +rm -r .penv +rm -r .venv # Pull the latest version git fetch @@ -209,7 +211,7 @@ chia init :::note Make sure you have [Python 3.10](https://www.python.org/downloads/release/python-3109) and [Git](https://git-scm.com/downloads) installed. -::: +::: ```bash # Download chia-blockchain @@ -245,6 +247,8 @@ deactivate # Remove the current virtual environment rm -r venv +rm -r .penv +rm -r .venv # Pull the latest version git fetch @@ -432,6 +436,16 @@ See [install from source](/installation#from-source) for detailed instruction. #### Install from binary package +```bash +# Install chia-blockchain as a binary package +python -m venv venv +ln -s venv/bin/activate +. #### Install from source - Amazon Linux 2 + +See [install from source](/installation#from-source) for detailed instruction. + +#### Install from binary package + ```bash # Install chia-blockchain as a binary package python -m venv venv @@ -447,13 +461,13 @@ pip install --extra-index-url https://pypi.chia.net/simple chia-blockchain miniu _**These instructions were tested with Chia 1.1.4 on FreeBSD 11.3- and 11.4-RELEASE, newer versions may exist**_ ---- +\*\*\*==crwdHRulesLBB_2_BBsuleRHdwrc== #### Upgrading Existing Chia Installs If you're upgrading from a previously built chia installation, exit from your previous venv environment (`deactivate`), create a new directory in which to place the latest Chia (e.g. `mkdir ~/chia-1.0.5 && cd ~/chia-1.0.5`), clone the latest repo (`git clone https://github.com/Chia-Network/chia-blockchain.git -b latest`), enter it and create a new Python virtual environment within it (`python3 -m venv venv`). Now, activate the newest environment (`. venv/bin/activate`), upgrade pip (`pip install --upgrade pip`). Now you may skip down to the [clvm_rs install section](#clvm_rs) and begin there. ---- +\*\*\*==crwdHRulesLBB_2_BBsuleRHdwrc== #### Why This Manual Installation? @@ -558,19 +572,136 @@ pkg install screen tmux git clone https://github.com/Chia-Network/chia-blockchain.git -b latest # or with SSH: git clone git@github.com:Chia-Network/chia-blockchain.git -b latest -# Note: you can specify the branch by adding "--branch " like: git clone http://github.com/Chia-Network/chia-blockchain.git --branch 1.0.1 +# Note: you can specify the branch by adding "--branch Now, activate the newest environment (`. venv/bin/activate`), upgrade pip (`pip install --upgrade pip`). Now you may skip down to the [clvm_rs install section](#clvm_rs) and begin there. + +---==crwdHRulesLBB_2_BBsuleRHdwrc== + +#### Why This Manual Installation? + +Currently the only way to ensure Chia builds on FreeBSD is to do it from the source. By following these instructions to the letter, you should have no problem building the latest Chia from source on a FreeBSD 11.3 or 11.4. This should also work on FreeBSD 12, possibly with some modifications - e.g. if the ports py-cryptography version is newer than 3.3.2, simply edit as needed - or if your preferred Python version is 3.8+ it should all still work considering you modify the package names as necessary. + +#### Notes on FreeNAS (TrueNAS) + +If you had been using NFS or Samba sharing to expose your plots to a harvester on another OS, such as Linux, you can instead build Chia within a jail (see the FreeNAS manual for 'jails'), expose your plot directories to it and run the harvester within. In my experience, it provides lower-latency and more reliable access to the plots since the disks are direct-attached and not being provided through an extra few layers of network protocols. + +If you are using a fresh jail created by the FreeNAS web GUI you may need to install openssh and setup a ssh key to login as root because by default it appears PAM password logins do not work. The jail shell CLI provided by the FreeNAS GUI allows copy and pasting so you can easily paste your public-key into /root/.ssh/authorized_keys && chmod -R 700 /root/.ssh. + +These instructions would be applicable to 11.3 and 11.4 jails created within FreeNAS 11 only. Version 12 (FreeBSD 12) ✔ + +#### Other Notes + +These instructions will have you building both chia-blockchain and clvm_rs from github source, and python-cryptography from FreeBSD's ports. + +The result of this build will be the "chia version" showing the current release branch ahead by 1 and in "dev0"; for instance building 1.0.1 results in "chia version" returning "1.0.2.dev0". If someone knows why this is and how to fix it, please, edit and correct this! It does not happen on Linux. + +_**These instructions assume a fresh FreeBSD 11 installation!**_ + +#### Discouraged? + +Following the instructions in this document will result in a working Chia CLI build on FreeBSD 11 if you follow step-by-step starting from a vanilla FreeBSD installation. Is something broken? Compare the commands you typed, accessible in your **bash** shell history, and match them with each command in this document. If you feel you've messed something up, do the following: +``` +# if you have (venv) in your shell prompt, type deactivate +deactivate +# remove the chia-blockchain directory which will contain clvm_rs and the Python venv +rm -rf chia-blockchain +# ... now start again! You don't need to do all the setup steps but instead may start at the upgrade notes above if you had finished up to the py-cryptography ports build. ``` -Create a virtual environment directory 'venv' from _within_ the 'chia-blockchain' directory and activate it before proceeding +#### Pre-requisite package installation + +_If starting the build again after a failure and you have not re-installed FreeBSD, don't just skip this package installation section! You may have missed one or more software packages critical to the build._ + +The 'pkg', 'portsnap' and port build are to be run as root. Everything else can be run from a normal non-root user. + +As root, update pkg and ports, and then install all packages as instructed below. ``` -cd chia-blockchain -python3 -m venv venv -source venv/bin/activate +# Update your packages and ports; if ports are already installed as part of your fresh install run portsnap update instead of fetch/extract. +pkg update +portsnap fetch && portsnap extract + +# Install bash if you have not; the default csh will not suffice for the build scripts. +pkg install bash +# change your shell to bash +chsh -s /usr/local/bin/bash +# run bash +/usr/local/bin/bash ``` -You are now in the virtual environment that Python (and so chia) will use. You should have a "(venv)" prefix to your terminal prompt to confirm the venv is working. +Make sure you change the shell for your non-root chia-blockchain user. If you're opting to run Chia as root, you can skip this. If you are root, run this as it appears below; otherwise, you can omit the username because you are already that user. + +``` +chsh -s /usr/local/bin/bash NONROOT_USERNAME +``` + +Now proceed with installing the mandatory development tools. + +``` +pkg install lang/gcc9 gcc gmake cmake + +``` + +#### gcc notes + +After installing gcc version 9.0, this message appears: + +``` +To ensure binaries built with this toolchain find appropriate versions +of the necessary run-time libraries, you may want to link using + + -Wl,-rpath=/usr/local/lib/gcc9 +``` + +It's probably possible to build the libraries in a way that doesn't require `export LD_LIBRARY_PATH=/usr/local/lib/gcc9`. If you know how click "edit" and dish. + +#### Install rust, Python, and everything else. + +``` +pkg install lang/rust +pkg install lang/python37 py37-pip py37-setuptools py37-wheel py37-sqlite3 py37-cffi py37-virtualenv py37-maturin python +pkg install node npm git openssl +``` + +If you are ssh'ing into the machine you might want to use 'screen' so that processes will continue even if you logout. For more information: https://www.freebsd.org/cgi/man.cgi?query=screen. 'tmux' is also a great alternative especially if you use iTerm2 on macOS as it supports native tabs and windows with the '-CC' CLI option. + +``` +# optional packages +pkg install screen tmux +``` + +#### Repo Cloning and Virtual Environment (venv) Activation + +**From this point on, with the exception of the security/py-cryptography port build process (and any other exceptions noted), you may proceed as a normal user.** + +``` +# Clone the latest chia-blockchain repository, via HTTP: +git clone https://github.com/Chia-Network/chia-blockchain.git -b latest +# or with SSH: +git clone git@github.com:Chia-Network/chia-blockchain.git -b latest +# Note: you can specify the branch by adding "--branch :::note +Make sure you have [Python 3.10](https://www.python.org/downloads/release/python-3109) and [Git](https://git-scm.com/downloads) installed. +::: + +```bash +# Download chia-blockchain +git clone https://github.com/Chia-Network/chia-blockchain -b latest --recurse-submodules + +# Change directory +cd chia-blockchain + +# Checkout the beta or release candidate by tag, tags can be found https://github.com/Chia-Network/chia-blockchain/tags. +git checkout tags/2.1.2-rc2 + +# Install dependencies +./Install.ps1 + +# Activate virtual environment +. ./venv/Scripts/Activate.ps1 + +# Initialize +chia init +``` You should have a "(venv)" prefix to your terminal prompt to confirm the venv is working. Upgrade pip: @@ -698,7 +829,7 @@ sed -i .bak 's/enable_upnp: True/enable_upnp: False' ~/.chia/mainnet/config/conf While you don't absolutely need port 8444 forwarded to your Chia node, it is advised that you do so that other peers may connect to you instead of you solely connecting to them. For the average at-home farmer it is advised you do not disable UPnP unless you absolutely know what you're doing or have another node on your local network already using the port and are planning to [Farm on Many Machines](https://docs.chia.net/farming-on-many-machines/). ---- +---==crwdHRulesLBB_2_BBsuleRHdwrc== #### Installed and Ready to Farm! @@ -819,6 +950,211 @@ The GUI can now be launched using the following commands: cd chia-blockchain . ./activate +cd chia-blockchain-gui +npm run electron +``` ./venv/bin/activate +pip install --upgrade pip + +cd ../chiavdf/ +pip install . + +cd ../maturin/ +# don't pass static compiler flags to the rust linker because that would cause +# a core dump, possibly because of resource limits +sed -i 's|cargo_args.extend(\["--", "-C", "link-arg=-s"\])|#cargo_args.extend(\["--", "-C", "link-arg=-s"\])|' setup.py +pip install . + +cd ../clvm_rs/ +maturin develop --release + +# XXX should be a more elegant way... +" like: git clone http://github.com/Chia-Network/chia-blockchain.git --branch 1.0.1 + +``` + +Create a virtual environment directory 'venv' from _within_ the 'chia-blockchain' directory and activate it before proceeding + +``` +cd chia-blockchain +python3 -m venv venv +source venv/bin/activate +``` + +You are now in the virtual environment that Python (and so chia) will use. You should have a "(venv)" prefix to your terminal prompt to confirm the venv is working. + +Upgrade pip: + +``` +pip install --upgrade pip +``` + +To exit the virtual environment: + +``` +deactivate +``` + +#### Building py-cryptography from ports + +_**You'll need to switch to root for this part. If you're already using root remember to leave the virtual environment for this step.**_ + +``` +cd /usr/ports/security/py-cryptography + +# Instruct 'make' that the SSL library is openssl. +# Also force the Python version in case the port tries for a higher one +echo "DEFAULT_VERSIONS+=ssl=openssl python=3.7 python3=3.7" >> /etc/make.conf + +make +``` + +You'll probably see a bunch of warnings and notices; these are not errors and it will build. + +Do NOT run make install. We will do our own py-cryptography install because 'make install' does not copy to our virtual environment. (If you know how to change this, please edit). + +If you are running inside a jail and make fails with an error about the OSVERSION not matching UNAME, you will need to set the UNAME_r environment variable to match your jails OSVERSION: + +``` +# Adjust the value to match your jails OSVERSION +export UNAME_r=11.4-RELEASE +``` + +A full version list can be found [here](https://docs.freebsd.org/en/books/porters-handbook/book.html#versions). + +Once complete switch back to your non-root user if you so optioned. You must now be in your venv once again. + +#### clvm_rs + +Build and install the current version of [clvm_rs](https://github.com/Chia-Network/clvm_rs). +These instructions were created for version 0.1.7 but a newer version may exist. + +``` +git clone http://github.com/Chia-Network/clvm_rs.git --branch 0.1.7 +cd clvm_rs +maturin develop --release +pip install git+https://github.com/Chia-Network/clvm@use_clvm_rs +``` + +clvm_rs 0.1.7 is now installed in your virtual environment. + +#### Install py-cryptography to the venv + +Copy py-cryptography and its meta-data from the staging directory to your virtual environment: + +``` +cp -R /usr/ports/security/py-cryptography/work-py37/stage/usr/local/lib/python3.7/site-packages/cryptography ${VIRTUAL_ENV}/lib/python3.7/site-packages/cryptography +cp -R /usr/ports/security/py-cryptography/work-py37/stage/usr/local/lib/python3.7/site-packages/cryptography-3.3.2-py3.7.egg-info ${VIRTUAL_ENV}/lib/python3.7/site-packages/cryptography-3.3.2-py3.7.egg-info +``` + +Clear any Python byte-code cache files that may contain the old path. These should be re-built by the interpreter but we like a clean environment. + +``` +find ${VIRTUAL_ENV}/lib/python3.7/site-packages/cryptography -name __pycache__ | xargs -I{} rm -rf "{}" +``` + +#### Chia modifications and Building Chia Itself + +Switch to your chia-blockchain clone directory. You will need to edit two files. + +Using your favorite text editor, modify setup.py to edit the cryptography package version to 3.3.2. + +``` +"cryptography==3.4.6" --> to --> "cryptography==3.3.2" +``` + +Now you must modify chia/util/keychain.py to provide a static key when using the Python keyring. This is mandatory otherwise every time the keyring is accessed your passphrase will need to be entered on the command line, and for the CLI daemon this will not do. + +On line 25 of chia/util/keychain.py, change: + +``` +elif platform=="linux": +``` + +to: + +``` +elif platform=="linux" or platform.startswith("freebsd"): +``` + +On line 27 of the same file, change the passphrase from "your keyring password" to whatever you wish your passphrase to be. This is intended to be fixed in future versions but, for the time being, Linux and FreeBSD must have the keyphrase provided statically. + +``` +keyring.keyring_key = "your keyring password" # type: ignore +``` + +can be changed like so: + +``` +keyring.keyring_key = "Too Many Secrets" +``` + +Now, you will build Chia! + +``` +sh install.sh +``` + +Once done, run: + +``` +chia init +``` + +NOTE: if you need to disable UPnP - a protocol which automatically sets up port-forwarding on routers using NAT which is a typical setup at any residence with broadband - set "enable_upnp: False" in config.yaml. You can use the one-liner below or do it yourself. + +``` +sed -i .bak 's/enable_upnp: True/enable_upnp: False' ~/.chia/mainnet/config/config.yaml +``` + +While you don't absolutely need port 8444 forwarded to your Chia node, it is advised that you do so that other peers may connect to you instead of you solely connecting to them. For the average at-home farmer it is advised you do not disable UPnP unless you absolutely know what you're doing or have another node on your local network already using the port and are planning to [Farm on Many Machines](https://docs.chia.net/farming-on-many-machines/). + +\*\*\*==crwdHRulesLBB_2_BBsuleRHdwrc== + +#### Installed and Ready to Farm! + +That's it! Provided the instructions were followed to the T, and the build is a fresh FreeBSD 11.3 or 11.4, either hardware or FreeNAS jailed, you should be good to go! Now go to town with `chia start node` or whatever floats your boat. + +More details can be found in the [Chia Introduction](https://docs.chia.net/introduction). + +_WARNING: Although the following steps have been used successfully, the resulting GUI will be run with an older version of electron than is recommended by the Chia Network team. This may result in unexpected problems._ + +#### Prerequisite package installation + +As root (or using doas / sudo), first install some additional OpenBSD packages required for GUI usage: + +```bash +pkg_add -i electron +``` + +#### Build + +```bash +cd chia-blockchain +. ./activate + +cd chia-blockchain-gui + +# build / set up GUI +npm run build + +# Remove failed electron 8.2.5 install and fall back to the OpenBSD +# ports tree 8.2.0 electron, which currently (as of 6/10/2020) works. +# +# This may not continue to work in the future. A full solution to +# this requires official OpenBSD electron builds, provided by the +# electron project itself. + +rm -rf node_modules/electron +``` + +#### Launch GUI + +The GUI can now be launched using the following commands: + +```bash +cd chia-blockchain +. ./activate + cd chia-blockchain-gui npm run electron ``` @@ -874,6 +1210,14 @@ This can be done by running the following command: export PATH=/Applications/Chia.app/Contents/Resources/app.asar.unpacked/daemon:$PATH ``` +To load this on startup, add it to the `.bashrc`, `.bash_profile`, or `.zshrc` file depending on which is used by the shell. + +This can be done by running the following command: + +```bash +export PATH=/Applications/Chia.app/Contents/Resources/app.asar.unpacked/daemon:$PATH +``` + To load this on startup, add it to the `.bashrc`, `.bash_profile`, or `.zshrc` file depending on which is used by the shell. @@ -1004,9 +1348,9 @@ chia start farmer ### Systemd -Linux users who have installed the `chia-blockchain-cli` package using [apt, yum, or dnf](https://docs.chia.net/installation/#using-the-cli) will receive systemd configuration files for initializing and managing the Chia processes. Each Chia service needs to be managed separately with systemd, except for the chia-daemon, which will be initialized automatically when any other Chia service is started with systemd (for example, the data-layer service will not automatically start the wallet service - both need to be started individually with systemd). A user must be specified during the initialization to ensure the resulting process can find the Chia root directory. The included systemd files support the default Chia directory location of `/home//.chia/mainnet` only. +Linux users who have installed the `chia-blockchain-cli` package using [apt, yum, or dnf](https://docs.chia.net/installation/#using-the-cli) will receive systemd configuration files for initializing and managing the Chia processes. Each Chia service needs to be managed separately with systemd, except for the chia-daemon, which will be initialized automatically when any other Chia service is started with systemd (for example, the data-layer service will not automatically start the wallet service - both need to be started individually with systemd). A user must be specified during the initialization to ensure the resulting process can find the Chia root directory. The included systemd files support the default Chia directory location of `/home//.chia/mainnet` only. Each Chia service needs to be managed separately with systemd, except for the chia-daemon, which will be initialized automatically when any other Chia service is started with systemd (for example, the data-layer service will not automatically start the wallet service - both need to be started individually with systemd). A user must be specified during the initialization to ensure the resulting process can find the Chia root directory. The included systemd files support the default Chia directory location of `/home//.chia/mainnet` only. -To start a Chia process with systemd, the command format is `systemctl start chia-@`. For example, if starting a Chia full node for the Linux user `ubuntu`, the command would be: +To start a Chia process with systemd, the command format is `systemctl start chia-@`. For example, if starting a Chia full node for the Linux user `ubuntu`, the command would be: For example, if starting a Chia full node for the Linux user `ubuntu`, the command would be: ``` systemctl start chia-full-node@ubuntu @@ -1037,10 +1381,10 @@ Note that the `chia-timelord` service runs the timelord coordinator service, but ## Troubleshooting -Sometimes stray daemons left over from previously running processes will cause strange bugs/errors when upgrading to a new version. Make sure all daemons and chia processes are killed before installing or upgrading. +Sometimes stray daemons left over from previously running processes will cause strange bugs/errors when upgrading to a new version. Make sure all daemons and chia processes are killed before installing or upgrading. Make sure all daemons and chia processes are killed before installing or upgrading. This is normally done by executing `chia stop -d all` from the upgrade example above. -But it doesn't hurt to double check using `ps -Af | grep chia` to make sure there are no chia processes left running. You may have to manually kill the chia daemon if an install and chia start was performed without first running `chia stop -d all` +But it doesn't hurt to double check using `ps -Af | grep chia` to make sure there are no chia processes left running. You may have to manually kill the chia daemon if an install and chia start was performed without first running `chia stop -d all` You may have to manually kill the chia daemon if an install and chia start was performed without first running `chia stop -d all` If all else fails, rebooting the machine and restarting the chia daemon/processes usually does the trick. @@ -1048,7 +1392,7 @@ If all else fails, rebooting the machine and restarting the chia daemon/processe To join a testnet, follow the instructions on [How to Join the Official Testnet](/testnets#join-the-official-testnet). -It is recommended that you keep a separate testnet environment by prepending `CHIA_ROOT="~/.chia/testnetx"` to all of your cli commands. For example, `CHIA_ROOT="~/.chia/testnet11" chia init`. An easier way to do this is to run `export CHIA_ROOT="~/.chia/testnet11"` so that all commands will use testnet11 instead of mainnet. You can update all config values to the testnet values by running `chia configure -t true`. +It is recommended that you keep a separate testnet environment by prepending `CHIA_ROOT="~/.chia/testnetx"` to all of your cli commands. For example, `CHIA_ROOT="~/.chia/testnet10" chia init`. An easier way to do this is to run `export CHIA_ROOT="~/.chia/testnet10"` so that all commands will use testnet10 instead of mainnet. If you're using a version above 1.2.11, you can update all config values to the testnet values by running `chia configure -t true`. For example, `CHIA_ROOT="~/.chia/testnet11" chia init`. An easier way to do this is to run `export CHIA_ROOT="~/.chia/testnet11"` so that all commands will use testnet11 instead of mainnet. You can update all config values to the testnet values by running `chia configure -t true`. ## Beta and release candidate installations @@ -1066,7 +1410,7 @@ values={[ :::note Make sure you have [Python 3.10](https://www.python.org/downloads/release/python-3109) and [Git](https://git-scm.com/downloads) installed. -::: +::: ```bash # Download chia-blockchain @@ -1093,7 +1437,7 @@ chia init :::note Make sure you have [Python 3.10](https://www.python.org/downloads/release/python-3109) and [Git](https://git-scm.com/downloads) installed. -::: +::: ```bash # Download chia-blockchain @@ -1129,7 +1473,6 @@ values={[ ]}> -```bash # Install packages sudo apt-get update sudo apt-get install ca-certificates curl gnupg @@ -1138,27 +1481,39 @@ sudo apt-get install ca-certificates curl gnupg curl -sL https://repo.chia.net/FD39E6D3.pubkey.asc | sudo gpg --dearmor -o /usr/share/keyrings/chia.gpg # Set up repository -echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/chia.gpg] https://repo.chia.net/prerelease/debian/ prerelease main" | sudo tee /etc/apt/sources.list.d/chia-blockchain-prerelease.list > /dev/null +echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/chia.gpg] https://repo.chia.net/prerelease/debian/ prerelease main" | sudo tee /etc/apt/sources.list.d/chia-blockchain-prerelease.list > /dev/null sudo apt-get update # Install chia-blockchain sudo apt-get install chia-blockchain # Use chia-blockchain-cli instead for CLI only -``` +:::note +Make sure you have [Python 3.10](https://www.python.org/downloads/release/python-3109) and [Git](https://git-scm.com/downloads) installed. +::: + ```bash -# Navigate to downloads page -Open https://github.com/Chia-Network/chia-blockchain/releases in a web browser +# Download chia-blockchain +git clone https://github.com/Chia-Network/chia-blockchain -b latest --recurse-submodules -# Download the correct asset -Navigate to the release candidate of interest and download the necessary installer for your OS (ex. exe for windows) +# Change directory +cd chia-blockchain -# Install the downloaded installer -Using your system finder/file explorer install the downloaded installer (note - make sure no other versions of chia are installed prior to this step) +# Checkout the beta or release candidate by tag, tags can be found https://github.com/Chia-Network/chia-blockchain/tags. +git checkout tags/2.1.2-rc2 + +# Install dependencies +sh install.sh + +# Activate virtual environment +. ./activate + +# Initialize +chia init ``` diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting-started/timelords.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting-started/timelords.md index 286e8f95af..2784d47f76 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting-started/timelords.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting-started/timelords.md @@ -10,7 +10,7 @@ import TabItem from '@theme/TabItem'; **DO NOT** overclock ASICs, overclocking diminishes the life of the ASIC! ::: -Timelord architecture information can be found [here](/timelord-architecture). +Timelord architecture information can be found [here](/timelord-architecture).\ The hw_vdf_client parameter information can be found [here](/asic-cli). --- @@ -18,7 +18,7 @@ The hw_vdf_client parameter information can be found [here](/asic-cli). ## Timelord Requirements and Dependencies :::info -Due to restrictions on how [MSVC](https://en.wikipedia.org/wiki/Microsoft_Visual_C%2B%2B) handles 128 bit numbers and how Python relies upon MSVC, it is not possible to build and run Timelords of all types on Windows. +Due to restrictions on how [MSVC](https://en.wikipedia.org/wiki/Microsoft_Visual_C%2B%2B) handles 128 bit numbers and how Python relies upon MSVC, it is not possible to build and run Timelords of all types on Windows.\ Running a timelord on a farming machine will reduce the efficiency of the farmer and the timelord, for this reason it is recommended to have a dedicated machine for running timelords. ::: @@ -55,8 +55,7 @@ values={[ {label: 'Software TL', value: 'sw-tl'}, {label: 'Bluebox TL', value: 'bb-tl'}, {label: 'Hardware (ASIC) TL', value: 'hw-tl'}, -]}> - +]}> :::info Use `chia-blockchain-cli` instead of `chia-blockchain` for CLI only version that does not have a GUI. ::: @@ -83,37 +82,13 @@ chia start node timelord & -```bash -# Install packages -sudo apt-get update -sudo apt-get install ca-certificates curl gnupg - -# Add GPG key -curl -sL https://repo.chia.net/FD39E6D3.pubkey.asc | sudo gpg --dearmor -o /usr/share/keyrings/chia.gpg - -# Set up repository -echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/chia.gpg] https://repo.chia.net/debian/ stable main" | sudo tee /etc/apt/sources.list.d/chia.list > /dev/null -sudo apt-get update - -# Install chia-blockchain -sudo apt-get install chia-blockchain - -# Bluebox timelord setup -For bluebox timelords you will need to make two changes to `~/.chia/mainnet/config.yaml`. -- In the `timelord:` section, set `bluebox_mode:` to `True`. -- In the `full_node:` section and set `send_uncompact_interval:` to something greater than 0. We recommend `300` seconds there so that your Bluebox has some time to prove through a lot of the un-compacted Proofs of Time before the node drops more into its lap. - -Note - The default settings may otherwise work but if the total effort is a little too much for whatever machine you are on you can also lower the `process_count:` from 3 to 2, or even 1, in the `timelord_launcher:` section. You know it is working if you see `VDF Client: Sent proof` in your logs at INFO level. - -# Launch timelord -chia start node timelord & -``` +The bluebox timelord must be installed from scratch following the instructions [here](/timelord-install#installing-a-timelord-from-source). :::warning -**DO NOT** overclock ASICs, overclocking diminishes the life of the ASIC! +**DO NOT** overclock ASICs, overclocking diminishes the life of the ASIC!\ Detailed information about the hw_vdf_client parameters can be found [here](/asic-cli). ::: @@ -128,7 +103,7 @@ Main Machine (ASIC 1) -------------------------- (chia node, timelord-only, and ASIC software) \_____ ASIC 3 (ASIC software only, IP set to main machine) ``` -For an ASIC cluster you will need to follow the below install steps on the main machine to include the chia node, timelord-only, and ASIC software processes are all being run on the main machine. +For an ASIC cluster you will need to follow the below install steps on the main machine to include the chia node, timelord-only, and ASIC software processes are all being run on the main machine.\ The additional ASIC hosts will only need the ASIC software installed (noted in the below install instructions). ```bash @@ -161,7 +136,7 @@ chia start node timelord-only ### Installing a Timelord from Source :::info -On MacOS x86_64 and all Linux distributions, building a Timelord is as easy as running `chia start timelord &` in the virtual environment. You can also run `./vdf_bench square_asm 400000` once you've built Timelord to give you a sense of your optimal and unloaded ips. Each run of `vdf_bench` can be surprisingly variable and, in production, the actual ips you will obtain will usually be about 20% lower due to load of creating proofs. The default configuration for Timelords is good enough to just let you start it up. Set your log level to INFO and then grep for "Estimated IPS:" to get a sense of what actual ips your Timelord is achieving. +On MacOS x86_64 and all Linux distributions, building a Timelord is as easy as running `chia start timelord &` in the virtual environment. You can also run `./vdf_bench square_asm 400000` once you've built Timelord to give you a sense of your optimal and unloaded ips. Each run of `vdf_bench` can be surprisingly variable and, in production, the actual ips you will obtain will usually be about 20% lower due to load of creating proofs. The default configuration for Timelords is good enough to just let you start it up. Set your log level to INFO and then grep for "Estimated IPS:" to get a sense of what actual ips your Timelord is achieving.\ Detailed information about the hw_vdf_client parameters can be found [here](/asic-cli). ::: @@ -186,13 +161,23 @@ chia init sh install-timelord.sh # Start timelord (skip this step and proceed below if installing a bluebox or ASIC timelord) -chia start full_node timelord +chia start node timelord # Bluebox timelord setup -Once you build the Timelord with `sh install-timelord.sh` in the virtual environment, you will need to make two changes to `~/.chia/VERSION/config.yaml`. +Once you build the Timelord with `sh install-timelord.sh` in the virtual environment, you will need to make some changes to `~/.chia/VERSION/config.yaml`. - In the `timelord:` section, set `bluebox_mode:` to `True`. +(Note: It is possible to run a bluebox timelord on a separate machine from your full node. If you wish to run them separately, make the change listed below on your full node machine.) - In the `full_node:` section and set `send_uncompact_interval:` to something greater than 0. We recommend `300` seconds there so that your Bluebox has some time to prove through a lot of the un-compacted Proofs of Time before the node drops more into its lap. +# Additional config.yaml change ONLY for running a bluebox timelord on a separate machine from full node +- In the config.yaml of your bluebox timelord, go to the 'timelord:' section under 'full_node_peers' and, modify the 'host' value from 'localhost' to the local IP of your full node (i.e. 192.168.1.3) + +## Start the daemon, timelord-launcher, timelord, and node for a Bluebox timelord + full node running on the same device +chia start node timelord + +## Start the daemon, timelord-launcher, and timelord for a Bluebox timelord connecting to a separate full node +chia start timelord-launcher-only timelord-only + Note - The default settings may otherwise work but if the total effort is a little too much for whatever machine you are on you can also lower the `process_count:` from 3 to 2, or even 1, in the `timelord_launcher:` section. You know it is working if you see `VDF Client: Sent proof` in your logs at INFO level. # ASIC timelord setup: install the timelord repo, run the timelord-only chia service, and run the ASIC software @@ -222,7 +207,7 @@ chia start node timelord-only ## ASIC Timelord Systemd Setup -Below is an example of a systemd service file to run the ASIC hw vdf processes. +Below is an example of a systemd service file to run the ASIC hw vdf processes.\ NOTE - make sure to replace `USERNAME` with your system's username. ```bash diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting-started/wallet-guide.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting-started/wallet-guide.md index 14e9629470..8aa6e48fca 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting-started/wallet-guide.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting-started/wallet-guide.md @@ -695,6 +695,7 @@ This is viewable in the offer's details: +
While the Offer is pending, the Maker attempts to send 0.1 XCH to another address. diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/green-paper/constants-variables-notation.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/green-paper/constants-variables-notation.md index 181b63c4e5..16210e7f7e 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/green-paper/constants-variables-notation.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/green-paper/constants-variables-notation.md @@ -8,29 +8,29 @@ slug: /constants-variables-notation ## 0.1 重要常数 -| 常数 | Description | -| ----------- | ----------------------------------------- | -| 10分钟 | 目标 **子时隙（sub-slot）的间隔时长** | -| 32个区块 | 每个目标 **子时隙的区块数量** | -| 16/64个区块 | 每个时隙的最小/最大区块数量 | -| 4608个区块 | 平均每个**纪元（epoch）的区块**数量 | +| 常数 | Description | +| -------- | --------------------------- | +| 10分钟 | 目标 **子时隙（sub-slot）的间隔时长** | +| 32个区块 | 每个目标 **子时隙的区块数量** | +| 16/64个区块 | 每个时隙的最小/最大区块数量 | +| 4608个区块 | 平均每个**纪元（epoch）的区块**数量 | | 384个区块 | 平均每个**子纪元（sub-epoch）的区块**数量 | -| 64个签名点 | 每个**子时隙的签名点**数量 | +| 64个签名点 | 每个**子时隙的签名点**数量 | 由上可得以下结论： -| 隐含的常数 | Description | -| ---------- | ------------------------------------------------------------------------------------------------------------------------- | -| 1天 | **一个纪元的时长**为 $$10 {\ \sf min}\cdot\frac{4608{\ \sf blocks}}{32\ \sf blocks}=1440{\ \sf min}\quad (=1{ \sf day})$$ | -| 2小时 | **目标**子纪元的时长\*\*\*\* | -| 18.75秒 | 平均**完成一个区块的时长**为 $\frac{10{\sf\ min}}{32}=18.75 {\sf\ sec}$ | -| 9.375秒 | **签名点之间的时长**为 $\frac{600}{64}=9.375 {\sf\ sec}$ | +| 隐含的常数 | Description | +| ------ | ----------------------------------------------------------------------------------------------------------------------------- | +| 1天 | **一个纪元的时长**为 $$10 {\ \sf min}\cdot\frac{4608{\ \sf blocks}}{32\ \sf blocks}=1440{\ \sf min}\quad (=1{ \sf day})$$ | +| 2小时 | **目标**子纪元的时长**** | +| 18.75秒 | 平均**完成一个区块的时长**为 $\frac{10{\sf\ min}}{32}=18.75 {\sf\ sec}$ | +| 9.375秒 | **签名点之间的时长**为 $\frac{600}{64}=9.375 {\sf\ sec}$ | ## 0.2 重要变量 -| 变量 | Description | -| ------------------ | -------------------------------------------------------------------------------- | -| $D\in{\mathbb N}$ | 难度参数。 每个纪元重新校准一次，以满足每个时隙（slot）32个区块的目标 | +| 变量 | Description | +| -------------------- | ------------------------------------------- | +| $D\in{\mathbb N}$ | 难度参数。 每个纪元重新校准一次，以满足每个时隙（slot）32个区块的目标 | | $T\in {\mathbb N}$ | 时间参数（子时隙的VDF步数）。 每个纪元重新校准一次，以满足每个子时隙10分钟的目标 | ## 0.3 提示 diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/green-paper/green-paper-abstract.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/green-paper/green-paper-abstract.md index ee74e0e667..b80dedd5e5 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/green-paper/green-paper-abstract.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/green-paper/green-paper-abstract.md @@ -14,6 +14,8 @@ slug: /green-paper-abstract 本文不是 $\textrm{{\sf Chia}}$ 的正式规范。 相反，它面向那些希望理解 $\textrm{{\sf Chia}}$ 共识设计选择的读者，以及对来自高效证明系统的无需许可的最长链区块链感兴趣的人。 +[Green Paper PDF](https://docs.chia.net/files/ChiaGreenPaper_20241008.pdf) - updated October 8, 2024 + --- ### 先前版本共识绿皮书 diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/green-paper/green-paper-appendix.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/green-paper/green-paper-appendix.md index 2e86b7f27f..d50a92e9e5 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/green-paper/green-paper-appendix.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/green-paper/green-paper-appendix.md @@ -12,21 +12,13 @@ In this section we sketch the main building blocks used in the $\textsf{Chia}$  A digital signature scheme is specified by three algorithms; a (probabilistic) key-generation algorithm ${{\sf Sig.keygen}}$, a signing algorithm $\mu\gets {{\sf Sig.sign}}(sk,m)$ and a verification algorithm ${{\sf Sig.verify}}$. We assume the standard security notion (unforgeability under chosen message attacks) and perfect completeness, that is, a correctly generated signature will always verify: -$$ -\begin{aligned} -\forall m,&& -\Pr[{{\sf Sig.verify}}(pk,m,\mu)={\sf accept}]=1\\ -\textrm{where}&&(pk,sk)\gets{{\sf Sig.keygen}}\ ;\ \mu\gets{{\sf Sig.sign}}(sk,m)~. -\end{aligned} -$$ +$$ \begin{aligned} \forall m,&& \Pr[{{\sf Sig.verify}}(pk,m,\mu)={\sf accept}]=1\\ +\textrm{where}&&(pk,sk)\gets{{\sf Sig.keygen}}\ ;\ \mu\gets{{\sf Sig.sign}}(sk,m)~. \end{aligned} $$ $\textsf{Chia}$ uses signatures in the foliage (to chain foliage blocks and to bind them to the trunk) and also in the trunk (so only the farmer can compute the challenge). To avoid grinding attacks, the signatures used in the trunk must be unique, that is for every $pk$ (this includes maliciously generated public keys) and message $m$ there can be at most one accepting signature -$$ -\forall pk,m,\ -({{\sf Sig.verify}}(pk,m,\mu)={\sf accept})\wedge -({{\sf Sig.verify}}(pk,m,\mu')={\sf accept})\Rightarrow (\mu=\mu')~. -$$ +$$ \forall pk,m,\ +({{\sf Sig.verify}}(pk,m,\mu)={\sf accept})\wedge ({{\sf Sig.verify}}(pk,m,\mu')={\sf accept})\Rightarrow (\mu=\mu')~. $$ $$ ## A.2 (Unique) Proofs Of Space @@ -56,28 +48,18 @@ To prevent grinding attacks, we need our PoSpace to be unique as defined below. A PoSpace is unique if for any identity $pk$ and any challenge $c$ there is exactly one proof, i.e., -$$ -\begin{aligned} -&\forall N,pk,c,\\ -&\left|\{\sigma\ :\ \left({{\sf PoSpace.verify}}(\sigma)={\sf accept}\right)\wedge \left( (\sigma.N,\sigma.pk,\sigma.c)=(N,pk,c)\right)\}\right|= 1 -\end{aligned} -$$ +$$ \begin{aligned} &\forall N,pk,c,\\ +&\left|\{\sigma\ :\ \left({{\sf PoSpace.verify}}(\sigma)={\sf accept}\right)\wedge \left( (\sigma.N,\sigma.pk,\sigma.c)=(N,pk,c)\right)\}\right|= 1 \end{aligned} $$ We call a PoSpace _weakly_ unique if the _expected_ number of proofs is close to $1$, i.e., -$$ -\begin{aligned} -&\forall N,pk,c,\\ -&{\mathrm E}_{c\gets \{0,1\}^w}\left[|\{\sigma : \left({{\sf PoSpace.verify}}(\sigma)={\sf accept}\} \right) -\wedge \left((\sigma.N,\sigma.pk,\sigma.c)=(N,pk,c)\right) -|\right]\\ -&\approx 1 -\end{aligned} -$$ +$$ \begin{aligned} &\forall N,pk,c,\\ +&{\mathrm E}_{c\gets \{0,1\}^w}\left[|\{\sigma : \left({{\sf PoSpace.verify}}(\sigma)={\sf accept}\} \right) \wedge \left((\sigma.N,\sigma.pk,\sigma.c)=(N,pk,c)\right) |\right]\\ +&\approx 1 \end{aligned} $$ For weakly unique PoSpace we assume that whenever there is more than one proof for a given challenge which passes verification, ${\sf PoSpace.prove}(S,c)$ outputs all of them. -The [AAC+17] PoSpace used in $\textsf{Chia}$ is only _weakly unique_. To be able to focus on the main challenges, we will nonetheless assume a _unique_ PoSpace when analyzing $\textsf{Chia}$ but our analysis can be extended without major difficulties to handle weakly unique PoSpace, things just get a bit more messy. +The [AAC+17] PoSpace used in $\textsf{Chia}$ is only _weakly unique_. To be able to focus on the main challenges, we will nonetheless assume a _unique_ PoSpace when analyzing $\textsf{Chia}$ but our analysis can be extended without major difficulties to handle weakly unique PoSpace, things just get a bit more messy. To be able to focus on the main challenges, we will nonetheless assume a _unique_ PoSpace when analyzing $\textsf{Chia}$ but our analysis can be extended without major difficulties to handle weakly unique PoSpace, things just get a bit more messy. ### A.2.4 The [AAC+17] PoSpace @@ -85,16 +67,11 @@ We give a very high level outline of the PoSpace from [Pie19b; Wes20] VDFs discussed below also $\tau.\pi$ is unique. -**sequentiality:** -Informally, sequentiality states that for any $t$, an adversary ${\cal A}$ who makes less than $t$ sequential steps will not find an accepting proof on a random challenge. I.e., for some tiny $\epsilon$ +**sequentiality:** Informally, sequentiality states that for any $t$, an adversary ${\cal A}$ who makes less than $t$ sequential steps will not find an accepting proof on a random challenge. I.e., for some tiny $\epsilon$ -$$ -\hspace{-1cm} - \Pr[{\sf VDF.verify}(\tau)={\sf accept}\ \wedge \ \tau.c=c\ \wedge\ \tau.t=t \ :\ c\stackrel{rand}{\gets}\{0,1\}^w,\tau\gets{\cal A}(c,t)]\le \epsilon -$$ +$$ \hspace{-1cm} \Pr[{\sf VDF.verify}(\tau)={\sf accept}\ \wedge \ \tau.c=c\ \wedge\ \tau.t=t \ :\ c\stackrel{rand}{\gets}\{0,1\}^w,\tau\gets{\cal A}(c,t)]\le \epsilon $$ Let us stress that ${\cal A}$ is only bounded by the number of _sequential_ steps, but they can use high parallelism. Thus the VDF output cannot be computed faster by adding parallelism beyond what can be used to speed up a single step of the VDF computation. ### A.3.1 The [Pie19b, Wes20] VDFs -The VDFs proposed in [Pie19b; Wes20] (see [BBBF18a] for an overview of those constructions) are both based on squaring in a group of unknown order, for concreteness let the group be $\mathbb{Z}_N^*$ where $N=pq$ is the product of two large primes $p,q$. On input ${\sf VDF.solve}(c,t)$ one would first map the challenge $c$ on a group element, say as $x_c:= hash(c)\bmod N$, and the output is $(y,\pi)$ with $y=x_c^{2^t}\bmod N$. This $y$ can be computed by squaring $x_c$ sequentially $t$ times $x_c\rightarrow x_c^2\rightarrow x_c^{2^2}\rightarrow \cdots \rightarrow x_c^{2^t}$, and it is conjectured that there is no shortcut to this computation if one doesn't know the factorization of $N$. +The VDFs proposed in \[Pie19b; Wes20\] (see [BBBF18a] for an overview of those constructions) are both based on squaring in a group of unknown order, for concreteness let the group be $\mathbb{Z}_N^*$ where $N=pq$ is the product of two large primes $p,q$. On input ${\sf VDF.solve}(c,t)$ one would first map the challenge $c$ on a group element, say as $x_c:= hash(c)\bmod N$, and the output is $(y,\pi)$ with $y=x_c^{2^t}\bmod N$. This $y$ can be computed by squaring $x_c$ sequentially $t$ times $x_c\rightarrow x_c^2\rightarrow x_c^{2^2}\rightarrow \cdots \rightarrow x_c^{2^t}$, and it is conjectured that there is no shortcut to this computation if one doesn't know the factorization of $N$. The VDFs from [Pie19b; Wes20] differ in how the proof $\pi$ that certifies that $y=x_c^{2^t}\bmod N$ is defined. The proof in [Pie19b] is shorter ($1$ vs. $\log(T)$ elements), but soundness of the proof requires an additional assumption (that taking random roots is hard). diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/green-paper/green-paper-introduction.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/green-paper/green-paper-introduction.md index 7390890b37..19af568982 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/green-paper/green-paper-introduction.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/green-paper/green-paper-introduction.md @@ -52,7 +52,7 @@ This assumption comes at a prize: there's a $1.47$ factor by which the adversari The bound in eq.(1) is not tight in the sense that we don't have an attack that works if we replace "$>$" with "$<$". We have an attack assuming giving the adversary a slightly lower boosting factor of $1.34$ -$$ \textrm{double spending in {\sf Chia}\ possible if : }space_h\cdot vdf_h < space_a \cdot vdf_a \cdot 1.34 $$ +$$ \textrm{double spending in {\sf Chia}\ possible if : }space_h\cdot vdf_h < space_a \cdot vdf_a \cdot 1.34 $$
eq.(3)
diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/green-paper/green-paper-references.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/green-paper/green-paper-references.md index 46313aac7f..8ba22edd52 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/green-paper/green-paper-references.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/green-paper/green-paper-references.md @@ -9,8 +9,8 @@ slug: /green-paper-references | Identifier | Publication | | ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | AAC+17 | Hamza Abusalah, Joël Alwen, Bram Cohen, Danylo Khilko, Krzysztof Pietrzak, and Leonid Reyzin. Beyond Hellman’s time-memory trade-offs with applications to proofs of space. In Tsuyoshi Takagi and Thomas Peyrin, editors, _Advances in Cryptology - ASI- ACRYPT 2017 - 23rd International Conference on the Theory and Applications of Cryptology and Information Security, Hong Kong, China, December 3-7, 2017, Proceedings, Part II_, volume 10625 of _Lecture Notes in Computer Science_, pages 357–379. Springer, 2017. | -| BBBF18 | Dan Boneh, Joseph Bonneau, Benedikt Bu ̈nz, and Ben Fisch. Verifiable delay functions. In Hovav Shacham and Alexandra Boldyreva, editors, _Advances in Cryptology - CRYPTO 2018 - 38th Annual International Cryptology Conference, Santa Barbara, CA, USA, August 19-23, 2018, Proceedings, Part I, volume 10991 of Lecture Notes in Computer Science_, pages 757–788. Springer, 2018. | -| BBF18 | Dan Boneh, Benedikt Bu ̈nz, and Ben Fisch. A survey of two verifi- able delay functions. _IACR Cryptol. ePrint Arch._, page 712, 2018. | +| BBBF18 | Dan Boneh, Joseph Bonneau, Benedikt Bu ̈nz, and Ben Fisch. Verifiable delay functions. In Hovav Shacham and Alexandra Boldyreva, editors, _Advances in Cryptology - CRYPTO 2018 - 38th Annual International Cryptology Conference, Santa Barbara, CA, USA, August 19-23, 2018, Proceedings, Part I, volume 10991 of Lecture Notes in Computer Science_, pages 757–788. Springer, 2018. | +| BBF18 | Dan Boneh, Benedikt Bu ̈nz, and Ben Fisch. A survey of two verifi- able delay functions. _IACR Cryptol. ePrint Arch._, page 712, 2018. | | BDK+19 | Vivek Bagaria, Amir Dembo, Sreeram Kannan, Sewoong Oh, David Tse, Pramod Viswanath, Xuechao Wang, and Ofer Zeitouni. Proof- of-stake longest chain protocols: Security vs predictability. 2019. | | BGK+18 | Christian Badertscher, Peter Gazi, Aggelos Kiayias, Alexander Russell, and Vassilis Zikas. Ouroboros genesis: Composable proof-of-stake blockchains with dynamic availability. In David Lie, Mohammad Mannan, Michael Backes, and XiaoFeng Wang, editors, _Proceedings of the 2018 ACM SIGSAC Conference on Computer and Communications Security, CCS 2018, Toronto, ON, Canada, October 15-19, 2018_, pages 913–930. ACM, 2018. | | BNPW19 | Jonah Brown-Cohen, Arvind Narayanan, Alexandros Psomas, and S. Matthew Weinberg. Formal barriers to longest-chain proof-of-stake protocols. In Anna Karlin, Nicole Immorlica, and Ramesh Johari, editors, _Proceedings of the 2019 ACM Conference on Economics and Computation, EC 2019, Phoenix, AZ, USA, June 24-28, 2019_, pages 459–473. ACM, 2019. | @@ -21,7 +21,7 @@ slug: /green-paper-references | DKT21 | Soubhik Deb, Sreeram Kannan, and David Tse. Posat: Proof-of-work availability and unpredictability, without the work. In Nikita Borisov and Claudia Diaz, editors, _Financial Cryptography and Data Security - 25th International Conference, FC 2021, Virtual Event, March 1-5, 2021, Revised Selected Papers, Part II, volume 12675 of Lecture Notes in Computer Science_, pages 104–128. Springer, 2021. | | DW13 | Christian Decker and Roger Wattenhofer. Information propagation in the bitcoin network. In _13th IEEE International Conference on Peer-to-Peer Computing, IEEE P2P 2013, Trento, Italy, September 9-11, 2013_, Proceedings, pages 1–10. IEEE, 2013. | | EFKP20 | Naomi Ephraim, Cody Freitag, Ilan Komargodski, and Rafael Pass. Continuous verifiable delay functions. Naomi Ephraim, Cody Freitag, Ilan Komargodski, and Rafael Pass. Continuous verifiable delay functions. In Anne Canteaut and Yuval Ishai, editors, _Advances in Cryptology - EUROCRYPT 2020 - 39th Annual International Conference on the Theory and Applications of Cryptographic Techniques, Zagreb, Croatia, May 10-14, 2020, Proceedings, Part III_, volume 12107 of _Lecture Notes in Computer Science_, pages 125–154. Springer, 2020. Springer, 2020. | -| ES18 | Ittay Eyal and Emin Gu ̈n Sirer. Majority is not enough: bitcoin mining is vulnerable. _Commun_. ACM, 61(7):95–102, 2018. | +| ES18 | Ittay Eyal and Emin Gu ̈n Sirer. Majority is not enough: bitcoin mining is vulnerable. _Commun_. ACM, 61(7):95–102, 2018. | | FZ17 | Lei Fan and Hong-Sheng Zhou. iching: A scalable proof-of-stake blockchain in the open setting (or, how to mimic nakamoto’s design via proof-of-stake). _IACR Cryptol. ePrint Arch._, page 656, 2017. | | GKL15 | Juan A. Garay, Aggelos Kiayias, and Nikos Leonardos. The bitcoin backbone protocol: Analysis and applications. In Elisabeth Oswald and Marc Fischlin, editors, _Advances in Cryptology - EUROCRYPT 2015 - 34th Annual International Conference on the Theory and Applications of Cryptographic Techniques, Sofia, Bulgaria, April 26-30, 2015, Proceedings, Part II_, volume 9057 of _Lecture Notes in Computer Science_, pages 281–310. Springer, 2015. | | GKR18 | Peter Gazi, Aggelos Kiayias, and Alexander Russell. Stake-bleeding attacks on proof-of-stake blockchains. In _Crypto Valley Conference on Blockchain Technology, CVCBT 2018, Zug, Switzerland, June 20-22, 2018_, pages 85–92. IEEE, 2018. | @@ -29,10 +29,10 @@ slug: /green-paper-references | Lew21 | Andrew Lewis-Pye. Byzantine generals in the permissionless setting. _CoRR_, abs/2101.07095, 2021. | | LR21 | Andrew Lewis-Pye and Tim Roughgarden. How does blockchain security dictate blockchain implementation? In Yongdae Kim, Jong Kim, Giovanni Vigna, and Elaine Shi, editors, _CCS ’21: 2021 ACM SIGSAC Conference on Computer and Communications Security, Virtual Event, Republic of Korea, November 15 - 19, 2021_, pages 1006–1019. ACM, 2021. | | Pie19a | Krzysztof Pietrzak. Proofs of catalytic space. In Avrim Blum, editor, _10th Innovations in Theoretical Computer Science Conference, ITCS 2019, January 10-12, 2019, San Diego, California, USA_, volume 124 of LIPIcs, pages 59:1–59:25. Schloss Dagstuhl - Leibniz- Zentrum für Informatik, 2019. | -| Pie19b | Krzysztof Pietrzak. Simple verifiable delay functions. In Avrim Blum, editor, 1*0th Innovations in Theoretical Computer Science Conference, ITCS 2019, January 10-12, 2019, San Diego, California, USA*, volume 124 of LIPIcs, pages 60:1–60:15. Schloss Dagstuhl - Leibniz-Zentrum fu ̈r Informatik, 2019. | -| PKF+18 | Sunoo Park, Albert Kwon, Georg Fuchsbauer, Peter Gazi, Joël Alwen, and Krzysztof Pietrzak. Spacemint: A cryptocurrency based on proofs of space. In Sarah Meiklejohn and Kazue Sako, editors, _Financial Cryptography and Data Security - 22nd International Conference, FC 2018, Nieuwpoort, Cura ̧cao, February 26 - March 2, 2018, Revised Selected Papers_, volume 10957 of _Lecture Notes in Computer Science_, pages 480–499. Springer, 2018. | +| Pie19b | Krzysztof Pietrzak. Simple verifiable delay functions. In Avrim Blum, editor, 1*0th Innovations in Theoretical Computer Science Conference, ITCS 2019, January 10-12, 2019, San Diego, California, USA*, volume 124 of LIPIcs, pages 60:1–60:15. Schloss Dagstuhl - Leibniz-Zentrum fu ̈r Informatik, 2019. | +| PKF+18 | Sunoo Park, Albert Kwon, Georg Fuchsbauer, Peter Gazi, Joël Alwen, and Krzysztof Pietrzak. Spacemint: A cryptocurrency based on proofs of space. In Sarah Meiklejohn and Kazue Sako, editors, _Financial Cryptography and Data Security - 22nd International Conference, FC 2018, Nieuwpoort, Cura ̧cao, February 26 - March 2, 2018, Revised Selected Papers_, volume 10957 of _Lecture Notes in Computer Science_, pages 480–499. Springer, 2018. | | PS17 | Rafael Pass and Elaine Shi. The sleepy model of consensus. Rafael Pass and Elaine Shi. The sleepy model of consensus. In Tsuyoshi Takagi and Thomas Peyrin, editors, _Advances in Cryptology - ASIACRYPT 2017 - 23rd International Conference on the Theory and Applications of Cryptology and Information Security, Hong Kong, China, December 3-7, 2017, Proceedings, Part II_, volume 10625 of _Lecture Notes in Computer Science_, pages 380–409. Springer, 2017. Springer, 2017. | -| SNM+21 | Caspar Schwarz-Schilling, Joachim Neu, Barnab ́e Monnot, Aditya Asgaonkar, Ertem Nusret Tas, and David Tse. Three attacks on proof-of-stake ethereum. _IACR Cryptol. ePrint Arch._, page 1413, 2021. | +| SNM+21 | Caspar Schwarz-Schilling, Joachim Neu, Barnab ́e Monnot, Aditya Asgaonkar, Ertem Nusret Tas, and David Tse. Three attacks on proof-of-stake ethereum. _IACR Cryptol. ePrint Arch._, page 1413, 2021. | | SSZ15 | Ayelet Sapirshtein, Yonatan Sompolinsky, and Aviv Zohar. Optimal selfish mining strategies in bitcoin. _CoRR_, abs/1507.06183, 2015. | | Wes20 | Benjamin Wesolowski. Efficient verifiable delay functions. _J. Cryptol._, 33(4):2113–2147, 2020. | diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/green-paper/hash-and-vdf-chains.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/green-paper/hash-and-vdf-chains.md index a700077553..e4c010e737 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/green-paper/hash-and-vdf-chains.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/green-paper/hash-and-vdf-chains.md @@ -12,9 +12,7 @@ A key ingredient in longest-chain blockchains are hash-chains as discussed in § For this writeup, a _hash chain_ is a sequence $b_0,b_1,b_2\ldots$ of blocks, where each block $b_i=\{h_i,x_i\}$ contains some data value $x_i$ (possibly empty) and (with the exception of $b_0$) a hash value of the current data and the previous block. -$$ -h_i:={\sf H}(b_{i-1},x_i) -$$ +$$ h_i:={\sf H}(b_{i-1},x_i) $$ #### Security from hash chains. @@ -22,22 +20,21 @@ A hash chain is immutable in the following sense: --- -**Proposition 2** (immutability of hash chains). _If ${\sf H}$ is a collision-resistant hash function, then it is computationally infeasible to find two distinct hash chains ${\cal H}=b_0,\ldots.b_i$ and ${\cal H'}=b'_0,\ldots,b'_j$ where $h_i=h'_j$ and no chain is a prefix of the other (which holds if they start with the same $x_0=x'_0$)._ +**Proposition 2** (immutability of hash chains). **Proposition 2** (immutability of hash chains). _If ${\sf H}$ is a collision-resistant hash function, then it is computationally infeasible to find two distinct hash chains ${\cal H}=b_0,\ldots.b_i$ and ${\cal H'}=b'_0,\ldots,b'_j$ where $h_i=h'_j$ and no chain is a prefix of the other (which holds if they start with the same $x_0=x'_0$)._ --- ## 4.2 VDF chains
- Illustration of a VDF chain -
Figure 6: Illustration of a VDF chain.
+ Illustration of a VDF chain +
Figure 6: Illustration of a VDF chain.
A VDF chain is a sequence $$ -{\cal V}=z_0,\tau_1,z_1,\tau_2,z_2,\ldots,\tau_\ell -$$ +{\cal V}=z_0,\tau_1,z_1,\tau_2,z_2,\ldots,\tau_\ell $$
eq.(5)
@@ -49,15 +46,13 @@ $$ and the challenge for the $i$th VDF is derived from the previous VDF output (except for $i=1$) and data value -$$ -\tau_1.c := \mathsf{VDF.sample}(z_0) \quad \text{ and } \quad \forall i > 1 : \tau_i.\mathsf{c} := \mathsf{VDF.sample}(\tau_{i-1}.\mathsf{y}, z_{i-1}) -$$ +$$ \tau_1.c := \mathsf{VDF.sample}(z_0) \quad \text{ and } \quad \forall i > 1 : \tau_i.\mathsf{c} := \mathsf{VDF.sample}(\tau_{i-1}.\mathsf{y}, z_{i-1}) $$ where we use the convention that $\tau_0.{\sf y}$ is the empty string. ### 4.2.1 Notation for VDF chains -We naturally extend the notion for VDFs as described in §A.3 to VDF chains. The _total number of VDF steps in a VDF chain_ as in eq.(5) is simply the sum of the steps in its VDFs +We naturally extend the notion for VDFs as described in §A.3 to VDF chains. We naturally extend the notion for VDFs as described in §A.3 to VDF chains. The _total number of VDF steps in a VDF chain_ as in eq.(5) is simply the sum of the steps in its VDFs $$ {\cal V}.{\sf t}\stackrel{\scriptsize \sf def}{=}\sum_{i=1}^\ell \tau_i.{\sf t} @@ -69,16 +64,15 @@ VDF chains give two basic security guarantees, the first is immutability analogo --- -**Proposition 3** (immutability and sequentiality of VDF chains). *Like a hash chain, a VDF chain is *immutable* in the sense that it's computationally infeasible to come up with two different VDF chains* +**Proposition 3** (immutability and sequentiality of VDF chains). **Proposition 3** (immutability and sequentiality of VDF chains). *Like a hash chain, a VDF chain is *immutable* in the sense that it's computationally infeasible to come up with two different VDF chains* $$ -{\cal V}=z_0,\tau_1,z_1,\tau_2,z_2,\ldots,\tau_\ell -\qquad -{\cal V}'=z'_0,\tau'_1,z'_1,\tau'_2,z'_2,\ldots,\tau'_{\ell'} +{\cal V}=z_0,\tau_1,z_1,\tau_2,z_2,\ldots,\tau_\ell \qquad +{\cal V}=z_0,\tau_1,z_1,\tau_2,z_2,\ldots,\tau_\ell \qquad {\cal V}'=z'_0,\tau'_1,z'_1,\tau'_2,z'_2,\ldots,\tau'_{\ell'} $$ -where the last VDF outputs collide, i.e., $\tau_\ell.{\sf y}=\tau'_{\ell'}.{\sf y}$. Here different means that either they have different length $\ell\neq \ell'$ and neither is a prefix of the other. Or (if $\ell=\ell'$) there exists an $i$ s.t. either $z_i\neq z'_i$ or $\tau_i.{\sf y}\neq \tau'_i.{\sf y}$ or $\tau.{\sf t}\neq \tau'.{\sf t}$. Note that we ignore the proofs $\tau.\pi$ when comparing chains (we just use them to determine whether the chain is valid) as they must not be unique. +where the last VDF outputs collide, i.e., $\tau_\ell.{\sf y}=\tau'_{\ell'}.{\sf y}$. Here different means that either they have different length $\ell\neq \ell'$ and neither is a prefix of the other. Or (if $\ell=\ell'$) there exists an $i$ s.t. either $z_i\neq z'_i$ or $\tau_i.{\sf y}\neq \tau'_i.{\sf y}$ or $\tau.{\sf t}\neq \tau'.{\sf t}$. Note that we ignore the proofs $\tau.\pi$ when comparing chains (we just use them to determine whether the chain is valid) as they must not be unique. Here different means that either they have different length $\ell\neq \ell'$ and neither is a prefix of the other. Or (if $\ell=\ell'$) there exists an $i$ s.t. either $z_i\neq z'_i$ or $\tau_i.{\sf y}\neq \tau'_i.{\sf y}$ or $\tau.{\sf t}\neq \tau'.{\sf t}$. Note that we ignore the proofs $\tau.\pi$ when comparing chains (we just use them to determine whether the chain is valid) as they must not be unique. -Moreover a VDF chain is _sequential_, meaning that not only the individual VDFs must be computed sequentially (which follows from the security definition of VDFs), but also the VDFs in the chain were computed sequentially. I.e., computing a chain ${\cal V}$ as above requires $\sum_{i=1}^\ell \tau_i.{\sf t}$ sequential steps. +Moreover a VDF chain is _sequential_, meaning that not only the individual VDFs must be computed sequentially (which follows from the security definition of VDFs), but also the VDFs in the chain were computed sequentially. I.e., computing a chain ${\cal V}$ as above requires $\sum_{i=1}^\ell \tau_i.{\sf t}$ sequential steps. I.e., computing a chain ${\cal V}$ as above requires $\sum_{i=1}^\ell \tau_i.{\sf t}$ sequential steps. --- diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/green-paper/rational-attackers.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/green-paper/rational-attackers.md index 73861a7799..c26f12b576 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/green-paper/rational-attackers.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/green-paper/rational-attackers.md @@ -42,11 +42,9 @@ By the Proposition below delayed gratification and the no slowdown property impl _Proof._ Consider an adversarial miner ${\cal A}$ with an $\alpha$ fraction of the resource and let $\ell$ denote the (expected) number of blocks to be found if everyone would mine honestly. By the no slowdown property, no matter what ${\cal A}$ does the number of blocks found is at least $\ell'\ge (1-\alpha)\cdot\ell$. By delayed gratification, at most $\alpha\cdot\ell$ of those blocks were created by ${\cal A}$, we get a chain quality of By the no slowdown property, no matter what ${\cal A}$ does the number of blocks found is at least $\ell'\ge (1-\alpha)\cdot\ell$. By delayed gratification, at most $\alpha\cdot\ell$ of those blocks were created by ${\cal A}$, we get a chain quality of -$$ -\begin{aligned} \textit{chain quality}&=\frac{\text{honest blocks}}{\text{total blocks}}\\ +$$ \begin{aligned} \textit{chain quality}&=\frac{\text{honest blocks}}{\text{total blocks}}\\ &=\frac{\ell' - \alpha \cdot \ell}{\ell'}\\ &=1-\frac{\alpha\cdot\ell}{\ell'}\\ -&\ge 1-\frac{\alpha\cdot\ell}{(1-\alpha)\cdot \ell}\\ &=1-\frac{\alpha}{1-\alpha} \hspace{10em}\square \end{aligned} -$$ +&\ge 1-\frac{\alpha\cdot\ell}{(1-\alpha)\cdot \ell}\\ &=1-\frac{\alpha}{1-\alpha} \hspace{10em}\square \end{aligned} $$ --- diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/green-paper/recovering-from-51-percent-attacks.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/green-paper/recovering-from-51-percent-attacks.md index 42ab5f8a46..8b20242a42 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/green-paper/recovering-from-51-percent-attacks.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/green-paper/recovering-from-51-percent-attacks.md @@ -14,10 +14,10 @@ We discussed in §2 the main security issues of a PoSpace based longest-chain b
+ ![](/img/green-paper/table-1.png)
- Table 1: Summary of the ability to heal from malicious majority and provide - security under dynamic availability of longest-chain protocols based various - proof systems. + Table 1: Summary of the ability to heal from malicious majority and provide security under dynamic availability of longest-chain protocols based various proof systems. +
@@ -31,21 +31,20 @@ There's also a key difference between PoStake and PoSpace. By using VDFs in addi While Bitcoin provides no security if more than half of the hashrate is controlled by an adversary, it is "self-healing" in the sense that once the majority of the hashrate is again controlled by honest parties, Bitcoin regains (after some delay) all its security properties. -A bit more formally, let ${\sf PoW}_h(t)$ and ${\sf PoW}_a(t)$ denote the hashing power of the honest and adversarial parties at clock time $t$, respectively. For $t_0eq.(11) @@ -53,12 +52,8 @@ If this holds the adversary can simply start at time $t_0$ to mine a chain in pr To be secure it's not sufficient that no $t_0,t_1$ as in eq.(11) exist, but one needs to be "sufficiently far" from this situation to guarantee that double spending can only happen with some tiny probability. From the standard Chernoff bound it follows that the probability that a fork starting at a block added at time $t_0$ and being released at time $t_1$ will be successful (i.e., have higher weight than the honest chain) is exponentially small in the number of expected honest blocks ${\sf PoW}_h(t_0,t_1)/D$ and the square of the honest to adversarial advantage, i.e., -$$ -\begin{aligned} -&\text{Pr}\left[\text{fork starting at } t_0 \text{ and released at } t_1 \text{ heavier than honest chain}\right] \\ -&\le -\exp\left(\frac{\mathsf{PoW}_h(t_0,t_1)}{D} \cdot\left( \frac{\mathsf{PoW}_h(t_0,t_1)}{\mathsf{PoW}_a(t_0,t_1)}-1 \right)^2\right) -\end{aligned} -$$ +$$ \begin{aligned} &\text{Pr}\left[\text{fork starting at } t_0 \text{ and released at } t_1 \text{ heavier than honest chain}\right] \\ +&\le -\exp\left(\frac{\mathsf{PoW}_h(t_0,t_1)}{D} \cdot\left( \frac{\mathsf{PoW}_h(t_0,t_1)}{\mathsf{PoW}_a(t_0,t_1)}-1 \right)^2\right) \end{aligned} $$
eq.(12)
@@ -74,11 +69,11 @@ A longest-chain protocol using only PoSpace (like Spacemint [eq.(6) @@ -116,22 +106,17 @@ The reward chain ${\cal RC}$ is a VDF chain that the time lords evaluate in para Whenever a farmer receives new signage points ${\sf cc\_sp}_{i,j},{\sf rc\_sp}_{i,j}$ they first check whether this points lie on a heaviest chain (cf. the discussion in §1.5) and their VDF proofs verify. If the this is the case, the farmer checks they can create a winning PoSpace proof. This process will, for a subset of the plots, produce a PoSpace $\sigma$ and some additional value $\sigma.{\sf required\_iterations}$. Whether this PoSpace is a winning proof is now determined by the time parameter $T_i$ as -$$ -\textrm{winning condition : } -\sigma.{\sf required\_iterations} < {\sf spi}_i\quad (=T_i/64) -$$ +$$ \textrm{winning condition : } \sigma.{\sf required\_iterations} < {\sf spi}_i\quad (=T_i/64) $$
eq.(7)
:::tip Design Choice 2: Why 32 Blocks in Expectation and not Exactly? -With our winning condition we have 32 blocks per slot _in expectation_ depending on a challenge. We could have used a different design to enforce _exactly_ 32 challenges, but then it would be impossible to achieve our Objective 1.(c), which asks that whether a plot wins must depend solely on the challenge. +With our winning condition we have 32 blocks per slot _in expectation_ depending on a challenge. We could have used a different design to enforce _exactly_ 32 challenges, but then it would be impossible to achieve our Objective 1.(c), which asks that whether a plot wins must depend solely on the challenge. ::: We could have used a different design to enforce _exactly_ 32 challenges, but then it would be impossible to achieve our Objective 1.(c), which asks that whether a plot wins must depend solely on the challenge. ::: If a farmer has a winning PoSpace $\sigma$ they can produce a block $\beta=(\beta_T,\beta_F)$ which contains the foliage block $\beta_F$ and the trunk block $\beta_T$. The actual $\textsf{Chia}$ blocks are more sophisticated than our description below, but in this writeup we focus on the entries which are absolutely necessary for functionality and security of the chain and ignore entries which are there for efficiency like weight proofs for light clients or pooling. They key entries in a valid trunk block -$$ -\beta_T=(\sigma,\mu_{{{\sf rc\_sp}}}) -$$ +$$ \beta_T=(\sigma,\mu_{{{\sf rc\_sp}}}) $$ are @@ -144,22 +129,19 @@ $\mu_{\sf rc\_sp}\gets {{\sf Sig.sign}}(S.sk,{\sf rc\_sp}_{i,j})$, a signature u The reward chain ${\cal RC}$ is a VDF chain that time lords compute in parallel to ${\cal CC}$. Like ${\cal CC}$, ${\cal RC}$ can be spilt in a sequence of slots. $$ -{\cal RC}={\cal RC}_1,{\cal RC}_2,\ldots -$$ +{\cal RC}={\cal RC}_1,{\cal RC}_2,\ldots $$ While in ${\cal CC}$ the $i$th slot just contains a VDF $\tau^{\cal CC}_i$ and the value ${\sf ic}_i$ infused at the end, each slot ${\cal RC}_i$ of the ${\cal RC}$ chain $$ -{\cal RC}_i=\tau^{\cal RC}_{i,1},\beta_1,\tau^{\cal RC}_{i,2},\beta_2\ldots, \beta_{b_i} \tau^{\cal RC}_{i,b_i+1},({\sf ic}_i,\tau^{\cal CC}_{i}.{\sf y}) -$$ +{\cal RC}_i=\tau^{\cal RC}_{i,1},\beta_1,\tau^{\cal RC}_{i,2},\beta_2\ldots, \beta_{b_i} \tau^{\cal RC}_{i,b_i+1},({\sf ic}_i,\tau^{\cal CC}_{i}.{\sf y}) $$
eq.(8)
is a VDF chain with typically around $33$ infused values: around 32 blocks $b_i$ and at the end of the slot also the ${\cal CC}$ and ${\sf i}{\cal CC}$ points at the same depth. The ${\cal RC}$ signage points are $$ -{\sf rc\_sp}_{i,j}\stackrel{\scriptsize \sf def}{=}{\cal RC}_i[j\cdot {\sf spi}_i] -$$ +{\sf rc\_sp}_{i,j}\stackrel{\scriptsize \sf def}{=}{\cal RC}_i[j\cdot {\sf spi}_i] $$
eq.(9)
@@ -182,29 +164,21 @@ Recall that the challenge chain ${\cal CC}$ is used to create PoSpace challenges Concretely, the infused challenge of the $i$th slot is the output of a VDF computation $$ -{\sf ic}_i\stackrel{\scriptsize \sf def}{=}\tau.{\sf y}\qquad \tau={\sf VDF.solve}(x,t) -$$ +{\sf ic}_i\stackrel{\scriptsize \sf def}{=}\tau.{\sf y}\qquad \tau={\sf VDF.solve}(x,t) $$ on some challenge $x$ and time $t$ which are defined as follows. Let $\beta_T=(\sigma,\mu_{{{\sf rc\_sp}}})$ be the first trunk block infused into the $i$th slot ${\cal RC}_i$ past the 3rd signage point, using notion as in eq.(10) -$$ -\beta_T=\beta_j \textrm{ where }j=\min\{k\ :\ \beta_k.{\sf d}>3\cdot {\sf spi}\} -$$ +$$ \beta_T=\beta_j \textrm{ where }j=\min\{k\ :\ \beta_k.{\sf d}>3\cdot {\sf spi}\} $$ now the challenge $x$ is derived from the PoSpace in this block and the value of ${\cal CC}$ at the depth of its infusion point -$$ -\quad -x\gets {\sf VDF.sample}(\sigma,{\cal CC}[{\sf rc\_ip}(\beta_T).{\sf D}].{\sf y}) -$$ +$$ \quad x\gets {\sf VDF.sample}(\sigma,{\cal CC}[{\sf rc\_ip}(\beta_T).{\sf D}].{\sf y}) $$ the number of steps $t$ is the the remaining number of VDF steps in the slot, so the value ${\sf ic}_i$ will be available at the end of the slot when it's required, but not earlier -$$ -t={\sf cc\_ip}_{i,0}.{\sf D}- {\sf rc\_ip}(\beta).{\sf D} -$$ +$$ t={\sf cc\_ip}_{i,0}.{\sf D}- {\sf rc\_ip}(\beta).{\sf D} $$ :::danger Security Notice 1: Why iCC depends only on σ We only use $\sigma$, not the entire trunk block $\beta_T=(\sigma,\mu_{{{\sf rc\_sp}}})$, to compute the infused challenge ${\sf ic}_i$. This is crucial to ensure that the challenges depend only on a single challenge per slot. Had we infused the entire $\beta_T$ (as we do into ${\cal RC}$), the challenges would depend on all blocks (as $\mu_{{\sf rc\_sp}}$ depends on ${\cal RC}$ which infuses all blocks) and we would not get security against double dipping. @@ -232,15 +206,11 @@ To limit the impact of double-dipping we use correlated randomness [ +
Once you have a synced wallet and some TXCH, you are ready to run the CAT admin tool. @@ -96,7 +97,7 @@ values={[ ]}> -Your Linux installation may not come with Python's development tools installed by default. To be sure that these tools are installed, run: +Your Linux installation may not come with Python's development tools installed by default. Your Linux installation may not come with Python's development tools installed by default. To be sure that these tools are installed, run: ```bash sudo apt-get install -y build-essential python3-dev @@ -144,6 +145,31 @@ pip install chia-dev-tools --no-deps Install pytest: +```bash +pip install pytest +``` ./venv/bin/activate +``` + +Install the prerequisites: + +```bash +python3 -m pip install --upgrade pip setuptools wheel +``` + +Install the tool: + +```bash +pip install . +``` + +Install chia dev tools: + +```bash +pip install chia-dev-tools --no-deps +``` + +Install pytest: + ```bash pip install pytest ``` @@ -200,6 +226,23 @@ pip install pytest :::note You might receive an error such as ERROR: Failed building wheel for CAT-admin-tool. This is likely safe to ignore. As long as you can run cats --help without errors, the tool has been installed properly. ::: +``` + +Install Chia dev tools: + +```bash +pip install chia-dev-tools --no-deps +``` + +Install pytest: + +```bash +pip install pytest +``` + +:::note +You might receive an error such as ERROR: Failed building wheel for CAT-admin-tool. This is likely safe to ignore. As long as you can run cats --help without errors, the tool has been installed properly. +::: @@ -207,7 +250,7 @@ You might receive an error such as ERROR: Failed building wheel for CAT-admin-to ---
- + Your environment should be all set, but let's make sure: - Run `cats --help`. You should get a usage statement. @@ -224,7 +267,8 @@ To get started, you will create a single-issuance CAT. This is the default way t :::note -A TAIL is a Chialisp program that defines the rules for issuing and melting tokens. Learn more about the [Token and Asset Issuance Limitations program](https://chialisp.com/cats/#tail). +A TAIL is a Chialisp program that defines the rules for issuing and melting tokens. Learn more about the [Token and Asset Issuance Limitations program](https://chialisp.com/cats/#tail). Learn more about the [Token and Asset Issuance Limitations program](https://chialisp.com/cats/#tail). +Single issuance CATs can **NOT** be melted. ::: @@ -232,7 +276,7 @@ A CAT with a single-issuance TAIL will be useful for anyone who wants to create First, figure out how many tokens you want to issue. Because creating a single token takes 1,000 mojos, you will multiply your supply by 1,000 to figure out how much TXCH (or XCH on mainnet) is needed. For example, if you want to issue 1 million tokens, you'll need 1 billion mojos (1/1000 of a TXCH/XCH). -Take note of your _Receive Address_ in the Chia GUI. (Alternatively, run `chia wallet get_address` from a terminal window.) You'll need this address for the next step. +Take note of your _Receive Address_ in the Chia GUI. (Alternatively, run `chia wallet get_address` from a terminal window.) You'll need this address for the next step. (Alternatively, run `chia wallet get_address` from a terminal window.) You'll need this address for the next step. After confirming you are within the admin tool directory, run: @@ -277,10 +321,12 @@ We'll set up this CAT to delegate the same TAIL we set up previously. What this First, figure out how many tokens you want to issue. Because creating a single token takes 1,000 mojos, you will multiply your supply by 1,000 to figure out how much TXCH (or XCH on mainnet) is needed. For example, if you want to issue 1 million tokens, you'll need 1 billion mojos (1/1000 of a TXCH/XCH). :::note +Multi-issuance CATs can be melted with a custom spend bundle as described [here](#melting-a-cat). + Just as with the Single Issuance CAT, we recommend that you include a fee with your transaction. This fee will ensure that your transaction is processed in front of any dust in the mempool. Whether you're running on testnet or mainnet, the recommended fee amount is 100 million mojos (`-m 100000000`). Even though you will run the `cats` command multiple times, the fee will only be applied once, when the transaction is pushed to the network. ::: -Run `chia wallet get_address` from a terminal window to get a new receive address. You will use this address shortly. +Run `chia wallet get_address` from a terminal window to get a new receive address. You will use this address shortly. You will use this address shortly. Run `chia keys show`. Take note of your **fingerprint** and **master public key**. @@ -339,6 +385,7 @@ Now you can add a wallet ID for your new CAT. In the lower left corner, click `M
Manage Token List
+
The first few tokens listed will be there by default (Marmot, Spacebucks, etc). At the end of the list, you should find your CAT's `asset ID`. Feel free to rename your CAT, and click the slider to add a new wallet with that CAT: @@ -346,6 +393,7 @@ The first few tokens listed will be there by default (Marmot, Spacebucks, etc).
Enable new CAT
+
You will now see your token in your wallet with the full issued quantity. As a reminder, this should be the number of mojos spent divided by 1,000 (as each CAT token requires 1,000 mojos to issue). @@ -353,10 +401,30 @@ You will now see your token in your wallet with the full issued quantity. As a r
View new CAT
+
You now have access to your CAT in the GUI. You can send and receive your new tokens just like you would with regular XCH. +## Melting a CAT + +When you spend one or more CAT coins, you provide an Extra Delta in the solution, which is essentially by how much the supply is changing. If it's positive, you're increasing the supply. And if it's negative, you're melting the CAT away. + +When the Extra Delta is non-zero, you have to run the TAIL program, which describes the rules for when you are allowed to change the supply. + +Single issuance CATs cannot be melted because the TAIL only allows being run if the coin has a specific parent. In other words, the supply can only be set once, and never modified thereafter. For multi issuance CATs, you need to sign with the issuance key in order to authorize the supply change, and therefore it does support melting. + +You reveal and run the TAIL by outputting the following condition from the inner puzzle's spend: +`(list CREATE_COIN () -113 )` + +The documentation for this Extra Delta concept can be found [here](https://chialisp.com/cats/#extra-delta). + +This is an [example](https://github.com/Rigidity/chia-wallet-sdk/blob/main/crates/chia-sdk-driver/src/puzzles/cat/cat_spend.rs#L250-L268) of melting a CAT from Rigidity's wallet SDK. + +In this example, you start with a supply of 10000, use an extra delta of -3000, reveal the TAIL and output a new CAT with the remaining supply of 7000. + +Here is another [example](https://github.com/irulast/chia_crypto_utils/blob/0bbf32a422e2b624cd3f84b7b643b0f83f18be51/integration_test/cat/cat_multi_issuance_test.dart#L44) of melting a CAT from Irulast's chia crypto utils. + ## Preparing for Mainnet After you are comfortable with issuing your CAT on testnet, you may wish to move to mainnet. **Please keep in mind that there are extra risks inherent to publishing code on a public blockchain.** If your seed phrase is ever exposed, your funds could be stolen. If you created a custom TAIL, there is a possiblity of funds being bricked. **Proceed with caution.** @@ -369,7 +437,7 @@ When you are ready to issue your CAT to mainnet, the first step is to switch to chia configure -t false ``` -The second step is to generate a new key pair and store the mnemonic in a secure manner. You can generate your key by clicking `Add Wallet` and `Create New` from the `Wallet Keys` login screen of the GUI. This will work in the same manner as earlier for our testnet CAT. +The second step is to generate a new key pair and store the mnemonic in a secure manner. The second step is to generate a new key pair and store the mnemonic in a secure manner. You can generate your key by clicking `Add Wallet` and `Create New` from the `Wallet Keys` login screen of the GUI. This will work in the same manner as earlier for our testnet CAT. This will work in the same manner as earlier for our testnet CAT. :::danger We recommend the new keypair being used exclusively for the CAT ownership. @@ -382,9 +450,7 @@ This would be a complex and time-consuming process that would likely result in p ::: :::tip -You can generate keys from the CLI as well. -Use `chia keys show` to see your available keys. Take note of their fingerprint as you will want to _not_ use an existing key. -Generate a key with `chia keys generate`, followed by `chia keys show --show-mnemonic-seed` to reveal the 24 words. +You can generate keys from the CLI as well. Use `chia keys show` to see your available keys. Take note of their fingerprint as you will want to _not_ use an existing key. Generate a key with `chia keys generate`, followed by `chia keys show --show-mnemonic-seed` to reveal the 24 words. ::: Copy your new key pair's **mnemonic seed (24 secret words)** to a secure offline location. These 24 words are all you'll need to restore your wallet in the future. @@ -395,6 +461,6 @@ Finally, you can go through the same process to create a CAT now using real XCH Congratulations! You've created your first CAT. What now? -Well, hopefully you can share your CAT with the world and get some traction. In the meantime, you can learn more about the [Single Issuance TAIL](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/wallet/cat_wallet/puzzles/genesis_by_coin_id.clsp) and [Multi Issuance TAIL](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/wallet/cat_wallet/puzzles/delegated_tail.clsp). +Well, hopefully you can share your CAT with the world and get some traction. Well, hopefully you can share your CAT with the world and get some traction. In the meantime, you can learn more about the [Single Issuance TAIL](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/wallet/cat_wallet/puzzles/genesis_by_coin_id.clsp) and [Multi Issuance TAIL](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/wallet/cat_wallet/puzzles/delegated_tail.clsp). This guide was for fungible tokens. Now you can learn about [non-fungible tokens](/guides/nft-intro). diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guides/cat/cat2-upgrade/cat2-issuance.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guides/cat/cat2-upgrade/cat2-issuance.md index 041427d9bf..9a37338603 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guides/cat/cat2-upgrade/cat2-issuance.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guides/cat/cat2-upgrade/cat2-issuance.md @@ -64,6 +64,7 @@ python -m venv venv ```bash python3 -m venv venv . ./venv/bin/activate +``` ./venv/bin/activate ``` @@ -72,6 +73,7 @@ python3 -m venv venv ```bash python3 -m venv venv . ./venv/bin/activate +``` ./venv/bin/activate ``` @@ -164,7 +166,7 @@ If you are unsure whether your CAT used a single- or multi-issuance TAIL, step 1 - You can run either the light wallet or a full node. - You are recommended to have enough mojos to cover transaction fees for the reissuance. The recommended amount is five hundred thousand (500,000) mojos per coin to be reissued. - You are **required** to have a single coin that is large enough to cover the entire reissuance. Even if your XCH balance is sufficient, it may be separated into multiple small coins. The easiest way to ensure that you have a sufficiently large coin is to send a transaction to yourself of at least the total value required. - ::: +::: 3. Use the CAT Admin Tool to select a coin that will be used for issuing the CAT2 tokens. @@ -363,7 +365,7 @@ You need to use the same public/private key pair to sign the CAT2 issuance as yo - You can run either the light wallet or a full node. - You are recommended to have enough mojos to cover transaction fees for the reissuance. The recommended amount is five hundred thousand (500,000) mojos per coin to be reissued. - You are **required** to have a single coin that is large enough to cover the entire reissuance. Even if your XCH balance is sufficient, it may be separated into multiple small coins. The easiest way to ensure that you have a sufficiently large coin is to send a transaction to yourself of at least the total value required. - ::: +::: 3. Use the CAT Admin Tool to select a coin that will be used for issuing the CAT2 tokens. @@ -622,6 +624,7 @@ values={[ ```powershell cats --tail .\reference_tails\delegated_tail.clsp.hex --curry 0x8a7afe10d00899b94cf0d407b85e1b9fca21868bcf158563fe9432b60e36db7136055186221fbd27ecc7fc0d5b99ef1b --send-to xch1rd7hejemt57amqtxq8azqg90hgxyhd9shwyjuppq5ez2jn4rlznscn4efy --amount 6000000000 --as-bytes --solution "(a (q 2 (i 47 (q 8) (q 2 (i (= 45 2) () (q 8)) 1)) 1) (c (q . 0x11038a7e107cb7e17a503ba201d94166018deecd777314e4697c5269d9f37fb6) 1))" --signature b75390ee21b001b7a721f719ff045e3dc2a1072ab0824a8e75c881398db0fbed8fde5c62bbdfe629dce5da3d77834559016acd6d403f9b90d3102da2e9452461457514088af0cabe0b8a8493fc9c09d1785f1322abc8958ecf7907eba0e0abcc +``` 0x11038a7e107cb7e17a503ba201d94166018deecd777314e4697c5269d9f37fb6) 1))" --signature b75390ee21b001b7a721f719ff045e3dc2a1072ab0824a8e75c881398db0fbed8fde5c62bbdfe629dce5da3d77834559016acd6d403f9b90d3102da2e9452461457514088af0cabe0b8a8493fc9c09d1785f1322abc8958ecf7907eba0e0abcc ``` diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guides/cat/cat2-upgrade/cat2-snapshot.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guides/cat/cat2-upgrade/cat2-snapshot.md index e8c6538d78..e6e2e341fa 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guides/cat/cat2-upgrade/cat2-snapshot.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guides/cat/cat2-upgrade/cat2-snapshot.md @@ -44,17 +44,18 @@ values={[ ]}> -- If you previously installed Chia from a **binary build**, then set up an alias to the `chia` command: +1. If you previously installed Chia from a **binary build**, then set up an alias to the `chia` command: :::caution Ensure that you replace `` and `` with the actual folders -::: + +::: ```powershell Set-Alias -Name chia "C:\Users\\AppData\Local\chia-blockchain\app-\resources\app.asar.unpacked\daemon\chia.exe" ``` -- If you previously installed Chia **from source**, then navigate to the `chia-blockchain` directory and activate your virtual environment: +2. If you previously installed Chia **from source**, then navigate to the `chia-blockchain` directory and activate your virtual environment: ```powershell .\venv\Scripts\Activate.ps1 @@ -65,25 +66,29 @@ Set-Alias -Name chia "C:\Users\\AppData\Local\chia-blockchain\app- -- If you previously installed Chia from a **binary build**, then set up an alias to the `chia` command: +1. If you previously installed Chia from a **binary build**, then set up an alias to the `chia` command: ```bash alias chia="/Applications/Chia.app/Contents/Resources/app.asar.unpacked/daemon/chia" ``` -- If you previously installed Chia **from source**, then navigate to the `chia-blockchain` directory and activate your virtual environment: +2. If you previously installed Chia **from source**, then navigate to the `chia-blockchain` directory and activate your virtual environment: ```bash . ./activate +``` ./activate ``` @@ -110,9 +115,8 @@ alias chia="/Applications/Chia.app/Contents/Resources/app.asar.unpacked/daemon/c 3. `START_HEIGHT` - The height of the blockchain to start creating the snapshot from (default: `0`). If you are attempting to obtain all records for your CAT, the recommended start height is `1146800`, which is just before CAT1 was introduced. 4. `TARGET_HEIGHT` - The height of the blockchain to end the snapshot (no default - must be set). The recommended height is `2311760`, which is the last block at which CAT1 is valid. - :::caution - Running this process with the recommended block heights could take over 40 hours to complete. You may wish to test it first by setting the `TARGET_HEIGHT` to `1146900`. This will pull data from only 100 blocks, which should only take a few seconds. - ::: + :::caution Running this process with the recommended block heights could take over 40 hours to complete. You may wish to test it first by setting the `TARGET_HEIGHT` to `1146900`. This will pull data from only 100 blocks, which should only take a few seconds. +::: In order to set these variables, you are recommended to put them into a file called `.env` at the root of the `CAT-addresses` project. The tool will automatically read the variables in this file. For example: @@ -192,6 +196,7 @@ python3 setup.py install :::note The result may contain several warnings such as `WARNING: The wheel package is not available.` These can be safely ignored. ::: +::: This command may take a few minutes to complete. At the end of the output, you should see something like: @@ -242,6 +247,7 @@ python3 setup_database.py :::tip If you receive an error message such as `ModuleNotFoundError: No module named 'chia'`, then make sure you can run the `chia` command from this directory and try again. ::: +::: If this command succeeds, then it will output: @@ -286,7 +292,7 @@ python3 start.py This command will show its progress according to the block height. If you used the recommended range for `START_HEIGHT` and `TARGET_HEIGHT` in your `.env` file, then this command could take over 40 hours to complete. The reason it takes so long is it needs to process each block, one at a time. If multiple blocks were done in parallel, then there would be a chance that the results would not be accurate. By processing one block at a time, the tool will return the correct results for the range provided. :::note -You can only generate a snapshot for each block once. If you attempt to run this command over a range against which it has already been run, you will receive an error containing this message: +You can only generate a snapshot for each block once. If you attempt to run this command over a range against which it has already been run, you will receive an error containing this message: If you attempt to run this command over a range against which it has already been run, you will receive an error containing this message: ``` sqlite3.IntegrityError: UNIQUE constraint failed: coin_create.coin_name @@ -373,10 +379,10 @@ python3 export.py --output-dir /Users/Username/CAT-addresses/results/CKC_ --tail - `` - a string to be prepended to the output file name - `` - the TAIL hash you obtained from taildatabase.com - `--coins` - an **optional** flag that will add information about individual coins to the output (which might be helpful for auditing purposes) - ::: +::: :::note -This command will not create any directories, so make sure `` already exists before running it. Otherwise, you will receive a `FileNotFoundError`. +This command will not create any directories, so make sure `` already exists before running it. Otherwise, you will receive a `FileNotFoundError`. ::: Otherwise, you will receive a `FileNotFoundError`. ::: ## Fix EOL Characters {#fix-eol} diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guides/cat/cr-cat-tutorial.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guides/cat/cr-cat-tutorial.md index ee81b6d1db..8307fd3a2d 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guides/cat/cr-cat-tutorial.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guides/cat/cr-cat-tutorial.md @@ -53,6 +53,7 @@ It is possible to brick\* funds by sending them to an address without the approp \* Technically, the funds will remain recoverable, but this process will not be easy. ::: +::: ### DID and VC Setup @@ -134,6 +135,7 @@ The VC is also viewable from the GUI:
Authorized provider VC
+
#### VC Holder Wallet @@ -181,6 +183,7 @@ The VC is also viewable from the GUI:
Holder VC
+
#### XCH Wallet @@ -246,6 +249,19 @@ python3 -m pip install --upgrade pip setuptools wheel Install the CAT admin tool: +```bash +pip install . +``` ./venv/bin/activate +``` + +Install all prerequisites: + +```bash +python3 -m pip install --upgrade pip setuptools wheel +``` + +Install the CAT admin tool: + ```bash pip install . ``` @@ -287,6 +303,7 @@ Install the CAT admin tool: ```bash pip install . +``` ``` @@ -371,6 +388,7 @@ Response (truncated): ```bash ... +... Profile 1: -Total Balance: 1.0 -Pending Total Balance: 1.0 @@ -460,6 +478,7 @@ Response (truncated): ```bash ... +... CAT 3ba9e16dca39f3fb...: -Total Balance: 1000.0 (1000000 mojo) -Balance Pending VC Approval: 0.0 (0 mojo) @@ -478,6 +497,7 @@ This information is also viewable in the GUI:
CR-CAT issuance
+
The Authorized Provider now has control of all 1000 of the issued CR-CATs. This type of CAT is distinguished in the GUI by a padlock icon and `Restricted CAT`. The Authorized Provider now has control of all 1000 of the issued CR-CATs. This type of CAT is distinguished in the GUI by a padlock icon and `Restricted CAT`. The Authorized Provider also possesses a VC with the required proof (`test_proof1`), so a green icon appears when viewing the CAT. @@ -493,6 +513,7 @@ You can send CR-CATs just as you would with regular CATs:
CR-CAT send
+
You should see a "success" message: @@ -500,6 +521,7 @@ You should see a "success" message:
CR-CAT send success
+
In this example, the recipient is the VC Holder's wallet. This wallet holds the credential with the required proof (`test_proof1`) for holding this CR-CAT. Because the proof exists, a green `APPROVE` button will appear. @@ -509,6 +531,7 @@ From the VC Holder's wallet, click this button to finalize the transaction:
VC Holder Approve
+
An on-chain transaction is required for the approval to be processed. An on-chain transaction is required for the approval to be processed. This is necessary to guard against unauthorized wallets holding CR-CATs, as will be demonstrated later in this tutorial. Enter a transaction fee and click `APPROVE PENDING TRANSACTIONS`: Enter a transaction fee and click `APPROVE PENDING TRANSACTIONS`: @@ -516,6 +539,7 @@ An on-chain transaction is required for the approval to be processed. An on-chai
Approve pending transactions
+
After the transaction has been processed, the CR-CATs will become available to the VC Holder, who can now send or trade them just like normal CATs. @@ -523,6 +547,7 @@ After the transaction has been processed, the CR-CATs will become available to t
CR-CAT approved
+
### Sending from the CLI @@ -555,6 +580,7 @@ Response: ```bash Submitting transaction... +Submitting transaction... Transaction submitted to nodes: [{'peer_id': 'b3d9de85d29931c10050b56c7afb91c99141943fc81ff2d1a8425e52be0d08ab', 'inclusion_status': 'SUCCESS', 'error_msg': None}] Run 'chia wallet get_transaction -f 3152280463 -tx 0xab577bdce7fdd1be8b4e0634ad69aa5cff66f6d9dc7d26e0119d1a3a740f91e8' to get status ``` @@ -573,6 +599,8 @@ Status: Confirmed Amount sent: 100 CAT 3ba9e16dca39f3fb... To address: txch1yzjq802ym3lv9aupl6nyvv6s24fdm9wpnte2rvhk04arr3jyt4js2287gz Created at: 2023-09-22 09:21:25 +To address: txch1yzjq802ym3lv9aupl6nyvv6s24fdm9wpnte2rvhk04arr3jyt4js2287gz +Created at: 2023-09-22 09:21:25 ``` **After switching to the VC Holder's wallet**, you should see the CR-CATs that are pending approval (in this case `100.0 (100000 mojo)`): @@ -669,6 +697,7 @@ In this example, as the **Authorized Provider**, click `CREATE AN OFFER` from th
Create an Offer
+
Next, fill out the Offer Builder. Next, fill out the Offer Builder. For this example, we will offer to trade 99 CR-CATs for 0.1 TXCH: @@ -676,6 +705,7 @@ Next, fill out the Offer Builder. Next, fill out the Offer Builder. For this exa
Offer Builder
+
After creating the Offer, Authorized Provider can save it as a local file or post it to a marketplace. @@ -685,6 +715,7 @@ For this example, we will change to the **VC Holder** wallet and load the Offer
Accept Offer
+
While the on-chain transaction to accept the Offer is pending, the 99 CR-CATs will be displayed in the VC Holder's `Pending Balance`. Note that the `Pending Balance for Approval` is `0` in this case: Note that the `Pending Balance for Approval` is `0` in this case: @@ -692,6 +723,7 @@ While the on-chain transaction to accept the Offer is pending, the 99 CR-CATs wi
Pending Offer Acceptance
+
After the transaction has been confirmed, the balance is updated. After the transaction has been confirmed, the balance is updated. When receiving CR-CATs via an Offer, there is no need to perform another transaction to approve of the incoming tokens. This is because the proof requirement is already baked into the Offer file. This is because the proof requirement is already baked into the Offer file. @@ -699,6 +731,7 @@ After the transaction has been confirmed, the balance is updated. After the tran
Completed Offer
+
At this point, the VC Holder wallet has full possession of the CR-CATs. @@ -837,6 +870,7 @@ Let's say the Authorized Provider obtains the XCH Wallet's address and sends 50
Send CR-CATs to address lacking proofs
+
Even though the recipient is not allowed to hold these CR-CATs, the transaction itself is valid. Even though the recipient is not allowed to hold these CR-CATs, the transaction itself is valid. However, just as in the examples at the beginning of this tutorial, the XCH Wallet will receive the CR-CATs in the `Pending Balance for Approval` section of the GUI. In this case, the required proof (in the red circle below) is not present. In this case, the required proof (in the red circle below) is not present. @@ -846,11 +880,13 @@ The XCH Wallet can still attempt to approve these CR-CATs:
Proof not present
+
Attempt to approve
+
However, this attempt will fail because the required proofs are missing: @@ -858,6 +894,7 @@ However, this attempt will fail because the required proofs are missing:
Required providers missing
+
The status of these CR-CATs is as follows: @@ -887,6 +924,7 @@ Let's say the owner of the XCH Wallet locates a CR-CAT Offer. Let's say the owne
Offer where required providers missing
+
Any attempts to accept this Offer without first receiving a VC with the required proofs will fail: @@ -894,6 +932,7 @@ Any attempts to accept this Offer without first receiving a VC with the required
Offer acceptance where required providers missing
+
Thus, when using Offers, the funds cannot accidentally be sent to an unauthorized recipient. diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guides/clawback/clawback-primitive-guide.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guides/clawback/clawback-primitive-guide.md index cc6e3591ca..d17d335e02 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guides/clawback/clawback-primitive-guide.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guides/clawback/clawback-primitive-guide.md @@ -105,6 +105,7 @@ python -m venv venv ```bash python3 -m venv venv . ./venv/bin/activate +``` ./venv/bin/activate ``` @@ -113,6 +114,7 @@ python3 -m venv venv ```bash python3 -m venv venv . ./venv/bin/activate +``` ./venv/bin/activate ``` diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guides/clawback/clawback-user-guide.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guides/clawback/clawback-user-guide.md index 9fd453a517..cda71653b8 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guides/clawback/clawback-user-guide.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guides/clawback/clawback-user-guide.md @@ -229,7 +229,7 @@ The receiver's wallet will show a pending transaction, including the value, the - While the transaction is in this state, it does not show up in any of the `Balance` fields in the receiver's wallet. This is because the sender can still claw it back. The receiver should therefore not assume the amount will eventually be claimed. This is because the sender can still claw it back. The receiver should therefore not assume the amount will eventually be claimed. - The timer showing how long until the transaction can be claimed does not begin counting down until the original transaction is confirmed on the blockchain. -::: +:::
@@ -48,6 +49,9 @@ python3 -m venv venv . ./venv/bin/activate python -m pip install --upgrade pip setuptools wheel pip install . +``` ./venv/bin/activate +python -m pip install --upgrade pip setuptools wheel +pip install . ``` @@ -344,8 +348,7 @@ Use chia wallet get_offers --id 41f5bfab75ff5f35489b0954597aa76c56ed7098aa9ad137 ``` -You'll notice there is a line for `Included Fees`, which is currently 0. As the blockchain becomes more saturated, a fee may need to be applied by either the maker or taker with an additional CLI flag. -Let's continue by getting the offer's information. +You'll notice there is a line for `Included Fees`, which is currently 0. As the blockchain becomes more saturated, a fee may need to be applied by either the maker or taker with an additional CLI flag. Let's continue by getting the offer's information. ```bash chia wallet get_offers --id 41f5bfab75ff5f35489b0954597aa76c56ed7098aa9ad137f0132b584541119f -f 1660000549 @@ -428,8 +431,7 @@ Once you have the image URL and the hash, we can create the NFT with a command l chia wallet nft mint -i -u -nh -m ``` -This will include the wallet ID, URL, data hash, and a fee. -If this command is issued successfully, you will have created an NFT on Chia! +This will include the wallet ID, URL, data hash, and a fee. If this command is issued successfully, you will have created an NFT on Chia! You can get the details of your new NFT with: @@ -465,32 +467,32 @@ Response: ``` NFT minted Successfully with spend bundle: { - 'aggregated_signature': '0x8673a394dca82d91cd1ddeff0b518cb02056fa24ce45b8cda4e7819258c9cc13a68ed71d4d25ef7254358af2f033d99b180b2b0255a8f113d699517e7019b825b09f68eb126da228f82b474f316bc8a657310a527ff54a4668971e9486c39c89', - 'coin_solutions': [{ - 'coin': { - 'amount': 1, - 'parent_coin_info': '0x75690e6a336be6223d3282d71085af366a1c94e9418c25ca9f5fba9d29e09a8d', - 'puzzle_hash': '0xd41dce69252d14db9a19eb0fcbd0e014d416245460b76a9fe4e7a8030e1bb4c6' - }, - 'puzzle_reveal': '0xff02ffff01ff02ffff01ff02ffff03ffff18ff2fff3480ffff01ff04ffff04ff20ffff04ff2fff808080ffff04ffff02ff3effff04ff02ffff04ff05ffff04ffff02ff2affff04ff02ffff04ff27ffff04ffff02ffff03ff77ffff01ff02ff36ffff04ff02ffff04ff09ffff04ff57ffff04ffff02ff2effff04ff02ffff04ff05ff80808080ff808080808080ffff011d80ff0180ffff04ffff02ffff03ff77ffff0181b7ffff015780ff0180ff808080808080ffff04ff77ff808080808080ffff02ff3affff04ff02ffff04ff05ffff04ffff02ff0bff5f80ffff01ff8080808080808080ffff01ff088080ff0180ffff04ffff01ffffffff4947ff0233ffff0401ff0102ffffff20ff02ffff03ff05ffff01ff02ff32ffff04ff02ffff04ff0dffff04ffff0bff3cffff0bff34ff2480ffff0bff3cffff0bff3cffff0bff34ff2c80ff0980ffff0bff3cff0bffff0bff34ff8080808080ff8080808080ffff010b80ff0180ffff02ffff03ffff22ffff09ffff0dff0580ff2280ffff09ffff0dff0b80ff2280ffff15ff17ffff0181ff8080ffff01ff0bff05ff0bff1780ffff01ff088080ff0180ff02ffff03ff0bffff01ff02ffff03ffff02ff26ffff04ff02ffff04ff13ff80808080ffff01ff02ffff03ffff20ff1780ffff01ff02ffff03ffff09ff81b3ffff01818f80ffff01ff02ff3affff04ff02ffff04ff05ffff04ff1bffff04ff34ff808080808080ffff01ff04ffff04ff23ffff04ffff02ff36ffff04ff02ffff04ff09ffff04ff53ffff04ffff02ff2effff04ff02ffff04ff05ff80808080ff808080808080ff738080ffff02ff3affff04ff02ffff04ff05ffff04ff1bffff04ff34ff8080808080808080ff0180ffff01ff088080ff0180ffff01ff04ff13ffff02ff3affff04ff02ffff04ff05ffff04ff1bffff04ff17ff8080808080808080ff0180ffff01ff02ffff03ff17ff80ffff01ff088080ff018080ff0180ffffff02ffff03ffff09ff09ff3880ffff01ff02ffff03ffff18ff2dffff010180ffff01ff0101ff8080ff0180ff8080ff0180ff0bff3cffff0bff34ff2880ffff0bff3cffff0bff3cffff0bff34ff2c80ff0580ffff0bff3cffff02ff32ffff04ff02ffff04ff07ffff04ffff0bff34ff3480ff8080808080ffff0bff34ff8080808080ffff02ffff03ffff07ff0580ffff01ff0bffff0102ffff02ff2effff04ff02ffff04ff09ff80808080ffff02ff2effff04ff02ffff04ff0dff8080808080ffff01ff0bffff0101ff058080ff0180ff02ffff03ffff21ff17ffff09ff0bff158080ffff01ff04ff30ffff04ff0bff808080ffff01ff088080ff0180ff018080ffff04ffff01ffa07faa3253bfddd1e0decb0906b2dc6247bbc4cf608f58345d173adb63e8b47c9fffa075690e6a336be6223d3282d71085af366a1c94e9418c25ca9f5fba9d29e09a8da0eff07522495060c066f66f32acc2a77e3a3e737aca8baea4d1a64ea4cdc13da9ffff04ffff01ff02ffff01ff02ffff01ff02ff3effff04ff02ffff04ff05ffff04ffff02ff2fff5f80ffff04ff80ffff04ffff04ffff04ff0bffff04ff17ff808080ffff01ff808080ffff01ff8080808080808080ffff04ffff01ffffff0233ff04ff0101ffff02ff02ffff03ff05ffff01ff02ff1affff04ff02ffff04ff0dffff04ffff0bff12ffff0bff2cff1480ffff0bff12ffff0bff12ffff0bff2cff3c80ff0980ffff0bff12ff0bffff0bff2cff8080808080ff8080808080ffff010b80ff0180ffff0bff12ffff0bff2cff1080ffff0bff12ffff0bff12ffff0bff2cff3c80ff0580ffff0bff12ffff02ff1affff04ff02ffff04ff07ffff04ffff0bff2cff2c80ff8080808080ffff0bff2cff8080808080ffff02ffff03ffff07ff0580ffff01ff0bffff0102ffff02ff2effff04ff02ffff04ff09ff80808080ffff02ff2effff04ff02ffff04ff0dff8080808080ffff01ff0bffff0101ff058080ff0180ff02ffff03ff0bffff01ff02ffff03ffff09ff23ff1880ffff01ff02ffff03ffff18ff81b3ff2c80ffff01ff02ffff03ffff20ff1780ffff01ff02ff3effff04ff02ffff04ff05ffff04ff1bffff04ff33ffff04ff2fffff04ff5fff8080808080808080ffff01ff088080ff0180ffff01ff04ff13ffff02ff3effff04ff02ffff04ff05ffff04ff1bffff04ff17ffff04ff2fffff04ff5fff80808080808080808080ff0180ffff01ff02ffff03ffff09ff23ffff0181e880ffff01ff02ff3effff04ff02ffff04ff05ffff04ff1bffff04ff17ffff04ffff02ffff03ffff22ffff09ffff02ff2effff04ff02ffff04ff53ff80808080ff82014f80ffff20ff5f8080ffff01ff02ff53ffff04ff818fffff04ff82014fffff04ff81b3ff8080808080ffff01ff088080ff0180ffff04ff2cff8080808080808080ffff01ff04ff13ffff02ff3effff04ff02ffff04ff05ffff04ff1bffff04ff17ffff04ff2fffff04ff5fff80808080808080808080ff018080ff0180ffff01ff04ffff04ff18ffff04ffff02ff16ffff04ff02ffff04ff05ffff04ff27ffff04ffff0bff2cff82014f80ffff04ffff02ff2effff04ff02ffff04ff818fff80808080ffff04ffff0bff2cff0580ff8080808080808080ff378080ff81af8080ff0180ff018080ffff04ffff01a0a04d9f57764f54a43e4030befb4d80026e870519aaa66334aef8304f5d0393c2ffff04ffff01ffff75ffc04468747470733a2f2f696d616765732e706578656c732e636f6d2f70686f746f732f31313035333037322f706578656c732d70686f746f2d31313035333037322e6a70656780ffff68a014836b86a48e1b2b5e857213af97534704475b4c155d34b2cb83ed4b7cba2bb0ffff826d7580ffff826c7580ffff82736e01ffff8273740180ffff04ffff01a0fe8a4b4e27a2e29a4d3fc7ce9d527adbcaccbab6ada3903ccf3ba9a769d2d78bffff04ffff01ff02ffff01ff02ffff01ff02ff26ffff04ff02ffff04ff05ffff04ff17ffff04ff0bffff04ffff02ff2fff5f80ff80808080808080ffff04ffff01ffffff82ad4cff0233ffff3e04ff81f601ffffff0102ffff02ffff03ff05ffff01ff02ff2affff04ff02ffff04ff0dffff04ffff0bff32ffff0bff3cff3480ffff0bff32ffff0bff32ffff0bff3cff2280ff0980ffff0bff32ff0bffff0bff3cff8080808080ff8080808080ffff010b80ff0180ff04ffff04ff38ffff04ffff02ff36ffff04ff02ffff04ff05ffff04ff27ffff04ffff02ff2effff04ff02ffff04ffff02ffff03ff81afffff0181afffff010b80ff0180ff80808080ffff04ffff0bff3cff4f80ffff04ffff0bff3cff0580ff8080808080808080ff378080ff82016f80ffffff02ff3effff04ff02ffff04ff05ffff04ff0bffff04ff17ffff04ff2fffff04ff2fffff01ff80ff808080808080808080ff0bff32ffff0bff3cff2880ffff0bff32ffff0bff32ffff0bff3cff2280ff0580ffff0bff32ffff02ff2affff04ff02ffff04ff07ffff04ffff0bff3cff3c80ff8080808080ffff0bff3cff8080808080ffff02ffff03ffff07ff0580ffff01ff0bffff0102ffff02ff2effff04ff02ffff04ff09ff80808080ffff02ff2effff04ff02ffff04ff0dff8080808080ffff01ff0bffff0101ff058080ff0180ff02ffff03ff5fffff01ff02ffff03ffff09ff82011fff3880ffff01ff02ffff03ffff09ffff18ff82059f80ff3c80ffff01ff02ffff03ffff20ff81bf80ffff01ff02ff3effff04ff02ffff04ff05ffff04ff0bffff04ff17ffff04ff2fffff04ff81dfffff04ff82019fffff04ff82017fff80808080808080808080ffff01ff088080ff0180ffff01ff04ff819fffff02ff3effff04ff02ffff04ff05ffff04ff0bffff04ff17ffff04ff2fffff04ff81dfffff04ff81bfffff04ff82017fff808080808080808080808080ff0180ffff01ff02ffff03ffff09ff82011fff2c80ffff01ff02ffff03ffff20ff82017f80ffff01ff04ffff04ff24ffff04ffff0eff10ffff02ff2effff04ff02ffff04ff82019fff8080808080ff808080ffff02ff3effff04ff02ffff04ff05ffff04ff0bffff04ff17ffff04ff2fffff04ff81dfffff04ff81bfffff04ffff02ff0bffff04ff17ffff04ff2fffff04ff82019fff8080808080ff8080808080808080808080ffff01ff088080ff0180ffff01ff02ffff03ffff09ff82011fff2480ffff01ff02ffff03ffff20ffff02ffff03ffff09ffff0122ffff0dff82029f8080ffff01ff02ffff03ffff09ffff0cff82029fff80ffff010280ff1080ffff01ff0101ff8080ff0180ff8080ff018080ffff01ff04ff819fffff02ff3effff04ff02ffff04ff05ffff04ff0bffff04ff17ffff04ff2fffff04ff81dfffff04ff81bfffff04ff82017fff8080808080808080808080ffff01ff088080ff0180ffff01ff04ff819fffff02ff3effff04ff02ffff04ff05ffff04ff0bffff04ff17ffff04ff2fffff04ff81dfffff04ff81bfffff04ff82017fff808080808080808080808080ff018080ff018080ff0180ffff01ff02ff3affff04ff02ffff04ff05ffff04ff0bffff04ff81bfffff04ffff02ffff03ff82017fffff0182017fffff01ff02ff0bffff04ff17ffff04ff2fffff01ff808080808080ff0180ff8080808080808080ff0180ff018080ffff04ffff01a0c5abea79afaa001b5427dfa0c8cf42ca6f38f5841b78f9b3c252733eb2de2726ffff04ffff0180ffff04ffff01ff02ffff01ff02ffff01ff02ffff03ff81bfffff01ff04ff82013fffff04ff80ffff04ffff02ffff03ffff22ff82013fffff20ffff09ff82013fff2f808080ffff01ff04ffff04ff10ffff04ffff0bffff02ff2effff04ff02ffff04ff09ffff04ff8205bfffff04ffff02ff3effff04ff02ffff04ffff04ff09ffff04ff82013fff1d8080ff80808080ff808080808080ff1580ff808080ffff02ff16ffff04ff02ffff04ff0bffff04ff17ffff04ff8202bfffff04ff15ff8080808080808080ffff01ff02ff16ffff04ff02ffff04ff0bffff04ff17ffff04ff8202bfffff04ff15ff8080808080808080ff0180ff80808080ffff01ff04ff2fffff01ff80ff80808080ff0180ffff04ffff01ffffff3f02ff04ff0101ffff822710ff02ff02ffff03ff05ffff01ff02ff3affff04ff02ffff04ff0dffff04ffff0bff2affff0bff2cff1480ffff0bff2affff0bff2affff0bff2cff3c80ff0980ffff0bff2aff0bffff0bff2cff8080808080ff8080808080ffff010b80ff0180ffff02ffff03ff17ffff01ff04ffff04ff10ffff04ffff0bff81a7ffff02ff3effff04ff02ffff04ffff04ff2fffff04ffff04ff05ffff04ffff05ffff14ffff12ff47ff0b80ff128080ffff04ffff04ff05ff8080ff80808080ff808080ff8080808080ff808080ffff02ff16ffff04ff02ffff04ff05ffff04ff0bffff04ff37ffff04ff2fff8080808080808080ff8080ff0180ffff0bff2affff0bff2cff1880ffff0bff2affff0bff2affff0bff2cff3c80ff0580ffff0bff2affff02ff3affff04ff02ffff04ff07ffff04ffff0bff2cff2c80ff8080808080ffff0bff2cff8080808080ff02ffff03ffff07ff0580ffff01ff0bffff0102ffff02ff3effff04ff02ffff04ff09ff80808080ffff02ff3effff04ff02ffff04ff0dff8080808080ffff01ff0bffff0101ff058080ff0180ff018080ffff04ffff01ffa07faa3253bfddd1e0decb0906b2dc6247bbc4cf608f58345d173adb63e8b47c9fffa075690e6a336be6223d3282d71085af366a1c94e9418c25ca9f5fba9d29e09a8da0eff07522495060c066f66f32acc2a77e3a3e737aca8baea4d1a64ea4cdc13da9ffff04ffff01a0c05f74b4f7e8b79dbb23118d7bcdebcadbaddac46824acebe455481c3ec850daffff04ffff0180ff0180808080ffff04ffff01ff02ffff01ff02ffff01ff02ffff03ff0bffff01ff02ffff03ffff09ff05ffff1dff0bffff1effff0bff0bffff02ff06ffff04ff02ffff04ff17ff8080808080808080ffff01ff02ff17ff2f80ffff01ff088080ff0180ffff01ff04ffff04ff04ffff04ff05ffff04ffff02ff06ffff04ff02ffff04ff17ff80808080ff80808080ffff02ff17ff2f808080ff0180ffff04ffff01ff32ff02ffff03ffff07ff0580ffff01ff0bffff0102ffff02ff06ffff04ff02ffff04ff09ff80808080ffff02ff06ffff04ff02ffff04ff0dff8080808080ffff01ff0bffff0101ff058080ff0180ff018080ffff04ffff01b0815cec38feefbc2669d2eab272deb4badc17bc42a0f1cecbf1f5cf8c0219d9b7cdad195b9588291642db49da17b99b6eff018080ff018080808080ff018080808080ff01808080', - 'solution': '0xffffa02f1c4f4568c420033fb690c134ed3ed3d8d9fa3bdb75f1044d51789b59ea3a1dff0180ff01ffffffff80ffff01ffff81f6ff80ff80ff8080ffff33ffa0e68767ba2b431eb8efd9b8dd0db668d5c0c00c7a04e83f6bc6504c0f2626fdf6ff01ffffa0e68767ba2b431eb8efd9b8dd0db668d5c0c00c7a04e83f6bc6504c0f2626fdf6ffa0e68767ba2b431eb8efd9b8dd0db668d5c0c00c7a04e83f6bc6504c0f2626fdf6808080ff8080808080' - }, { - 'coin': { - 'amount': 9734999999, - 'parent_coin_info': '0x265cee97bfc72cc1c41692c9462d098009f5bcade81202cfbacf717a988b8667', - 'puzzle_hash': '0x7b0628c573b77df18bf858b6111be39e25e040f4fdb74c74702dfd94b1bd7fbb' - }, - 'puzzle_reveal': '0xff02ffff01ff02ffff01ff02ffff03ff0bffff01ff02ffff03ffff09ff05ffff1dff0bffff1effff0bff0bffff02ff06ffff04ff02ffff04ff17ff8080808080808080ffff01ff02ff17ff2f80ffff01ff088080ff0180ffff01ff04ffff04ff04ffff04ff05ffff04ffff02ff06ffff04ff02ffff04ff17ff80808080ff80808080ffff02ff17ff2f808080ff0180ffff04ffff01ff32ff02ffff03ffff07ff0580ffff01ff0bffff0102ffff02ff06ffff04ff02ffff04ff09ff80808080ffff02ff06ffff04ff02ffff04ff0dff8080808080ffff01ff0bffff0101ff058080ff0180ff018080ffff04ffff01b0aa1fdb303fb4e59c8082380e3462a0a4ff3f66ccfb5c40b33b6a13706206b1796f2a32c035a452a26d9926fccb0e3246ff018080', - 'solution': '0xff80ffff01ffff33ffa0eff07522495060c066f66f32acc2a77e3a3e737aca8baea4d1a64ea4cdc13da9ff0180ffff33ffa0e520db6f3cab1c1a26f84f6bb19f44c103a3609a2b552ed1e2647dbf600fd160ff85023474bb7e80ffff34ff840fcb944080ffff3cffa0a8520fb03d767496573596438ba3e9414cc845b1d2ab26c159ab64be397dd7ba80ffff3dffa05751070a5bfeabb3f71640bacfa81ea2275c36a25a60bb4381ef598cb56bca578080ff8080' - }, { - 'coin': { - 'amount': 1, - 'parent_coin_info': '0x2f1c4f4568c420033fb690c134ed3ed3d8d9fa3bdb75f1044d51789b59ea3a1d', - 'puzzle_hash': '0xeff07522495060c066f66f32acc2a77e3a3e737aca8baea4d1a64ea4cdc13da9' - }, - 'puzzle_reveal': '0xff02ffff01ff04ffff04ff04ffff04ff05ffff04ff0bff80808080ffff04ffff04ff0affff04ffff02ff0effff04ff02ffff04ffff04ff05ffff04ff0bffff04ff17ff80808080ff80808080ff808080ff808080ffff04ffff01ff33ff3cff02ffff03ffff07ff0580ffff01ff0bffff0102ffff02ff0effff04ff02ffff04ff09ff80808080ffff02ff0effff04ff02ffff04ff0dff8080808080ffff01ff0bffff0101ff058080ff0180ff018080', - 'solution': '0xffa0d41dce69252d14db9a19eb0fcbd0e014d416245460b76a9fe4e7a8030e1bb4c6ff01ff8080' - }] + 'aggregated_signature': '0x8673a394dca82d91cd1ddeff0b518cb02056fa24ce45b8cda4e7819258c9cc13a68ed71d4d25ef7254358af2f033d99b180b2b0255a8f113d699517e7019b825b09f68eb126da228f82b474f316bc8a657310a527ff54a4668971e9486c39c89', + 'coin_solutions': [{ + 'coin': { + 'amount': 1, + 'parent_coin_info': '0x75690e6a336be6223d3282d71085af366a1c94e9418c25ca9f5fba9d29e09a8d', + 'puzzle_hash': '0xd41dce69252d14db9a19eb0fcbd0e014d416245460b76a9fe4e7a8030e1bb4c6' + }, + 'puzzle_reveal': '0xff02ffff01ff02ffff01ff02ffff03ffff18ff2fff3480ffff01ff04ffff04ff20ffff04ff2fff808080ffff04ffff02ff3effff04ff02ffff04ff05ffff04ffff02ff2affff04ff02ffff04ff27ffff04ffff02ffff03ff77ffff01ff02ff36ffff04ff02ffff04ff09ffff04ff57ffff04ffff02ff2effff04ff02ffff04ff05ff80808080ff808080808080ffff011d80ff0180ffff04ffff02ffff03ff77ffff0181b7ffff015780ff0180ff808080808080ffff04ff77ff808080808080ffff02ff3affff04ff02ffff04ff05ffff04ffff02ff0bff5f80ffff01ff8080808080808080ffff01ff088080ff0180ffff04ffff01ffffffff4947ff0233ffff0401ff0102ffffff20ff02ffff03ff05ffff01ff02ff32ffff04ff02ffff04ff0dffff04ffff0bff3cffff0bff34ff2480ffff0bff3cffff0bff3cffff0bff34ff2c80ff0980ffff0bff3cff0bffff0bff34ff8080808080ff8080808080ffff010b80ff0180ffff02ffff03ffff22ffff09ffff0dff0580ff2280ffff09ffff0dff0b80ff2280ffff15ff17ffff0181ff8080ffff01ff0bff05ff0bff1780ffff01ff088080ff0180ff02ffff03ff0bffff01ff02ffff03ffff02ff26ffff04ff02ffff04ff13ff80808080ffff01ff02ffff03ffff20ff1780ffff01ff02ffff03ffff09ff81b3ffff01818f80ffff01ff02ff3affff04ff02ffff04ff05ffff04ff1bffff04ff34ff808080808080ffff01ff04ffff04ff23ffff04ffff02ff36ffff04ff02ffff04ff09ffff04ff53ffff04ffff02ff2effff04ff02ffff04ff05ff80808080ff808080808080ff738080ffff02ff3affff04ff02ffff04ff05ffff04ff1bffff04ff34ff8080808080808080ff0180ffff01ff088080ff0180ffff01ff04ff13ffff02ff3affff04ff02ffff04ff05ffff04ff1bffff04ff17ff8080808080808080ff0180ffff01ff02ffff03ff17ff80ffff01ff088080ff018080ff0180ffffff02ffff03ffff09ff09ff3880ffff01ff02ffff03ffff18ff2dffff010180ffff01ff0101ff8080ff0180ff8080ff0180ff0bff3cffff0bff34ff2880ffff0bff3cffff0bff3cffff0bff34ff2c80ff0580ffff0bff3cffff02ff32ffff04ff02ffff04ff07ffff04ffff0bff34ff3480ff8080808080ffff0bff34ff8080808080ffff02ffff03ffff07ff0580ffff01ff0bffff0102ffff02ff2effff04ff02ffff04ff09ff80808080ffff02ff2effff04ff02ffff04ff0dff8080808080ffff01ff0bffff0101ff058080ff0180ff02ffff03ffff21ff17ffff09ff0bff158080ffff01ff04ff30ffff04ff0bff808080ffff01ff088080ff0180ff018080ffff04ffff01ffa07faa3253bfddd1e0decb0906b2dc6247bbc4cf608f58345d173adb63e8b47c9fffa075690e6a336be6223d3282d71085af366a1c94e9418c25ca9f5fba9d29e09a8da0eff07522495060c066f66f32acc2a77e3a3e737aca8baea4d1a64ea4cdc13da9ffff04ffff01ff02ffff01ff02ffff01ff02ff3effff04ff02ffff04ff05ffff04ffff02ff2fff5f80ffff04ff80ffff04ffff04ffff04ff0bffff04ff17ff808080ffff01ff808080ffff01ff8080808080808080ffff04ffff01ffffff0233ff04ff0101ffff02ff02ffff03ff05ffff01ff02ff1affff04ff02ffff04ff0dffff04ffff0bff12ffff0bff2cff1480ffff0bff12ffff0bff12ffff0bff2cff3c80ff0980ffff0bff12ff0bffff0bff2cff8080808080ff8080808080ffff010b80ff0180ffff0bff12ffff0bff2cff1080ffff0bff12ffff0bff12ffff0bff2cff3c80ff0580ffff0bff12ffff02ff1affff04ff02ffff04ff07ffff04ffff0bff2cff2c80ff8080808080ffff0bff2cff8080808080ffff02ffff03ffff07ff0580ffff01ff0bffff0102ffff02ff2effff04ff02ffff04ff09ff80808080ffff02ff2effff04ff02ffff04ff0dff8080808080ffff01ff0bffff0101ff058080ff0180ff02ffff03ff0bffff01ff02ffff03ffff09ff23ff1880ffff01ff02ffff03ffff18ff81b3ff2c80ffff01ff02ffff03ffff20ff1780ffff01ff02ff3effff04ff02ffff04ff05ffff04ff1bffff04ff33ffff04ff2fffff04ff5fff8080808080808080ffff01ff088080ff0180ffff01ff04ff13ffff02ff3effff04ff02ffff04ff05ffff04ff1bffff04ff17ffff04ff2fffff04ff5fff80808080808080808080ff0180ffff01ff02ffff03ffff09ff23ffff0181e880ffff01ff02ff3effff04ff02ffff04ff05ffff04ff1bffff04ff17ffff04ffff02ffff03ffff22ffff09ffff02ff2effff04ff02ffff04ff53ff80808080ff82014f80ffff20ff5f8080ffff01ff02ff53ffff04ff818fffff04ff82014fffff04ff81b3ff8080808080ffff01ff088080ff0180ffff04ff2cff8080808080808080ffff01ff04ff13ffff02ff3effff04ff02ffff04ff05ffff04ff1bffff04ff17ffff04ff2fffff04ff5fff80808080808080808080ff018080ff0180ffff01ff04ffff04ff18ffff04ffff02ff16ffff04ff02ffff04ff05ffff04ff27ffff04ffff0bff2cff82014f80ffff04ffff02ff2effff04ff02ffff04ff818fff80808080ffff04ffff0bff2cff0580ff8080808080808080ff378080ff81af8080ff0180ff018080ffff04ffff01a0a04d9f57764f54a43e4030befb4d80026e870519aaa66334aef8304f5d0393c2ffff04ffff01ffff75ffc04468747470733a2f2f696d616765732e706578656c732e636f6d2f70686f746f732f31313035333037322f706578656c732d70686f746f2d31313035333037322e6a70656780ffff68a014836b86a48e1b2b5e857213af97534704475b4c155d34b2cb83ed4b7cba2bb0ffff826d7580ffff826c7580ffff82736e01ffff8273740180ffff04ffff01a0fe8a4b4e27a2e29a4d3fc7ce9d527adbcaccbab6ada3903ccf3ba9a769d2d78bffff04ffff01ff02ffff01ff02ffff01ff02ff26ffff04ff02ffff04ff05ffff04ff17ffff04ff0bffff04ffff02ff2fff5f80ff80808080808080ffff04ffff01ffffff82ad4cff0233ffff3e04ff81f601ffffff0102ffff02ffff03ff05ffff01ff02ff2affff04ff02ffff04ff0dffff04ffff0bff32ffff0bff3cff3480ffff0bff32ffff0bff32ffff0bff3cff2280ff0980ffff0bff32ff0bffff0bff3cff8080808080ff8080808080ffff010b80ff0180ff04ffff04ff38ffff04ffff02ff36ffff04ff02ffff04ff05ffff04ff27ffff04ffff02ff2effff04ff02ffff04ffff02ffff03ff81afffff0181afffff010b80ff0180ff80808080ffff04ffff0bff3cff4f80ffff04ffff0bff3cff0580ff8080808080808080ff378080ff82016f80ffffff02ff3effff04ff02ffff04ff05ffff04ff0bffff04ff17ffff04ff2fffff04ff2fffff01ff80ff808080808080808080ff0bff32ffff0bff3cff2880ffff0bff32ffff0bff32ffff0bff3cff2280ff0580ffff0bff32ffff02ff2affff04ff02ffff04ff07ffff04ffff0bff3cff3c80ff8080808080ffff0bff3cff8080808080ffff02ffff03ffff07ff0580ffff01ff0bffff0102ffff02ff2effff04ff02ffff04ff09ff80808080ffff02ff2effff04ff02ffff04ff0dff8080808080ffff01ff0bffff0101ff058080ff0180ff02ffff03ff5fffff01ff02ffff03ffff09ff82011fff3880ffff01ff02ffff03ffff09ffff18ff82059f80ff3c80ffff01ff02ffff03ffff20ff81bf80ffff01ff02ff3effff04ff02ffff04ff05ffff04ff0bffff04ff17ffff04ff2fffff04ff81dfffff04ff82019fffff04ff82017fff80808080808080808080ffff01ff088080ff0180ffff01ff04ff819fffff02ff3effff04ff02ffff04ff05ffff04ff0bffff04ff17ffff04ff2fffff04ff81dfffff04ff81bfffff04ff82017fff808080808080808080808080ff0180ffff01ff02ffff03ffff09ff82011fff2c80ffff01ff02ffff03ffff20ff82017f80ffff01ff04ffff04ff24ffff04ffff0eff10ffff02ff2effff04ff02ffff04ff82019fff8080808080ff808080ffff02ff3effff04ff02ffff04ff05ffff04ff0bffff04ff17ffff04ff2fffff04ff81dfffff04ff81bfffff04ffff02ff0bffff04ff17ffff04ff2fffff04ff82019fff8080808080ff8080808080808080808080ffff01ff088080ff0180ffff01ff02ffff03ffff09ff82011fff2480ffff01ff02ffff03ffff20ffff02ffff03ffff09ffff0122ffff0dff82029f8080ffff01ff02ffff03ffff09ffff0cff82029fff80ffff010280ff1080ffff01ff0101ff8080ff0180ff8080ff018080ffff01ff04ff819fffff02ff3effff04ff02ffff04ff05ffff04ff0bffff04ff17ffff04ff2fffff04ff81dfffff04ff81bfffff04ff82017fff8080808080808080808080ffff01ff088080ff0180ffff01ff04ff819fffff02ff3effff04ff02ffff04ff05ffff04ff0bffff04ff17ffff04ff2fffff04ff81dfffff04ff81bfffff04ff82017fff808080808080808080808080ff018080ff018080ff0180ffff01ff02ff3affff04ff02ffff04ff05ffff04ff0bffff04ff81bfffff04ffff02ffff03ff82017fffff0182017fffff01ff02ff0bffff04ff17ffff04ff2fffff01ff808080808080ff0180ff8080808080808080ff0180ff018080ffff04ffff01a0c5abea79afaa001b5427dfa0c8cf42ca6f38f5841b78f9b3c252733eb2de2726ffff04ffff0180ffff04ffff01ff02ffff01ff02ffff01ff02ffff03ff81bfffff01ff04ff82013fffff04ff80ffff04ffff02ffff03ffff22ff82013fffff20ffff09ff82013fff2f808080ffff01ff04ffff04ff10ffff04ffff0bffff02ff2effff04ff02ffff04ff09ffff04ff8205bfffff04ffff02ff3effff04ff02ffff04ffff04ff09ffff04ff82013fff1d8080ff80808080ff808080808080ff1580ff808080ffff02ff16ffff04ff02ffff04ff0bffff04ff17ffff04ff8202bfffff04ff15ff8080808080808080ffff01ff02ff16ffff04ff02ffff04ff0bffff04ff17ffff04ff8202bfffff04ff15ff8080808080808080ff0180ff80808080ffff01ff04ff2fffff01ff80ff80808080ff0180ffff04ffff01ffffff3f02ff04ff0101ffff822710ff02ff02ffff03ff05ffff01ff02ff3affff04ff02ffff04ff0dffff04ffff0bff2affff0bff2cff1480ffff0bff2affff0bff2affff0bff2cff3c80ff0980ffff0bff2aff0bffff0bff2cff8080808080ff8080808080ffff010b80ff0180ffff02ffff03ff17ffff01ff04ffff04ff10ffff04ffff0bff81a7ffff02ff3effff04ff02ffff04ffff04ff2fffff04ffff04ff05ffff04ffff05ffff14ffff12ff47ff0b80ff128080ffff04ffff04ff05ff8080ff80808080ff808080ff8080808080ff808080ffff02ff16ffff04ff02ffff04ff05ffff04ff0bffff04ff37ffff04ff2fff8080808080808080ff8080ff0180ffff0bff2affff0bff2cff1880ffff0bff2affff0bff2affff0bff2cff3c80ff0580ffff0bff2affff02ff3affff04ff02ffff04ff07ffff04ffff0bff2cff2c80ff8080808080ffff0bff2cff8080808080ff02ffff03ffff07ff0580ffff01ff0bffff0102ffff02ff3effff04ff02ffff04ff09ff80808080ffff02ff3effff04ff02ffff04ff0dff8080808080ffff01ff0bffff0101ff058080ff0180ff018080ffff04ffff01ffa07faa3253bfddd1e0decb0906b2dc6247bbc4cf608f58345d173adb63e8b47c9fffa075690e6a336be6223d3282d71085af366a1c94e9418c25ca9f5fba9d29e09a8da0eff07522495060c066f66f32acc2a77e3a3e737aca8baea4d1a64ea4cdc13da9ffff04ffff01a0c05f74b4f7e8b79dbb23118d7bcdebcadbaddac46824acebe455481c3ec850daffff04ffff0180ff0180808080ffff04ffff01ff02ffff01ff02ffff01ff02ffff03ff0bffff01ff02ffff03ffff09ff05ffff1dff0bffff1effff0bff0bffff02ff06ffff04ff02ffff04ff17ff8080808080808080ffff01ff02ff17ff2f80ffff01ff088080ff0180ffff01ff04ffff04ff04ffff04ff05ffff04ffff02ff06ffff04ff02ffff04ff17ff80808080ff80808080ffff02ff17ff2f808080ff0180ffff04ffff01ff32ff02ffff03ffff07ff0580ffff01ff0bffff0102ffff02ff06ffff04ff02ffff04ff09ff80808080ffff02ff06ffff04ff02ffff04ff0dff8080808080ffff01ff0bffff0101ff058080ff0180ff018080ffff04ffff01b0815cec38feefbc2669d2eab272deb4badc17bc42a0f1cecbf1f5cf8c0219d9b7cdad195b9588291642db49da17b99b6eff018080ff018080808080ff018080808080ff01808080', + 'solution': '0xffffa02f1c4f4568c420033fb690c134ed3ed3d8d9fa3bdb75f1044d51789b59ea3a1dff0180ff01ffffffff80ffff01ffff81f6ff80ff80ff8080ffff33ffa0e68767ba2b431eb8efd9b8dd0db668d5c0c00c7a04e83f6bc6504c0f2626fdf6ff01ffffa0e68767ba2b431eb8efd9b8dd0db668d5c0c00c7a04e83f6bc6504c0f2626fdf6ffa0e68767ba2b431eb8efd9b8dd0db668d5c0c00c7a04e83f6bc6504c0f2626fdf6808080ff8080808080' + }, { + 'coin': { + 'amount': 9734999999, + 'parent_coin_info': '0x265cee97bfc72cc1c41692c9462d098009f5bcade81202cfbacf717a988b8667', + 'puzzle_hash': '0x7b0628c573b77df18bf858b6111be39e25e040f4fdb74c74702dfd94b1bd7fbb' + }, + 'puzzle_reveal': '0xff02ffff01ff02ffff01ff02ffff03ff0bffff01ff02ffff03ffff09ff05ffff1dff0bffff1effff0bff0bffff02ff06ffff04ff02ffff04ff17ff8080808080808080ffff01ff02ff17ff2f80ffff01ff088080ff0180ffff01ff04ffff04ff04ffff04ff05ffff04ffff02ff06ffff04ff02ffff04ff17ff80808080ff80808080ffff02ff17ff2f808080ff0180ffff04ffff01ff32ff02ffff03ffff07ff0580ffff01ff0bffff0102ffff02ff06ffff04ff02ffff04ff09ff80808080ffff02ff06ffff04ff02ffff04ff0dff8080808080ffff01ff0bffff0101ff058080ff0180ff018080ffff04ffff01b0aa1fdb303fb4e59c8082380e3462a0a4ff3f66ccfb5c40b33b6a13706206b1796f2a32c035a452a26d9926fccb0e3246ff018080', + 'solution': '0xff80ffff01ffff33ffa0eff07522495060c066f66f32acc2a77e3a3e737aca8baea4d1a64ea4cdc13da9ff0180ffff33ffa0e520db6f3cab1c1a26f84f6bb19f44c103a3609a2b552ed1e2647dbf600fd160ff85023474bb7e80ffff34ff840fcb944080ffff3cffa0a8520fb03d767496573596438ba3e9414cc845b1d2ab26c159ab64be397dd7ba80ffff3dffa05751070a5bfeabb3f71640bacfa81ea2275c36a25a60bb4381ef598cb56bca578080ff8080' + }, { + 'coin': { + 'amount': 1, + 'parent_coin_info': '0x2f1c4f4568c420033fb690c134ed3ed3d8d9fa3bdb75f1044d51789b59ea3a1d', + 'puzzle_hash': '0xeff07522495060c066f66f32acc2a77e3a3e737aca8baea4d1a64ea4cdc13da9' + }, + 'puzzle_reveal': '0xff02ffff01ff04ffff04ff04ffff04ff05ffff04ff0bff80808080ffff04ffff04ff0affff04ffff02ff0effff04ff02ffff04ffff04ff05ffff04ff0bffff04ff17ff80808080ff80808080ff808080ff808080ffff04ffff01ff33ff3cff02ffff03ffff07ff0580ffff01ff0bffff0102ffff02ff0effff04ff02ffff04ff09ff80808080ffff02ff0effff04ff02ffff04ff0dff8080808080ffff01ff0bffff0101ff058080ff0180ff018080', + 'solution': '0xffa0d41dce69252d14db9a19eb0fcbd0e014d416245460b76a9fe4e7a8030e1bb4c6ff01ff8080' + }] } ``` diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guides/crash-course/chialisp.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guides/crash-course/chialisp.md index 96f1d979d8..8553e7b26e 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guides/crash-course/chialisp.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guides/crash-course/chialisp.md @@ -122,7 +122,7 @@ Which should produce the following output: 42 ``` -So Chialisp can calculate the [meaning of life]()! +So Chialisp can calculate the [meaning of life](https://en.wikipedia.org/wiki/42_(number)#The_Hitchhiker's_Guide_to_the_Galaxy)! --- diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guides/crash-course/intro-to-chialisp.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guides/crash-course/intro-to-chialisp.md index f3852f4042..c8796dea15 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guides/crash-course/intro-to-chialisp.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guides/crash-course/intro-to-chialisp.md @@ -132,7 +132,7 @@ Which should produce the following output: 42 ``` -So Chialisp can calculate the [meaning of life]()! +So Chialisp can calculate the [meaning of life](https://en.wikipedia.org/wiki/42_(number)#The_Hitchhiker's_Guide_to_the_Galaxy)! --- diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guides/custody/custody-tool-description.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guides/custody/custody-tool-description.md index 42bf2bfe49..018c9f50b9 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guides/custody/custody-tool-description.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guides/custody/custody-tool-description.md @@ -42,7 +42,7 @@ The singleton comes in two layers -- one permanent and one non-permanent. ### Permanent layer | Setting | Prefarm Value | Description | -| :------ | :------------ | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +|:------- |:------------- |:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `wt` | 30 days | Withdrawal Timelock -- When attempting to begin a withdrawal, this is the minimum number of seconds that must have elapsed since the last withdrawal, rekey or clawback. | | `pc` | 90 days | Payment Clawback -- The minimum number of seconds that must elapse after initiating a withdrawal before the withdrawal can be completed. Clawbacks are possible during this window. | | `rt` | 15 days | Rekey Timelock -- When attempting to begin a standard rekey, this is the minimum number of seconds that must have elapsed since the last withdrawal, rekey or clawback. For a slow rekey, this amount gets added for each key less than `m` (in addition to the amount of time that would have been required in a standard rekey). | @@ -52,10 +52,10 @@ The singleton comes in two layers -- one permanent and one non-permanent. ### Non-permanent layer | Setting | Initial
Value | Description | -| :------ | :---------------- | :-------------------------------------------------------------------------- | -| `m` | 3 | The initial number of pubkeys required to do a withdrawal or standard rekey | -| `n` | 5 | The maximum number of pubkeys required to do a withdrawal or standard rekey | -| `pks` | | A comma separated list of pubkey files that will control this money | +|:------- |:----------------------- |:--------------------------------------------------------------------------- | +| `m` | 3 | The initial number of pubkeys required to do a withdrawal or standard rekey | +| `n` | 5 | The maximum number of pubkeys required to do a withdrawal or standard rekey | +| `pks` | | A comma separated list of pubkey files that will control this money | ## Allowed Actions @@ -123,10 +123,10 @@ The amount of time before the rekey can begin depends on the number of keys used The following table illustrates a few examples of initiation timelock lengths, for various values of `m` and `k`. For this table, `rt` is set to 15 days and `sp` is set to 45 days (these are both denominated in seconds). The table assumes that `n` (5) and the minimum `k` (1) have not been modified from their default values: | `m` | `k` | Days | Comment | -| :-: | :-: | :--: | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +|:---:|:---:|:----:|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | 3 | 3 | 15 | Standard rekey, no penalty | -| 3 | 2 | 75 | Slow rekey, `sp` day penalty + 2 \* standard `rt` days | -| 3 | 1 | 90 | Slow rekey, `sp` day penalty + 3 \* `rt` days | +| 3 | 2 | 75 | Slow rekey, `sp` day penalty + 2 \* standard `rt` days | +| 3 | 1 | 90 | Slow rekey, `sp` day penalty + 3 \* `rt` days | | 1 | 1 | 15 | This is a case where, after a prior rekey, `m` was reduced to 1. There is no penalty, even with a single key | | 5 | 3 | 90 | In this case, a lock level increase has been performed, so 5 of 5 keys are required to avoid a penalty | | 5 | 1 | 120 | This is the longest possible initiation timelock duration when `n` is 5 and the minimum `k` is 1. In this case, `m` has been increased to 5, and 1 key is being used for the rekey | @@ -190,11 +190,11 @@ The following table lists the action/consequence, given the current value of `m`
-| `m` | Keys Sniffed | Keys Stolen | Keys Lost | -| :-- | :------------------------------------------------------------------------------------------------------------------------------------ | :------------------------------------------------------- | :------------------------------------------------------- | -| 3 | 0-2: normal rekey
3: lock level increase to 4, normal rekey
4: lock level increase to 5, normal rekey
5: deadlocked | 0-2: normal rekey
3-5: drained | 0-2: normal rekey
3-4: slow rekey
5: bricked | -| 4 | 0-3: normal rekey
4: lock level increase to 5, normal rekey
5: deadlocked | 0-1: normal rekey
2: slow rekey
3-5: drained | 0-1: normal rekey
2-4: slow rekey
5: bricked | -| 5 | 0-4: normal rekey
5: deadlocked | 0: normal rekey
1-2: slow rekey
3-5: drained | 0: normal rekey
1-4: slow rekey
5: bricked | +| `m` | Keys Sniffed | Keys Stolen | Keys Lost | +|:--- |:------------------------------------------------------------------------------------------------------------------------------------------------------- |:-------------------------------------------------------------------- |:-------------------------------------------------------------------- | +| 3 | 0-2: normal rekey
3: lock level increase to 4, normal rekey
4: lock level increase to 5, normal rekey
5: deadlocked | 0-2: normal rekey
3-5: drained | 0-2: normal rekey
3-4: slow rekey
5: bricked | +| 4 | 0-3: normal rekey
4: lock level increase to 5, normal rekey
5: deadlocked | 0-1: normal rekey
2: slow rekey
3-5: drained | 0-1: normal rekey
2-4: slow rekey
5: bricked | +| 5 | 0-4: normal rekey
5: deadlocked | 0: normal rekey
1-2: slow rekey
3-5: drained | 0: normal rekey
1-4: slow rekey
5: bricked | --- diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guides/custody/custody-tool-user-guide.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guides/custody/custody-tool-user-guide.md index f0e775ad96..6ba1557e90 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guides/custody/custody-tool-user-guide.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guides/custody/custody-tool-user-guide.md @@ -80,6 +80,7 @@ python -m venv venv ```bash python3 -m venv venv . ./venv/bin/activate +``` ./venv/bin/activate ``` @@ -88,6 +89,7 @@ python3 -m venv venv ```bash python3 -m venv venv . ./venv/bin/activate +``` ./venv/bin/activate ``` @@ -123,7 +125,7 @@ If you get a usage statement, then `cic` (Chia Internal Custody) has been instal --- -### Command Notes +## Command Notes :::info A few notes about the commands in this guide @@ -137,12 +139,9 @@ Most of the commands from this tutorial will _not_ alter the blockchain. This in :::warning warning for windows users -Windows uses different line endings than Linux and MacOS. -If you only plan to use Windows for both generating and signing spend bundles, this won't be a problem. +Windows uses different line endings than Linux and MacOS. If you only plan to use Windows for both generating and signing spend bundles, this won't be a problem. -However, if you plan to generate your spend bundles on Windows and sign them using a Linux HSM, then you will need to modify the line endings before signing. -The easiest way to accomplish this is with `dos2unix`. -This is not included with Windows, so you will need to download it from [SourceForge](https://sourceforge.net/projects/dos2unix/). +However, if you plan to generate your spend bundles on Windows and sign them using a Linux HSM, then you will need to modify the line endings before signing. The easiest way to accomplish this is with `dos2unix`. This is not included with Windows, so you will need to download it from [SourceForge](https://sourceforge.net/projects/dos2unix/). The command to convert your spend bundles is then: @@ -249,13 +248,13 @@ The `cic init` command will initialize the permanent layer of the singleton. **N For this guide, we'll create an example singleton that uses the values listed in the table below. As a reminder, these settings correspond to those used in the [flow chart](https://docs.chia.net/files/chia-custody-tool.png). | Flag  | Example
Value | Description | -| :--------- | :---------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `-d` | keys_and_sb | The directory where the keys and spend bundles will be stored. | -| `-wt` | 600 seconds | Withdrawal Timelock -- the minimum number of seconds that must have elapsed since the last withdrawal, rekey or clawback before a withdrawal can be initiated. | -| `-pc` | 1200 seconds | Payment Claw back -- the minimum number of seconds that must elapse after initiating a withdrawal before the withdrawal can be completed. Clawbacks are possible during this window. | -| `-rt` | 300 seconds | Rekey Timelock -- when attempting to begin a standard rekey, this is the minimum number of seconds that must have elapsed since the last withdrawal, rekey or claw back. For a slow rekey, this amount gets added for each key less than `m`. | -| `-rc` | 600 seconds | Rekey Claw back -- the minimum number of seconds that must elapse after initiating a rekey before the rekey can be completed. Claw backs are possible during this window. | -| `-sp` | 900 seconds | Slow rekey Penalty -- this amount gets added to the Rekey Timelock when a slow rekey is being performed. | +|:---------- |:----------------------- |:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `-d` | keys_and_sb | The directory where the keys and spend bundles will be stored. | +| `-wt` | 600 seconds | Withdrawal Timelock -- the minimum number of seconds that must have elapsed since the last withdrawal, rekey or clawback before a withdrawal can be initiated. | +| `-pc` | 1200 seconds | Payment Claw back -- the minimum number of seconds that must elapse after initiating a withdrawal before the withdrawal can be completed. Clawbacks are possible during this window. | +| `-rt` | 300 seconds | Rekey Timelock -- when attempting to begin a standard rekey, this is the minimum number of seconds that must have elapsed since the last withdrawal, rekey or claw back. For a slow rekey, this amount gets added for each key less than `m`. | +| `-rc` | 600 seconds | Rekey Claw back -- the minimum number of seconds that must elapse after initiating a rekey before the rekey can be completed. Claw backs are possible during this window. | +| `-sp` | 900 seconds | Slow rekey Penalty -- this amount gets added to the Rekey Timelock when a slow rekey is being performed. | :::info notes regarding the above table @@ -316,12 +315,9 @@ As a result of running this command, `Configuration (awaiting launch).txt` will ::: -In this step, you will run `cic launch_singleton`, which will create the singleton on the blockchain. -In order to run this command, you will need to have at least 1 mojo in your wallet to create the singleton. +In this step, you will run `cic launch_singleton`, which will create the singleton on the blockchain. In order to run this command, you will need to have at least 1 mojo in your wallet to create the singleton. -The `launch_singleton` command also includes a recommended `--fee` flag to specify a blockchain fee in mojos. -This fee is completely separate from the actual financing of the singleton, which will occur in a later step. -It is also possible to launch the singleton using one wallet and fund it with another -- think of the singleton as a brand new wallet. +The `launch_singleton` command also includes a recommended `--fee` flag to specify a blockchain fee in mojos. This fee is completely separate from the actual financing of the singleton, which will occur in a later step. It is also possible to launch the singleton using one wallet and fund it with another -- think of the singleton as a brand new wallet. Aside from the fees, the `launch_singleton` command includes an optional `--configuration` flag to specify the name and location of the configuration file. By default, the command will look in `./Configuration (awaiting launch).txt`. @@ -375,8 +371,7 @@ Congratulations, you have successfully launched the singleton! (You will need to At this point, the singleton should exist on the blockchain. However, it has not yet been funded. For now, let's view it. -Currently your local custody database does not know about the singleton. -Therefore, in order to view the singleton, you must first synchronize the localhost with the blockchain by running the `sync` command. +Currently your local custody database does not know about the singleton. Therefore, in order to view the singleton, you must first synchronize the localhost with the blockchain by running the `sync` command. The first time you run the `sync` command, you need to specify the configuration file, which will then be copied into your config database. @@ -409,9 +404,7 @@ Outstanding events: REKEYS: ``` -To view the configuration, run `cic show` and add the `-c` flag. -To view the derivation info, run `cic show` and add the `-d` flag. -You can also add both flags. +To view the configuration, run `cic show` and add the `-c` flag. To view the derivation info, run `cic show` and add the `-d` flag. You can also add both flags. For example: @@ -629,8 +622,7 @@ This test will run through the complete sequence of withdrawing money from the s This command generates an unsigned spend bundle which requires specific keys. Signers can take this spend bundle to an HSM for signing. -To begin the payment process, use the `cic payment` command. -For this example, we'll use the following arguments (see the [CLI reference](/custody-tool#payment "payment command") for all options): +To begin the payment process, use the `cic payment` command. For this example, we'll use the following arguments (see the [CLI reference](/custody-tool#payment "payment command") for all options): - `-f` : The name of the file in which to save the unsigned spend bundle - `-pks`: The public keys that will be used to sign the withdrawal. Exactly `m` keys must be included. The only keys allowed to sign are those that were originally used in the `derive_root` command @@ -753,9 +745,7 @@ Once you have the signed spend bundle on a synced node with some XCH/TXCH for a cic push_tx -b ./withdrawal.signed -m 10000000 ``` -The withdrawal has now been added to the blockchain. However, the money has not yet reached its final destination. -Instead, it will now sit in a "drop coin" (aka escrow) and cannot be withdrawn for at least (`-pc`) seconds, which is built into the singleton and cannot be changed. -For this example, we used 1200 seconds for this value. +The withdrawal has now been added to the blockchain. However, the money has not yet reached its final destination. Instead, it will now sit in a "drop coin" (aka escrow) and cannot be withdrawn for at least (`-pc`) seconds, which is built into the singleton and cannot be changed. For this example, we used 1200 seconds for this value. #### View the payment's status @@ -796,9 +786,7 @@ As the output of this command shows, there is a new payment outstanding (`PAYMEN - If (`-pc`) seconds have not elapsed since the drop coin's creation, the output will display `(Ready at: )` - If (`-pc`) seconds have elapsed, then the output will say `(Ready)` -In either case, claw backs are allowed until the payment has been completed. -(Even if the withdrawal is in "Ready" state, it can still be clawed back. However, because _anyone_ can -complete the withdrawal, claw backs should no longer be assumed to be available once the "Ready" state has been reached.) +In either case, claw backs are allowed until the payment has been completed. (Even if the withdrawal is in "Ready" state, it can still be clawed back. However, because _anyone_ can complete the withdrawal, claw backs should no longer be assumed to be available once the "Ready" state has been reached.) Note that even when the state is "Ready", the next transaction block will still need to be created before the withdrawal is _actually_ ready. @@ -971,8 +959,7 @@ Outstanding events: REKEYS: ``` -Instead of completing the payment, we'll claw it back. If you want to test this feature, be sure to make the value of `-pc` sufficiently large to give yourself plenty of time to perform the clawback. -In this example we still have 17 minutes remaining (`Ready at` minus `Current time` from the above output). +Instead of completing the payment, we'll claw it back. If you want to test this feature, be sure to make the value of `-pc` sufficiently large to give yourself plenty of time to perform the clawback. In this example we still have 17 minutes remaining (`Ready at` minus `Current time` from the above output). #### Create an unsigned spend bundle for the clawback @@ -1056,8 +1043,7 @@ echo 549614102252741379514039214279174962654364157854486736945228183041555384205 This command should have no output. The signatures are now stored in text files. -Finally, merge the claw back signatures into a signed spend bundle. -Note that an arbitrary number of signatures can be passed into this command. We'll use two signatures for this example. +Finally, merge the claw back signatures into a signed spend bundle. Note that an arbitrary number of signatures can be passed into this command. We'll use two signatures for this example. ```bash hsmmerge ./clawback.unsigned ./clawback_1.sig ./clawback_2.sig > clawback.signed @@ -1257,9 +1243,7 @@ Custody rules successfully added to configuration ::: -Next, run `start_rekey`, which will create an unsigned spend bundle for the rekey. Note that in this command, -`-pks` refers to the original keys that must sign to allow the rekey to happen. -The configuration file from the `-new` flag contains all of the new info that will be used after the rekey has completed. +Next, run `start_rekey`, which will create an unsigned spend bundle for the rekey. Note that in this command, `-pks` refers to the original keys that must sign to allow the rekey to happen. The configuration file from the `-new` flag contains all of the new info that will be used after the rekey has completed. ```bash cic start_rekey -f rekey.unsigned -pks "1.pk,2.pk" -new './Configuration (after rekey).txt' @@ -1318,9 +1302,7 @@ echo 555391688726247518407714092604079246104554134754321333331702549926309406250 echo 5561137392380018602752549597282386367838345256392677171809614780347764174154608487537742644428466353746831639451621586320322685820178179047514852085991565214608652175820480007073564769669494661900487484133333312104972188050976529086895435776 > rekey_2.sig ``` -Finally, merge the rekey signatures into a signed spend bundle. -Note that an arbitrary number of signatures can be passed into this command. -For this example, we need to use the two signatures we just calculated: +Finally, merge the rekey signatures into a signed spend bundle. Note that an arbitrary number of signatures can be passed into this command. For this example, we need to use the two signatures we just calculated: ```bash hsmmerge ./rekey.unsigned ./rekey_1.sig ./rekey_2.sig > rekey.signed @@ -1391,12 +1373,9 @@ As the output of this command shows, there is a new rekey outstanding (`REKEY fr - If (`-rc`) seconds have not elapsed since the drop coin's creation, the output will display `(Ready at: )` - If (`-rc`) seconds have elapsed, then the output will say `(Ready)` -In either case, cancellation/clawback is allowed until the rekey is completed. -(Even if the rekey is in "Ready" state, it can still be clawed back. However, because _anyone_ can -complete the rekey, claw backs should no longer be assumed to be available once it reaches the "Ready" state.) +In either case, cancellation/clawback is allowed until the rekey is completed. (Even if the rekey is in "Ready" state, it can still be clawed back. However, because _anyone_ can complete the rekey, claw backs should no longer be assumed to be available once it reaches the "Ready" state.) -Note that even when the state is "Ready", the next transaction block will still need to be created before the rekey is _actually_ ready. -Transaction blocks happen every 52 seconds on average. +Note that even when the state is "Ready", the next transaction block will still need to be created before the rekey is _actually_ ready. Transaction blocks happen every 52 seconds on average. #### Create a signed spend bundle for the completion diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guides/custody/prefarm-audit.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guides/custody/prefarm-audit.md index 18bdf90209..cb5d4e9b59 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guides/custody/prefarm-audit.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guides/custody/prefarm-audit.md @@ -3,11 +3,11 @@ slug: /custody/prefarm-audit-tutorial title: Prefarm Audit Tutorial --- -Chia Network Inc's prefarm is secured by a complex set of custodial rules. This document describes how to use the custody tool to audit the prefarm configuration. A moderate level of technical proficiency is probably needed to understand the details. For a high-level overview of the prefarm custody wallets, see our [blog post](https://www.chia.net/2022/10/29/a-new-home-for-the-prefarm/). +Chia Network Inc's prefarm is secured by a complex set of custodial rules. This document describes how to use the custody tool to audit the prefarm configuration. A moderate level of technical proficiency is probably needed to understand the details. For a high-level overview of the prefarm custody wallets, see our [blog post](https://www.chia.net/2022/10/29/a-new-home-for-the-prefarm/). This document describes how to use the custody tool to audit the prefarm configuration. A moderate level of technical proficiency is probably needed to understand the details. For a high-level overview of the prefarm custody wallets, see our [blog post](https://www.chia.net/2022/10/29/a-new-home-for-the-prefarm/). Other relevant documents: -- [Flow chart](https://docs.chia.net/img/chia-custody-tool.png) to visualize how the custody tool works +- [Flow chart](/img/chia-custody-tool.png) to visualize how the custody tool works - [User guide](/guides/custody-tool-user-guide) to help you get up and running - [CLI reference](/custody-tool) for all custody commands used in this tutorial - [Prefarm Alert Tool](https://github.com/Chia-Network/prefarm-alert) to access the public prefarm config files @@ -76,9 +76,7 @@ xch1jj0gm4ahhlu3ke0r0fx955v8axr6za7rzz6hc0y26lewa7zw6fws5nwvv6 :::info -NOTE: A high level of technical proficiency is needed to understand the details of this manual process for what the cic tool does above. -This process is a high-level guide and does not display expected results for each step. -The [chia-dev-tools](https://github.com/Chia-Network/chia-dev-tools#install) are needed for this audit. +NOTE: A high level of technical proficiency is needed to understand the details of this manual process for what the cic tool does above. This process is a high-level guide and does not display expected results for each step. NOTE: A high level of technical proficiency is needed to understand the details of this manual process for what the cic tool does above. This process is a high-level guide and does not display expected results for each step. The [chia-dev-tools](https://github.com/Chia-Network/chia-dev-tools#install) are needed for this audit. ::: @@ -93,7 +91,7 @@ The [chia-dev-tools](https://github.com/Chia-Network/chia-dev-tools#install) are 4. `BASE_REKEY_TIMELOCK` = integer of the rekey timelock. 5. `SLOW_REKEY_PENALTY` = integer of the slow rekey penalty. 3. Curry the necessary parameters into singleton_top_layer_v1_1.clsp `(SINGLETON_STRUCT INNER_PUZZLE)`: - 1. `SINGLETON_STRUCT` = a tree with the following elements in order `(MOD_HASH . (LAUNCHER_ID . LAUNCHER_PUZZLE_HASH))`: + 1. `SINGLETON_STRUCT` = a tree with the following elements in order `(MOD_HASH . (LAUNCHER_ID . LAUNCHER_PUZZLE_HASH))`: (LAUNCHER_ID . LAUNCHER_PUZZLE_HASH)): 1. `MOD_HASH` = singleton_top_layer puzzle sha256 tree hash without its curried arguments. 2. `LAUNCHER_ID` = the ID of the singleton we are committed to paying. 3. `LAUNCHER_PUZZLE_HASH` = the puzzle hash of the launcher. diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guides/datalayer/datalayer-permissions.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guides/datalayer/datalayer-permissions.md index 97b4722a9a..dee976c9f3 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guides/datalayer/datalayer-permissions.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guides/datalayer/datalayer-permissions.md @@ -86,7 +86,7 @@ Functionality: Configure a store for uploading Request Parameters: | Parameter | Type | Required | Description | -| :-------- | :----- | :------- | :-------------------------- | +|:--------- |:------ |:-------- |:--------------------------- | | store_id | STRING | True | The store ID, in hex format | Response: `{"handle_upload": [true|false]}` @@ -100,7 +100,7 @@ Functionality: Configure a store for downloading from a mirror Request Parameters: | Parameter | Type | Required | Description | -| :-------- | :----- | :------- | :------------------------------------- | +|:--------- |:------ |:-------- |:-------------------------------------- | | store_id | STRING | True | The store ID, in hex format | | url | STRING | True | The URL of the mirror to download from | @@ -118,11 +118,11 @@ Functionality: Upload data to a store Request Parameters: -| Parameter | Type | Required | Description | -| :----------------- | :----- | :------- | :-------------------------- | -| store_id | STRING | True | The store ID, in hex format | +| Parameter | Type | Required | Description | +|:-------------------- |:------ |:-------- |:--------------------------- | +| store_id | STRING | True | The store ID, in hex format | | full_tree_filename | STRING | True | Name of full tree dat file | -| diff_filename | STRING | True | Name of delta dat file | +| diff_filename | STRING | True | Name of delta dat file | Response: `{"uploaded": [true|false]}` @@ -139,7 +139,7 @@ Functionality: Download a data file from a URI Request Parameters: | Parameter | Type | Required | Description | -| :-------- | :----- | :------- | :------------------------------------------------- | +|:--------- |:------ |:-------- |:-------------------------------------------------- | | url | STRING | True | The URI for the download, eg `"server_info.url"` | | filename | STRING | True | The name of the file to download, eg `"file1.dat"` | @@ -158,7 +158,7 @@ Functionality: Add missing files to a store Request Parameters: | Parameter | Type | Required | Description | -| :-------- | :----- | :------- | :----------------------------------------------------------------------- | +|:--------- |:------ |:-------- |:------------------------------------------------------------------------ | | store_id | STRING | True | The store ID, in hex format | | files | LIST | True | The list of files to be added, for example: `["file1.dat", "file2.dat"]` | @@ -233,10 +233,10 @@ Functionality: Add a new store Request Parameters: | Parameter | Type | Required | Description | -| :-------- | :----- | :------- | :---------------------------------------------------------------------------------------------------------- | +|:--------- |:------ |:-------- |:----------------------------------------------------------------------------------------------------------- | | store_id | STRING | True | The store ID, in hex format | -| bucket | STRING | True\* | The name of the S3 bucket [* Either `bucket` or `urls` or both is required] | -| urls | LIST | True\* | A list of s3 URLs, for example `["s3://one", "s3://two"]` [* Either `bucket` or `urls` or both is required] | +| bucket | STRING | True\* | The name of the S3 bucket [* Either `bucket` or `urls` or both is required] | +| urls | LIST | True\* | A list of s3 URLs, for example `["s3://one", "s3://two"]` [* Either `bucket` or `urls` or both is required] | Success Response: `{"success": true, "id": store id}` @@ -255,7 +255,7 @@ Functionality: Remove a store Request Parameters: | Parameter | Type | Required | Description | -| :-------- | :----- | :------- | :-------------------------- | +|:--------- |:------ |:-------- |:--------------------------- | | store_id | STRING | True | The store ID, in hex format | Response: `{"success": [true|false], "store_id":store id in hex if successful}` diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guides/datalayer/datalayer-user-guide.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guides/datalayer/datalayer-user-guide.md index 42fc256126..b9e07116b5 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guides/datalayer/datalayer-user-guide.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guides/datalayer/datalayer-user-guide.md @@ -278,7 +278,7 @@ Regardless of the status of `FULL NODE`, you may safely proceed with this tutori - Green dot = full node is synced - `FULL NODE` is missing = you are running in `Wallet Mode` -::: +:::
Synced wallet diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guides/nft/nft-bulk-mint.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guides/nft/nft-bulk-mint.md index 0286378474..67e5aef8b6 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guides/nft/nft-bulk-mint.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guides/nft/nft-bulk-mint.md @@ -105,6 +105,7 @@ python -m venv venv ```bash python3 -m venv venv . ./venv/bin/activate +``` ./venv/bin/activate ``` @@ -113,6 +114,7 @@ python3 -m venv venv ```bash python3 -m venv venv . ./venv/bin/activate +``` ./venv/bin/activate ``` @@ -121,7 +123,7 @@ python3 -m venv venv 4. Install the bulk minting tool. This will install a copy of Chia in your virtual environment, as well as all other dependencies for the tool: ```bash -pip install --editable .[dev] +pip install --editable '.[dev]' ``` ## Configure Chia to use the bulk minting tool @@ -139,14 +141,11 @@ chia configure --testnet true ``` :::note -If you previously had been running Chia on mainnet, then your peers table will be populated with mainnet peers. -When you switch to running on the testnet, the peers listed in this table will time out. -Eventually the table will be repopulated with testnet peers, but this can take a long time. -In order to expedite this process, We recommend that you delete your peers tables: +If you previously had been running Chia on mainnet, then your peers table will be populated with mainnet peers. When you switch to running on the testnet, the peers listed in this table will time out. Eventually the table will be repopulated with testnet peers, but this can take a long time. In order to expedite this process, We recommend that you delete your peers tables: - `~/.chia/mainnet/db/peers.dat` - `~/.chia/mainnet/wallet/db/wallet_peers.dat` - ::: +::: 2. We recommend that you use `INFO` level logging instead of the default `WARNING` level. To do this, run: @@ -185,7 +184,7 @@ Showing all public and private keys Fingerprint: 3049838316 (...) - Mnemonic seed (24 secret words): + Mnemonic seed (24 secret words): youth stomach social aware clay pottery benefit asthma mail cry rubber panda wife around provide atom cute sand staff exotic pink east gloom minute ``` @@ -199,7 +198,7 @@ If you ever need to display your address, run `chia keys show`. This command wil 6. In order to continue, you will need to have some TXCH in your wallet. If your total balance is 0, you can obtain 1 TXCH from our faucet. Copy the value of "First wallet address:" from the output of the `chia keys show` command. It will be a long string beginning with "txch". -Open our [testnet faucet page](https://testnet11-faucet.chia.net "Chia's testnet11 faucet link"). Paste your address and click "Submit". +Open our [testnet faucet page](https://testnet10-faucet.chia.net "Chia's testnet10 faucet link"). Paste your address and click "Submit". Paste your address and click "Submit". You will receive this message: `Accepted. Your request is in the queue and will be processed in the order it was received.` At some point you will receive 1 TXCH. Depending on how busy the faucet and the testnet are, this could take several minutes. However, you don't need to wait for your coins to arrive before continuing. @@ -209,12 +208,12 @@ You will receive this message: `Accepted. Your request is in the queue and will mkdir ~/.chia/mainnet/db ``` -8. If you downloaded a copy of the testnet database, you will need to wait for the download to complete before continuing. After the download has completed, use an archive manager such as [7-Zip](https://www.7-zip.org/ "7-Zip's website") to extract the file. You should now have a file in your Downloads folder called `blockchain_v2_testnet11.sqlite`. +8. If you downloaded a copy of the testnet database, you will need to wait for the download to complete before continuing. After the download has completed, use an archive manager such as [7-Zip](https://www.7-zip.org/ "7-Zip's website") to extract the file. If you downloaded a copy of the testnet database, you will need to wait for the download to complete before continuing. After the download has completed, use an archive manager such as [7-Zip](https://www.7-zip.org/ "7-Zip's website") to extract the file. You should now have a file in your Downloads folder called `blockchain_v2_testnet10.sqlite`. Move the database to the folder you just created: ```bash -mv ~/Downloads/blockchain_v2_testnet11.sqlite ~/.chia/mainnet/db +mv ~/Downloads/blockchain_v2_testnet10.sqlite ~/.chia/mainnet/db ``` 9. Start the full node, which will begin syncing to the database file: @@ -235,9 +234,9 @@ chia show -s Eventually, it will say `Full Node Synced`: ```text -Network: testnet11 Port: 58444 RPC Port: 8555 +Network: testnet10 Port: 58444 RPC Port: 8555 Node ID: 82a73b06b3a5f9493a3ac4e3d903026b39c85b748158ba41c623d531947f2a2a -Genesis Challenge: 37a90eb5185a9c4439a91ddc98bbadce7b4feba060d50116a067de66bf236615 +Genesis Challenge: ae83525ba8d1dd3f09b277de18ca3e43fc0af20d20c4b3e92ef2a48bd291ccb2 Current Blockchain Status: Full Node Synced ``` @@ -506,7 +505,7 @@ chianft submit-spend-bundles -m 10 -o 100 output.pkl Each time a spend bundle is submitted, some status info will appear. For example: ```bash -SUBMITTED: 1/4 TX: 104.70s FEE: 0.04s OFFER: 6.02s TOTAL: 120.77s +SUBMITTED: 1/4 TX: 104.70s FEE: 0.04s OFFER: 6.02s TOTAL: 120.77s ``` Expect the total time for each spend bundle to be around 1-2 minutes. A project with `10 000` NFTs could take anywhere from 7-14 hours to complete. @@ -600,7 +599,7 @@ This can be safely ignored. 4. Submit the spend bundles created in the output file (output.pkl in this example). This command has two flags: - `-m`: an optional transaction fee, in mojos. This is a fee to be used for inclusion in the blockchain, completely separate from the royalty percentage. This fee will be applied once per spend bundle of 25 NFTs. The bulk mint tool will not verify that you have enough money to cover this fee beforehand - - `-o`: _Not set._ In this example, we don't provide this option as we will be air-dropping them to their targeted address in the `metadata.csv`. We declared these spend bundles to include a targeted address in the previous command. We would not be able to create offers for NFTs where we are offering the NFT if we are not the owner. (The air-drop address is the NFT owner.) + - `-o`: _Not set._ In this example, we don't provide this option as we will be air-dropping them to their targeted address in the `metadata.csv`. We declared these spend bundles to include a targeted address in the previous command. We would not be able to create offers for NFTs where we are offering the NFT if we are not the owner. (The air-drop address is the NFT owner.) We declared these spend bundles to include a targeted address in the previous command. We would not be able to create offers for NFTs where we are offering the NFT if we are not the owner. (The air-drop address is the NFT owner.) ```bash chianft submit-spend-bundles -m 10 output.pkl @@ -609,7 +608,7 @@ chianft submit-spend-bundles -m 10 output.pkl Each time a spend bundle is submitted, some status info will appear. For example: ```bash -SUBMITTED: 1/4 TX: 104.70s FEE: 0.04s OFFER: 6.02s TOTAL: 120.77s +SUBMITTED: 1/4 TX: 104.70s FEE: 0.04s OFFER: 6.02s TOTAL: 120.77s ``` Expect the total time for each spend bundle to be around 1-2 minutes. A project with `10 000` NFTs could take anywhere from 7-14 hours to complete. diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guides/nft/nft-intro.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guides/nft/nft-intro.md index a441bcc244..bfa66bf165 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guides/nft/nft-intro.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guides/nft/nft-intro.md @@ -63,7 +63,7 @@ The cost for minting and modifying NFTs is significantly higher. The following c If the mempool is not full, then a 1-mojo fee will be sufficient for any of these spends to be included in the next transaction block. To view the current status of the mempool, see the [Mempool Cost](https://dashboard.chia.net/d/46EAA05E/mempool-transactions-and-fees?orgId=1&viewPanel=40) table on our dashboard site. (If the green line representing the current mempool cost is close to the red line representing the maximum cost, then the mempool is full, and the following table should be used.) | Operation | Cost (approx) | Min fee (mojos) | Cost in USD at $30/XCH | -| :------------------------------ | ------------: | :-------------- | :--------------------- | +|:------------------------------- | -------------:|:--------------- |:---------------------- | | Minting NFT without DID | 53 million | 265 million | $0.00795 | | Minting NFT with DID | 123 million | 615 million | $0.01845 | | Adding a URI to NFT without DID | 41 million | 205 million | $0.00615 | diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guides/seeder-user-guide.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guides/seeder-user-guide.md index a4c14c8a9b..91ec81703f 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guides/seeder-user-guide.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guides/seeder-user-guide.md @@ -11,9 +11,9 @@ It does so by crawling through the network, periodically revisiting known nodes The Chia Seeder runs a mini-DNS server. The Chia Seeder runs a mini-DNS server. Anyone can obtain an entry point into Chia’s decentralized and permissionless network via a simple DNS request for reliable node IPs. -The Chia Seeder has very low memory and CPU requirements. It runs a faux full_node process and does not need its own node. +The Chia Seeder has low memory and CPU requirements. It runs a faux full_node process and does not need its own node. -Chia’s core developers have already been running an instance of the Chia Seeder for some time. You can view the current status of this instance by running: You can view the current status of this instance by running: +Chia’s core developers have been running an instance of the Chia Seeder for some time. You can view the current status of this instance by running: ```bash # IPv4 @@ -23,7 +23,7 @@ dig dns-introducer.chia.net dig -t AAAA dns-introducer.chia.net ``` -Chia has now decided to release the Seeder as a tool for anyone to maintain their own list of reliable nodes, which contributes to the further decentralization of Chia’s network by taking this tool off of the core team’s hands. +Chia Network released the Seeder as a tool for anyone to maintain their own list of reliable nodes, which contributes to the further decentralization of Chia’s network by taking this tool off of the core team’s hands. Features: @@ -31,6 +31,8 @@ Features: - Runs a mini-DNS server on port 53, along with a full node to crawl the network. - Stores peer IPs and peer statistics into a database, so that they are persisted across runs. +@dns_xch from Dexie created an [alternate light implemntation}](https://github.com/dexie-space/chia-seeder-light) in Rust that uses 99% less CPU and 66% less RAM. + ## Expectations for Chia Seeder operators The Chia network core developers endeavor to minimize the level of trust in the DNS servers associated with a Chia Seeder. In this regard, it is expected for each Chia Seeder to be run by an individual or organization recognized as well-intentioned within the Chia community. In this regard, it is expected for each Chia Seeder to be run by an individual or organization recognized as well-intentioned within the Chia community. @@ -72,13 +74,13 @@ nameserver 8.8.8.8 nameserver 8.8.4.4 ``` -Once you have completed freeing up port 53, you will then need to allow the python executable in your venv to have access to port 53: +Once you have completed freeing up port 53, you will then need to allow the python executable in your venv to have access to port 53. From an activated venv run `whereis python` and use the result in the command below: ```bash -sudo setcap CAP_NET_BIND_SERVICE=+eip $(readlink -f /home/{{ user }}/chia-blockchain/venv/bin/python) +sudo setcap CAP_NET_BIND_SERVICE=+eip $(readlink -f /home/{{ user }}/chia-blockchain/.venv/bin/python) ``` -Note that anytime you change the python executable by rerunning `sh install.sh` or when `apt` upgrades python, you will need to re-run this command. +Note that anytime you change the python executable by rerunning `sh install.sh` or when `apt` upgrades python, you will need to re-run this command. Also, the exact path to python has changed as of version 2.4.3 and that new usual default is what is specified above. ## Configuration diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guides/tutorials/offers-cli.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guides/tutorials/offers-cli.md index 4237631503..eef4580821 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guides/tutorials/offers-cli.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guides/tutorials/offers-cli.md @@ -381,7 +381,7 @@ Wallet ID 4 type COLOURED_COIN CAT King Cole (Asset ID: 1121996b75cce3c746369ace ## Create an expiring Offer (RPC) -In this example, we will offer 0.1 CATs (`Launcher ID: 91aa...004r`) in exchange for 1 TXCH (`Wallet ID: 1`). In addition, we will add an expiry timestamp so that this Offer will expire on Jan. 1, 2024: In addition, we will add an expiry timestamp so that this Offer will expire on Jan. 1, 2024. This is accomplished with the `max_time` flag: +In this example, we will offer 0.1 CATs (`TAIL/Asset ID: 91aa...004r`) in exchange for 1 TXCH (`Wallet ID: 1`). In addition, we will add an expiry timestamp so that this Offer will expire on Jan. 1, 2024. This is accomplished with the `max_time` flag: ```bash chia rpc wallet create_offer_for_ids '{"offer":{"1":1000000000000,"91aa49303fd325cf8029cc0ee5e19ac78ec33d641d63b50d0ba859309a73004d":-100},"fee":10000000,"driver_dict":{},"validate_only":false, "max_time": 1704070800}' diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guides/walletconnect/walletconnect-developer-guide.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guides/walletconnect/walletconnect-developer-guide.md index 53337fc203..8631fcf17f 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guides/walletconnect/walletconnect-developer-guide.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guides/walletconnect/walletconnect-developer-guide.md @@ -18,50 +18,50 @@ For more info, see our WalletConnect [command documentation](/walletconnect-comm The following table shows each RPC for Chia WalletConnect dApps, along with a description of what each RPC does, and a link to the equivalent Chia RPC: -| WalletConnect RPC | Chia Wallet RPC | Description | -| :-------------------- | :--------------------------------------------------------------- | :------------------------------------------------------------------------------------------------ | -| addCATtoken | [create_new_wallet](/wallet-rpc#create_new_wallet) | Create a new wallet for CATs | -| addVCProofs | [vc_add_proofs](/vc-rpc/#vc_add_proofs) | Add a set of proofs to the DB that can be used when spending a VC | -| cancelOffer | [cancel_offer](/wallet-rpc#cancel_offer) | Cancel an offer | -| checkOfferValidity | [check_offer_validity](/wallet-rpc#check_offer_validity) | Check if an offer is valid | -| createNewDIDWallet | [create_new_wallet](/did-rpc/#create_new_wallet) | Create a new DID wallet | -| createOfferForIDs | [create_offer_for_ids](/wallet-rpc#create_offer_for_ids) | Create a new offer | -| getAllOffers | [get_all_offers](/wallet-rpc#get_all_offers) | Show the details of all offers for this wallet | -| getCATAssetId | [cat_get_asset_id](/wallet-rpc#cat_get_asset_id) | Retrieve a the asset ID from a CAT wallet | -| getCATWalletInfo | [get_wallets](/wallet-rpc/#get_wallets) | Get CAT Wallet Info | +| WalletConnect RPC | Chia Wallet RPC | Description | +|:--------------------- |:-------------------------------------------------------------------- |:------------------------------------------------------------------------------------------------- | +| addCATtoken | [create_new_wallet](/wallet-rpc#create_new_wallet) | Create a new wallet for CATs | +| addVCProofs | [vc_add_proofs](/vc-rpc/#vc_add_proofs) | Add a set of proofs to the DB that can be used when spending a VC | +| cancelOffer | [cancel_offer](/wallet-rpc#cancel_offer) | Cancel an offer | +| checkOfferValidity | [check_offer_validity](/wallet-rpc#check_offer_validity) | Check if an offer is valid | +| createNewDIDWallet | [create_new_wallet](/did-rpc/#create_new_wallet) | Create a new DID wallet | +| createOfferForIDs | [create_offer_for_ids](/wallet-rpc#create_offer_for_ids) | Create a new offer | +| getAllOffers | [get_all_offers](/wallet-rpc#get_all_offers) | Show the details of all offers for this wallet | +| getCATAssetId | [cat_get_asset_id](/wallet-rpc#cat_get_asset_id) | Retrieve a the asset ID from a CAT wallet | +| getCATWalletInfo | [get_wallets](/wallet-rpc/#get_wallets) | Get CAT Wallet Info | | getCurrentAddress | [get_next_address](/wallet-rpc#get_next_address)\* | Set `new_address` to `false` to use the current address | | getNextAddress | [get_next_address](/wallet-rpc#get_next_address)\* | Set `new_address` to `true` to create a new address | -| getNFTsCount | [nft_count_nfts](/nft-rpc/#nft_count_nfts) | Count the number of NFTs in a wallet | -| getNFTInfo | [nft_get_info](/nft-rpc/#nft_get_info) | Get info about an NFT | -| getNFTs | [nft_get_nfts](/nft-rpc/#nft_get_nfts) | Show all NFTs in a given wallet | +| getNFTsCount | [nft_count_nfts](/nft-rpc/#nft_count_nfts) | Count the number of NFTs in a wallet | +| getNFTInfo | [nft_get_info](/nft-rpc/#nft_get_info) | Get info about an NFT | +| getNFTs | [nft_get_nfts](/nft-rpc/#nft_get_nfts) | Show all NFTs in a given wallet | | getNFTWalletsWithDIDs | [nft_get_wallets_with_dids](/nft-rpc/#nft_get_wallets_with_dids) | Show all NFT wallets that are associated with DIDs | -| getOfferData | [get_offer](/wallet-rpc#get_offer) | Show the details of one offer | -| getOfferRecord | [get_all_offers](/wallet-rpc#get_all_offers) | Show the details of all offers for this wallet | -| getOffersCount | [get_offers_count](/wallet-rpc#get_offers_count) | Obtain the number of offers from the current wallet | -| getOfferSummary | [get_offer_summary](/wallet-rpc#get_offer_summary) | Show a summary of an offer | +| getOfferData | [get_offer](/wallet-rpc#get_offer) | Show the details of one offer | +| getOfferRecord | [get_all_offers](/wallet-rpc#get_all_offers) | Show the details of all offers for this wallet | +| getOffersCount | [get_offers_count](/wallet-rpc#get_offers_count) | Obtain the number of offers from the current wallet | +| getOfferSummary | [get_offer_summary](/wallet-rpc#get_offer_summary) | Show a summary of an offer | | getProofsForRoot | [vc_get_proofs_for_root](/vc-rpc/#vc_get_proofs_for_root) | Given a specified VC root, get any proofs associated with that root | -| getPublicKey | [get_public_key](/daemon-rpc#get_public_key) | Request the user to provide their master public key | -| getSyncStatus | [get_sync_status](/wallet-rpc#get_sync_status) | Show whether the current wallet is syncing or synced | -| getTransaction | [get_transaction](/wallet-rpc#get_transaction) | Get a transaction's details from its ID | -| getVC | [vc_get](/vc-rpc/#vc_get) | Given a launcher ID, get the Verifiable Credential | -| getVCList | [vc_get_list](/vc-rpc/#vc_get_list) | Get a list of Verifiable Credentials | -| getWalletAddresses | [get_wallet_addresses](/daemon-rpc/#get_wallet_addresses) | Get wallet addresses for one or more wallet keys | -| getWalletBalance | [get_wallet_balance](/wallet-rpc#get_wallet_balance) | Obtain the balance (and related info) from a wallet | -| getWalletBalances | [get_wallet_balances](/wallet-rpc/#get_wallet_balances) | Request the asset balances for specific wallets associated with the current wallet key | -| getWallets | [get_wallets](/wallet-rpc#get_wallets) | Show all wallets associated with the current fingerprint, including (by default) coin information | -| logIn | [log_in](/wallet-rpc#log_in) | Log into the wallet with the specified key | -| mintNFT | [nft_mint_nft](/nft-rpc/#nft_mint_nft) | Mint an NFT | -| revokeVC | [vc_revoke](/vc-rpc/#vc_revoke) | Revoke an on chain VC provided the correct DID is available | -| sendTransaction | [send_transaction](/wallet-rpc#send_transaction) | Send a transaction | -| setDIDName | [did_set_wallet_name](/did-rpc/#did_set_wallet_name) | Set the name of a DID wallet | -| setNFTDID | [nft_set_nft_did](/nft-rpc/#nft_set_nft_did) | Set the DID for an NFT | -| showNotification | [get_notifications](/wallet-rpc/#get_notifications) | Show notification with offer or general announcement | -| signMessageByAddress | [sign_message_by_address](/wallet-rpc#sign_message_by_address) | Sign a message using an XCH address without incurring an on-chain transaction | -| signMessageById | [sign_message_by_id](/wallet-rpc#sign_message_by_id) | Sign a message using a DID or NFT ID without incurring an on-chain transaction | -| spendCAT | [cat_spend](/wallet-rpc#cat_spend) | Send CAT funds to another wallet | -| spendClawbackCoins | [spend_clawback_coins](/wallet-rpc/#spend_clawback_coins) | Claw back or claim claw back transaction | -| takeOffer | [take_offer](/wallet-rpc#take_offer) | Take an offer | -| transferNFT | [nft_transfer_nft](/nft-rpc#nft_transfer_nft) | Transfer an NFT to a new wallet address | -| spendVC | [vc_spend](/vc-rpc/#vc_spend) | Add Proofs To Verifiable Credential | -| verifySignature | [verify_signature](/wallet-rpc#verify_signature) | Given a public key, message and signature, verify if it is valid | -| waitForConfirmation | | | +| getPublicKey | [get_public_key](/daemon-rpc#get_public_key) | Request the user to provide their master public key | +| getSyncStatus | [get_sync_status](/wallet-rpc#get_sync_status) | Show whether the current wallet is syncing or synced | +| getTransaction | [get_transaction](/wallet-rpc#get_transaction) | Get a transaction's details from its ID | +| getVC | [vc_get](/vc-rpc/#vc_get) | Given a launcher ID, get the Verifiable Credential | +| getVCList | [vc_get_list](/vc-rpc/#vc_get_list) | Get a list of Verifiable Credentials | +| getWalletAddresses | [get_wallet_addresses](/daemon-rpc/#get_wallet_addresses) | Get wallet addresses for one or more wallet keys | +| getWalletBalance | [get_wallet_balance](/wallet-rpc#get_wallet_balance) | Obtain the balance (and related info) from a wallet | +| getWalletBalances | [get_wallet_balances](/wallet-rpc/#get_wallet_balances) | Request the asset balances for specific wallets associated with the current wallet key | +| getWallets | [get_wallets](/wallet-rpc#get_wallets) | Show all wallets associated with the current fingerprint, including (by default) coin information | +| logIn | [log_in](/wallet-rpc#log_in) | Log into the wallet with the specified key | +| mintNFT | [nft_mint_nft](/nft-rpc/#nft_mint_nft) | Mint an NFT | +| revokeVC | [vc_revoke](/vc-rpc/#vc_revoke) | Revoke an on chain VC provided the correct DID is available | +| sendTransaction | [send_transaction](/wallet-rpc#send_transaction) | Send a transaction | +| setDIDName | [did_set_wallet_name](/did-rpc/#did_set_wallet_name) | Set the name of a DID wallet | +| setNFTDID | [nft_set_nft_did](/nft-rpc/#nft_set_nft_did) | Set the DID for an NFT | +| showNotification | [get_notifications](/wallet-rpc/#get_notifications) | Show notification with offer or general announcement | +| signMessageByAddress | [sign_message_by_address](/wallet-rpc#sign_message_by_address) | Sign a message using an XCH address without incurring an on-chain transaction | +| signMessageById | [sign_message_by_id](/wallet-rpc#sign_message_by_id) | Sign a message using a DID or NFT ID without incurring an on-chain transaction | +| spendCAT | [cat_spend](/wallet-rpc#cat_spend) | Send CAT funds to another wallet | +| spendClawbackCoins | [spend_clawback_coins](/wallet-rpc/#spend_clawback_coins) | Claw back or claim claw back transaction | +| takeOffer | [take_offer](/wallet-rpc#take_offer) | Take an offer | +| transferNFT | [nft_transfer_nft](/nft-rpc#nft_transfer_nft) | Transfer an NFT to a new wallet address | +| spendVC | [vc_spend](/vc-rpc/#vc_spend) | Add Proofs To Verifiable Credential | +| verifySignature | [verify_signature](/wallet-rpc#verify_signature) | Given a public key, message and signature, verify if it is valid | +| waitForConfirmation | | | diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guides/walletconnect/walletconnect-user-guide.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guides/walletconnect/walletconnect-user-guide.md index f2985d916c..337df5750f 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guides/walletconnect/walletconnect-user-guide.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guides/walletconnect/walletconnect-user-guide.md @@ -242,7 +242,7 @@ Returning to the sample dApp, a new dialog with the response will appear. In thi
-You have now installed, configured, and used the sample dApp. Feel free to test the other functions, as well as create your own! + You have now installed, configured, and used the sample dApp. Feel free to test the other functions, as well as create your own! --- diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/keys/keys-and-signatures.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/keys/keys-and-signatures.md index 6c8b9af288..3c4b331675 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/keys/keys-and-signatures.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/keys/keys-and-signatures.md @@ -5,7 +5,7 @@ slug: /bls-keys This section will explain the different types of keys in the Chia network. It will also cover how the keys are generated, stored, and used. These systems are designed to be flexible enough to support many different configurations and pooling setups and to be resilient to various attacks. -All Chia keys are [BLS-12-381](https://github.com/zkcrypto/bls12_381) private keys, following the [IETF specification](https://datatracker.ietf.org/doc/draft-irtf-cfrg-bls-signature/), the [EIP-2333](https://eips.ethereum.org/EIPS/eip-2333) specification for key derivation and [BIP 44 registered](https://github.com/satoshilabs/slips/blob/master/slip-0044.md). Private keys are 32 bytes, public keys 48 bytes, and signatures 96 bytes (public keys are points in G1, signatures are points in G2.) +All Chia keys are [BLS-12-381](https://github.com/supranational/blst/) private keys, following the [IETF specification](https://datatracker.ietf.org/doc/draft-irtf-cfrg-bls-signature/), the [EIP-2333](https://eips.ethereum.org/EIPS/eip-2333) specification for key derivation and [BIP 44 registered](https://github.com/satoshilabs/slips/blob/master/slip-0044.md). Private keys are 32 bytes, public keys 48 bytes, and signatures 96 bytes (public keys are points in G1, signatures are points in G2.) :::warning There is a slight difference between Chia's implementation and EIP-2333, as described in the next section. diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/new-proof-format/new-proof-faq.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/new-proof-format/new-proof-faq.md new file mode 100644 index 0000000000..b8dfa4a28b --- /dev/null +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/new-proof-format/new-proof-faq.md @@ -0,0 +1,157 @@ +--- +sidebar_label: FAQ +title: FAQ +slug: /new-proof-faq +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +:::note + +This information was updated on 12/11/2024. + +::: + +This page will answer your most common questions. Expect it to grow with time. + +### What will this break/change? + +Initially nothing, to give everyone time to upgrade. When the hard fork becomes activated six months after the release of Chia 3.0 there will be changes to the blockchain consensus which will cause non-upgraded full nodes and wallets to break. The upgrades software vendors will need to make before then are small and will be included in the reference codebase. Farmers will have to replot during the transition period and use upgraded plotters and harvesters. The computational requirements for harvesting will be slightly larger than with the original plot file format but vastly less than for compressed plots. + +### When will I be able to farm with new plots on mainnet? + +After the hard fork date, currently expected Q4 2025 (see [timeline](/new-proof-timeline)). + +### When will the old plot format be fully phased out? + +By the end of the transition period, currently expected Q4 2026 (see [timeline](/new-proof-timeline)). + +### When should I replot? + +Sometime during the transition period. When will be best for you will depend on your setup, but there will be a long enough time that the plots compliant with the new format will be neutral in weight to your existing plots so you can do it at your leisure. We will provide guidelines on how to evaluate which time window would be ideal to transition for your setup. + +### With a modern GPU such as a 3090, what will be my expected plot times? + +Around 1-2 minutes for a k32 ~100GiB plot, but this may change depending on how the final parameters are tuned for the proof of space. See our table of [expected plot times](/new-proof-plotting-requirements#expected-plot-times). + +### Will you also support CPU plotting, and if so, what will be my expected plot times? + +CPU plotting will be supported but will not be recommended for plotting any significant amount. A multi-threaded CPU will be about 100x slower than a 3090, potentially completing a k30 in 45 minutes. The more CPU threads and memory channels your system has will reduce this time. + +### What will the hardware requirements be for harvesters? + +Harvesting consists of two main components: plot retrieval and proof solving when a good proof is found. + +For plot retrieval, even large farms can use low-spec computers such as original Raspberry Pis, as most of the time is spent simply reading from storage, which uses minimal compute resources. + +The proof-solving hardware requirement depends on the largest plot size (k-size) in your farm, not the total number of plots. If a proof of space wins a block or pool partial, your hardware must be capable of solving proofs for the largest k-size plot within the required timeframe. + +For example, if your farm includes k28, k30, and k32 plots, your proof-solving machine must meet the requirements for solving k32 proofs, even if the majority of your plots are smaller. If you want a single machine for both harvesting tasks (plot retrieval and proof solving), it should meet the k32 specs for solving proofs and can also handle plot retrieval. + +For large farms or setups with multiple harvesters, you can use low-spec devices like Raspberry Pis for plot retrieval and designate a higher-spec machine capable of solving proofs for your largest k-size as the central proof-solving service. If your farm contains only k28 plots, a Raspberry Pi 5 can serve as both a plot retrieval device and the central proof-solving service for your entire farm. + +See our [farming requirements](/new-proof-farming-requirements) for more detailed information. + +### What is the difficulty level in the new format? + +The new plot format allows us to tune a difficulty setting to directly influence plot time. The higher the plot time, the more compression resistant the format becomes. However, we need to balance the difficulty with what should be an acceptable plotting time for most farmers, yet still have enough difficulty for significant compression resistance. + +### How do you know that compression won’t be possible with the new format? + +Compression is always possible, but the incentive will be severely limited. For instance, you could compress 100% of the plot by constructing a plot on the fly in under 30 seconds when a challenge comes in. However, this would require a cluster of the latest GPU’s to achieve, and would cost hundreds of thousands of dollars, just to spoof the space taken up by less than a TB. Alternatively, a farmer could make a plot with just 1 bit dropped per entry, and save ~0.5% of space. However, even this could incur more energy per TiB than the honest farmer. + +In the future we expect extremely high efficiency in compute, however, storage will also improve in cost and efficiency during that time. With the advent of extremely low power SSDs when on idle, most farmers will be better off staying with the default plot format. Those farmers looking to squeeze the most out of their system by bit-dropping for extra levels of compression might achieve marginal gains despite higher energy costs per eTiB, but risk needing to replot and adjust their systems based on price fluctuations. If compute efficiency significantly outpaces gains in storage cost and efficiency, we could see bit-dropping with recompute reaching up to 10% space savings with marginal extra % gains in net rewards. + +### Will there still be a plot filter after the new format is available? + +Yes, and there are also additional filters in play. However, these filters are not expected to vary on a timed schedule (we only propose changing them if/when needed, with plenty of advanced notice), so as a farmer you won’t need to plan for any pre-scheduled dates where the filter will change. It is possible, if there are no longer any HDDs in use, we could propose a fork to alter the plot filter to improve resistance further since the restriction on seek times for HDDs would be lifted. Also, if GPU efficiency increases substantially in the future, to 10x or 100x what it is today, we can apply a soft fork to increase the plot difficulty – this would affect plot times and allow the phase-in of new plots that would be resistant to the hardware specifications at that future point in time. Note, however, that as cost per TB and also idle storage Watts also decreases over time, this counterbalances with GPU efficiency. So, while we may see 10x more efficient GPUs in 5 years, it does not necessarily mean we already need to adjust plot difficulty since the economics of farming on cheaper storage with extremely low idle power usage will also be a factor. + +### How many times will I have to replot? + +Once for the foreseeable 5-year outlook, and possibly much longer. The security of the network against rental attacks should be very strong for at least 10 years. + +### What's this about different HDD and SSD plot formats (i.e. what is benes compression)? + +There will be a single proof format for the blockchain. There will be no way to tell which blocks came from which format. There will be a proof format available that uses Benes Compression which we initially thought would only work on SSD but after testing has proven to also work on HDD. + +Benes compression is designed to save approximately **7-8 bits per entry per plot**, regardless of the k-size. This results in notable space savings, especially for smaller plots like k28, which have the fewest bits per entry. For a k28 plot, this translates to an estimated **5-10% reduction in plot size**. + +While the space savings are promising, constructing Benes-compressed plots comes with significant challenges: + +- **All-RAM Plotting**: Plotting with Benes requires all-RAM construction, and demands additional system resources. +- **Longer Plot Times**: Plot creation using Benes compression is expected to take significantly more time and energy compared to traditional plotting methods. +- **GPU Assistance Uncertainty**: It is currently unclear whether GPUs can effectively assist CPUs in constructing Benes-compressed plots, as the plotting process is difficult to parallelize. This limitation raises questions about whether plotting speeds could exceed 100 GiB/day on a single system. +- **Increased disk activity**: Benes-compressed plots require twice the disk reads during farming. This increased disk activity may negate the energy savings achieved from smaller plot sizes, particularly for HDD-based setups. + +The additional cost and energy required for Benes-compressed plotting and increased disk activity during harvesting may outweigh the benefits of 5-10% space savings. Farmers will need to assess whether these savings are sufficient to justify the increased plotting resources and time. + +Despite these challenges, we plan to include an **option for Benes compression** in the upcoming release for those who wish to experiment with it. Farmers can decide whether the trade-offs align with their individual farming strategies and goals. + +### How much space will someone be able to save using GPU compression? + +It will be possible to save a few percent of space using bit dropping but the costs will go up exponentially. Currently we expect a 4090 on a large farm may be incentivized to compress up to 2-3% of the plot size, although this is still subject to change based on the final tuning parameters for the proof of space. + +### For an energy-conscious farmer, what will be the optimal CPU or GPU for farming? + +Smaller k-sizes, such as k28, lead to increased disk activity, which in turn raises the energy consumption of storage media. For SSDs, this extra activity is negligible, and a low-power device like a Raspberry Pi 5 is sufficient to handle even large farms spanning multiple petabytes. + +For HDD-based farms, HDDs consume more power (typically around 50 to 100% more) when actively reading compared to being idle. For example, a large 20TiB HDD filled with k28 plots will be active approximately 6% of the time, compared to 0.4% for k32 plots, and just 0.1% for k34 plots. This would result in a 3-6% increase in energy consumption when using k28 instead of k32 or k34 plots. + +For farmers with a large number of drives, it may be more efficient to use a higher-performance recompute machine capable of handling larger k-size plots (e.g., k32) without consuming more power than the additional energy costs incurred by smaller plots. A system like a Mac Mini M1 offers low idle power usage and can efficiently handle k32 plots or larger. + +The most energy-conscious approach is to leverage an existing system already online that meets the recomputation requirements for larger k-sizes. By running a solver on standby, this system can handle requests for full proofs as needed with negligible impact on its overall energy usage. This method avoids the need for additional dedicated hardware while keeping power consumption minimal. + +### When do you expect the CHIP to be made publicly available? + +The scope of changes to the original plot format has expanded significantly due to recent technological advancements. To ensure a comprehensive and practical release, we plan to make the CHIP publicly available once development of the plotter and solver is complete and extensively tested to be near production-ready. + +This approach will allow us to provide accurate performance metrics that reflect real-world usage, giving farmers a clear understanding of what to expect. Our tentative timeline for the CHIP release is **Q1 2025**. + +### When can I review the source code for plotting? + +When the CHIP is released we will have code for plotting and verification available for review. + +### Have you decided how long the transition period will be? + +6-12 months. + +### Given that a 3090 can create a k-28 plot in 5 seconds, how will grinding be prevented? + +Grinding, or creating a plot on the fly without storing to disk, generates rewards that are roughly the same per compute across the various k-sizes, provided the grinding fits into fast memory. With GPU clusters now having large VRAM capacities, there is no practical k-size that cannot be accommodated in some advanced GPU system. For instance, a k28 will complete a 3GiB plot in 5 seconds, and likewise, a k32, being ~18 times larger (~61 GiB), would take 18 times longer on the same GPU. However, with a cluster of 18 GPUs, the k32 plot could still be generated in approximately 5 seconds. + +In the original proof of space design, grinding posed a significant risk because a grinder could exploit the **plot ID filter**. The filter passes plots with a 1 in 256 chance, meaning a grinder could spoof the equivalent of 256 plots by generating a plot ID that passes this filter. + +The new proof of space introduces **two additional filters**—the **scan filter** and the **proof chaining filter**—to mitigate grinding risks. These filters significantly reduce the effectiveness of grinding by requiring that the plot passes the plot ID filter (1 in 256 chance), and also passes the scan filter and proof chaining filter, which introduce an additional 1 in 64 chance. As a result, the grinder can only spoof the equivalent of 4 plots per signage point. Across 3 signage points, this totals 12 spoofed plots before the plot ID filter changes for the next set of challenges. + +For example, a 3090 could spoof a maximum of 24 k28 plots (~72GiB of storage). However, the cost of a 3090 far exceeds the cost of storing 72 GiB of data on an HDD for an honest farmer. Additionally, the energy consumption of a 3090 is vastly higher than the energy required to maintain 72 GiB of storage on an HDD. + +To spoof **1 EiB** of netspace, a grinder would need to rent at least **15 million 3090 GPUs**. Even then, this is an order of magnitude less than the resources needed to control half of Chia’s netspace, making grinding practically and economically unfeasible on a large scale. + +### What metrics should we look at in determining whether grinding will be possible (plot size, plot speed, filter size, etc)? + +The feasibility of grinding can be assessed by calculating the amount of space that could be spoofed and comparing it to the resources required to achieve this. + +First, we determine how quickly a system can generate plots and whether the generated space can meaningfully spoof a significant portion of netspace. Then, we assess the probability of passing filters (e.g., plot ID, scan, and proof chaining filters) and how many plots would need to be generated to spoof a given amount of space. And finally, we evaluate whether it is feasible to rent or acquire the required computational resources (e.g., GPUs or GPU clusters) to generate enough spoofed space to impact the network. + +While it’s straightforward to calculate spoofed space (as demonstrated in the previous answer), the primary question is whether sufficient resources can be obtained at scale. For example: spoofing **20 EiB** of netspace would require **300 million 3090 GPUs**, far exceeding the global availability of GPUs today. Controlling such a large number of GPUs at a financially viable price is unlikely in the foreseeable future. + +Thus, while grinding is theoretically possible, it remains economically and logistically infeasible to execute at a scale that could threaten the network. + +### Under the current settings for the new format, for how long do you expect to be able to support k-28? + +Short answer: +K28 plots are expected to remain viable for as long as no significant vulnerabilities emerge. If any risks arise, they would likely apply to higher K-sizes as well over time, given advancements in hardware and technology. + +Long answer: +Under the current settings for the new format, the primary risk to continued support for K28 plots stems from the potential development of ASICs or FPGAs. These specialized devices could potentially reduce production costs for K28 plots compared to larger K-sizes, as smaller plots require less RAM. However, the viability of ASICs is a complex issue, heavily influenced by development costs and the financial rewards they might yield. While FPGAs, known for their high efficiency, could theoretically pose a risk if optimized, they are typically slower than high-end GPUs and face similar challenges. + +The new plot format has been designed to resist both rental and compression attacks, even against more powerful GPUs that may be developed in the future. This makes it uncertain whether FPGAs or other specialized hardware would gain any meaningful advantage for plot compression. Reducing plot size through bit-dropping quickly becomes impractical, as the resources required to achieve even a modest reduction escalate to nearly the same as grinding full plots. + +Given these safeguards, K28 plots are expected to remain viable for the foreseeable future under the current settings. However, advancements in hardware and unexpected vulnerabilities will continue to be monitored to ensure the format's long-term stability and security. + +### What are the settings that could be changed in a hard/soft fork to prevent grinding or other techniques to turn PoSpace into PoW? + +Currently, the plan is to maintain the plot ID filter at a level of 256, with a scheduled reduction on a periodic basis. This allows flexibility to adapt over time. The scan filter and chain filter are fixed and not expected to change. If conditions do not warrant reducing the plot filter during a given period, a soft fork can delay the reduction to the next scheduled period without disrupting the network. + +In the future, if SSDs become the dominant storage medium for proof of space, the current disk activity constraints imposed by HDDs will no longer be necessary. This shift would allow for a more significant reduction in the plot filter, enhancing both grinding and compression resistance. The reduction in the plot filter is directly proportional to the increase in resistance, and we have up to **two additional orders of magnitude** available for tuning. This means the plot filter could eventually decrease from 256 to as low as 1, providing substantial flexibility to counter emerging risks while maintaining the integrity of the proof of space system. diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/new-proof-format/new-proof-farming-requirements.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/new-proof-format/new-proof-farming-requirements.md new file mode 100644 index 0000000000..e6aa15ceb6 --- /dev/null +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/new-proof-format/new-proof-farming-requirements.md @@ -0,0 +1,53 @@ +--- +sidebar_label: Farming Requirements +title: Farming Requirements +slug: /new-proof-farming-requirements +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +:::note + +This information was updated on 12/11/2024. + +::: + +In general, the larger your farm, the more powerful your harvesters will need to be. However, keep in mind that one farm can be broken into multiple harvesters, so it is possible to run a large farm without any high-end equipment. + +### Proof Solving Times + +After a proof of sufficiently high quality is found it needs to be ‘solved’ which reconstructs the full proof so it can be verified by others. Proof-solving hardware requirements depend on the maximum k-size in the farm. Solve times should ideally stay under 8 seconds. + +| Plot Size | Raspberry Pi 5 | Ryzen 5600
(6-core) | Threadripper | Nvidia 3090 | +| :-------- | :------------------------------------------- | :------------------------------------------- | :---------------------------------- | :---------------------------------- | +| k34 | N/A | N/A | N/A | <8 seconds | +| k32 | N/A | ~15 seconds | <8 seconds | 960 ms | +| k30 | N/A | <8 seconds | <4 seconds | 240 ms | +| k28 | ~6.8 seconds | <2 seconds | <1 second | 60 ms | + +### HDD Disk Activity + +Lower k-sizes increase disk activity but lower your minimum hardware requirements for proof solving (see previous section). For SSDs, k28 plots are recommended due to minimal impact on farming performance. + +| Plot Size | Full 5TiB
disk load | Full 20TiB
disk load | Full 20TiB
disk load
Benes compression | +| :-------- | :-------------------------------------- | :------------------------------------ | :------------------------------------------------- | +| k34 | ~0.025% | ~0.1% | ~0.2% | +| k32 | ~0.1% | ~0.4% | ~0.8% | +| k30 | ~0.4% | ~1.5% | ~3% | +| k28 | ~1.6% | ~6.4% | ~12.8% | + +### Quality Strings Frequency + +Quality strings are found when a plot passes several filters, including plot ID, scan, and chain filters. Once found, they are tested against a difficulty filter to determine if they qualify as a block or pool partial win. + +**Solo farming:** The frequency of quality strings does not significantly impact farming activity. + +**Pool farming:** Increased quality string frequency improves pool size estimation accuracy for smaller farmers, helping stabilize rewards. Farmers with few plots may experience fluctuating estimated space and rewards day-to-day, but over time, rewards will align with actual plotted space. + +| Plot Size | Avg. Quality
Strings per hr
per TiB | +| :-------- | :-------------------------------------------------------------- | +| k34 | ~0.12 | +| k32 | ~0.5 | +| k30 | ~2.1 | +| k28 | ~9.1 | diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/new-proof-format/new-proof-introduction.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/new-proof-format/new-proof-introduction.md new file mode 100644 index 0000000000..21484cf390 --- /dev/null +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/new-proof-format/new-proof-introduction.md @@ -0,0 +1,35 @@ +--- +sidebar_label: Introduction +title: Introduction +slug: /new-proof-introduction +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +:::note + +This information was updated on 12/11/2024. + +::: + +## New Proof Format + +In 2024 we announced that we were developing a new Proof of Space format. This is a long-term project which is not expected to be finalized until the end of 2026. All farmers will need to replot in the year leading up to that date. This will be a gradual process, so farmers will have plenty of time to plan ahead. + +:::warning + +The documents in this section describe a technology that is still being developed. Everything you read here is subject to change. + +::: + +While the development of this technology is ongoing, we have put together several documents to answer all of your questions: + +- A [blog post](https://www.chia.net/2024/12/11/upcoming-changes-for-chias-new-proof-of-space-format) by Dr. Nick, which takes a deep dive into our current plans +- A list of the expected [plotting requirements](/new-proof-plotting-requirements) +- A list of the expected [farming requirements](/new-proof-farming-requirements) +- A [timeline](/new-proof-timeline) of when we expect to reach each milestone +- A list of [frequently asked questions](/new-proof-faq) +- An [overview](/new-proof-technical-overview) of the new format +- The [technical details](/new-proof-details/) of the new format +- The original [blog post](https://www.chia.net/2024/08/08/approaching-the-next-generation-of-proof-of-space/) by Dr. Nick, which takes a deep dive into the initial plans for the new Proof Format. Note that this blog is outdated and the new blog should be used for the latest information. diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/new-proof-format/new-proof-plotting-requirements.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/new-proof-format/new-proof-plotting-requirements.md new file mode 100644 index 0000000000..22f6131ab2 --- /dev/null +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/new-proof-format/new-proof-plotting-requirements.md @@ -0,0 +1,74 @@ +--- +sidebar_label: Plotting Requirements +title: Plotting Requirements +slug: /new-proof-plotting-requirements +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +:::note + +This information was updated on 12/11/2024. + +::: + +## Plot Sizes + +The new proof of space format supports plots as small as 3 GiB. Due to symmetric properties of the format, only even-sized k-sizes are supported. While we currently have no plans to support sizes smaller than k28, larger k-sizes may be enabled in the future. Each even-step k-size is a little over four times larger than the previous size. + +| Plot Size | All RAM | +| :-------- | :----------------------- | +| k34 | ~260 GiB | +| k32 | ~61 GiB | +| k30 | ~14 GiB | +| k28 | ~3 GiB | + +## Memory + +We have separated the memory requirements by RAM only (no disk needed) and RAM + disk (for systems with 32 GiB of RAM). We also break down these requirements for plots meant to be stored on HDDs and for those meant to be stored on SSDs. + +### RAM Requirements + +Memory requirements for full plotting in RAM for HDD friendly format: + +| Plot Size | All RAM | RAM + Disk | Nvidia 3090 | +| :-------- | :------ | :--------- | :---------- | +| k34 | 512GB | 8GB | 8GB VRAM | +| k32 | 128GB | 2GB | 2GB VRAM | +| k30 | 32GB | 512MB | 512MB VRAM | +| k28 | 8GB | 128MB | 128MB VRAM | + +### HDD + +Technically, HDD plots will also work on SSDs, but we also have a format that is optimized to be stored on SSDs for farming. + +### SSD optimized + +Memory requirements for Benes compression used in the SSD-only format will likely require significantly more RAM and plotting time, exact details still to be determined. + +## GPU versus CPU plotting + +GPU plotting will be strongly recommended. Plotting times for a k32 format with a 3090 Nvidia GPU are expected to take about 1-2 minutes, and times for higher-end GPUs will scale down relative to their performance in memory bandwidth and compute. For each increase or decrease in k size (by 2), expect plotting time to double or half respectively. + +:::info + +Note that plot times are currently estimated and may still be adjusted depending on the final security and compression resistance requirements chosen at a later date. + +::: + +CPU plotting will be possible but slow and expensive, and thus only recommended for small numbers of plots. Expect a modern high-end multi-threaded cpu system to take about 100x longer than a 3090 GPU, and a single processor with DDR4 RAM to take 450x times longer than a 3090 GPU. + +## Expected plot times + +Some expected plot times according to size and format: + +| Plot Size | Raspberry Pi 5 | Ryzen 5600
(6-core) | Nvidia 3090 | +| :---------------------- | :-------------------------- | :------------------------------------------- | :--------------------------- | +| k34 | N/A | ~10 hours | ~6 minutes | +| k32 | N/A | ~3 hours | ~1-2 minutes | +| k30 | N/A | ~45 minutes | ~30 seconds | +| k28 | ~40 minutes | ~12 minutes | ~5 seconds | +| Plotted
space/day | Up to 170 GiB | Up to 800 GiB | Up to 100 TiB | + +Eventual support for Apple M-Series and iGPU’s acceleration. First releases will support CPU plotting and nVidia GPUs, and later additional support for other chips will be included. diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/new-proof-format/new-proof-technical-details.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/new-proof-format/new-proof-technical-details.md new file mode 100644 index 0000000000..3771ca031d --- /dev/null +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/new-proof-format/new-proof-technical-details.md @@ -0,0 +1,127 @@ +--- +sidebar_label: Technical Details +title: Technical Details +slug: /new-proof-details +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +:::note + +This information was not updated on 12/11/2024 with the rest of this section. +This information will be updated once the CHIP has been submitted in Q1 2025. + +::: + +## New Matching Algorithm + +The matching algorithm for all tables has changed, and now forms the basis of security. It is a memory hard algorithm which can be tuned to take more or less time by adjusting the number of match indexes to test for whether two entries match. + +The benefit of this algorithm is that we can set the difficulty very high so that plotting will take longer and compression attacks will be more expensive, yet it incurs negligible cost when validating a proof. Since validation is “free”, we can tune this to be as difficult as we need, without adding extra compute expense to the network. + +### Matching Bits + +The matching algorithm takes an additional index number which is used to show that a match works. The left value and the index results in a bucket. This must match a bucket which the right value hashes to, and the matching combination of them have to pass an additional filter. Index bits will be included in proofs to make verification fast. To keep required memory down, entries are sorted into sections. All of the buckets to which a left value hashes will land in the same section. + +### T1 Matching + +For the first table of matches, we match a k-bit value that comprises section_bits and random_bits. Match_index_bits is an additional variable to define which match_index creates a match. + +For the first set of pairs, x1 and x2 match iff: + +- The upper section_bits of x1 are equal to the upper section bits of x2. +- There exists a match_index in the range `[0..<2^match_index_bits]` where the random_bits produced from hash(x1 + plot_id + match_index) are equal to the random_bits produced from x2 with hash(x2 + plot_id). +- A new_meta is created by hashing x1 and x2. +- A hash of new_meta must pass a filter for it to be a match. + +
+ Flow chart +
+
+ +### Matching Difficulty + +The time to find a match is heavily influenced by match_index_bits, as the higher the range of match_indexes the more the number of lookups to test for a match. + +Since most bit dropping attacks are limited by the difficulty of matching in the earlier tables, the number of match index_bits will be tuned much higher for the first and second tables, and set lower for subsequent tables. + +## New Plot Filters + +The new proof of space comprises 3 plot filters: + +1. Plot id filter +2. EncryptedX’s scan filter +3. Random x-quadruple quality filter + +### Plot Id Filter + +The plot id filter is the same as the original proof of space – the challenge and plot id create a hash that validates the plot for that challenge if it passes the filter. For the new proof of space we will be able to reduce this filter significantly compared to the original. Once set, it is expected to stay fixed over time. + +### EncryptedX’s Scan Filter + +A few definitions: + +- x1 and x2 are pairs matched in the first table, and are the left side match in the next table. +- x3 and x4 are pairs matched in the first table, that then form the right-side match with x1 and x2 in the second table. +- Xdata totals 2k bits, comprising the upper section bits of x1, additional bits of x1, additional bits of x2, and match index for pairing x1 and x2, upper section bits of x3, additional bits of x3, additional bits of x4, and match index for pairing x3 and x4. + +E.g. if we have a k32, 6 section bits and 6 match bits, we form: [upper 6 bits of x1 and x2 (which are the same)][bits 7-16 of x1][bits 7-16 of x2][6 match index bits (applied to x1)][upper 6 bits of x3 and x4 (which are the same)][bits 7-16 of x3][bits 7-16 of x4][6 match index bits (applied to x3)]. + +- EncryptedXs is the 2k-bits encrypted Xdata with a seed based on plot_id (reversible) +- S is a random range within 0..2^2k based on the challenge + +#### The Challenge + +Find a proof where: + +1. The last 4 x values in the proof are converted to EncryptedX’s and are in range S, and +2. `hash(challenge,EncryptedXs)` passes a filter (e.g. 1 in cardinality S chance will pass on average 1 result from this range). + +In order to quickly satisfy the challenge for the plot, we store the sorted EncryptedXs in the second table, and drop the first table. This requires only 1 or 2 disk seeks to read the number of EncrpytedXs in the range S for the challenge. + +To reconstruct the original x values a farmer finds all possible values of buckets for x1 and x2 and finds a collision between them. In the k32 example above bits 17-32 of x1 and x2 are missing so there are 2^16 possibilities for each. To find the values a farmer makes a list of all 2^16 possibilities for one of the values (it doesn’t matter which) then sorts it, then scans over all 2^16 possible values for the other looking up each one in the sorted list to see if it’s there. For a farmer to store fewer bits they can drop bits from the EncryptedX, which doubles the amount of work necessary to be done. For them to need less work but more space they can store unencrypted x bits which halves the amount of work needed for each bit stored. Because there’s an exponential increase in work per bit and computers are fast there’s a range of bit dropping which has very little work even on low end hardware but where the costs of farming get prohibitive even on high end hardware with even a tiny increase in compression. + +The EncryptedXs scan filter forces a particular ordering and dataset in the plot format that severely limits the flexibility for an attacker to re-organize the data in a way to leverage particular bit dropping attacks. + +### Random x-quadruple quality filter + +For each x1/2/3/4 set that passes the scan filter, find another random full x-quadruple in the proof based on the hash of those x’s, the plot_id, and challenge. This x-quadruple then forms the value for the quality string that determines whether a good proof has been found. + +The additional random x-quadruple lookup ensures that all plot data is needed in order to find a quality by forcing a backwards traversal down the tables. + +### Benefits + +The plot id filter can be set lower, since the EncryptedXs scan filter only requires 1 or 2 disk lookups. A low plot id filter, combined with an additional filter on the EncryptedXs scan, forces rental attackers to generate at least the first two tables of a plot which require the most time, and then discard most of their results if it doesn’t pass the scan filter. The scan filter also reduces the load on HDD disks by only passing a fraction of the time for the x-quadruple quality filter which requires more lookups. + +The combination of these three filters severely constrain the flexibility afforded to an attacker. The default level of bit dropping gives the honest farmer a baseline with negligible extra compute, but imposes an immediate difficulty for the attacker to compress much further without losing efficiency compared to the honest farmer. + +## Benes Compression + +A new compression algorithm allows us to compress each table in the plot by 2-3 extra bits compared to the original format. Note that this is not bit dropping (which incurs costs that go up exponentially based on the amount of data being dropped), but rather an improved way to losslessly store information in each table. The findings are based on this [blog post](https://hackmd.io/@dabo/rkP8Pcf9t). + +In addition, Benes compression has the unique property that plot tables can be traversed in both directions, whereas the HDD friendly format requires additional data to store an index from the T2 table to the last table (so that it can then traverse entries down the table). + +Each table in the plot using Benes compression comes at the cost of doing a few more random seeks in data retrieval. While it would be possible to put a few such Benes plots on an HDD, the proof retrieval times are not guaranteed to be completed in time. On SSD using Benes compression has minimal impact on farming and is the recommended storage format. + +While we hope to release Benes compression for plots prior to the hard fork, constructing the proof of space using the Benes algorithms is more challenging and could require significantly more RAM and slower plotting times. + +## Further Compression by Additional Bit Dropping + +One of the first known compression attacks is to bit drop on x1/x2 pairs on the first table, and recompute for the missing range of values. With the new scan filter requiring both an encryption step on x-quadruples and a range to satisfy a challenge, any attacker wanting to alter which bits in those x-quadruples to drop, will forfeit compression they receive from the ordered encrypted values, and immediately require making up for k bits of lost compression. Likewise, any other attempts to re-organize x data for other bit dropping or compression methods will result in similar penalties. + +It is still possible to drop the lower-order bits from the EncryptedX values, where each bit dropped would require a doubling of compute. A potentially more advantageous approach is to leave the default x values intact and instead drop bits from the back pointers starting from table T3. In the original format, dropping two bits (one from each of the two back pointers in T3) would have saved approximately 1% of space, at the cost of doubling the time needed to recompute the quality string and the full proof. + +In the new format, we have restructured the back pointers, and currently, we see the potential to drop only 1 bit per back pointer for a doubling of compute. Further research may reveal the possibility of more aggressive bit dropping back up to 2 bits per doubling of recompute. + +As it stands, the default plot already includes a certain level of bit dropping, and bit dropping further quickly becomes too expensive. Depending on the final parameter settings, we don’t expect this to be economically viable beyond a few bits on today’s hardware, with each bit dropped saving ~0.5%. We will also offer the ability to plot using the most optimal method for further compression for those interested. + +## Impact to Honest Farmers + +The x values stored in T2 have default levels of bit-dropping already applied that are defined in the challenge scan filter. A small amount of compute is required when fetching a final quality string, similar to the low C-levels of the bladebit formats. The honest farmer will have to grind an additional small amount to get the full x values for the proof. + +There will also be an option to omit this low-level grinding if desired, at the cost of adding more bits to the plot format. However, since the compute required for the grind is low and designed to be close to optimal, the default level of bit dropping specified by the challenge is the recommended setting. + +## Impact to Rental Attacks + +Due to the long plotting time, lower plot id filter, and additional scan and x-quadruple filters that potentially throw away a newly created plot; rental attacks are no longer deemed to be a viable threat (>$1 billion per hour for an attack and will be well over 1000 times more expensive than the original format). diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/new-proof-format/new-proof-technical-overview.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/new-proof-format/new-proof-technical-overview.md new file mode 100644 index 0000000000..d40db3d434 --- /dev/null +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/new-proof-format/new-proof-technical-overview.md @@ -0,0 +1,37 @@ +--- +sidebar_label: Technical Overview +title: Technical Overview +slug: /new-proof-technical-overview +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +:::note + +This information was not updated on 12/11/2024 with the rest of this section. +This information will be updated once the CHIP has been submitted in Q1 2025. + +::: + +This section will go over some of the novel ideas for the proof of space and reasons why they are beneficial. + +The most notable changes to the proof of space are: + +### New matching algorithm + +This offers security with tunable difficulty per table, yet allows instant verification of proofs. As a result, we are able to increase the difficulty of plotting without affecting proof validation time. The benefit is that we can increase resistance to rental and compression attacks without wasting energy when validating proofs for the network. + +### Challenge based on x values + +A challenge will no longer start lookups based on a final y bucket. Instead, we use a special kind of scan filter on x values, specifically designed to constrain attackers against re-ordering data to accommodate various bit-dropping techniques. Now, an attacker is either restricted to organize data in a very specific way which severely limits the number of potential attacks, or the attacker must re-organize data by adding extra bits to account for that restructuring and incur a large penalty. + +### Default compression to drop first table + +There is a small amount of compression where the first table is dropped by default. The parameters for the compression are specifically chosen to be the easiest bits to drop and recompute, with minimal cpu time needed. This creates optimal settings, and further bit dropping by an attacker will very quickly impose economic disadvantages to create an upper bound on how much compression is viable even for future hardware. + +### Benes compression + +We can compress an additional 2 bits per entry (without bit dropping) and drop a whole lookup table using a Benes network. This results in up to ~20% additional space savings depending on k-size when compared to the HDD friendly format. + +In terms of impact to farmers, because we drop some data to optimize efficiency, a small amount of compute is required when fetching a final quality string, similar to the low C-levels of the bladebit formats. We will include an option to omit this low-level grinding if desired, so that many Petabytes could be farmed on a Raspberry Pi for instance, at the cost of adding more bits to the plot format (up to 10-15% more space). diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/new-proof-format/new-proof-timeline.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/new-proof-format/new-proof-timeline.md new file mode 100644 index 0000000000..0a84eeeb59 --- /dev/null +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/new-proof-format/new-proof-timeline.md @@ -0,0 +1,24 @@ +--- +sidebar_label: Timeline +title: Timeline +slug: /new-proof-timeline +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +:::note + +This information was not updated on 12/11/2024 with the rest of this section. +This information will be updated once the CHIP has been submitted in Q1 2025. + +::: + +This table gives a _rough_ timeline of what to expect with the new format. We will know the exact timeline (to within a few days) when we enter the locked in period. + +| Time frame | Name | Begins when | Ends when | Description | +| :----------------------- | :---------------------- | :-------------------------------------- | :-------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------- | +| 2H 2024 -
1H 2025 | Proposal
period | New format
announced | Chia 3.0
released | \* New format still under development
\* A CHIP will be released
\* Feedback will be welcome
\* Significant testing and refining required | +| 1H 2025 -
2H 2025 | Locked in
period | Chia 3.0
released | Hard fork
activated | \* CHIP is finalized
\* Farmers must upgrade to 3.0
\* Only old plots are valid | +| 2H 2025 -
2H 2026 | Replotting
period | Hard fork
activated | Old format
becomes invalid | \* New plots become valid
\* Old plots remain valid
\* Replot during this period | +| 2H 2026
and beyond | A new era | Old format
becomes invalid | - | \* Only new plots are valid | diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/plotting/plotting-basics.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/plotting/plotting-basics.md index 27355b5f87..67e467cd58 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/plotting/plotting-basics.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/plotting/plotting-basics.md @@ -68,6 +68,8 @@ Plot "compression" is possible because the data contained within a plot is deter By mid-2023, most new Chia plots were being created using these "compression" techniques. Each individual plot earns the same rewards as an equivalent uncompressed plot. However, because the compressed plots are smaller, more of them fit on each disk. Farmers therefore earn extra income compared with using uncompressed plots. +In 2024, we proposed a new proof format that would make it much more difficult to compress plots. This is an ongoing project, which will not be complete until the end of 2026 according to current estimates. For more info, see our section dedicated to the [new proof format](/new-proof-introduction). + ### Tradeoffs As with most technologies, compressed plots come with tradeoffs. The fact that they are left incomplete upon being created means that they require more energy to be "completed" while farming. Luckily, the lower levels of compression only require a small amount of extra energy, while yielding 15% more rewards. As with most technologies, compressed plots come with tradeoffs. The fact that they are left incomplete upon being created means that they require more energy to be "completed" while farming. Luckily, the lower levels of compression only require a small amount of extra energy, while yielding 15% more rewards. On the other hand, plots using the highest levels of compression require more compute while farming, thus necessitating the use of a GPU. diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/plotting/plotting-compression.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/plotting/plotting-compression.md index a638ec7872..fdc8be45ac 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/plotting/plotting-compression.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/plotting/plotting-compression.md @@ -24,16 +24,16 @@ The next sections list three methods to determine the compression level that wil You can use the following table as a basic guide for choosing a compression level. You can use the following table as a basic guide for choosing a compression level. It assumes BladeBit CUDA was used to create K32 plots: |
Level | Size
(GiB) | Relative
Size | Reward
Increase | Min Spec
Harvester | -| :---------- | :--------------- | :------------------ | :-------------------- | :------------------------ | -| C0 | 101.4 | 100% | 0% | Pi 4 | -| C1 | 87.5 | 86.3% | 15.9% | Pi 4 | -| C2 | 86.0 | 84.8% | 17.9% | Pi 4 | -| C3 | 84.5 | 83.3% | 20.0% | Pi 4 | -| C4 | 82.9 | 81.8% | 22.3% | Desktop CPU | -| C5 | 81.3 | 80.2% | 24.7% | Fast CPU | -| C6 | 79.6 | 78.5% | 27.4% | Fast CPU | -| C7 | 78.0 | 76.9% | 29.8% | GPU | -| C9 | 75.2 | 74.2% | 34.8% | GPU | +|:----------------- |:---------------------- |:------------------------- |:--------------------------- |:------------------------------- | +| C0 | 101.4 | 100% | 0% | Pi 4 | +| C1 | 87.5 | 86.3% | 15.9% | Pi 4 | +| C2 | 86.0 | 84.8% | 17.9% | Pi 4 | +| C3 | 84.5 | 83.3% | 20.0% | Pi 4 | +| C4 | 82.9 | 81.8% | 22.3% | Desktop CPU | +| C5 | 81.3 | 80.2% | 24.7% | Fast CPU | +| C6 | 79.6 | 78.5% | 27.4% | Fast CPU | +| C7 | 78.0 | 76.9% | 29.8% | GPU | +| C9 | 75.2 | 74.2% | 34.8% | GPU | The right column (Min Spec Harvester) shows the minimum type of computer required for harvesting at each compression level, where: diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/plotting/plotting-faq.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/plotting/plotting-faq.md index fbda7e01a3..c1a1149fdd 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/plotting/plotting-faq.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/plotting/plotting-faq.md @@ -3,6 +3,14 @@ title: 生成地块常见问题解答 slug: /plotting-faq --- +:::info + +In 2024 we proposed a new proof format. Please see our [frequently asked questions](/new-proof-faq) for the new format. For additional information, see our [new proof format](/new-proof-introduction) section. + +The questions listed on this page only pertain to the original format. + +::: + ## 如果停电会发生什么？ Any plots that were partially made will be invalid. 这可能会留下许多`.tmp`文件，可以将其删除。 在许多情况下，临时文件将会自动删除，但这是一个可能需要手动删除文件的情况。 这不会损坏已经完成的任何现有地块。 diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/plotting/plotting-hardware.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/plotting/plotting-hardware.md index 4ee4da6078..730a0ae3e3 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/plotting/plotting-hardware.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/plotting/plotting-hardware.md @@ -7,6 +7,16 @@ slug: /plotting-hardware import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; +## New proof format + +In 2024, we proposed a new proof format. This format will have slightly different hardware requirements for plotting and farming versus the original format. For more info about the new format, see the following resources: + +- [plotting requirements](/new-proof-plotting-requirements) +- [farming requirements](/new-proof-farming-requirements) +- [timeline](/new-proof-timeline) + +The rest of this page only pertains to the original proof format. + ## Cost/time tradeoffs 生成地块需要计算资源，计算资源越多，生成地块时间越快。 With that in mind, it may be tempting to run out and buy the fastest computer you can find for plotting. But first, you should consider a few important points, and answer some related questions: But first, you should consider a few important points, and answer some related questions: @@ -57,13 +67,13 @@ The **BladeBit CUDA** plotter requires an NVIDIA GPU with CUDA capability 5.2 an The following table lists the general plotter types, along with their requirements, for creating k32 plots: -| Processor +
Storage | Plotter
Name(s) | Chia
Version | Comp.
Plots | Compute | Temp
Disk
(GB) | RAM
(GB) | Plot
Times
(min.) | -| :---------------------- | :--------------------------------------- | :----------------- | :-------------- | :------ | :--------------------- | :----------- | :------------------------ | -| **GPU +
RAM** | BladeBit CUDA | 2.0 | Yes | GPU | None | 256 | 1-3 | -| **GPU +
SSD** | BladeBit CUDA | 2.1 | Yes | GPU | 180 | 128 | 3-5 | -| **CPU +
RAM** | BladeBit RAM | 2.0 | Yes | CPU | None | 416 | 2-5 | -| **CPU +
SSD** | Bladebit Disk
madMAx
ChiaPoS | 2.0 | No | CPU | 512 | 4 | 15-60 | -| **CPU +
HDD** | Bladebit Disk
madMAx
ChiaPoS | 2.0 | No | CPU | 512 | 4 | > 60 | +| Processor +
Storage | Plotter
Name(s) | Chia
Version | Comp.
Plots | Compute | Temp
Disk
(GB) | RAM
(GB) | Plot
Times
(min.) | +|:----------------------------- |:---------------------------------------------------- |:------------------------ |:--------------------- |:------- |:---------------------------------- |:------------------ |:------------------------------------- | +| **GPU +
RAM** | BladeBit CUDA | 2.0 | Yes | GPU | None | 256 | 1-3 | +| **GPU +
SSD** | BladeBit CUDA | 2.1 | Yes | GPU | 180 | 128 | 3-5 | +| **CPU +
RAM** | BladeBit RAM | 2.0 | Yes | CPU | None | 416 | 2-5 | +| **CPU +
SSD** | Bladebit Disk
madMAx
ChiaPoS | 2.0 | No | CPU | 512 | 4 | 15-60 | +| **CPU +
HDD** | Bladebit Disk
madMAx
ChiaPoS | 2.0 | No | CPU | 512 | 4 | > 60 | :::note diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/plotting/plotting-how-to.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/plotting/plotting-how-to.md index 5af6e0776e..1b0166c782 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/plotting/plotting-how-to.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/plotting/plotting-how-to.md @@ -15,7 +15,7 @@ To create plots, you must have: This page will give a basic overview of how to obtain these values. This page will give a basic overview of how to obtain these values. For a detailed description, see the [Beginner's Guide to Farming](/farming-guide). -If you already have a wallet with a plot NFT, feel free to skip to the section for [CLI Plotting](#cli-plotting) or [GUI Plotting](#图形用户界面gui生成地块). +If you already have a wallet with a plot NFT, feel free to skip to the section for [CLI Plotting](#cli-plotting) or [GUI Plotting](#gui-plotting). ## Public Keys @@ -74,7 +74,7 @@ You can also choose a custom name for your wallet. Click `NEXT` when you are fin If someone obtains a copy of these words, they can steal your entire wallet, including all of its funds. Be sure to store your recovery phrase in a safe place. Be sure to store your recovery phrase in a safe place. -::: +:::
Wallet seed phrase diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/plotting/plotting-setup.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/plotting/plotting-setup.md index cc4aeabee0..01f63a3ce3 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/plotting/plotting-setup.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/plotting/plotting-setup.md @@ -34,13 +34,13 @@ One thing to keep in mind is that a farming computer only cares about the comple With that in mind, the following table will give you an idea of what compression level to use, given your farming computer. This assumes you will use the Bladbit plotter that comes prepackaged with Chia installations: This assumes you will use the Bladbit plotter that comes prepackaged with Chia installations: |
Level | Size
(GiB) | Relative
Size | Reward
Increase | Farm
With | -| :---------- | :--------------- | :------------------ | :-------------------- | :--------------- | -| C0 | 101.4 | 100% | 0% | Pi 4 | -| C1 | 87.5 | 86.3% | 15.9% | Pi 4 | -| C2 | 86.0 | 84.8% | 17.9% | Pi 4 | -| C3 | 84.5 | 83.3% | 20.0% | Pi 4 | -| C4 | 82.9 | 81.8% | 22.3% | Pi 4 | -| C5 | 81.3 | 80.2% | 24.7% | Fast CPU | -| C6 | 79.6 | 78.5% | 27.4% | Fast CPU | -| C7 | 78.0 | 76.9% | 29.8% | GPU | -| C9 | 75.2 | 74.2% | 34.8% | GPU | +|:----------------- |:---------------------- |:------------------------- |:--------------------------- |:---------------------- | +| C0 | 101.4 | 100% | 0% | Pi 4 | +| C1 | 87.5 | 86.3% | 15.9% | Pi 4 | +| C2 | 86.0 | 84.8% | 17.9% | Pi 4 | +| C3 | 84.5 | 83.3% | 20.0% | Pi 4 | +| C4 | 82.9 | 81.8% | 22.3% | Pi 4 | +| C5 | 81.3 | 80.2% | 24.7% | Fast CPU | +| C6 | 79.6 | 78.5% | 27.4% | Fast CPU | +| C7 | 78.0 | 76.9% | 29.8% | GPU | +| C9 | 75.2 | 74.2% | 34.8% | GPU | diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/plotting/ssd-endurance.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/plotting/ssd-endurance.md index 34ebc48839..d4b691d878 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/plotting/ssd-endurance.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/plotting/ssd-endurance.md @@ -16,14 +16,14 @@ The fastest plot creation is done completely in memory, but requires a server wi 衡量SSD耐久性的度量标准是以一定的工作负载为基础的写入总量，即TBW。 一般来说，工作负载是根据JEDEC组织的JESD219工作负载来定义的。 An SSD can still plot well beyond meeting its rated TBW limit, because UBER can be measured (when seeing host errors) and retention is not required (Chia plotting requires temporary or ephemeral storage). -| 地块生成程序 | 缓存/内存磁盘 | K=32的写入次数 | -| ------------------- | ------------- | -------------- | -| Chiapos beta (2020) | 0 | 1.8 TBW | -| Chiapos 2021 | 0 | 1.4 TBW | -| madMAx Chia_plot | 0 | 1.43 TBW | -| madMAx Chia_plot | 110G | 0.396 TBW | -| Bladebit Disk | 0 | 1.225 TBW | -| Bladebit Disk | \>99G | 0.381 TBW | +| 地块生成程序 | 缓存/内存磁盘 | K=32的写入次数 | +| ------------------- | ------- | --------- | +| Chiapos beta (2020) | 0 | 1.8 TBW | +| Chiapos 2021 | 0 | 1.4 TBW | +| madMAx Chia_plot | 0 | 1.43 TBW | +| madMAx Chia_plot | 110G | 0.396 TBW | +| Bladebit Disk | 0 | 1.225 TBW | +| Bladebit Disk | \>99G | 0.381 TBW | Consumer NVMe SSDs are generally not recommended due to their lower endurance, and they often employ caching algorithms to faster media (SLC, or single level cell) for great bursty performance. They do not perform well under heavy workload sustained I/O. 虽然有一些高性能的消费级NVMe SSD可以提供出色的生成地块性能，但较低的TBW将导致更快的磨损。 They do not perform well under heavy workload sustained I/O. 虽然有一些高性能的消费级NVMe SSD可以提供出色的生成地块性能，但较低的TBW将导致更快的磨损。 diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/protocol/networking-protocol.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/protocol/networking-protocol.md index f39c782001..87a8b44866 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/protocol/networking-protocol.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/protocol/networking-protocol.md @@ -32,7 +32,7 @@ All peers in the Chia protocol (whether they are farmers, full nodes, timelords, ```python class Handshake(Streamable): - network_id: str # Network id, usually the genesis challenge of the blockchain + network_id: str # Network id, ex. mainnet, testnet11, simulator0 protocol_version: str # Protocol version to determine which messages the peer supports software_version: str # Version of the software, to debug and determine feature support server_port: uint16 # Which port the server is listening on diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/protocol/pool/pool-protocol-specification.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/protocol/pool/pool-protocol-specification.md index 4716a96cdd..5bf8481d85 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/protocol/pool/pool-protocol-specification.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/protocol/pool/pool-protocol-specification.md @@ -187,7 +187,7 @@ This is a BLS signature of the hashed serialization of the following data in the | -------------------- | ------- | | method_name | string | | launcher_id | bytes32 | -| target_puzzle_hash | bytes32 | +| target_puzzle_hash | bytes32 | | authentication_token | uint64 | where `method_name` must be the serialized string `"get_farmer"`, the parameters must be serialized and hashed according to [Signature validation](#signature-validation) and the signature must be signed by the private key of the `authentication_public_key` using the Augmented Scheme in the BLS IETF spec. @@ -439,7 +439,7 @@ This is a BLS signature of the hashed serialization of the following data in the | -------------------- | ------- | | method_name | string | | launcher_id | bytes32 | -| target_puzzle_hash | bytes32 | +| target_puzzle_hash | bytes32 | | authentication_token | uint64 | where `method_name` must be the serialized string `"get_login"` and `target_puzzle_hash` is pool's target puzzle hash (see [GET /pool_info](#get-pool_info)). The parameters must be serialized and hashed according to [Signature validation](#signature-validation) and the signature must be signed by the private key of the `authentication_public_key` using the Augmented Scheme in the BLS IETF spec. diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/reference-client/key-management.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/reference-client/key-management.md index a6f227db89..8c1b6653b2 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/reference-client/key-management.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/reference-client/key-management.md @@ -35,7 +35,7 @@ Configuration steps: - Delete the second key: `chia keys delete -f ` - /!\ **Caution**: make sure you have a backup of the 24 words mnemonic or you will lose access to the key for ever. - It should prompt a WARNING message like "Deleting private_key with fingerprint ``" :::warning Using a farmer address which we don't have the private keys for. We searched the first 500 addresses. Consider overriding `` with `` - ::: +::: - Make sure the `` corresponds to your second key wallet address. Your setup is complete. Your machine can farm XCH and rewards will be sent to the key that you stored on paper. Would you need to transfer funds you can add it back to your computer's Chia keychain by doing: `chia keys add` diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/resources/chia-farming-workload.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/resources/chia-farming-workload.md index b8feb5549a..32c6369088 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/resources/chia-farming-workload.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/resources/chia-farming-workload.md @@ -31,12 +31,12 @@ The proof of space construction and the [Proof of Space page](/proof-of-space) c We can estimate the storage workload on a given drive capacity (measured in TB, terabytes) by knowing the k size selected and n number of plots that fit on the drive. -| Drive size (TB) | 4 | 8 | 10 | 12 | 14 | 16 | 18 | 20 | -| --------------- | --: | --: | --: | --: | --: | --: | --: | --: | -| k value | 32 | 32 | 32 | 32 | 32 | 32 | 32 | 32 | -| Number of plots | 36 | 73 | 91 | 110 | 128 | 146 | 165 | 183 | -| k value | 34 | 34 | 34 | 34 | 34 | 34 | 34 | 34 | -| Number of plots | 8 | 17 | 21 | 25 | 30 | 34 | 38 | 43 | +| Drive size (TB) | 4 | 8 | 10 | 12 | 14 | 16 | 18 | 20 | +| --------------- | --:| --:| --:| ---:| ---:| ---:| ---:| ---:| +| k value | 32 | 32 | 32 | 32 | 32 | 32 | 32 | 32 | +| Number of plots | 36 | 73 | 91 | 110 | 128 | 146 | 165 | 183 | +| k value | 34 | 34 | 34 | 34 | 34 | 34 | 34 | 34 | +| Number of plots | 8 | 17 | 21 | 25 | 30 | 34 | 38 | 43 | Events per day, plots passing filter = signage points per day ✕ n plots / filter constant number of reads =(Events per day, plots passing filter ✕ IO Proof quality check) +(IO Full proof of space ✕ Partials per day IOPS average =number of reads per day / 86400 seconds MB read per day = Number of reads ✕ average IO size per request (kB) / 1000 @@ -150,8 +150,8 @@ UBER is defined as "A metric for the rate of occurrence of data errors, equal to Consumer HDDs are rated for less than 1 error per 1014 (sometimes shown as UBER of 10-14). This means that if a consumer reads on 800TB of data, they would expect a single read error on average. -| Device | UBER | Data read per error | -| -------------- | ------ | ------------------- | +| Device | UBER | Data read per error | +| -------------- | ------- | ------------------- | | Consumer HDD | 10\-14 | 800 TB | | Enterprise HDD | 10\-15 | 8 PB | | SSD | 10\-17 | 800 PB | diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/resources/faq.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/resources/faq.md index 8b7c052219..a5a7a662a5 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/resources/faq.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/resources/faq.md @@ -32,7 +32,7 @@ A genesis challenge is the first VDF challenge on a network that uses the Proof ### What is XCH, TXCH, and mojos? -XCH is the currency symbol for Chia. TXCH is the currency symbol currently being used for testnet chias. TXCH has no value and is only used for testing purposes. Chias and testnet chias can be divided up to 12 decimal places (trillionths). The smallest unit of chia, a trillionth of a chia, is called a mojo, as a tribute to [Mojo Nation](), a decentralized file storage platform created in the early 2000s by Zooko Wilcox, Bram Cohen, and others. +XCH is the currency symbol for Chia. TXCH is the currency symbol currently being used for testnet chias. TXCH has no value and is only used for testing purposes. Chias and testnet chias can be divided up to 12 decimal places (trillionths). The smallest unit of chia, a trillionth of a chia, is called a mojo, as a tribute to [Mojo Nation](https://en.wikipedia.org/wiki/Mnet_(peer-to-peer_network)#Evil_Geniuses_for_a_Better_Tomorrow), a decentralized file storage platform created in the early 2000s by Zooko Wilcox, Bram Cohen, and others. ### Chia vs XCH vs mojo vs chia @@ -1137,6 +1137,12 @@ This error message occurs when you submit a transaction that does not include a --- +## Cloud Wallet + +See our dedicated page for [Cloud Wallet FAQs](/getting-started/cloud-wallet/faq). + +--- + ## Offers ### What are Chia Offers? @@ -1618,14 +1624,14 @@ values={[ If installed just for your user: -````powershell +```powershell Set-Alias -Name chia "C:\Users\ If installed just for your user: ```powershell Set-Alias -Name chia "C:\Users\\AppData\Local\Programs\Chia\resources\app.asar.unpacked\daemon\chia.exe" -```` +``` If installed for all users: diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/resources/glossary.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/resources/glossary.md new file mode 100644 index 0000000000..5f0584b99b --- /dev/null +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/resources/glossary.md @@ -0,0 +1,113 @@ +--- +title: Glossary +slug: /glossary +--- + +# The Great Chia Glossary + +This guide will act as a glossary for many of the concepts utilised in Chia. +If you are familiar with how Bitcoin transactions work, a lot of this will be familiar. + +--- + +- **Aggregated Signature/AggSig** - Aggregated Signatures allow us to condense multiple signatures into a single aggregated signature, such that if we know a public key and value we can verify if it exists inside of the single aggregate. This uses BLS non-interactive aggregation. + +- **Authorized Payees** - Authorized Payees is a smart contract that means that Wallet A can give Wallet B some money, but Wallet B is only allowed to spend that money in ways that Wallet A has explicitly authorised. + +- **CATs** - Chia Asset Token - a special kind of chia coin which are created by users. A CAT is a uniquely marked subset of chia which can't be forged and can be linked to other assets. More information can be found on the [CATs Puzzles page](https://chialisp.com/docs/puzzles/cats). + +- **CAT1** - First version of the Chia token standard, there was a bug in this standard and its fix deprecated the standard creating the CAT2 standard. + +- **CAT2** - Second version of the Chia token standard, there was a bug in the first standard and its fix deprecated the standard creating the CAT2 standard. + +- **Chia** - Uppercase “Chia”. The software, the blockchain, or the company. + +- **chia** - Lowercase "chia" represents the coin aka "xch". + +- **Chia Network Inc.** - Proper format for Chia the company's name. + +- **chia reference wallet** - our own implementation which supports many features, but does not use wallet SDK and contains other wallets - e.g CAT wallets, DID wallet, NFT wallets and is mapped to a specific wallet key. + +- **ChiaLisp** - ChiaLisp is the Turing-complete functional language which the puzzles for spending coin are programmed in. For more information see our [Chialisp site](https://chialisp.com/). + +- **CHIPs** - CHia Improvement Proposals. + +- **CLVM** - The CLVM is the ChiaLisp Virtual Machine which is the sandboxed environment that puzzles and solutions are run in. The CLVM only runs the compiled minimal version of ChiaLisp, though a compiler can convert the higher level ChiaLisp to the compiled minimal version. See more about that [here](https://chialisp.com/clvm/) + +- **CNI** - Chia Network Inc. + +- **Coin (TXO/transaction output)** - A coin stores value. All coins are generated as the output of a transaction or a coinbase reward or fee target. A coin is spent exactly once, allowing its value to go into other coins, and is then permanently destroyed. Each unspent coin is locked with a ChiaLisp program which is that coin’s puzzle, and whoever has the information to solve that puzzle is the person who can spend that coin. The most basic puzzle has a public key and accepts a solution which contains a list of conditions signed by the corresponding private key, so only the owner of the private key can unlock the coin and spend it. + +- **Coin ID/CoinName (TXO ID/transaction output ID)** - The ID of a coin in Chia is generated by hashing the primary input ID, puzzle hash, and amount concatenated in that order. This is very different from Bitcoin which uses much more data to form the TXO ID, restricting what smart contracts are capable of. (See also: [SegWit](https://en.wikipedia.org/wiki/SegWit)) + +- **DAO** - Decentralized Autonomous Organization. + +- **dApp** - Decentralized Application. + +- **DataLayer™** - Datalayer connects an offchain database to the chia blockchain via merkel tree hashes ensuring any and all changes to the database are transparent and auditable. https://chia.net/chia-datalayer. + +- **Decentralised ID (DID)** - A decentralised ID is a smart contract that enables a wallet to act as an ID which can create messages to other IDs. Based on the work of the [identity foundation](https://identity.foundation/). + +- **Farming** - Verifying transactions and creating blocks on the chia blockchain. + +- **full node rpc api** - Full node access with JSON formatting. + +- **green paper** - Overviews the chia blockchain and the various new technologies implemented at the consensus level. + +- **Light Wallet** - Chia client functionality - a chia wallet that does not require a full node but rather gets balance and transaction data from peers in a decentralized method. + +- **NFT** - Non-fungible Token, a token that is inherently and provably unique. + +- **NFT0** - Chia’s in development NFT standard before NFT1 was launched. + +- **NFT1** - Chia’s current NFT standard. + +- **Op Constraints/Conditions** - Constraints are returned by the puzzle when it’s passed the solution. If all of the returned conditions are met then a transaction is valid. + +- **PFP** - Profile picture. + +- **plugin wallet** - A wallet implementation that uses the wallet SDK to provide extremely easy access to adding new coins and app types. + +- **PoS or POS** - Proof of Stake. + +- **PoSpace** - Proof of Space. + +- **PoST** - Proof of Space and Time. + +- **Prepend Signature** - Prepend signatures are used so that we can retain metadata about the structure of an aggregated signature. + +- **Primary Input/Parent** - When a coin is created the coin that was used as input in the transaction is designated as the primary input. This is used to create the coin ID. If more than one coin is used up as an input in a transaction then one of the coins is designated the primary input, and the others simply reinforce the transaction. + +- **Puzzle (Scriptpubkey)** - A ChiaLisp program which specifies the behaviour of a coin when it is spent. A puzzle can either reject a solution or output a set of constraints. + +- **Puzzle Generator** - A wallet will use a Puzzle Generator to define how it wants to receive transactions. Most wallets will want to generate the standard transaction, however by storing a ChiaLisp program that generate a puzzle, all a Sending Wallet needs to do is ask the Recipient Wallet what its Program Generator is and then run that to create the puzzle to lock the coin up with. + +- **Puzzle Generator ID** - This is the hash of a wallet's puzzle generator. A wallet can do a hash-lookup and see if it already knows the source code for that puzzle generator. If not, it will request the full source code and store that information in its lookup table. + +- **Rue** - Rue is an alternative language to Chialisp that compiles to CLVM which the puzzles for spending coin are programmed. Rue is being developed by a community member (Rigidity) and more information can be found on his [github repo](https://github.com/Rigidity/rue) or the [Rue website](https://rue-lang.com/). + +- **Smart Contract/Puzzle** - A smart contract is a specialised ChiaLisp puzzle which locks a coin up and enables complex blockchain interactions. + +- **Solution (Scriptsig)** - This is some ChiaLisp which is passed to the puzzle for evaluation when a transaction is submitted. For more information about how transactions work, and how solutions can generate new coins check out this [guide](https://docs.chia.net/guides/crash-course/signatures/#build-a-solution) + +- **Spend/CoinSolution** - A spend is a reveal of a coin's ID, along with the full puzzle code, and a solution to be ran with the puzzle. The result of a spend is determined by the returned Op Constraints after running the puzzle with the solution. + +- **Spend Bundle** - A spend bundle is a collection of spends grouped together with an aggregated signature to be sent to the network. + +- **Unspents (UTXO set/unspent transaction output set)** - This is the set of all unspent coins on the network. It is used to check if a transaction is valid, acting as a lookup for the puzzles. It maps a coin ID to a birthdate in blockheight. A transaction must contain a reveal of the information used to calculate the ID in order for it to be possible to validate because the unspents doesn’t contain that information, only hashes which can be used to validate it. + +- **Unspent Coin (UTXO/unspent transaction output)** - A coin which has been created but not yet spent and hence is storing value. + +- **VDF** - Verifiable Delay Function. This creates the proofs of time in a method that is verifiable and requires some amount of time to complete. + +- **VPB** - Virtual Private Blockchain. + +- **Wallet** - Software written to interact with transactions. Chia uses Hierarchical Deterministic Wallets (HD Wallets). This means that they can generate many different public keys that are all valid and verifiable as unique to that wallet. A wallet contains a coin if it possesses the information necessary to unlock that coin and create a transaction which spends it. + +- **wallet protocol** - Communication protocol for wallets and full nodes to interact via WebSocket Streamable integrations. + +- **wallet rpc api** - Wallet node access with JSON formatting. + +- **wallet SDK** - Software that calls wallet protocol, potentially abstracting out sync and rollbacks. + +- **white paper** - Overviews Chia Network Inc as a business and its founding objectives. diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/resources/k-sizes.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/resources/k-sizes.md index 1e9d718f54..0d1a179a13 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/resources/k-sizes.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/resources/k-sizes.md @@ -6,16 +6,16 @@ slug: /k-sizes ## K值大小与压缩等级 | 压缩等级 | 地块大小 k=32（GiB） | 地块大小 k=32（GB） | 地块大小 k=33（GiB） | 地块大小 k=34（GiB） | 地块大小 k=35（GiB） | -| -------- | -------------------- | ------------------- | -------------------- | -------------------- | -------------------- | -| 0 | 101.4 | 108.8 | 208.8 | 429.9 | 884.1 | -| 1 | 87.5 | 94.0 | 179.6 | 368.2 | 754.3 | -| 2 | 86.0 | 92.4 | 176.6 | 362.1 | 742.2 | -| 3 | 84.5 | 90.7 | 173.4 | 355.9 | 729.7 | -| 4 | 82.9 | 89.0 | 170.2 | 349.4 | 716.8 | -| 5 | 81.3 | 87.2 | 167.0 | 343.0 | 704.0 | -| 6 | 79.6 | 85.5 | 163.8 | 336.6 | 691.1 | -| 7 | 78.0 | 83.8 | 160.6 | 330.2 | 678.3 | -| 9 | 75.2 | 80.7 | 154.1 | 315.5 | 645.8 | +| ---- | -------------- | ------------- | -------------- | -------------- | -------------- | +| 0 | 101.4 | 108.8 | 208.8 | 429.9 | 884.1 | +| 1 | 87.5 | 94.0 | 179.6 | 368.2 | 754.3 | +| 2 | 86.0 | 92.4 | 176.6 | 362.1 | 742.2 | +| 3 | 84.5 | 90.7 | 173.4 | 355.9 | 729.7 | +| 4 | 82.9 | 89.0 | 170.2 | 349.4 | 716.8 | +| 5 | 81.3 | 87.2 | 167.0 | 343.0 | 704.0 | +| 6 | 79.6 | 85.5 | 163.8 | 336.6 | 691.1 | +| 7 | 78.0 | 83.8 | 160.6 | 330.2 | 678.3 | +| 9 | 75.2 | 80.7 | 154.1 | 315.5 | 645.8 | :::info **k=32**是可用于耕种（farming）的最小地块。 尽管可能会看到k=25，但这仅用于测试目的。 @@ -30,16 +30,16 @@ For a given _k_, the plot size is roughly `((2 * k) + 1) * (2 ** (k - 1)) * 0.78 The following table shows the old size estimation of C0 plots, along with the new estimations: -| k | Old est. size (GB) | New est. size (GB) | -| --: | -----------------: | -----------------: | -| 32 | 106.3648651 | 108.8844003 | -| 33 | 219.2752603 | 224.469379 | -| 34 | 451.641581 | 462.339915 | -| 35 | 929.4652826 | 951.4821439 | -| 36 | 1911.294806 | 1956.568916 | -| 37 | 3927.318095 | 4020.347087 | -| 38 | 8064.093156 | 8255.112685 | -| 39 | 16547.10024 | 16939.06239 | +| k | Old est. size (GB) | New est. size (GB) | +| --:| ------------------:| ------------------:| +| 32 | 106.3648651 | 108.8844003 | +| 33 | 219.2752603 | 224.469379 | +| 34 | 451.641581 | 462.339915 | +| 35 | 929.4652826 | 951.4821439 | +| 36 | 1911.294806 | 1956.568916 | +| 37 | 3927.318095 | 4020.347087 | +| 38 | 8064.093156 | 8255.112685 | +| 39 | 16547.10024 | 16939.06239 | ## Storage requirements for uncompressed plots diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/rpc-reference/daemon.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/rpc-reference/daemon.md index 83801278fb..9df237d5e9 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/rpc-reference/daemon.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/rpc-reference/daemon.md @@ -51,12 +51,12 @@ values={[ Be sure to replace `username` with your actual username for both the `.crt` and `.key` file. -````powershell +```powershell wscat -n --cert C:\Users\ ```powershell wscat -n --cert C:\Users\\.chia\mainnet\config\ssl\daemon\private_daemon.crt --key C:\Users\\.chia\mainnet\config\ssl\daemon\private_daemon.key -c wss://0.0.0.0:55400 -```` +``` @@ -134,7 +134,7 @@ Usage: chia rpc daemon [OPTIONS] exit [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | @@ -174,7 +174,7 @@ Usage: chia rpc daemon [OPTIONS] get_routes [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | @@ -230,7 +230,7 @@ Usage: chia rpc daemon [OPTIONS] get_status [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | @@ -265,7 +265,7 @@ Usage: chia rpc daemon [OPTIONS] get_version [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | @@ -300,17 +300,17 @@ Usage: chia rpc daemon [OPTIONS] get_wallet_addresses [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: -| Flag | Type | Required | Description | -| :---------------------- | :------ | :------- | :------------------------------------------------------------------------------------------ | -| fingerprints | NUMBER | False | List the keys for the specified fingerprints only [Default: list keys for all fingerprints] | -| index | NUMBER | False | Starting index for addresses to list [Default: 0] | -| count | NUMBER | False | Number of addresses to list [Default: 1] | +| Flag | Type | Required | Description | +|:------------------------- |:------- |:-------- |:------------------------------------------------------------------------------------------- | +| fingerprints | NUMBER | False | List the keys for the specified fingerprints only [Default: list keys for all fingerprints] | +| index | NUMBER | False | Starting index for addresses to list [Default: 0] | +| count | NUMBER | False | Number of addresses to list [Default: 1] | | non_observer_derivation | BOOLEAN | False | Set to `True` to use non-observer derivation [Default: `False`] |
@@ -388,7 +388,7 @@ Usage: chia rpc daemon [OPTIONS] is_keyring_locked [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | @@ -423,14 +423,14 @@ Usage: chia rpc daemon [OPTIONS] is_running [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: -| Flag | Type | Required | Description | -| :------ | :----- | :------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Flag | Type | Required | Description | +|:------- |:------ |:-------- |:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | service | STRING | TRUE | The service to query; valid examples include, but are not limited to, "chia_data_layer", "chia_data_layer_http", "chia_wallet", "chia_full_node", "chia_harvester", "chia_farmer", "chia_introducer", "chia_timelord", "chia_timelord_launcher", "chia_full_node_simulator", "chia_seeder", "chia_crawler", "wallet_ui" |
@@ -465,7 +465,7 @@ Usage: chia rpc daemon [OPTIONS] keyring_status [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | @@ -508,14 +508,14 @@ Usage: chia rpc daemon [OPTIONS] register_service [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :------ | :----- | :------- | :---------------------------------- | +|:------- |:------ |:-------- |:----------------------------------- | | service | STRING | TRUE | The name of the service to register |
@@ -546,14 +546,14 @@ Usage: chia rpc daemon [OPTIONS] remove_keyring_passphrase [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :----------------- | :----- | :------- | :-------------------------------------------------------------------------------- | +|:------------------ |:------ |:-------- |:--------------------------------------------------------------------------------- | | current_passphrase | STRING | True | The current passphrase; if entered correctly, it will be removed from the keyring |
@@ -607,7 +607,7 @@ Usage: chia rpc daemon [OPTIONS] running_services [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | @@ -648,14 +648,14 @@ Usage: chia rpc daemon [OPTIONS] set_keyring_passphrase [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :----------------- | :------ | :------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +|:------------------ |:------- |:-------- |:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | current_passphrase | STRING | True | The current passphrase (if none, use an empty string) | | new_passphrase | STRING | True | The new passphrase, by default must be at least 8 characters long | | passphrase_hint | STRING | False | The new passphrase hint, if one is desired | @@ -690,14 +690,14 @@ Usage: chia rpc daemon [OPTIONS] start_service [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :------ | :------ | :------- | :------------------------------------------------------------ | +|:------- |:------- |:-------- |:------------------------------------------------------------- | | service | STRING | True | The service to start | | testing | Boolean | False | If `true`, then test the start_service RPC [Default: `false`] | @@ -733,14 +733,14 @@ Usage: chia rpc daemon [OPTIONS] stop_service [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :------ | :----- | :------- | :------------------ | +|:------- |:------ |:-------- |:------------------- | | service | STRING | True | The service to stop |
@@ -774,14 +774,14 @@ Usage: chia rpc daemon [OPTIONS] unlock_keyring [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :--- | :----- | :------- | :-------------------------------- | +|:---- |:------ |:-------- |:--------------------------------- | | key | STRING | False | The key to unlock [Default: None] |
@@ -813,14 +813,14 @@ Usage: chia rpc daemon [OPTIONS] validate_keyring_passphrase [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :--- | :----- | :------- | :--------------- | +|:---- |:------ |:-------- |:---------------- | | key | STRING | True | The key to check |
@@ -854,14 +854,14 @@ Usage: chia rpc daemon [OPTIONS] get_keys_for_plotting [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :----------- | :----- | :------- | :------------------------------------------------------------------------------------------ | +|:------------ |:------ |:-------- |:------------------------------------------------------------------------------------------- | | fingerprints | NUMBER | False | List the keys for the specified fingerprints only [Default: list keys for all fingerprints] |
@@ -900,7 +900,7 @@ Usage: chia rpc daemon [OPTIONS] get_plotters [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | @@ -953,14 +953,14 @@ Usage: chia rpc daemon [OPTIONS] start_plotting [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :-------- | :------ | :------- | :--------------------------------------------------------------------- | +|:--------- |:------- |:-------- |:---------------------------------------------------------------------- | | service | STRING | True | The plotting service to use | | plotter | STRING | False | The plotter to use [Default: "chiapos"] | | delay | INTEGER | False | The number of seconds to delay before starting to plot [Default: 0] | @@ -988,14 +988,14 @@ Usage: chia rpc daemon [OPTIONS] stop_plotting [REQUEST] Options: Stop creating a plot | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :--- | :----- | :------- | :---------------------------------- | +|:---- |:------ |:-------- |:----------------------------------- | | id | STRING | True | The ID of the plot to stop creating |
@@ -1028,14 +1028,14 @@ Usage: chia rpc daemon [OPTIONS] add_private_key [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :------- | :----- | :------- | :----------------------------------------------- | +|:-------- |:------ |:-------- |:------------------------------------------------ | | mnemonic | STRING | True | The mnemonic word list (see below for details) | | label | STRING | False | The label to assign for this key [Default: None] | @@ -1139,14 +1139,14 @@ Usage: chia rpc daemon [OPTIONS] check_keys [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | -| :-------- | :----- | :------- | +|:--------- |:------ |:-------- | | root_path | STRING | True | --- @@ -1160,7 +1160,7 @@ Usage: chia rpc daemon [OPTIONS] delete_all_keys [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | @@ -1185,14 +1185,14 @@ Usage: chia rpc daemon [OPTIONS] delete_key_by_fingerprint [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :---------- | :------ | :------- | :------------------------------------------- | +|:----------- |:------- |:-------- |:-------------------------------------------- | | fingerprint | INTEGER | True | The fingerprint whose key you want to delete | Note that this command will fail if the OS key ring is locked. @@ -1243,7 +1243,7 @@ Usage: chia rpc daemon [OPTIONS] get_all_private_keys [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | @@ -1289,7 +1289,7 @@ Usage: chia rpc daemon [OPTIONS] get_first_private_key [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | @@ -1327,14 +1327,14 @@ Usage: chia rpc daemon [OPTIONS] get_key_for_fingerprint [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :---------- | :------ | :------- | :------------------------------------------------------ | +|:----------- |:------- |:-------- |:------------------------------------------------------- | | fingerprint | INTEGER | False | The fingerprint to look up [Default: get the first key] |
@@ -1367,14 +1367,14 @@ Usage: chia rpc daemon [OPTIONS] get_key [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :-------------- | :------ | :------- | :------------------------------------------------------------------ | +|:--------------- |:------- |:-------- |:------------------------------------------------------------------- | | fingerprint | INTEGER | True | The fingerprint whose key you want to look up | | include_secrets | BOOLEAN | False | Set to `true` to include secrets in the response [Default: `false`] | @@ -1412,14 +1412,14 @@ Usage: chia rpc daemon [OPTIONS] get_keys [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :-------------- | :------ | :------- | :------------------------------------------------------------------ | +|:--------------- |:------- |:-------- |:------------------------------------------------------------------- | | include_secrets | BOOLEAN | False | Set to `true` to include secrets in the response [Default: `false`] |
@@ -1458,14 +1458,14 @@ Usage: chia rpc daemon [OPTIONS] get_public_key [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :---------- | :------ | :------- | :-------------------------------------------- | +|:----------- |:------- |:-------- |:--------------------------------------------- | | fingerprint | INTEGER | True | The fingerprint whose key you want to look up |
@@ -1501,7 +1501,7 @@ Usage: chia rpc daemon [OPTIONS] get_public_keys [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | @@ -1542,14 +1542,14 @@ Usage: chia rpc daemon [OPTIONS] set_label [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :---------- | :------ | :------- | :------------------------------------------ | +|:----------- |:------- |:-------- |:------------------------------------------- | | fingerprint | INTEGER | True | The fingerprint whose label you want to set | | label | STRING | True | The new label | @@ -1600,14 +1600,14 @@ Usage: chia rpc daemon [OPTIONS] delete_label [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :---------- | :------ | :------- | :--------------------------------------------- | +|:----------- |:------- |:-------- |:---------------------------------------------- | | fingerprint | INTEGER | True | The fingerprint whose label you want to delete |
diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/rpc-reference/daos.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/rpc-reference/daos.md index 7e3d5d9f4b..ea30112c80 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/rpc-reference/daos.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/rpc-reference/daos.md @@ -57,12 +57,12 @@ Options: Request Parameters: -| Flag | Type | Required | Description | -| :---------------- | ------ | :------- | :------------------------------------------------------------------------------------ | -| wallet_id | NUMBER | True | The DAO wallet to which to add funds. Must be of type `DAOWallet` | -| funding_wallet_id | NUMBER | True | The wallet from which the funds will come. Must be of type `STANDARD_WALLET` or `CAT` | -| amount | NUMBER | True | The amount of funds to add, in mojos | -| fee | NUMBER | False | An optional blockchain fee, in mojos \[Default: 0] | +| Flag | Type | Required | Description | +| :---------------------------------------------------------- | ------ | :------- | :---------------------------------------------------------------------------------------------------------------------- | +| wallet_id | NUMBER | True | The DAO wallet to which to add funds. Must be of type `DAOWallet` | +| funding_wallet_id | NUMBER | True | The wallet from which the funds will come. Must be of type `STANDARD_WALLET` or `CAT` | +| amount | NUMBER | True | The amount of funds to add, in mojos | +| fee | NUMBER | False | An optional blockchain fee, in mojos \[Default: 0] |
Example @@ -200,10 +200,10 @@ Options: Request Parameters: -| Flag | Type | Required | Description | -| :----------- | ------ | :------- | :-------------------------------------------------------------------------------------------- | +| Flag | Type | Required | Description | +| :-------------------------------- | ------ | :------- | :------------------------------------------------------------------------------------------------------------ | | wallet_id | NUMBER | True | The ID of the wallet whose filter level you would like to adjust. Must be of type `DAOWallet` | -| filter_level | NUMBER | True | The new filter level. Propos with fewer votes than this will not be shown. | +| filter_level | NUMBER | True | The new filter level. Propos with fewer votes than this will not be shown. | --- @@ -222,11 +222,11 @@ Options: Request Parameters: -| Flag | Type | Required | Description | -| :---------- | ------ | :------- | :------------------------------------------------------------------------------------ | +| Flag | Type | Required | Description | +| :------------------------------- | ------ | :------- | :---------------------------------------------------------------------------------------------------- | | wallet_id | NUMBER | True | The ID of the wallet that contains the proposal to close. Must be of type `DAOWallet` | -| proposal_id | STRING | True | The ID of the proposal to close | -| fee | NUMBER | False | An optional blockchain fee, in mojos | +| proposal_id | STRING | True | The ID of the proposal to close | +| fee | NUMBER | False | An optional blockchain fee, in mojos | --- @@ -245,12 +245,12 @@ Options: Request Parameters: -| Flag | Type | Required | Description | -| :------------ | ------ | :------- | :--------------------------------------------------------------------------- | +| Flag | Type | Required | Description | +| :--------------------------------- | ------ | :------- | :------------------------------------------------------------------------------------------- | | wallet_id | NUMBER | True | The DAO wallet to use for creating the proposal. Must be of type `DAOWallet` | -| proposal_type | STRING | True | Must be either `spend`, `update`, or `mint` | -| vote_amount | NUMBER | False | The number of votes to add | -| fee | NUMBER | False | An optional blockchain fee, in mojos | +| proposal_type | STRING | True | Must be either `spend`, `update`, or `mint` | +| vote_amount | NUMBER | False | The number of votes to add | +| fee | NUMBER | False | An optional blockchain fee, in mojos | Proposal Types: @@ -264,38 +264,38 @@ If the proposal is of type `spend`, then `additions` may optionally be included `additions` is a list with the following elements: -| Element | Required | Description | -| :---------- | :------- | :-------------------------------------------------- | +| Element | Required | Description | +| :------------------------------- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------- | | asset_id | False | The asset_id of the funds to spend \[Default: None] | -| puzzle_hash | True | The puzzle_hash of the funds to spend | -| amount | True | The amount, in mojos, to spend | +| puzzle_hash | True | The puzzle_hash of the funds to spend | +| amount | True | The amount, in mojos, to spend | If the proposal is of type `spend`, and `additions` is not included, then the following **request parameters** will be used instead: -| Parameter | Required | Description | -| :------------ | :------- | :-------------------------------------------------- | +| Parameter | Required | Description | +| :--------------------------------- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------- | | asset_id | False | The asset_id of the funds to spend \[Default: None] | -| inner_address | True | The inner address of the funds to spend | -| amount | True | The amount, in mojos, to spend | +| inner_address | True | The inner address of the funds to spend | +| amount | True | The amount, in mojos, to spend | If the proposal is of type `update`, then the **request parameter** `new_dao_rules` is required. `new_dao_rules` is a list of optional rules to update. If a rule is missing from this list, it will not be updated: -| Rule | Required | Description | -| :------------------- | :------- | :------------------------------------------------------------------------------------------------- | -| proposal_timelock | False | The new minimum number of blocks before a proposal can close | -| soft_close_length | False | The number of blocks a proposal must remain unspent before closing | -| attendance_required | False | The minimum number of votes a proposal must receive to be accepted | -| pass_percentage | False | The percentage of 'yes' votes in basis points a proposal must receive to be accepted. 100% = 10000 | -| self_destruct_length | False | The number of blocks required before a proposal can be automatically removed | -| oracle_spend_delay | False | The number of blocks required between oracle spends of the treasury | +| Rule | Required | Description | +| :------------------------------------------------------------- | :------- | :----------------------------------------------------------------------------------------------------------------- | +| proposal_timelock | False | The new minimum number of blocks before a proposal can close | +| soft_close_length | False | The number of blocks a proposal must remain unspent before closing | +| attendance_required | False | The minimum number of votes a proposal must receive to be accepted | +| pass_percentage | False | The percentage of 'yes' votes in basis points a proposal must receive to be accepted. 100% = 10000 | +| self_destruct_length | False | The number of blocks required before a proposal can be automatically removed | +| oracle_spend_delay | False | The number of blocks required between oracle spends of the treasury | If the proposal is of type `mint`, then the following **request parameters** are required: -| Parameter | Required | Description | -| :----------------- | :------- | :------------------------------------------- | -| amount | True | The number of DAO CATs to mint | +| Parameter | Required | Description | +| :----------------------------------------------------------- | :------- | :------------------------------------------- | +| amount | True | The number of DAO CATs to mint | | cat_target_address | True | The xch address that will receive the tokens | --- @@ -315,11 +315,11 @@ Options: Request Parameters: -| Flag | Type | Required | Description | -| :-------- | ------ | :------- | :----------------------------------------------------------------------------------- | +| Flag | Type | Required | Description | +| :----------------------------- | ------ | :------- | :--------------------------------------------------------------------------------------------------- | | wallet_id | NUMBER | True | The ID of the wallet from which to release the DAO CATs. Must be of type `DAOWallet` | -| coins | STRING | False | A list of coin IDs to release | -| fee | NUMBER | False | An optional blockchain fee, in mojos | +| coins | STRING | False | A list of coin IDs to release | +| fee | NUMBER | False | An optional blockchain fee, in mojos | --- @@ -338,10 +338,10 @@ Options: Request Parameters: -| Flag | Type | Required | Description | -| :-------- | ------ | :------- | :----------------------------------------------------------------------------------- | +| Flag | Type | Required | Description | +| :----------------------------- | ------ | :------- | :--------------------------------------------------------------------------------------------------- | | wallet_id | NUMBER | True | The ID of the wallet from which to release the DAO CATs. Must be of type `DAOWallet` | -| fee | NUMBER | False | An optional blockchain fee, in mojos | +| fee | NUMBER | False | An optional blockchain fee, in mojos | --- @@ -360,8 +360,8 @@ Options: Request Parameters: -| Flag | Type | Required | Description | -| :-------- | ------ | :------- | :------------------------------------------------------------------- | +| Flag | Type | Required | Description | +| :----------------------------- | ------ | :------- | :------------------------------------------------------------------- | | wallet_id | NUMBER | True | The wallet from which to list proposals; must be of type `DAOWallet` |
@@ -424,10 +424,10 @@ Options: Request Parameters: -| Flag | Type | Required | Description | -| :---------- | ------ | :------- | :---------------------------------------------------------------------------------------------- | +| Flag | Type | Required | Description | +| :------------------------------- | ------ | :------- | :-------------------------------------------------------------------------------------------------------------- | | wallet_id | NUMBER | True | The ID of the DAO wallet from which to look up a proposal's status. Must be of type `DAOWallet` | -| proposal_id | STRING | True | The ID of the proposal whose status you would like to show | +| proposal_id | STRING | True | The ID of the proposal whose status you would like to show |
Example @@ -499,8 +499,8 @@ Options: Request Parameters: -| Flag | Type | Required | Description | -| :-------- | ------ | :------- | :----------------------------------------------------------------------- | +| Flag | Type | Required | Description | +| :----------------------------- | ------ | :------- | :--------------------------------------------------------------------------------------- | | wallet_id | NUMBER | True | The DAO wallet from which to show the rules. Must be of type `DAOWallet` |
@@ -548,8 +548,8 @@ Options: Request Parameters: -| Flag | Type | Required | Description | -| :-------- | ------ | :------- | :--------------------------------------------------------------------------------- | +| Flag | Type | Required | Description | +| :----------------------------- | ------ | :------- | :------------------------------------------------------------------------------------------------- | | wallet_id | NUMBER | True | The DAO whose treasury balance you would like to show. Must be of type `DAOWallet` |
@@ -591,8 +591,8 @@ Options: Request Parameters: -| Flag | Type | Required | Description | -| :-------- | ------ | :------- | :------------------------------------------------------------------------------ | +| Flag | Type | Required | Description | +| :----------------------------- | ------ | :------- | :---------------------------------------------------------------------------------------------- | | wallet_id | NUMBER | True | The DAO wallet whose ID you would like to retrieve. Must be of type `DAOWallet` |
@@ -627,10 +627,10 @@ Options: Request Parameters: -| Flag | Type | Required | Description | -| :---------- | ------ | :------- | :------------------------------------------------------------------- | +| Flag | Type | Required | Description | +| :------------------------------- | ------ | :------- | :----------------------------------------------------------------------------------- | | wallet_id | NUMBER | True | The DAO wallet where the proposal lives. Must be of type `DAOWallet` | -| proposal_id | STRING | True | The ID of the proposal whose details you would like to show | +| proposal_id | STRING | True | The ID of the proposal whose details you would like to show |
Example @@ -685,10 +685,10 @@ Options: Request Parameters: -| Flag | Type | Required | Description | -| :-------- | ------ | :------- | :---------------------------------------------------------------------------- | +| Flag | Type | Required | Description | +| :----------------------------- | ------ | :------- | :-------------------------------------------------------------------------------------------- | | wallet_id | NUMBER | True | The ID of the wallet from which to lock DAO CATs. Must be of type `DAOWallet` | -| amount | NUMBEr | True | The amount of CATs to lock for voting | +| amount | NUMBEr | True | The amount of CATs to lock for voting | --- @@ -707,12 +707,12 @@ Options: Request Parameters: -| Flag | Type | Required | Description | -| :---------- | ------- | :------- | :------------------------------------------------------------------------- | -| wallet_id | NUMBER | True | The ID of the wallet where the proposal lives. Must be of type `DAOWallet` | -| proposal_id | STRING | True | The ID of the proposal on which you would like to vote | -| vote_amount | NUMBER | False | The number of DAO CATs to use for this vote \[Default: None] | -| is_yes_vote | BOOLEAN | True | A boolean indicating whether this vote is "yes" (`true`) or "no" (`false`) | -| fee | NUMBER | False | An optional blockchain fee, in mojos | +| Flag | Type | Required | Description | +| :---------------------------------------------------- | ------- | :------- | :-------------------------------------------------------------------------------------------------------------------------------- | +| wallet_id | NUMBER | True | The ID of the wallet where the proposal lives. Must be of type `DAOWallet` | +| proposal_id | STRING | True | The ID of the proposal on which you would like to vote | +| vote_amount | NUMBER | False | The number of DAO CATs to use for this vote \[Default: None] | +| is_yes_vote | BOOLEAN | True | A boolean indicating whether this vote is "yes" (`true`) or "no" (`false`) | +| fee | NUMBER | False | An optional blockchain fee, in mojos | --- diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/rpc-reference/datalayer.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/rpc-reference/datalayer.md index 5872cbd55a..717f67a364 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/rpc-reference/datalayer.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/rpc-reference/datalayer.md @@ -55,14 +55,14 @@ Usage: chia rpc data_layer [OPTIONS] add_mirror [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :----- | :------ | :------- | :--------------------------------------------------------------------------------------------------------------- | +|:------ |:------- |:-------- |:---------------------------------------------------------------------------------------------------------------- | | id | TEXT | True | The hexadecimal ID of the store to mirror | | urls | TEXT | True | A list of URLs where the mirror will reside | | amount | INTEGER | True | The number of mojos to spend to create the mirror. In theory, mirrors with a higher `amount` will be prioritized | @@ -100,16 +100,16 @@ Usage: chia rpc data_layer [OPTIONS] add_missing_files [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: -| Flag | Type | Required | Description | -| :--------- | :------ | :------- | :------------------------------------------------------------------------------------------------------------------------------------------- | -| ids | TEXT | False | A list of hexadecimal store IDs to restore (default: all subscribed stores) | -| override | BOOLEAN | False | If `True`, will overwrite files that already exist (default: `False`) | +| Flag | Type | Required | Description | +|:---------- |:------- |:-------- |:-------------------------------------------------------------------------------------------------------------------------------------------------- | +| ids | TEXT | False | A list of hexadecimal store IDs to restore (default: all subscribed stores) | +| override | BOOLEAN | False | If `True`, will overwrite files that already exist (default: `False`) | | foldername | TEXT | False | The name of the folder where the files to be restored are located (default: `~/.chia/mainnet/data_layer/db/server_files_location_`) |
@@ -175,18 +175,18 @@ Usage: chia rpc data_layer [OPTIONS] batch_update [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: -| Flag | Type | Required | Description | -| :-------------- | :------ | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------- | -| id | TEXT | True | The hexadecimal store ID | -| changelist | TEXT | True | A string representing the changelist | +| Flag | Type | Required | Description | +|:----------------- |:------- |:-------- |:--------------------------------------------------------------------------------------------------------------------------------------------- | +| id | TEXT | True | The hexadecimal store ID | +| changelist | TEXT | True | A string representing the changelist | | submit_on_chain | BOOLEAN | False | Specify whether to submit the update to the blockchain (`True`), or to store it locally (`False`). Default: `True` (See info box for details) | -| fee | TEXT | False | Set the fee for the transaction, in mojos | +| fee | TEXT | False | Set the fee for the transaction, in mojos | :::info @@ -393,14 +393,14 @@ Usage: chia rpc data_layer [OPTIONS] cancel_offer [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :------- | :------ | :------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +|:-------- |:------- |:-------- |:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | trade_id | TEXT | True | The `trade_id` of the offer. This is displayed with the response of the [make_offer](#make_offer) RPC | | secure | BOOLEAN | True | If `true`, the offer will be canceled on the blockchain, making it impossible to be accepted later. If `false`, the offer will only be canceled locally. We recommend that you set this to `true` unless you are certain that the offer file has not left your computer | | fee | TEXT | False | If `secure` is `true`, this will set the fee for the transaction, in mojos. If `secure` is `false`, the fee will be ignored | @@ -435,7 +435,7 @@ Usage: chia rpc data_layer [OPTIONS] check_plugins [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | @@ -473,14 +473,14 @@ Usage: chia rpc data_layer [OPTIONS] clear_pending_roots [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :------- | :--- | :------- | :----------------------- | +|:-------- |:---- |:-------- |:------------------------ | | store_id | TEXT | True | The hexadecimal store ID |
@@ -517,14 +517,14 @@ Usage: chia rpc data_layer [OPTIONS] create_data_store [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :--- | :--- | :------- | :---------------------------------------- | +|:---- |:---- |:-------- |:----------------------------------------- | | fee | TEXT | False | Set the fee for the transaction, in mojos |
@@ -688,14 +688,14 @@ Usage: chia rpc data_layer [OPTIONS] delete_key [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :--- | :--- | :------- | :---------------------------------------- | +|:---- |:---- |:-------- |:----------------------------------------- | | id | TEXT | True | The hexadecimal store ID | | key | TEXT | True | The hexadecimal key | | fee | TEXT | False | Set the fee for the transaction, in mojos | @@ -731,14 +731,14 @@ Usage: chia rpc data_layer [OPTIONS] delete_mirror [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :--- | :--- | :------- | :--------------------------------------------------------------------------------------- | +|:---- |:---- |:-------- |:---------------------------------------------------------------------------------------- | | id | TEXT | True | The `coin_id` of the mirror to delete, obtainable by running [get_mirrors](#get_mirrors) | | fee | TEXT | False | Set the fee for the transaction, in mojos | @@ -787,14 +787,14 @@ Usage: chia rpc data_layer [OPTIONS] get_ancestors [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :--- | :--- | :------- | :--------------------------------------- | +|:---- |:---- |:-------- |:---------------------------------------- | | id | TEXT | True | The hexadecimal store ID | | hash | TEXT | True | The hash from which to display ancestors | @@ -846,17 +846,17 @@ Usage: chia rpc data_layer [OPTIONS] get_keys [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: -| Flag | Type | Required | Description | -| :------------ | :----- | :------- | :------------------------------------------------------------------------------------------------ | -| id | TEXT | True | The hexadecimal store ID | -| root_hash | TEXT | False | The root hash from which to obtain data | -| page | NUMBER | False | Enables pagination of the output and requests a specific page | +| Flag | Type | Required | Description | +|:--------------- |:------ |:-------- |:------------------------------------------------------------------------------------------------- | +| id | TEXT | True | The hexadecimal store ID | +| root_hash | TEXT | False | The root hash from which to obtain data | +| page | NUMBER | False | Enables pagination of the output and requests a specific page | | max_page_size | NUMBER | False | Set how many bytes to be included in a page. Only used if pagination is enabled. Default is 40 MB | :::info @@ -902,17 +902,17 @@ Usage: chia rpc data_layer [OPTIONS] get_keys_values [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: -| Flag | Type | Required | Description | -| :-----------: | :----: | :------: | :------------------------------------------------------------------------------------------------ | -| id | TEXT | True | The hexadecimal store ID | -| root_hash | TEXT | False | The root hash from which to obtain data | -| page | NUMBER | False | Enables pagination of the output and requests a specific page | +| Flag | Type | Required | Description | +|:---------------:|:------:|:--------:|:------------------------------------------------------------------------------------------------- | +| id | TEXT | True | The hexadecimal store ID | +| root_hash | TEXT | False | The root hash from which to obtain data | +| page | NUMBER | False | Enables pagination of the output and requests a specific page | | max_page_size | NUMBER | False | Set how many bytes to be included in a page. Only used if pagination is enabled. Default is 40 MB | :::info @@ -1026,18 +1026,18 @@ Usage: chia rpc data_layer [OPTIONS] get_kv_diff [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: -| Flag | Type | Required | Description | -| :------------ | :----- | :------- | :------------------------------------------------------------------------------------------------ | -| id | TEXT | True | The hexadecimal store ID | -| hash_1 | TEXT | True | The first hash to compare | -| hash_2 | TEXT | True | The second hash to compare | -| page | NUMBER | False | Enables pagination of the output and requests a specific page | +| Flag | Type | Required | Description | +|:--------------- |:------ |:-------- |:------------------------------------------------------------------------------------------------- | +| id | TEXT | True | The hexadecimal store ID | +| hash_1 | TEXT | True | The first hash to compare | +| hash_2 | TEXT | True | The second hash to compare | +| page | NUMBER | False | Enables pagination of the output and requests a specific page | | max_page_size | NUMBER | False | Set how many bytes to be included in a page. Only used if pagination is enabled. Default is 40 MB | :::info @@ -1088,14 +1088,14 @@ Usage: chia rpc data_layer [OPTIONS] get_local_root [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters:s | Flag | Type | Required | Description | -| :--- | :--- | :------- | :----------------------- | +|:---- |:---- |:-------- |:------------------------ | | id | TEXT | True | The hexadecimal store ID |
@@ -1127,14 +1127,14 @@ Usage: chia rpc data_layer [OPTIONS] get_mirrors [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :--- | :--- | :------- | :-------------------------------------------------------- | +|:---- |:---- |:-------- |:--------------------------------------------------------- | | id | TEXT | True | The hexadecimal ID of the store for which to list mirrors |
@@ -1174,7 +1174,7 @@ Usage: chia rpc data_layer [OPTIONS] get_owned_stores [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | @@ -1211,14 +1211,14 @@ Usage: chia rpc data_layer [OPTIONS] get_proof [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :------- | :---------- | :------- | :------------------------------------------ | +|:-------- |:----------- |:-------- |:------------------------------------------- | | store_id | TEXT | True | The hexadecimal store ID | | keys | STRING LIST | True | A list of keys for which to retrieve proofs | @@ -1269,14 +1269,14 @@ Usage: chia rpc data_layer [OPTIONS] get_root [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :--- | :--- | :------- | :----------------------- | +|:---- |:---- |:-------- |:------------------------ | | id | TEXT | True | The hexadecimal store ID |
@@ -1334,14 +1334,14 @@ Usage: chia rpc data_layer [OPTIONS] get_roots [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :--- | :--- | :------- | :------------------------------ | +|:---- |:---- |:-------- |:------------------------------- | | ids | TEXT | True | A list of hexadecimal store IDs |
@@ -1388,14 +1388,14 @@ Usage: chia rpc data_layer [OPTIONS] get_root_history [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :--- | :--- | :------- | :----------------------- | +|:---- |:---- |:-------- |:------------------------ | | id | TEXT | True | The hexadecimal store ID |
@@ -1468,7 +1468,7 @@ Usage: chia rpc data_layer [OPTIONS] get_routes Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | @@ -1543,14 +1543,14 @@ Usage: chia rpc data_layer [OPTIONS] get_sync_status [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :--- | :--- | :------- | :----------------------- | +|:---- |:---- |:-------- |:------------------------ | | id | TEXT | True | The hexadecimal store ID |
@@ -1587,14 +1587,14 @@ Usage: chia rpc data_layer [OPTIONS] get_value [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :-------- | :--- | :------- | :-------------------------------------- | +|:--------- |:---- |:-------- |:--------------------------------------- | | id | TEXT | True | The hexadecimal store ID | | key | TEXT | True | The hexadecimal key | | root_hash | TEXT | False | The root hash from which to obtain data | @@ -1636,14 +1636,14 @@ Usage: chia rpc data_layer [OPTIONS] insert [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :---- | :--- | :------- | :---------------------------------------- | +|:----- |:---- |:-------- |:----------------------------------------- | | id | TEXT | True | The hexadecimal store ID | | key | TEXT | True | The hexadecimal key | | value | TEXT | True | The hexadecimal value | @@ -1700,14 +1700,14 @@ Usage: chia rpc data_layer [OPTIONS] make_offer [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :---- | :--- | :------- | :-------------------------------------------------------- | +|:----- |:---- |:-------- |:--------------------------------------------------------- | | maker | TEXT | True | The hexadecimal ID of the store for which to list mirrors | | fee | TEXT | False | Set the fee for the offer, in mojos | @@ -1908,14 +1908,14 @@ Usage: chia rpc data_layer [OPTIONS] remove_subscriptions [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :--- | :--- | :------- | :--------------------------------------- | +|:---- |:---- |:-------- |:---------------------------------------- | | id | TEXT | True | The hexadecimal store ID | | urls | TEXT | True | A list of URLs from which to unsubscribe | @@ -1947,14 +1947,14 @@ Usage: chia rpc data_layer [OPTIONS] submit_pending_root [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :--- | :--- | :------- | :----------------------- | +|:---- |:---- |:-------- |:------------------------ | | id | TEXT | True | The hexadecimal store ID | --- @@ -1968,14 +1968,14 @@ Usage: chia rpc data_layer [OPTIONS] subscribe [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :--- | :--- | :------- | :----------------------------------------------------------------------- | +|:---- |:---- |:-------- |:------------------------------------------------------------------------ | | id | TEXT | True | The hexadecimal store ID | | urls | TEXT | True | A list of URLs where the data store resides. This list can be left blank | @@ -2028,7 +2028,7 @@ Usage: chia rpc data_layer [OPTIONS] subscriptions [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | @@ -2069,14 +2069,14 @@ Usage: chia rpc data_layer [OPTIONS] take_offer [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :---- | :--- | :------- | :----------------------------------------------------------------------------------------------------- | +|:----- |:---- |:-------- |:------------------------------------------------------------------------------------------------------ | | offer | TEXT | False | The offer, in JSON format (the output from the `make_offer` RPC). Includes Maker and Taker information | | fee | TEXT | False | Set the fee for the offer, in mojos | @@ -2181,14 +2181,14 @@ Usage: chia rpc data_layer [OPTIONS] unsubscribe [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :--- | :--- | :------- | :-------------------------------------------------------- | +|:---- |:---- |:-------- |:--------------------------------------------------------- | | id | TEXT | True | The hexadecimal ID of the store from which to unsubscribe | :::info @@ -2229,14 +2229,14 @@ Usage: chia rpc data_layer [OPTIONS] verify_offer [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :---- | :--- | :------- | :----------------------------------------------------------------------------------------------------- | +|:----- |:---- |:-------- |:------------------------------------------------------------------------------------------------------ | | offer | TEXT | False | The offer, in JSON format (the output from the `make_offer` RPC). Includes Maker and Taker information |
@@ -2291,16 +2291,16 @@ Usage: chia rpc data_layer [OPTIONS] verify_proof [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: -| Flag | Type | Required | Description | -| :---------------- | :----- | :------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| store_proofs | STRING | True | The proof to verify; requires a `proofs` parameter, which must contain the following parameters: `key_clvm_hash`, `value_clvm_hash`, `node_hash`, `layers`. See the example for usage. | -| coin_id | STRING | True | The ID of the coin to retrieve | +| Flag | Type | Required | Description | +|:------------------- |:------ |:-------- |:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| store_proofs | STRING | True | The proof to verify; requires a `proofs` parameter, which must contain the following parameters: `key_clvm_hash`, `value_clvm_hash`, `node_hash`, `layers`. See the example for usage. | +| coin_id | STRING | True | The ID of the coin to retrieve | | inner_puzzle_hash | STRING | True | The proof's inner puzzle hash | Notes about this command: @@ -2351,14 +2351,14 @@ Functionality: Request that the wallet service be logged in to the specified fin Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :---------- | :----- | :------- | :----------------------------------- | +|:----------- |:------ |:-------- |:------------------------------------ | | fingerprint | STRING | True | The fingerprint of the wallet to use |
@@ -2393,14 +2393,14 @@ Usage: chia rpc data_layer [OPTIONS] close_connection [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :-----: | :--: | :------: | :------------------------------------------------------------------------------------- | +|:-------:|:----:|:--------:|:-------------------------------------------------------------------------------------- | | node_id | TEXT | True | The hex ID of the node to close, obtainable from [`get_connections`](#get_connections) |
@@ -2448,7 +2448,7 @@ Usage: chia rpc data_layer [OPTIONS] get_connections [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | @@ -2498,14 +2498,14 @@ Usage: chia rpc data_layer [OPTIONS] open_connection [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :--- | :------ | :------- | :--------------------------------------------------- | +|:---- |:------- |:-------- |:---------------------------------------------------- | | host | TEXT | True | The IP or URL of the node to connect to | | port | INTEGER | True | The port through which to connect to the remote node | @@ -2539,7 +2539,7 @@ Note: Inherited from RPC Server Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/rpc-reference/dids.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/rpc-reference/dids.md index c9dd3f844d..252d1ef393 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/rpc-reference/dids.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/rpc-reference/dids.md @@ -39,20 +39,20 @@ Note: This is part of the wallet RPC API. It is included here to document the on Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :--- | :------- | :------------------------------------------------------------------ | +|:------------- |:------------ |:---- |:-------- |:------------------------------------------------------------------- | | -j | --json-file | TEXT | False | Instead of REQUEST, provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: -| Parameter | Required | Description | -| :----------------------- | :------- | :-------------------------------------------------------------------------------------------------------------------------- | -| wallet_type | True | This must be set to `did_wallet` in order to create a DID wallet | -| did_type | True | Set this to `new` to create a new DID | -| amount | True | Number of mojos to add to the DID initially. Minimum value is `1` | -| backup_dids | True | A list of DIDs to be used for recovery. Must match actual DIDs | +| Parameter | Required | Description | +|:---------------------------- |:-------- |:--------------------------------------------------------------------------------------------------------------------------- | +| wallet_type | True | This must be set to `did_wallet` in order to create a DID wallet | +| did_type | True | Set this to `new` to create a new DID | +| amount | True | Number of mojos to add to the DID initially. Minimum value is `1` | +| backup_dids | True | A list of DIDs to be used for recovery. Must match actual DIDs | | num_of_backup_ids_needed | True | The number of backup DIDs required for recovery. Minimum value is `1`, maximum value is the number of DIDs in `backup_dids` | -| fee | False | An optional blockchain fee, in mojos | +| fee | False | An optional blockchain fee, in mojos |
Example @@ -114,14 +114,14 @@ Usage: chia rpc wallet [OPTIONS] did_create_attest [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :--- | :------- | :------------------------------------------------------------------ | +|:------------- |:------------ |:---- |:-------- |:------------------------------------------------------------------- | | -j | --json-file | TEXT | False | Instead of REQUEST, provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Parameter | Required | Description | -| :-------- | :------- | :------------------------------------------- | +|:--------- |:-------- |:-------------------------------------------- | | wallet_id | True | The Wallet ID for which to create the attest | | coin_name | True | The coin to use for the attest | | pubkey | True | The public key to use for the attest | @@ -224,14 +224,14 @@ Usage: chia rpc wallet [OPTIONS] did_create_backup_file [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :--- | :------- | :------------------------------------------------------------------ | +|:------------- |:------------ |:---- |:-------- |:------------------------------------------------------------------- | | -j | --json-file | TEXT | False | Instead of REQUEST, provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Parameter | Required | Description | -| :-------- | :------- | :----------------------------------------------------------------- | +|:--------- |:-------- |:------------------------------------------------------------------ | | wallet_id | True | The Wallet ID of the DID wallet from which to obtain the coin info |
@@ -265,18 +265,18 @@ Usage: chia rpc wallet [OPTIONS] did_find_lost_did [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :--- | :------- | :------------------------------------------------------------------ | +|:------------- |:------------ |:---- |:-------- |:------------------------------------------------------------------- | | -j | --json-file | TEXT | False | Instead of REQUEST, provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: -| Parameter | Type | Required | Description | -| :----------------- | :----- | :------- | :---------------------------------------------------------------------------------------------------------------------------------- | -| coin_id | STRING | True | The DID ID, launcher ID, or latest coin ID of the DID you want to recover. The most time-efficient of these is the latest coin ID | +| Parameter | Type | Required | Description | +|:-------------------- |:------ |:-------- |:----------------------------------------------------------------------------------------------------------------------------------- | +| coin_id | STRING | True | The DID ID, launcher ID, or latest coin ID of the DID you want to recover. The most time-efficient of these is the latest coin ID | | recovery_list_hash | STRING | False | Override the recovery list hash of the DID. Only set this if your last DID spend updated the recovery list | -| num_verification | NUMBER | False | Override the required verification number of the DID. Only set this if your last DID spend updated the required verification number | -| metadata | STRING | False | The new whole metadata in json format | +| num_verification | NUMBER | False | Override the required verification number of the DID. Only set this if your last DID spend updated the required verification number | +| metadata | STRING | False | The new whole metadata in json format |
Example 1 @@ -326,14 +326,14 @@ Usage: chia rpc wallet [OPTIONS] did_get_current_coin_info [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :--- | :------- | :------------------------------------------------------------------ | +|:------------- |:------------ |:---- |:-------- |:------------------------------------------------------------------- | | -j | --json-file | TEXT | False | Instead of REQUEST, provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Parameter | Required | Description | -| :-------- | :------- | :----------------------------------------------------------------- | +|:--------- |:-------- |:------------------------------------------------------------------ | | wallet_id | True | The Wallet ID of the DID wallet from which to obtain the coin info |
@@ -369,14 +369,14 @@ Usage: chia rpc wallet [OPTIONS] did_get_did [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :--- | :------- | :------------------------------------------------------------------ | +|:------------- |:------------ |:---- |:-------- |:------------------------------------------------------------------- | | -j | --json-file | TEXT | False | Instead of REQUEST, provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Parameter | Required | Description | -| :-------- | :------- | :------------------------------------------------------------ | +|:--------- |:-------- |:------------------------------------------------------------- | | wallet_id | True | The Wallet ID of the DID wallet for which to get the DID info |
@@ -410,14 +410,14 @@ Usage: chia rpc wallet [OPTIONS] did_get_info [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :------ | :----- | :------- | :-------------------------------------------------------------------------------- | +|:------- |:------ |:-------- |:--------------------------------------------------------------------------------- | | coin_id | NUMBER | True | The coin ID of the DID get info (can be in the `0x618...` or `did:chia:16` format |
@@ -457,14 +457,14 @@ Usage: chia rpc wallet [OPTIONS] did_get_information_needed_for_recovery [REQUES Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :--- | :------- | :------------------------------------------------------------------ | +|:------------- |:------------ |:---- |:-------- |:------------------------------------------------------------------- | | -j | --json-file | TEXT | False | Instead of REQUEST, provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Parameter | Required | Description | -| :-------- | :------- | :---------------------------------------------------------------------------- | +|:--------- |:-------- |:----------------------------------------------------------------------------- | | wallet_id | True | The Wallet ID of the DID wallet from which to obtain the recovery information |
@@ -503,14 +503,14 @@ Usage: chia rpc wallet [OPTIONS] did_get_metadata [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :--- | :------- | :------------------------------------------------------------------ | +|:------------- |:------------ |:---- |:-------- |:------------------------------------------------------------------- | | -j | --json-file | TEXT | False | Instead of REQUEST, provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Parameter | Required | Description | -| :-------- | :------- | :----------------------------------------------------------------- | +|:--------- |:-------- |:------------------------------------------------------------------ | | wallet_id | True | The Wallet ID of the DID wallet for which to get the metadata list |
@@ -546,14 +546,14 @@ Usage: chia rpc wallet [OPTIONS] did_get_pubkey [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :--- | :------- | :------------------------------------------------------------------ | +|:------------- |:------------ |:---- |:-------- |:------------------------------------------------------------------- | | -j | --json-file | TEXT | False | Instead of REQUEST, provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Parameter | Required | Description | -| :-------- | :------- | :------------------------------------------------------------------ | +|:--------- |:-------- |:------------------------------------------------------------------- | | wallet_id | True | The Wallet ID of the DID wallet from which to obtain the public key |
@@ -585,14 +585,14 @@ Usage: chia rpc wallet [OPTIONS] did_get_recovery_list [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :--- | :------- | :------------------------------------------------------------------ | +|:------------- |:------------ |:---- |:-------- |:------------------------------------------------------------------- | | -j | --json-file | TEXT | False | Instead of REQUEST, provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Parameter | Required | Description | -| :-------- | :------- | :----------------------------------------------------------------- | +|:--------- |:-------- |:------------------------------------------------------------------ | | wallet_id | True | The Wallet ID of the DID wallet for which to get the recovery list |
@@ -629,14 +629,14 @@ Usage: chia rpc wallet [OPTIONS] did_get_wallet_name [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :--- | :------- | :------------------------------------------------------------------ | +|:------------- |:------------ |:---- |:-------- |:------------------------------------------------------------------- | | -j | --json-file | TEXT | False | Instead of REQUEST, provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Parameter | Required | Description | -| :-------- | :------- | :------------------------------------------------------- | +|:--------- |:-------- |:-------------------------------------------------------- | | wallet_id | True | The Wallet ID of the DID wallet on which to get the name |
@@ -669,14 +669,14 @@ Usage: chia rpc wallet [OPTIONS] did_message_spend [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :------------------- | :----- | :------- | :-------------------------------------------------------------- | +|:-------------------- |:------ |:-------- |:--------------------------------------------------------------- | | wallet_id | NUMBER | True | The Wallet ID of the DID wallet from which to spend the message | | coin_announcements | LIST | False | A list of coin announcements to include with the spend | | puzzle_announcements | LIST | False | A list of puzzle announcements to include with the spend | @@ -723,14 +723,14 @@ Usage: chia rpc wallet [OPTIONS] did_recovery_spend [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :--- | :------- | :------------------------------------------------------------------ | +|:------------- |:------------ |:---- |:-------- |:------------------------------------------------------------------- | | -j | --json-file | TEXT | False | Instead of REQUEST, provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Parameter | Required | Description | -| :---------- | :------- | :-------------------------------------------------------------------------------------------------------------- | +|:----------- |:-------- |:--------------------------------------------------------------------------------------------------------------- | | wallet_id | True | The Wallet ID of the DID wallet to recover | | attest_data | True | A list of attest files to be used for recovery | | pubkey | False | The public key of the wallet to recover. If this is not provided, a temporary public key will be used instead | @@ -1063,14 +1063,14 @@ Usage: chia rpc wallet [OPTIONS] did_set_wallet_name [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :--- | :------- | :------------------------------------------------------------------ | +|:------------- |:------------ |:---- |:-------- |:------------------------------------------------------------------- | | -j | --json-file | TEXT | False | Instead of REQUEST, provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Parameter | Required | Description | -| :-------- | :------- | :------------------------------------------------------- | +|:--------- |:-------- |:-------------------------------------------------------- | | wallet_id | True | The Wallet ID of the DID wallet on which to set the name | | name | True | The new name of the DID wallet | @@ -1125,19 +1125,19 @@ Usage: chia rpc wallet [OPTIONS] did_transfer_did [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :--- | :------- | :------------------------------------------------------------------ | +|:------------- |:------------ |:---- |:-------- |:------------------------------------------------------------------- | | -j | --json-file | TEXT | False | Instead of REQUEST, provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: -| Parameter | Required | Description | -| :----------------- | :------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| wallet_id | True | The Wallet ID of the DID wallet to transfer | -| inner_address | True | The address of the inner puzzle to which to transfer the DID | -| fee | False | An optional blockchain fee, in mojos | +| Parameter | Required | Description | +|:-------------------- |:-------- |:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| wallet_id | True | The Wallet ID of the DID wallet to transfer | +| inner_address | True | The address of the inner puzzle to which to transfer the DID | +| fee | False | An optional blockchain fee, in mojos | | with_recovery_info | False | If `True`, transfer recovery info [Default: `True`] | -| reuse_puzhash | False | If `true`, will not generate a new puzzle hash / address for this transaction only. Note that setting this parameter to `true` will override the global default setting from config.yaml | +| reuse_puzhash | False | If `true`, will not generate a new puzzle hash / address for this transaction only. Note that setting this parameter to `true` will override the global default setting from config.yaml |
Example @@ -1214,14 +1214,14 @@ Usage: chia rpc wallet [OPTIONS] did_update_metadata [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :--- | :------- | :------------------------------------------------------------------ | +|:------------- |:------------ |:---- |:-------- |:------------------------------------------------------------------- | | -j | --json-file | TEXT | False | Instead of REQUEST, provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Parameter | Required | Description | -| :------------ | :------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +|:------------- |:-------- |:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | wallet_id | True | The Wallet ID of the DID wallet for which to update the metadata | | metadata | False | The updated metadata | | fee | False | An optional blockchain fee, in mojos | @@ -1255,19 +1255,19 @@ Usage: chia rpc wallet [OPTIONS] did_update_recovery_ids [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :--- | :------- | :------------------------------------------------------------------ | +|:------------- |:------------ |:---- |:-------- |:------------------------------------------------------------------- | | -j | --json-file | TEXT | False | Instead of REQUEST, provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: -| Parameter | Required | Description | -| :------------------------- | :------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| wallet_id | True | The Wallet ID of the DID wallet for which to update the recovery IDs | -| new_list | True | The new recovery ID list. Each item from this list will be appended to the existing list | +| Parameter | Required | Description | +|:---------------------------- |:-------- |:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| wallet_id | True | The Wallet ID of the DID wallet for which to update the recovery IDs | +| new_list | True | The new recovery ID list. Each item from this list will be appended to the existing list | | num_verifications_required | False | Optionally set the number of IDs required for wallet recovery. If not set, then the entire updated list will be required by default | -| fee | False | An optional blockchain fee, in mojos | -| reuse_puzhash | False | If `true`, will not generate a new puzzle hash / address for this transaction only. Note that setting this parameter to `true` will override the global default setting from config.yaml | +| fee | False | An optional blockchain fee, in mojos | +| reuse_puzhash | False | If `true`, will not generate a new puzzle hash / address for this transaction only. Note that setting this parameter to `true` will override the global default setting from config.yaml |
Example diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/rpc-reference/farmer.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/rpc-reference/farmer.md index c80a71b037..23d4dc186b 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/rpc-reference/farmer.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/rpc-reference/farmer.md @@ -38,7 +38,7 @@ Usage: chia rpc farmer [OPTIONS] get_harvesters [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | @@ -99,7 +99,7 @@ Usage: chia rpc farmer [OPTIONS] get_harvesters_summary [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | @@ -149,14 +149,14 @@ Usage: chia rpc farmer [OPTIONS] get_harvester_plots_duplicates [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :-------- | :--------- | :------- | :------------------------------------------------------------------------------- | +|:--------- |:---------- |:-------- |:-------------------------------------------------------------------------------- | | node_id | HEX STRING | True | This node's `node_id`, obtainable from the [get_harvesters](#get_harvesters) RPC | | page | INTEGER | True | The page in the results sequence to list (starts with `0`) | | page_size | INTEGER | True | The number of entries per page to list | @@ -196,14 +196,14 @@ Usage: chia rpc farmer [OPTIONS] get_harvester_plots_invalid [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :-------- | :--------- | :------- | :------------------------------------------------------------------------------- | +|:--------- |:---------- |:-------- |:-------------------------------------------------------------------------------- | | node_id | HEX STRING | True | This node's `node_id`, obtainable from the [get_harvesters](#get_harvesters) RPC | | page | INTEGER | True | The page in the results sequence to list (starts with `0`) | | page_size | INTEGER | True | The number of entries per page to list | @@ -243,14 +243,14 @@ Usage: chia rpc farmer [OPTIONS] get_harvester_plots_keys_missing [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :-------- | :--------- | :------- | :------------------------------------------------------------------------------- | +|:--------- |:---------- |:-------- |:-------------------------------------------------------------------------------- | | node_id | HEX STRING | True | This node's `node_id`, obtainable from the [get_harvesters](#get_harvesters) RPC | | page | INTEGER | True | The page in the results sequence to list (starts with `0`) | | page_size | INTEGER | True | The number of entries per page to list | @@ -296,14 +296,14 @@ Usage: chia rpc farmer [OPTIONS] get_harvester_plots_valid [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :-------- | :--------- | :------- | :------------------------------------------------------------------------------- | +|:--------- |:---------- |:-------- |:-------------------------------------------------------------------------------- | | node_id | HEX STRING | True | This node's `node_id`, obtainable from the [get_harvesters](#get_harvesters) RPC | | page | INTEGER | True | The page in the results sequence to list (starts with `0`) | | page_size | INTEGER | True | The number of entries per page to list | @@ -354,14 +354,14 @@ Usage: chia rpc farmer [OPTIONS] get_pool_login_link [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: -| Flag | Type | Required | Description | -| :---------- | :--------- | :------- | :---------------------------------------------------------------------------------------- | +| Flag | Type | Required | Description | +|:----------- |:---------- |:-------- |:------------------------------------------------------------------------------------------- | | launcher_id | HEX STRING | True | The launcher_id from your pool, obtainable from the [get_pool_state](#get_pool_state) RPC |
@@ -393,7 +393,7 @@ Usage: chia rpc farmer [OPTIONS] get_pool_state [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | @@ -470,14 +470,14 @@ Usage: chia rpc farmer [OPTIONS] get_reward_targets [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: -| Flag | Type | Required | Description | -| :--------------------- | :------ | :------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Flag | Type | Required | Description | +|:------------------------ |:------- |:-------- |:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | search_for_private_key | BOOLEAN | True | List whether the private key (sk) is available for both the farmer and pool keys | | max_ph_to_search | INTEGER | False | The maximum number of puzzle hashes to search [Default: 500] If the wallet's derivation index is large, this number may be insufficient to locate the correct puzzle hashes. In this case, you may need to increase this value | @@ -511,7 +511,7 @@ Usage: chia rpc farmer [OPTIONS] get_routes [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | @@ -566,14 +566,14 @@ Usage: chia rpc farmer [OPTIONS] get_signage_point [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :------ | :--------- | :------- | :------------------------------------------------------------------------------------- | +|:------- |:---------- |:-------- |:-------------------------------------------------------------------------------------- | | sp_hash | HEX STRING | True | The hash of a signage point, listed as `pos_ss_cc_challenge_hash` in the block details |
@@ -613,7 +613,7 @@ Usage: chia rpc farmer [OPTIONS] get_signage_points [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | @@ -706,16 +706,16 @@ Usage: chia rpc farmer [OPTIONS] set_payout_instructions [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: -| Flag | Type | Required | Description | -| :------------------ | :--------- | :------- | :---------------------------------------------------------------------------------------- | +| Flag | Type | Required | Description | +|:------------------- |:---------- |:-------- |:------------------------------------------------------------------------------------------- | | launcher_id | HEX STRING | True | The launcher_id from your pool, obtainable from the [get_pool_state](#get_pool_state) RPC | -| payout_instructions | HEX STRING | True | The puzzle hash to be used as the new `payout_instructions` | +| payout_instructions | HEX STRING | True | The puzzle hash to be used as the new `payout_instructions` |
Example @@ -745,14 +745,14 @@ Usage: chia rpc farmer [OPTIONS] set_reward_targets [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :------------ | :--------- | :------- | :--------------------------- | +|:------------- |:---------- |:-------- |:---------------------------- | | farmer_target | HEX STRING | False | Set the farmer reward target | | pool_target | HEX STRING | False | Set the pool reward target | diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/rpc-reference/full-node.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/rpc-reference/full-node.md index 698efd9ae9..4fec64218f 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/rpc-reference/full-node.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/rpc-reference/full-node.md @@ -54,8 +54,8 @@ Options: Request Parameters: -| Flag | Type | Required | Description | -| :---------- | :--------- | :------- | :--------------------------- | +| Flag | Type | Required | Description | +| :------------------------------- | :--------- | :------- | :--------------------------- | | header_hash | HEX STRING | True | The header hash of the block | :::note @@ -822,8 +822,8 @@ Options: Request Parameters: -| Flag | Type | Required | Description | -| :---------- | :--------- | :------- | :-------------------------------------------------- | +| Flag | Type | Required | Description | +| :------------------------------- | :--------- | :------- | :------------------------------------------------------------------------------------- | | header_hash | HEX STRING | True | Header hash (block identifier) of the block to get. |
@@ -1066,10 +1066,10 @@ Options: Request Parameters: -| Flag | Type | Required | Description | -| :------------------ | :------ | :------- | :------------------------------------------------------------------ | -| start | INTEGER | True | The start height | -| end | INTEGER | True | The end height (non-inclusive) | +| Flag | Type | Required | Description | +| :------------------------------------------------------------ | :------ | :------- | :-------------------------------------------------------------------------------------------------------------------------------------- | +| start | INTEGER | True | The start height | +| end | INTEGER | True | The end height (non-inclusive) | | exclude_header_hash | BOOLEAN | False | Whether to exclude the header hash in the response [Default: false] |
@@ -1390,8 +1390,8 @@ Options: Request Parameters: -| Flag | Type | Required | Description | -| :---------- | :--------- | :------- | :------------------------ | +| Flag | Type | Required | Description | +| :------------------------------- | :--------- | :------- | :------------------------ | | header_hash | HEX STRING | True | The block's `header_hash` |
@@ -1474,8 +1474,8 @@ Options: Request Parameters: -| Flag | Type | Required | Description | -| :---- | :------ | :------- | :----------------------------- | +| Flag | Type | Required | Description | +| :---- | :------ | :------- | :------------------------------------------------ | | start | INTEGER | True | The start height (inclusive) | | end | INTEGER | True | The end height (non-inclusive) | @@ -1644,8 +1644,8 @@ Options: Request Parameters: -| Flag | Type | Required | Description | -| :----- | :------ | :------- | :------------------------------------------ | +| Flag | Type | Required | Description | +| :----- | :------ | :------- | :--------------------------------------------------------------------------------------- | | height | INTEGER | True | The height to get (must be \<= peak height) | :::note @@ -1754,8 +1754,8 @@ Options: Request Parameters: -| Flag | Type | Required | Description | -| :---------- | :--------- | :------- | :------------------------ | +| Flag | Type | Required | Description | +| :------------------------------- | :--------- | :------- | :------------------------ | | header_hash | HEX STRING | True | The block's `header_hash` | :::note @@ -2012,8 +2012,8 @@ Options: Request Parameters: -| Flag | Type | Required | Description | -| :---------- | :--------- | :------- | :------------------------ | +| Flag | Type | Required | Description | +| :------------------------------- | :--------- | :------- | :------------------------ | | header_hash | HEX STRING | True | The block's `header_hash` | :::note @@ -2132,11 +2132,11 @@ Options: Request Parameters: -| Flag | Type | Required | Description | -| :------------------ | :--------- | :------- | :------------------------------------------------------------------ | -| hint | HEX STRING | True | The hint to examine | -| start_height | INTEGER | False | The block height at which to begin the search | -| end_height | INTEGER | False | The block height at which to end the search | +| Flag | Type | Required | Description | +| :------------------------------------------------------------ | :--------- | :------- | :------------------------------------------------------------------------------------- | +| hint | HEX STRING | True | The hint to examine | +| start_height | INTEGER | False | The block height at which to begin the search | +| end_height | INTEGER | False | The block height at which to end the search | | include_spent_coins | BOOLEAN | False | A boolean indicating whether to include spent coins (default=false) |
@@ -2203,11 +2203,11 @@ Options: Request Parameters: -| Flag | Type | Required | Description | -| :------------------ | :--------------- | :------- | :------------------------------------------------------------------ | -| names | HEX STRING ARRAY | True | A list of coin_ids to examine | -| start_height | INTEGER | False | The block height at which to begin the search | -| end_height | INTEGER | False | The block height at which to end the search | +| Flag | Type | Required | Description | +| :------------------------------------------------------------ | :--------------- | :------- | :------------------------------------------------------------------------------------- | +| names | HEX STRING ARRAY | True | A list of coin_ids to examine | +| start_height | INTEGER | False | The block height at which to begin the search | +| end_height | INTEGER | False | The block height at which to end the search | | include_spent_coins | BOOLEAN | False | A boolean indicating whether to include spent coins (default=false) |
@@ -2274,11 +2274,11 @@ Options: Request Parameters: -| Flag | Type | Required | Description | -| :------------------ | :--------------- | :------- | :------------------------------------------------------------------ | -| parent_ids | HEX STRING ARRAY | True | A list of parent IDs to examine | -| start_height | INTEGER | False | The block height at which to begin the search | -| end_height | INTEGER | False | The block height at which to end the search | +| Flag | Type | Required | Description | +| :------------------------------------------------------------ | :--------------- | :------- | :------------------------------------------------------------------------------------- | +| parent_ids | HEX STRING ARRAY | True | A list of parent IDs to examine | +| start_height | INTEGER | False | The block height at which to begin the search | +| end_height | INTEGER | False | The block height at which to end the search | | include_spent_coins | BOOLEAN | False | A boolean indicating whether to include spent coins (default=false) |
@@ -2357,11 +2357,11 @@ Options: Request Parameters: -| Flag | Type | Required | Description | -| :------------------ | :--------- | :------- | :------------------------------------------------------------------ | -| puzzle_hash | HEX STRING | True | The puzzle hash to search for | -| start_height | INTEGER | False | The block height at which to begin the search | -| end_height | INTEGER | False | The block height at which to end the search | +| Flag | Type | Required | Description | +| :------------------------------------------------------------ | :--------- | :------- | :------------------------------------------------------------------------------------- | +| puzzle_hash | HEX STRING | True | The puzzle hash to search for | +| start_height | INTEGER | False | The block height at which to begin the search | +| end_height | INTEGER | False | The block height at which to end the search | | include_spent_coins | BOOLEAN | False | A boolean indicating whether to include spent coins (default=false) |
@@ -2464,11 +2464,11 @@ Options: Request Parameters: -| Flag | Type | Required | Description | -| :------------------ | :--------------- | :------- | :------------------------------------------------------------------ | -| puzzle_hashes | HEX STRING ARRAY | True | An array of puzzle hashes to examine | -| start_height | INTEGER | False | The block height at which to begin the search | -| end_height | INTEGER | False | The block height at which to end the search | +| Flag | Type | Required | Description | +| :------------------------------------------------------------ | :--------------- | :------- | :------------------------------------------------------------------------------------- | +| puzzle_hashes | HEX STRING ARRAY | True | An array of puzzle hashes to examine | +| start_height | INTEGER | False | The block height at which to begin the search | +| end_height | INTEGER | False | The block height at which to end the search | | include_spent_coins | BOOLEAN | False | A boolean indicating whether to include spent coins (default=false) |
@@ -2607,11 +2607,11 @@ Options: Request Parameters: -| Parameter | Type | Required | Description | -| :----------- | :------------ | :------- | ----------------------------------------------------------------------------------------------------------------------------------- | +| Parameter | Type | Required | Description | +| :-------------------------------- | :------------ | :------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | spend_bundle | FILENAME | True\* | The spend bundle file (in json format) for which to estimate the fee (\* Exactly one of `spend_bundle` or `cost` must be specified) | -| cost | INTEGER | True\* | The CLVM cost for which to estimate the fee (\* Exactly one of `spend_bundle` or `cost` must be specified) | -| target_times | INTEGER ARRAY | True | An array of the targeted times for transaction inclusion, in seconds. Each targeted time must be at least 0 | +| cost | INTEGER | True\* | The CLVM cost for which to estimate the fee (\* Exactly one of `spend_bundle` or `cost` must be specified) | +| target_times | INTEGER ARRAY | True | An array of the targeted times for transaction inclusion, in seconds. Each targeted time must be at least 0 | :::note @@ -2677,8 +2677,8 @@ Options: Request Parameters: -| Flag | Type | Required | Description | -| :---- | :--------- | :------- | :----------------------------------------------------------- | +| Flag | Type | Required | Description | +| :------------------------- | :--------- | :------- | :------------------------------------------------------------------------------ | | tx_id | HEX STRING | True | The spend bundle hash (tx ID) for which to retrieve the item |
@@ -2851,8 +2851,8 @@ Options: Request Parameters: -| Flag | Type | Required | Description | -| :-------- | :----- | :------- | :--------------------------------------------------------------------------------- | +| Flag | Type | Required | Description | +| :----------------------------- | :----- | :------- | :------------------------------------------------------------------------------------------------- | | coin_name | STRING | True | The ID of the coin to retreive. Must be in the mempool in order to return a result |
@@ -3017,8 +3017,8 @@ Options: Request Parameters: -| Flag | Type | Required | Description | -| :---------------------- | :--------- | :------- | :-------------------- | +| Flag | Type | Required | Description | +| :------------------------------------------------------------------------------------- | :--------- | :------- | :-------------------- | | older_block_header_hash | HEX STRING | True | The start header hash | | newer_block_header_hash | HEX STRING | True | The end header hash | @@ -3066,10 +3066,10 @@ Options: Request Parameters: -| Flag | Type | Required | Description | -| :------ | :--------- | :------- | :--------------------------------- | +| Flag | Type | Required | Description | +| :--------------------------- | :--------- | :------- | :--------------------------------- | | coin_id | HEX STRING | True | Coin ID of the coin to look up | -| height | INTEGER | True | Height at which the coin was spent | +| height | INTEGER | True | Height at which the coin was spent | :::note @@ -3126,10 +3126,10 @@ Options: Request Parameters: -| Flag | Type | Required | Description | -| :------------- | :--------- | :------- | :------------------------------------------------------------------------------- | -| sp_hash | HEX STRING | True\* | The hash of the output for a signage point (if it's in the middle of a sub slot) | -| challenge_hash | HEX STRING | True\* | The challenge_hash for the subslot (if it's an end of sub slot challenge) | +| Flag | Type | Required | Description | +| :---------------------------------- | :--------- | :------- | :---------------------------------------------------------------------------------------------------------------- | +| sp_hash | HEX STRING | True\* | The hash of the output for a signage point (if it's in the middle of a sub slot) | +| challenge_hash | HEX STRING | True\* | The challenge_hash for the subslot (if it's an end of sub slot challenge) | :::note @@ -3601,8 +3601,8 @@ Options: Request Parameters: -| Flag | Type | Required | Description | -| :----------- | :--- | :------- | :------------------------------ | +| Flag | Type | Required | Description | +| :-------------------------------- | :--- | :------- | :------------------------------ | | spend_bundle | JSON | True | Spend bundle to submit, in JSON |
@@ -3658,7 +3658,7 @@ each coin id that should be created by this spend bundle. The error status can be one of: - **SUCCESS**: if the transaction was successfully added to the mempool -- **PENDING**: if the transaction cannot be included yes due to timelocks or conflicts +- **PENDING**: if the transaction cannot be included yet due to timelocks or conflicts - **FAILED**: transaction was not added to the mempool, and was dropped ::: diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/rpc-reference/harvester.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/rpc-reference/harvester.md index 789b71f567..67a4040f3e 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/rpc-reference/harvester.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/rpc-reference/harvester.md @@ -38,14 +38,14 @@ Usage: chia rpc harvester [OPTIONS] add_plot_directory [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :------ | :--- | :------- | :------------------------------------ | +|:------- |:---- |:-------- |:------------------------------------- | | dirname | TEXT | True | The full path of the directory to add | :::note @@ -90,14 +90,14 @@ Usage: chia rpc harvester [OPTIONS] delete_plot [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :------- | :--- | :------- | :---------------------------------- | +|:-------- |:---- |:-------- |:----------------------------------- | | filename | TEXT | True | The file name of the plot to delete | :::note @@ -134,7 +134,7 @@ Usage: chia rpc harvester [OPTIONS] get_plots [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | @@ -204,7 +204,7 @@ Usage: chia rpc harvester [OPTIONS] get_plot_directories [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | @@ -242,7 +242,7 @@ Usage: chia rpc harvester [OPTIONS] get_routes [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | @@ -290,7 +290,7 @@ Usage: chia rpc harvester [OPTIONS] refresh_plots [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | @@ -330,14 +330,14 @@ Usage: chia rpc harvester [OPTIONS] remove_plot_directory [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :------ | :--- | :------- | :--------------------------------------- | +|:------- |:---- |:-------- |:---------------------------------------- | | dirname | TEXT | True | The full path of the directory to remove | :::note diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/rpc-reference/nfts.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/rpc-reference/nfts.md index 72586bbcc4..4f196120a2 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/rpc-reference/nfts.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/rpc-reference/nfts.md @@ -37,16 +37,16 @@ Usage: chia rpc wallet [OPTIONS] nft_add_uri [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :--- | :------- | :------------------------------------------------------------------ | +|:------------- |:------------ |:---- |:-------- |:------------------------------------------------------------------- | | -j | --json-file | TEXT | False | Instead of REQUEST, provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :------------ | :--------- | :------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +|:------------- |:---------- |:-------- |:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | wallet_id | NUMBER | True | The Wallet ID of the DID wallet to transfer | -| nft_coin_id | HEX STRING | True | The coin ID of the NFT on which to add a URI | +| nft_coin_id | HEX STRING | True | The coin ID of the NFT on which to add a URI | | key | STRING | True | Must be either `u` (data URI), `mu` (metadata URI), or `lu` (license URI) | | uri | STRING | True | The URI to add | | fee | NUMBER | False | The one-time blockchain fee to be used upon adding a URI | @@ -156,14 +156,14 @@ Usage: chia rpc wallet [OPTIONS] nft_calculate_royalties [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :--- | :------- | :------------------------------------------------------------------ | +|:------------- |:------------ |:---- |:-------- |:------------------------------------------------------------------- | | -j | --json-file | TEXT | False | Instead of REQUEST, provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Parameter | Sub-Parameter | Required | Description | -| :-------------- | :------------------------------------------------------------------------------ | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +|:--------------- |:------------------------------------------------------------------------------- |:-------- |:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | royalty_assets | Each royalty asset requires three sub-parameters, listed on the following lines | False | A list of NFTs for which to calculate royalties. If this parameter is not included, then nothing will be returned | | | asset | True | The asset ID of the NFT to be traded. This is only used for display in the response; a bogus value may be used | | | royalty_address | True | The address where the royalties will be sent. A bogus value may be used | @@ -259,14 +259,14 @@ Usage: chia rpc wallet [OPTIONS] nft_count_nfts [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :--- | :------- | :------------------------------------------------------------------ | +|:------------- |:------------ |:---- |:-------- |:------------------------------------------------------------------- | | -j | --json-file | TEXT | False | Instead of REQUEST, provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :-------- | :----- | :------- | :--------------------------------------------------------------------------- | +|:--------- |:------ |:-------- |:---------------------------------------------------------------------------- | | wallet_id | NUMBER | False | The ID of the wallet in which to count NFTs [Default: null (count all NFTs)] |
@@ -339,14 +339,14 @@ Usage: chia rpc wallet [OPTIONS] nft_get_by_did [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :--- | :------- | :------------------------------------------------------------------ | +|:------------- |:------------ |:---- |:-------- |:------------------------------------------------------------------- | | -j | --json-file | TEXT | False | Instead of REQUEST, provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :----- | :----- | :------- | :-------------------- | +|:------ |:------ |:-------- |:--------------------- | | did_id | NUMBER | True | The DID ID to examine |
@@ -378,14 +378,14 @@ Usage: chia rpc wallet [OPTIONS] nft_get_info [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :--- | :------- | :------------------------------------------------------------------ | +|:------------- |:------------ |:---- |:-------- |:------------------------------------------------------------------- | | -j | --json-file | TEXT | False | Instead of REQUEST, provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :-------- | :----- | :------- | :--------------------------------------------------- | +|:--------- |:------ |:-------- |:---------------------------------------------------- | | coin_id | NUMBER | True | The coin ID of the NFT about which to retrieve info | | wallet_id | NUMBER | False | The Wallet ID of the NFT from which to retrieve info | @@ -509,14 +509,14 @@ Usage: chia rpc wallet [OPTIONS] nft_get_nfts [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :--- | :------- | :------------------------------------------------------------------ | +|:------------- |:------------ |:---- |:-------- |:------------------------------------------------------------------- | | -j | --json-file | TEXT | False | Instead of REQUEST, provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :---------- | :----- | :------- | :----------------------------------------------------------------- | +|:----------- |:------ |:-------- |:------------------------------------------------------------------ | | wallet_id | NUMBER | True | The Wallet ID from which to retrieve the NFTs | | start_index | NUMBER | False | The NFT index at which to start retrieving the NFTs [Default: `0`] | | num | NUMBER | False | The maximum number of NFTs to retrieve [Default: `0`] | @@ -575,7 +575,7 @@ Usage: chia rpc wallet [OPTIONS] nft_get_wallets_with_dids Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :--- | :------- | :------------------------------------------------------------------ | +|:------------- |:------------ |:---- |:-------- |:------------------------------------------------------------------- | | -j | --json-file | TEXT | False | Instead of REQUEST, provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | @@ -616,14 +616,14 @@ Usage: chia rpc wallet [OPTIONS] nft_get_wallet_did [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :--- | :------- | :------------------------------------------------------------------ | +|:------------- |:------------ |:---- |:-------- |:------------------------------------------------------------------- | | -j | --json-file | TEXT | False | Instead of REQUEST, provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :-------- | :----- | :------- | :----------------------------- | +|:--------- |:------ |:-------- |:------------------------------ | | wallet_id | NUMBER | True | The Wallet ID of an NFT wallet |
@@ -655,30 +655,30 @@ Usage: chia rpc wallet [OPTIONS] nft_mint_bulk [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :--- | :------- | :------------------------------------------------------------------ | +|:------------- |:------------ |:---- |:-------- |:------------------------------------------------------------------- | | -j | --json-file | TEXT | False | Instead of REQUEST, provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: -| Flag | Type | Required | Description | -| :--------------------- | :----------- | :------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| wallet_id | NUMBER | True | The ID of the NFT wallet to use for bulk minting | -| metadata_list | STRING ARRAY | True | A list of dicts containing the metadata for each NFT to be minted | -| royalty_percentage | NUMBER | False | The royalty that will go to the original artist each time the NFT is sold. The percentage is multiplied by 100 -- for example, to set a 3% royalty, set this value to 300. The default value is 0 | -| royalty_address | STRING | False | The wallet address of the NFT's artist. This is where royalties will be sent. It could be either an XCH address or a DID address | -| target_list | STRING ARRAY | False | A list of wallet addresses where the NFTs will be sent upon minting | +| Flag | Type | Required | Description | +|:------------------------ |:------------ |:-------- |:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| wallet_id | NUMBER | True | The ID of the NFT wallet to use for bulk minting | +| metadata_list | STRING ARRAY | True | A list of dicts containing the metadata for each NFT to be minted | +| royalty_percentage | NUMBER | False | The royalty that will go to the original artist each time the NFT is sold. The percentage is multiplied by 100 -- for example, to set a 3% royalty, set this value to 300. The default value is 0 | +| royalty_address | STRING | False | The wallet address of the NFT's artist. This is where royalties will be sent. It could be either an XCH address or a DID address | +| target_list | STRING ARRAY | False | A list of wallet addresses where the NFTs will be sent upon minting | | mint_number_start | NUMBER | False | The starting point for mint number used in intermediate launcher puzzle. Default: 1 | -| mint_total | NUMBER | False | The total number of NFTs in the collection. Note that this is not necessarily reflective of the number of NFTs this command will create in the spend bundle, which is derived based on the `metadata_list`. For example, you could set `mint_total` to `1000` and pass only 10 dicts in `metadata_list`. | +| mint_total | NUMBER | False | The total number of NFTs in the collection. Note that this is not necessarily reflective of the number of NFTs this command will create in the spend bundle, which is derived based on the `metadata_list`. For example, you could set `mint_total` to `1000` and pass only 10 dicts in `metadata_list`. | | xch_coin_list | STRING ARRAY | False | A list of coins to be used for funding the minting spend. These coins can be created in the future | | xch_change_target | HEX STRING | False | For use with bulk minting, so we can specify the puzzle hash that the change from the funding transaction goes to. | -| new_innerpuzhash | HEX STRING | False | The new inner puzzle hash for the DID once it is spent. For bulk minting we generally don't provide this as the default behaviour is to re-use the existing inner puzzle hash | +| new_innerpuzhash | HEX STRING | False | The new inner puzzle hash for the DID once it is spent. For bulk minting we generally don't provide this as the default behaviour is to re-use the existing inner puzzle hash | | new_p2_puzhash | HEX STRING | False | The new p2 puzzle hash for the DID once it is spent. For bulk minting we generally don't provide this as the default behaviour is to re-use the existing inner puzzle hash | | did_coin_dict | DICTIONARY | False | The did coin to use for minting. Required for bulk minting when the DID coin will be created in the future | | did_lineage_parent_hex | HEX STRING | False | The parent coin to use for the lineage proof in the DID spend. Needed for bulk minting when the coin will be created in the future | | mint_from_did | BOOLEAN | False | Boolean to determine whether to mint from a DID. Default: false | -| fee | NUMBER | False | A blockchain fee to be deducted with each mint | -| reuse_puzhash | BOOLEAN | False | If `true`, will not generate a new puzzle hash / address for this transaction only. Note that setting this parameter to `true` will override the global default setting from config.yaml | +| fee | NUMBER | False | A blockchain fee to be deducted with each mint | +| reuse_puzhash | BOOLEAN | False | If `true`, will not generate a new puzzle hash / address for this transaction only. Note that setting this parameter to `true` will override the global default setting from config.yaml |
Example @@ -706,7 +706,7 @@ chia rpc wallet nft_mint_bulk '{ "wallet_id": 5, "royalty_address": "txch1zda49pjkj4hkv50fesvagf86f7pnlq68ej629dzp2hqa7p5n88sqtwnfuy", "royalty_percentage": 175, - "target_address_list": [ + "target_list": [ "txch1zda49pjkj4hkv50fesvagf86f7pnlq68ej629dzp2hqa7p5n88sqtwnfuy" ], "mint_number_start": 1, @@ -785,14 +785,14 @@ Usage: chia rpc wallet [OPTIONS] nft_mint_nft [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :--- | :------- | :------------------------------------------------------------------ | +|:------------- |:------------ |:---- |:-------- |:------------------------------------------------------------------- | | -j | --json-file | TEXT | False | Instead of REQUEST, provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :----------------- | :----------- | :------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- | +|:------------------ |:------------ |:-------- |:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | wallet_id | NUMBER | True | The Wallet ID in which to mint an NFT | | uris | STRING ARRAY | True | A list of URIs to mark the location(s) of the NFT | | hash | HEX STRING | True | The hash of the NFT's data. This should use sha256 for proper verification against the URI list | @@ -803,7 +803,7 @@ Request Parameters: | license_hash | HEX STRING | False | The hash of the NFT's license | | royalty_address | STRING | False | The wallet address of the NFT's artist. This is where royalties will be sent. It could be either an XCH address or a DID address | | royalty_percentage | NUMBER | False | The royalty that will go to the original artist each time the NFT is sold. The percentage is multiplied by 100 -- for example, to set a 3% royalty, set this value to 300. The default value is 0 | -| target_address | STRING | False | The wallet address of the initial owner of the NFT. This may be the same as the royalty address | | +| target_address | STRING | False | The wallet address of the initial owner of the NFT. This may be the same as the royalty address | | edition_number | NUMBER | False | If this NFT has multiple editions (multiple identical copies of an NFT), then this parameter indicates the edition number of this NFT. | | edition_total | NUMBER | False | If this NFT has multiple editions, then this parameter indicates the total number of editions of this NFT. This parameter should be used if and only if the `edition_number` parameter was also used | | fee | NUMBER | False | The one-time blockchain fee to be used upon minting the NFT | @@ -985,18 +985,18 @@ Usage: chia rpc wallet [OPTIONS] nft_set_did_bulk [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :--- | :------- | :------------------------------------------------------------------ | +|:------------- |:------------ |:---- |:-------- |:------------------------------------------------------------------- | | -j | --json-file | TEXT | False | Instead of REQUEST, provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: -| Flag | Type | Required | Description | -| :------------ | :----------- | :------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Flag | Type | Required | Description | +|:--------------- |:------------ |:-------- |:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | nft_coin_list | STRING ARRAY | True | A list of coin IDs corresponding to the NFTs, along with the current wallet_ids. Syntax: `[{"nft_coin_id": COIN_ID/NFT_ID, "wallet_id": WALLET_ID}, ...]` | -| did_id | STRING | False | The ID of the DID to which to transfer the NFTs. [Default: no DID (reset the NFTs' DIDs)] | -| fee | NUMBER | False | An optional blockchain fee | -| reuse_puzhash | BOOLEAN | False | If `true`, will not generate a new puzzle hash / address for this transaction only. Note that setting this parameter to `true` will override the global default setting from config.yaml | +| did_id | STRING | False | The ID of the DID to which to transfer the NFTs. [Default: no DID (reset the NFTs' DIDs)] | +| fee | NUMBER | False | An optional blockchain fee | +| reuse_puzhash | BOOLEAN | False | If `true`, will not generate a new puzzle hash / address for this transaction only. Note that setting this parameter to `true` will override the global default setting from config.yaml |
Example @@ -1088,16 +1088,16 @@ Usage: chia rpc wallet [OPTIONS] nft_set_nft_did [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :--- | :------- | :------------------------------------------------------------------ | +|:------------- |:------------ |:---- |:-------- |:------------------------------------------------------------------- | | -j | --json-file | TEXT | False | Instead of REQUEST, provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :------------ | :------ | :------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +|:------------- |:------- |:-------- |:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | wallet_id | NUMBER | True | The Wallet ID that holds the NFT on which to set the DID | -| nft_coin_id | NUMBER | True | The coin ID of the NFT on which to set the DID | +| nft_coin_id | NUMBER | True | The coin ID of the NFT on which to set the DID | | did_id | NUMBER | False | Optionally specify the DID to be associated with this NFT. If this parameter is not specified, the DID will be Unassigned | | fee | NUMBER | False | The one-time blockchain fee to be used upon adding a URI | | reuse_puzhash | BOOLEAN | False | If `true`, will not generate a new puzzle hash / address for this transaction only. Note that setting this parameter to `true` will override the global default setting from config.yaml | @@ -1270,14 +1270,14 @@ Usage: chia rpc wallet [OPTIONS] nft_set_nft_status [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :--- | :------- | :------------------------------------------------------------------ | +|:------------- |:------------ |:---- |:-------- |:------------------------------------------------------------------- | | -j | --json-file | TEXT | False | Instead of REQUEST, provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :------------- | :------ | :------- | :-------------------------------------------------- | +|:-------------- |:------- |:-------- |:--------------------------------------------------- | | wallet_id | NUMBER | True | The ID of an NFT wallet | | coin_id | NUMBER | True | The coin_id of the NFT on which to set the status | | in_transaction | BOOLEAN | True | A boolean to set the transaction status for the NFT | @@ -1310,18 +1310,18 @@ Usage: chia rpc wallet [OPTIONS] nft_transfer_bulk [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :--- | :------- | :------------------------------------------------------------------ | +|:------------- |:------------ |:---- |:-------- |:------------------------------------------------------------------- | | -j | --json-file | TEXT | False | Instead of REQUEST, provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: -| Flag | Type | Required | Description | -| :------------- | :----------- | :------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| nft_coin_list | STRING ARRAY | True | A list of coin IDs corresponding to the NFTs, along with the current wallet_ids. Syntax: `[{"nft_coin_id": COIN_ID/NFT_ID, "wallet_id": WALLET_ID}, ...]` | -| target_address | STRING | True | The address to which to transfer the NFTs | -| fee | NUMBER | False | An optional blockchain fee | -| reuse_puzhash | BOOLEAN | False | If `true`, will not generate a new puzzle hash / address for this transaction only. Note that setting this parameter to `true` will override the global default setting from config.yaml | +| Flag | Type | Required | Description | +|:--------------- |:------------ |:-------- |:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| nft_coin_list | STRING ARRAY | True | A list of coin IDs corresponding to the NFTs, along with the current wallet_ids. Syntax: `[{"nft_coin_id": COIN_ID/NFT_ID, "wallet_id": WALLET_ID}, ...]` | +| target_address | STRING | True | The address to which to transfer the NFTs | +| fee | NUMBER | False | An optional blockchain fee | +| reuse_puzhash | BOOLEAN | False | If `true`, will not generate a new puzzle hash / address for this transaction only. Note that setting this parameter to `true` will override the global default setting from config.yaml |
Example @@ -1404,17 +1404,17 @@ Usage: chia rpc wallet [OPTIONS] nft_transfer_nft [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :--- | :------- | :------------------------------------------------------------------ | +|:------------- |:------------ |:---- |:-------- |:------------------------------------------------------------------- | | -j | --json-file | TEXT | False | Instead of REQUEST, provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :------------- | :--------- | :------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +|:-------------- |:---------- |:-------- |:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | wallet_id | NUMBER | True | The Wallet ID of the NFT to transfer | | target_address | STRING | True | The address to transfer the NFT to. For NFT0 this must be an XCH address. For NFT1 this could also be a DID address | -| nft_coin_id | HEX STRING | True | The coin ID of the NFT to transfer | +| nft_coin_id | HEX STRING | True | The coin ID of the NFT to transfer | | fee | NUMBER | False | The one-time blockchain fee to be used upon transferring the NFT | | reuse_puzhash | BOOLEAN | False | If `true`, will not generate a new puzzle hash / address for this transaction only. Note that setting this parameter to `true` will override the global default setting from config.yaml | diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/rpc-reference/offers.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/rpc-reference/offers.md index 0d3e838589..216f85adde 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/rpc-reference/offers.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/rpc-reference/offers.md @@ -37,17 +37,17 @@ Usage: chia rpc wallet [OPTIONS] cancel_offer [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :--- | :------- | :------------------------------------------------------------------ | +|:------------- |:------------ |:---- |:-------- |:------------------------------------------------------------------- | | -j | --json-file | TEXT | False | Instead of REQUEST, provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: -| Flag | Type | Required | Description | -| :------- | :------ | :------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Flag | Type | Required | Description | +|:-------- |:------- |:-------- |:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | trade_id | STRING | True | The `trade_id` of the Offer to cancel. The `trade_id` of the Offer to cancel. Can be retrieved from an Offer file by calling `cdv inspect spendbundles ` | -| fee | NUMBER | False | An optional fee (in mojos) to include with the cancellation [Default: `0`] | -| secure | BOOLEAN | False | If `true`, then "cancel on blockchain," ie spend the coins being offered. If `false`, then cancel locally [Default: `true`] | +| fee | NUMBER | False | An optional fee (in mojos) to include with the cancellation [Default: `0`] | +| secure | BOOLEAN | False | If `true`, then "cancel on blockchain," ie spend the coins being offered. If `false`, then cancel locally [Default: `true`] | :::note @@ -83,14 +83,14 @@ Usage: chia rpc wallet [OPTIONS] cancel_offers [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :--- | :------- | :------------------------------------------------------------------ | +|:------------- |:------------ |:---- |:-------- |:------------------------------------------------------------------- | | -j | --json-file | TEXT | False | Instead of REQUEST, provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :--------- | :------ | :------- | :-------------------------------------------------------------------------------------------------------- | +|:---------- |:------- |:-------- |:--------------------------------------------------------------------------------------------------------- | | secure | BOOLEAN | True | If `true`, then "cancel on blockchain," ie spend the coins being offered. If `false`, then cancel locally | | fee | NUMBER | False | An optional fee (in mojos) to include with the cancellation [Default: `0`] | | batch_size | NUMBER | False | The number of Offers to cancel in one batch [Default: `5`] | @@ -125,14 +125,14 @@ Usage: chia rpc wallet [OPTIONS] check_offer_validity [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :--- | :------- | :------------------------------------------------------------------ | +|:------------- |:------------ |:---- |:-------- |:------------------------------------------------------------------- | | -j | --json-file | TEXT | False | Instead of REQUEST, provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :---- | :----- | :------- | :-------------------------------- | +|:----- |:------ |:-------- |:--------------------------------- | | offer | STRING | True | The text of the Offer to validate | :::note @@ -181,25 +181,25 @@ Usage: chia rpc wallet [OPTIONS] create_offer_for_ids [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :--- | :------- | :------------------------------------------------------------------ | +|:------------- |:------------ |:---- |:-------- |:------------------------------------------------------------------- | | -j | --json-file | TEXT | False | Instead of REQUEST, provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: -| Flag | Type | Required | Description | -| :-------------- | :------ | :------- | :-------------------------------------------------------------------------------------------------------------------------- | -| offer | OBJECT | True | A dictionary `[str, int]` of the Offer to create (see the examples below for specifics) | -| fee | NUMBER | False | An optional fee (in mojos) to include with the Offer [Default: `0`] | -| validate_only | BOOLEAN | False | Set to `true` to verify the validity of a potential Offer, rather than actually creating an Offer [Default: `false`] | -| driver_dict | OBJECT | False | A dictionary `[str, Any]` containing metadata of the asset being requested, for example an NFT's on-chain metadata | +| Flag | Type | Required | Description | +|:----------------- |:------- |:-------- |:--------------------------------------------------------------------------------------------------------------------------- | +| offer | OBJECT | True | A dictionary `[str, int]` of the Offer to create (see the examples below for specifics) | +| fee | NUMBER | False | An optional fee (in mojos) to include with the Offer [Default: `0`] | +| validate_only | BOOLEAN | False | Set to `true` to verify the validity of a potential Offer, rather than actually creating an Offer [Default: `false`] | +| driver_dict | OBJECT | False | A dictionary `[str, Any]` containing metadata of the asset being requested, for example an NFT's on-chain metadata | | min_coin_amount | NUMBER | False | The minimum coin size to be included in the Offer [Default: `0`] | | max_coin_amount | NUMBER | False | The maximum coin size to be included in the Offer [Default: `0`] | -| solver | | False | Default: None | -| min_height | NUMBER | False | The minimum block height that must be reached before this Offer becomes valid [Default: `null` (not used)] | -| min_time | NUMBER | False | The minimum UNIX timestamp that must be reached before this Offer becomes valid [Default: `null` (not used)] | -| max_height | NUMBER | False | The maximum block height where this Offer is still considered valid, aka the expiry height [Default: `null` (not used)] | -| max_time | NUMBER | False | The maximum UNIX timestamp where this Offer is stil considered valid, aka the expiry timestamp [Default: `null` (not used)] | +| solver | | False | Default: None | +| min_height | NUMBER | False | The minimum block height that must be reached before this Offer becomes valid [Default: `null` (not used)] | +| min_time | NUMBER | False | The minimum UNIX timestamp that must be reached before this Offer becomes valid [Default: `null` (not used)] | +| max_height | NUMBER | False | The maximum block height where this Offer is still considered valid, aka the expiry height [Default: `null` (not used)] | +| max_time | NUMBER | False | The maximum UNIX timestamp where this Offer is stil considered valid, aka the expiry timestamp [Default: `null` (not used)] | :::note @@ -722,22 +722,22 @@ Usage: chia rpc wallet [OPTIONS] get_all_offers [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :--- | :------- | :------------------------------------------------------------------ | +|:------------- |:------------ |:---- |:-------- |:------------------------------------------------------------------- | | -j | --json-file | TEXT | False | Instead of REQUEST, provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: -| Flag | Type | Required | Description | -| :------------------- | :------ | :------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| start | NUMBER | False | The first Offer to display, inclusive [Default: `0`] | -| end | NUMBER | False | The last Offer to display, exclusive [Default: `10`] | +| Flag | Type | Required | Description | +|:---------------------- |:------- |:-------- |:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| start | NUMBER | False | The first Offer to display, inclusive [Default: `0`] | +| end | NUMBER | False | The last Offer to display, exclusive [Default: `10`] | | exclude_my_offers | BOOLEAN | False | If `true`, don't show Offers that originated from this wallet [Default: `false`] | | exclude_taken_offers | BOOLEAN | False | If `true`, don't show any Offers with a status of `CONFIRMED` [Default: `false`] | -| include_completed | BOOLEAN | False | If `true`, show completed Offers [Default: `false`] | -| sort_key | STRING | False | Optionally change the sort order of the results, [sort_keys members](https://github.com/Chia-Network/chia-blockchain/blob/5f6c336e757534d3a36b1a03612e05b412a18c61/chia/wallet/transaction_sorting.py#L6) [Default: `confirmed_at_height`] | -| reverse | BOOLEAN | False | If `true`, reverse the results [Default: `false`] | -| file_contents | BOOLEAN | False | If `true`, return a summary for the Offer. If `false`, only return the Offer's basic metadata [Default: `false`] | +| include_completed | BOOLEAN | False | If `true`, show completed Offers [Default: `false`] | +| sort_key | STRING | False | Optionally change the sort order of the results, [sort_keys members](https://github.com/Chia-Network/chia-blockchain/blob/5f6c336e757534d3a36b1a03612e05b412a18c61/chia/wallet/transaction_sorting.py#L6) [Default: `confirmed_at_height`] | +| reverse | BOOLEAN | False | If `true`, reverse the results [Default: `false`] | +| file_contents | BOOLEAN | False | If `true`, return a summary for the Offer. If `false`, only return the Offer's basic metadata [Default: `false`] |
Example @@ -844,14 +844,14 @@ Usage: chia rpc wallet [OPTIONS] get_offer [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :--- | :------- | :------------------------------------------------------------------ | +|:------------- |:------------ |:---- |:-------- |:------------------------------------------------------------------- | | -j | --json-file | TEXT | False | Instead of REQUEST, provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :------------ | :------ | :------- | :--------------------------------------------------------------------------------------------------------------- | +|:------------- |:------- |:-------- |:---------------------------------------------------------------------------------------------------------------- | | trade_id | STRING | True | The `trade_id` of the Offer | | file_contents | BOOLEAN | False | If `true`, return a summary for the Offer. If `false`, only return the Offer's basic metadata [Default: `false`] | @@ -960,7 +960,7 @@ Functionality: Obtain a count of the number of offers created and taken with thi Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :--- | :------- | :------------------------------------------------------------------ | +|:------------- |:------------ |:---- |:-------- |:------------------------------------------------------------------- | | -j | --json-file | TEXT | False | Instead of REQUEST, provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | @@ -997,14 +997,14 @@ Usage: chia rpc wallet [OPTIONS] get_offer_summary [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :--- | :------- | :------------------------------------------------------------------ | +|:------------- |:------------ |:---- |:-------- |:------------------------------------------------------------------- | | -j | --json-file | TEXT | False | Instead of REQUEST, provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :------- | :------ | :------- | :-------------------------------------------------------------------- | +|:-------- |:------- |:-------- |:--------------------------------------------------------------------- | | offer | STRING | True | The text of the Offer to summarize | | advanced | BOOLEAN | False | Show advanced information, including expiration time [Default: false] | @@ -1127,14 +1127,14 @@ Usage: chia rpc wallet [OPTIONS] take_offer [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :--- | :------- | :------------------------------------------------------------------ | +|:------------- |:------------ |:---- |:-------- |:------------------------------------------------------------------- | | -j | --json-file | TEXT | False | Instead of REQUEST, provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :---- | :-------- | :------- | :-------------------------------------------------------------------- | +|:----- |:--------- |:-------- |:--------------------------------------------------------------------- | | offer | FILE PATH | True | The text of the Offer to take (must be in the `PENDING_ACCEPT` state) | | fee | NUMBER | False | An optional fee (in mojos) to include with the Offer [Default: `0`] | diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/rpc-reference/simulator.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/rpc-reference/simulator.md index e12f103bda..5bb3f8f0df 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/rpc-reference/simulator.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/rpc-reference/simulator.md @@ -52,17 +52,17 @@ Usage: chia rpc full_node [OPTIONS] farm_block [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :--- | :------- | :------------------------------------------------------------------ | +|:------------- |:------------ |:---- |:-------- |:------------------------------------------------------------------- | | -j | --json-file | TEXT | False | Instead of REQUEST, provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: -| Parameter | Required | Description | -| :----------------- | :------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| address | True | The address to use to farm the block | +| Parameter | Required | Description | +|:-------------------- |:-------- |:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| address | True | The address to use to farm the block | | guarantee_tx_block | False | Set to `True` to farm a transaction block (ie, farm new blocks until a tx block is farmed); set to `False` to farm the next block, which could also be a transaction block, but is not guaranteed (Default: `False`) | -| blocks | False | Number of blocks to farm. If `guarantee_tx_block` is `True`, then each block will be a transaction block (Default: 1) | +| blocks | False | Number of blocks to farm. If `guarantee_tx_block` is `True`, then each block will be a transaction block (Default: 1) |
Example 1 @@ -115,7 +115,7 @@ Usage: chia rpc full_node [OPTIONS] get_all_blocks [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :--- | :------- | :------------------------------------------------------------------ | +|:------------- |:------------ |:---- |:-------- |:------------------------------------------------------------------- | | -j | --json-file | TEXT | False | Instead of REQUEST, provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | @@ -222,14 +222,14 @@ Usage: chia rpc full_node [OPTIONS] get_all_coins [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :--- | :------- | :------------------------------------------------------------------ | +|:------------- |:------------ |:---- |:-------- |:------------------------------------------------------------------- | | -j | --json-file | TEXT | False | Instead of REQUEST, provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: -| Parameter | Required | Description | -| :------------------ | :------- | :------------------------------------------------------------------------------------ | +| Parameter | Required | Description | +|:--------------------- |:-------- |:------------------------------------------------------------------------------------- | | include_spent_coins | False | Boolean, if `True` then spent coins will be included in the result (Default: `False`) |
@@ -287,7 +287,7 @@ Usage: chia rpc full_node [OPTIONS] get_all_puzzle_hashes [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :--- | :------- | :------------------------------------------------------------------ | +|:------------- |:------------ |:---- |:-------- |:------------------------------------------------------------------- | | -j | --json-file | TEXT | False | Instead of REQUEST, provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | @@ -332,7 +332,7 @@ Usage: chia rpc full_node [OPTIONS] get_auto_farming [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :--- | :------- | :------------------------------------------------------------------ | +|:------------- |:------------ |:---- |:-------- |:------------------------------------------------------------------- | | -j | --json-file | TEXT | False | Instead of REQUEST, provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | @@ -367,7 +367,7 @@ Usage: chia rpc full_node [OPTIONS] get_farming_ph [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :--- | :------- | :------------------------------------------------------------------ | +|:------------- |:------------ |:---- |:-------- |:------------------------------------------------------------------- | | -j | --json-file | TEXT | False | Instead of REQUEST, provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | @@ -414,18 +414,18 @@ Usage: chia rpc full_node [OPTIONS] reorg_blocks [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :--- | :------- | :------------------------------------------------------------------ | +|:------------- |:------------ |:---- |:-------- |:------------------------------------------------------------------- | | -j | --json-file | TEXT | False | Instead of REQUEST, provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: -| Parameter | Required | Description | -| :------------------- | :------- | :------------------------------------------------------------------ | +| Parameter | Required | Description | +|:------------------------ |:-------- |:------------------------------------------------------------------- | | num_of_blocks_to_rev | False | The number of blocks to go back (Default: 1) | -| num_of_new_blocks | False | The number of blocks to add (Default: 1) | -| revert_all_blocks | False | Boolean, set to `True` to fork all blocks (Default: `False`) | -| random_seed | False | String, used to randomize the seed, which will differentiate reorgs | +| num_of_new_blocks | False | The number of blocks to add (Default: 1) | +| revert_all_blocks | False | Boolean, set to `True` to fork all blocks (Default: `False`) | +| random_seed | False | String, used to randomize the seed, which will differentiate reorgs |
Example 1 @@ -478,14 +478,14 @@ Usage: chia rpc full_node [OPTIONS] revert_blocks [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :--- | :------- | :------------------------------------------------------------------ | +|:------------- |:------------ |:---- |:-------- |:------------------------------------------------------------------- | | -j | --json-file | TEXT | False | Instead of REQUEST, provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: -| Parameter | Required | Description | -| :---------------- | :------- | :------------------------------------------------------------- | +| Parameter | Required | Description | +|:------------------- |:-------- |:-------------------------------------------------------------- | | num_of_blocks | False | The number of blocks to revert (Default: 1) | | delete_all_blocks | False | Boolean, set to `True` to revert all blocks (Default: `False`) | @@ -540,14 +540,14 @@ Usage: chia rpc full_node [OPTIONS] set_auto_farming [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :--- | :------- | :------------------------------------------------------------------ | +|:------------- |:------------ |:---- |:-------- |:------------------------------------------------------------------- | | -j | --json-file | TEXT | False | Instead of REQUEST, provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Parameter | Required | Description | -| :-------- | :------- | :---------------------------------------- | +|:--------- |:-------- |:----------------------------------------- | | auto_farm | True | Boolean to enable or disable auto farming |
diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/rpc-reference/vcs.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/rpc-reference/vcs.md index 6fc59ba562..ac16319ca2 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/rpc-reference/vcs.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/rpc-reference/vcs.md @@ -37,14 +37,14 @@ Usage: chia rpc wallet [OPTIONS] vc_add_proofs [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :--- | :------- | :------------------------------------------------------------------ | +|:------------- |:------------ |:---- |:-------- |:------------------------------------------------------------------- | | -j | --json-file | TEXT | False | Instead of REQUEST, provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Parameter | Type | Required | Description | -| :-------- | :--------- | :------- | :---------------------------------------------------- | +|:--------- |:---------- |:-------- |:----------------------------------------------------- | | proofs | DICTIONARY | True | A dictionary of key/value pairs to be added as proofs |
@@ -77,14 +77,14 @@ Usage: chia rpc wallet [OPTIONS] vc_get [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :--- | :------- | :------------------------------------------------------------------ | +|:------------- |:------------ |:---- |:-------- |:------------------------------------------------------------------- | | -j | --json-file | TEXT | False | Instead of REQUEST, provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Parameter | Type | Required | Description | -| :-------- | :----- | :------- | :----------------------------------------- | +|:--------- |:------ |:-------- |:------------------------------------------ | | vc_id | STRING | True | The launcher ID of a Verifiable Credential | This RPC returns the `vc_record` representing the specified Verifiable Credential @@ -142,14 +142,14 @@ Usage: chia rpc wallet [OPTIONS] vc_get_list [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :--- | :------- | :------------------------------------------------------------------ | +|:------------- |:------------ |:---- |:-------- |:------------------------------------------------------------------- | | -j | --json-file | TEXT | False | Instead of REQUEST, provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Parameter | Type | Required | Description | -| :-------- | :------ | :------- | :---------------------------------------------------- | +|:--------- |:------- |:-------- |:----------------------------------------------------- | | start | INTEGER | False | The index to start the list at [default: 0] | | count | INTEGER | False | The maximum number of results to return [default: 50] | @@ -214,14 +214,14 @@ Usage: chia rpc wallet [OPTIONS] vc_get_proofs_for_root [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :--- | :------- | :------------------------------------------------------------------ | +|:------------- |:------------ |:---- |:-------- |:------------------------------------------------------------------- | | -j | --json-file | TEXT | False | Instead of REQUEST, provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Parameter | Type | Required | Description | -| :-------- | :----- | :------- | :----------------------------------------------------------------------- | +|:--------- |:------ |:-------- |:------------------------------------------------------------------------ | | root | STRING | True | The tree hash of a set of proofs that have been stored in the dictionary | This RPC returns a dictionary of root hashes mapped to dictionaries of key value pairs of 'proofs'. @@ -258,14 +258,14 @@ Usage: chia rpc wallet [OPTIONS] vc_mint [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :--- | :------- | :------------------------------------------------------------------ | +|:------------- |:------------ |:---- |:-------- |:------------------------------------------------------------------- | | -j | --json-file | TEXT | False | Instead of REQUEST, provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Parameter | Type | Required | Description | -| :------------- | :----- | :------- | :----------------------------------------------------------------------------------- | +|:-------------- |:------ |:-------- |:------------------------------------------------------------------------------------ | | did_id | STRING | True | The ID of the DID that will be minting the VC | | target_address | STRING | False | The address where the VC will be sent upon minting [Default: send to minting wallet] | | fee | NUMBER | False | An optional blockchain fee, in mojos | @@ -431,20 +431,20 @@ Usage: chia rpc wallet [OPTIONS] vc_spend [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :--- | :------- | :------------------------------------------------------------------ | +|:------------- |:------------ |:---- |:-------- |:------------------------------------------------------------------- | | -j | --json-file | TEXT | False | Instead of REQUEST, provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: -| Parameter | Type | Required | Description | -| :--------------------- | :----- | :------- | :------------------------------------------------------------------------------------------------------------------ | -| vc_id | STRING | True | The launcher ID of the Verifiable Credential to spend | -| new_puzhash | None | False | The puzzle hash where the VC will be sent (can be derived from an XCH address) | +| Parameter | Type | Required | Description | +|:------------------------ |:------ |:-------- |:------------------------------------------------------------------------------------------------------------------- | +| vc_id | STRING | True | The launcher ID of the Verifiable Credential to spend | +| new_puzhash | None | False | The puzzle hash where the VC will be sent (can be derived from an XCH address) | | new_proof_hash | None | False | Can be used to update the vc's proofs -- the new root/proof hash | | provider_inner_puzhash | STRING | False | Can be used to update the vc's proofs -- the proof provider's inner puzzle hash | -| reuse_puzhash | None | False | If this flag is set, then send the VC back to the same puzzle hash it came from [Default: generate new puzzle hash] | -| fee | None | False | An optional blockchain fee, in mojos | +| reuse_puzhash | None | False | If this flag is set, then send the VC back to the same puzzle hash it came from [Default: generate new puzzle hash] | +| fee | None | False | An optional blockchain fee, in mojos |
Example @@ -649,17 +649,17 @@ Usage: chia rpc wallet [OPTIONS] vc_revoke [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :--- | :------- | :------------------------------------------------------------------ | +|:------------- |:------------ |:---- |:-------- |:------------------------------------------------------------------- | | -j | --json-file | TEXT | False | Instead of REQUEST, provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: -| Parameter | Type | Required | Description | -| :------------ | :------ | :------- | :------------------------------------------------------------------------------------------------------------------ | -| vc_parent_id | STRING | True | The parent ID of the VC coin | -| reuse_puzhash | None | False | If this flag is set, then send the VC back to the same puzzle hash it came from [Default: generate new puzzle hash] | -| fee | INTEGER | False | An optional blockchain fee, in mojos | +| Parameter | Type | Required | Description | +|:-------------- |:------- |:-------- |:------------------------------------------------------------------------------------------------------------------- | +| vc_parent_id | STRING | True | The parent ID of the VC coin | +| reuse_puzhash | None | False | If this flag is set, then send the VC back to the same puzzle hash it came from [Default: generate new puzzle hash] | +| fee | INTEGER | False | An optional blockchain fee, in mojos |
Example diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/rpc-reference/wallet.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/rpc-reference/wallet.md index f823ca2481..92bafb40bb 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/rpc-reference/wallet.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/rpc-reference/wallet.md @@ -39,14 +39,14 @@ To run the same command on Windows, you need to escape the quotes with backslash Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: -| Flag | Type | Required | Description | -| :------- | :--------- | :------- | :------------------------- | +| Flag | Type | Required | Description | +|:-------- |:---------- |:-------- |:-------------- | | mnemonic | TEXT ARRAY | True | 一个24字助记词，表示为数组 |
@@ -78,16 +78,16 @@ Response: Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: -| Flag | Type | Required | Description | -| :--------------- | :----- | :------- | :----------------------------------------------------------------- | -| fingerprint | NUMBER | True | The wallet's fingerprint, obtainable by running `chia wallet show` | -| max_ph_to_search | NUMBER | False | 要搜索的拼图哈希的最大数量[默认：100] | +| Flag | Type | Required | Description | +|:------------------ |:------ |:-------- |:------------------------------------------------------------------ | +| fingerprint | NUMBER | True | The wallet's fingerprint, obtainable by running `chia wallet show` | +| max_ph_to_search | NUMBER | False | 要搜索的拼图哈希的最大数量[默认：100] |
Example @@ -121,7 +121,7 @@ Response: Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | @@ -161,14 +161,14 @@ Response: Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :---------- | :----- | :------- | :----------------------------------------------------------------- | +|:----------- |:------ |:-------- |:------------------------------------------------------------------ | | fingerprint | NUMBER | True | The wallet's fingerprint, obtainable by running `chia wallet show` |
@@ -199,7 +199,7 @@ Response: Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | @@ -259,7 +259,7 @@ Response: Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | @@ -294,14 +294,14 @@ Response: Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :---------- | :----- | :------- | :----------------------------------------------------------------- | +|:----------- |:------ |:-------- |:------------------------------------------------------------------ | | fingerprint | NUMBER | True | The wallet's fingerprint, obtainable by running `chia wallet show` | :::warning @@ -346,7 +346,7 @@ Response: Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | @@ -381,14 +381,14 @@ Response: Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :---------- | :----- | :------- | :----------------------------------------------------------------- | +|:----------- |:------ |:-------- |:------------------------------------------------------------------ | | fingerprint | NUMBER | True | The wallet's fingerprint, obtainable by running `chia wallet show` |
@@ -422,7 +422,7 @@ Usage: chia rpc wallet [OPTIONS] get_auto_claim [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | @@ -462,7 +462,7 @@ Response: Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | @@ -497,7 +497,7 @@ Response: Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | @@ -533,7 +533,7 @@ Response: Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | @@ -570,14 +570,14 @@ Response: Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :----- | :----- | :------- | :--------------------------------------------------- | +|:------ |:------ |:-------- |:---------------------------------------------------- | | height | NUMBER | True | The block height for which to retrieve the timestamp |
@@ -611,15 +611,22 @@ Response: Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: -| Flag | Type | Required | Description | -| :----------- | :--------- | :------- | :----------------------------- | -| transactions | TEXT ARRAY | True | A list of transactions to push | +| Flag | Type | Required | Description | +|:------------ |:---------- |:-------- |:-------------------------------------------------------------------- | +| transactions | TEXT ARRAY | True | A list of transactions to push | +| fee | NUMBER | False | Add a transaction fee (in mojos) for the entire request [Default: 0] | + +:::info note + +`"success": true` does not guarantee that the transaction will get confirmed. A transaction may be dropped from the mempool and not included if the fee is too low. + +::: --- @@ -632,14 +639,14 @@ Request Parameters: Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :----------- | :--- | :------- | :------------------------------------- | +|:------------ |:---- |:-------- |:-------------------------------------- | | spend_bundle | TEXT | True | The spend bundle (transaction) to push | --- @@ -653,14 +660,14 @@ Usage: chia rpc wallet [OPTIONS] set_auto_claim [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :--------- | :------ | :------- | :----------------------------------------------------------------------- | +|:---------- |:------- |:-------- |:------------------------------------------------------------------------ | | enabled | BOOLEAN | TRUE | Set to `true` to enable auto claim, or `false` to disable it | | tx_fee | NUMBER | TRUE | The default transaction fee to be used for claims, in mojos | | min_amount | NUMBER | TRUE | The minimum value, in mojos, of a claim to be included in the auto claim | @@ -720,14 +727,14 @@ Response: Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :----- | :------ | :------- | :----------------------------------------------- | +|:------ |:------- |:-------- |:------------------------------------------------ | | enable | BOOLEAN | False | Set to `true` to enable resync [Default: `true`] |
@@ -760,25 +767,25 @@ Usage: chia rpc wallet [OPTIONS] create_new_wallet [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters (all wallet types): | Flag | Type | Required | Description | -| :---------- | :----- | :------- | :-------------------------------------------------------------------------------------------------------------------- | +|:----------- |:------ |:-------- |:--------------------------------------------------------------------------------------------------------------------- | | wallet_type | STRING | True | The type of wallet to create. Must be one of `cat_wallet`, `did_wallet`, `dao_wallet`, `nft_wallet`, or `pool_wallet` | | fee | NUMBER | False | An optional blockchain fee, in mojos | `cat_wallet` Parameters: -| Flag | Type | Required | Description | -| :------- | :----- | :------- | :--------------------------------------------------------------------------------------------------------------------- | -| mode | STRING | True | Must be either `new` of `existing` | -| name | STRING | False | The name of the wallet to create or modify [Default: `CAT` followed by the beginning of the CAT ID] | -| amount | NUMBER | True\* | \*Required if `mode` is `new`. Specify the value, in mojos, of this wallet | -| asset_id | STRING | True\* | \*Required if `mode` is `existing`. \*Required if `mode` is `existing`. Specify the `asset_id` of the wallet to update | +| Flag | Type | Required | Description | +|:-------- |:------ |:-------- |:----------------------------------------------------------------------------------------------------------------------- | +| mode | STRING | True | Must be either `new` of `existing` | +| name | STRING | False | The name of the wallet to create or modify [Default: `CAT` followed by the beginning of the CAT ID] | +| amount | NUMBER | True\* | \*Required if `mode` is `new`. Specify the value, in mojos, of this wallet | +| asset_id | STRING | True\* | \*Required if `mode` is `existing`. *Required if `mode` is `existing`. Specify the `asset_id` of the wallet to update |
Example 1 (CAT wallet with name) @@ -888,14 +895,14 @@ CAT 348dfae821c76f0a...: `did_wallet` Parameters: -| Flag | Type | Required | Description | -| :----------------------- | :----------- | :------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| did_type | STRING | True | Must be either `new` or `recovery`. Must be either `new` or `recovery`. If `recovery`, then each of the following parameters will be ignored | -| backup_dids | STRING ARRAY | True\* | \*Required if `did_type` is `new`. An array of backup DID IDs to be used for recovery. Must match actual DIDs | -| num_of_backup_ids_needed | NUMBER | True\* | \*Required if `did_type` is `new`. The number of backup DIDs required for recovery. Minimum value is `1`, maximum value is the number of DIDs in `backup_dids` | -| metadata | DICT | False | The metadata of the DID | -| wallet_name | STRING | False | The name of the DID wallet [Default: None] | -| amount | NUMBER | True\* | \*Required if `did_type` is `new`. Specify the initial value of this wallet, in mojos. Minimum value is `1` | +| Flag | Type | Required | Description | +|:---------------------------- |:------------ |:-------- |:---------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| did_type | STRING | True | Must be either `new` or `recovery`. Must be either `new` or `recovery`. If `recovery`, then each of the following parameters will be ignored | +| backup_dids | STRING ARRAY | True\* | \*Required if `did_type` is `new`. An array of backup DID IDs to be used for recovery. Must match actual DIDs | +| num_of_backup_ids_needed | NUMBER | True\* | \*Required if `did_type` is `new`. The number of backup DIDs required for recovery. Minimum value is `1`, maximum value is the number of DIDs in `backup_dids` | +| metadata | DICT | False | The metadata of the DID | +| wallet_name | STRING | False | The name of the DID wallet [Default: None] | +| amount | NUMBER | True\* | \*Required if `did_type` is `new`. Specify the initial value of this wallet, in mojos. Minimum value is `1` | Note: Because `backup_dids` is required, you must already have access to a DID in order to run this RPC for a did_wallet. If you do not already have a DID, then run [the CLI command](/did-cli#create) to create a DID wallet instead. If you do not already have a DID, then run [the CLI command](/did-cli#create) to create a DID wallet instead. @@ -952,16 +959,16 @@ Profile 1: `dao_wallet` Parameters: -| Flag | Type | Required | Description | -| :------------- | :-------- | :------- | :------------------------------------------------------------------------------------------------------------------------- | -| mode | STRING | True | Must be either `new` of `existing` | -| name | STRING | False | A name to give to the DAO new/existing wallet [Default: None] | -| dao_rules | JSON DICT | True\* | \*Required if `mode` is `new`; this is a json dictionary of the new DAO's rules | -| amount_of_cats | NUMBER | False\* | \*Only used if `mode` is `new`; this is the number of DAO CATs (in mojos) to create when initializing the DAO [Default: 0] | -| filter-amount | NUMBER | False | The minimum number of votes a proposal needs before the wallet will recognise it \[default: 1] | -| fee | NUMBER | False\* | \*Required if `mode` is `new`. This is the puzzle hash to which payouts will go | -| fee_for_cat | NUMBER | False\* | \*Only used if `mode` is `new`; this is a blockchain fee to add to the transaction to create the DAO CATs [Default: 0] | -| treasury_id | STRING | True\* | \*Required if `mode` is `existing`. \*Required if `mode` is `existing`. Specify the `asset_id` of the wallet to update | +| Flag | Type | Required | Description | +|:---------------- |:--------- |:--------- |:---------------------------------------------------------------------------------------------------------------------------- | +| mode | STRING | True | Must be either `new` of `existing` | +| name | STRING | False | A name to give to the DAO new/existing wallet [Default: None] | +| dao_rules | JSON DICT | True\* | \*Required if `mode` is `new`; this is a json dictionary of the new DAO's rules | +| amount_of_cats | NUMBER | False\* | \*Only used if `mode` is `new`; this is the number of DAO CATs (in mojos) to create when initializing the DAO [Default: 0] | +| filter-amount | NUMBER | False | The minimum number of votes a proposal needs before the wallet will recognise it \[default: 1] | +| fee | NUMBER | False\* | \*Required if `mode` is `new`. This is the puzzle hash to which payouts will go | +| fee_for_cat | NUMBER | False\* | \*Only used if `mode` is `new`; this is a blockchain fee to add to the transaction to create the DAO CATs [Default: 0] | +| treasury_id | STRING | True\* | \*Required if `mode` is `existing`. \*Required if `mode` is `existing`. Specify the `asset_id` of the wallet to update | Notes: @@ -974,21 +981,18 @@ Notes: Create a new wallet with some basic DAO rules; also mint CATs and include transaction fees: ```bash -chia rpc wallet create_new_wallet '{"wallet_type": "dao_wallet", "mode": "new", "name": "My Dao Wallet", "dao_rules": {"attendance_required": 3000, "oracle_spend_delay": 2, "pass_percentage": 5000, "proposal_minimum_amount": 1000001, "proposal_timelock": 3, "self_destruct_length": 1, "soft_close_length": 2}, "amount_of_cats": 1000, "filter-amount": 1, "fee": 500000000, "fee_for_cat": 100000000}' +Note: Because backup_dids is required, you must already have access to a DID in order to run this RPC for a did_wallet. If you do not already have a DID, then run the CLI command to create a DID wallet instead. If you do not already have a DID, then run the CLI command to create a DID wallet instead. ``` + is required, you must already have access to a DID in order to run this RPC for a did_wallet. If you do not already have a DID, then run [the CLI command](/did-cli#create) to create a DID wallet instead. If you do not already have a DID, then run [the CLI command](/did-cli#create) to create a DID wallet instead. + As a result, a new treasury will be created, along with a CAT wallet containing 1000 CATs, and a DAO CAT wallet: ```bash -{ - "cat_wallet_id": 4, - "dao_cat_wallet_id": 5, - "success": true, - "treasury_id": "0x89fdd510ce617c0b78d7f997d6fe52737a8c57100cca73c9dc4957eaf7fe55dc", - "type": 14, - "wallet_id": 3 -} +For this example, we'll use the wallet with ID 7. This wallet is type 6 (CAT): ``` +. This wallet is type 6 (CAT): +
@@ -998,28 +1002,25 @@ As a result, a new treasury will be created, along with a CAT wallet containing To join a DAO, set `mode` to `existing`: ```bash -chia rpc wallet create_new_wallet '{"wallet_type": "dao_wallet", "mode": "existing", "name": "My Dao Wallet", "filter-amount": 1, "treasury_id": "0x89fdd510ce617c0b78d7f997d6fe52737a8c57100cca73c9dc4957eaf7fe55dc"}' +This coin is "type": 7, so it is being sent from this wallet. This RPC can be used to claw back this coin as long as it has yet to be spent by the recipient wallet: ``` +, so it is being sent from this wallet. This RPC can be used to claw back this coin as long as it has yet to be spent by the recipient wallet: + Your wallet will join the treasury and automatically create the required DAO, CAT, and DAO_CAT wallets without any balance: ```bash -{ - "cat_wallet_id": 3, - "dao_cat_wallet_id": 4, - "success": true, - "treasury_id": "0x89fdd510ce617c0b78d7f997d6fe52737a8c57100cca73c9dc4957eaf7fe55dc", - "type": 14, - "wallet_id": 2 -} +The type of wallet to create. The type of wallet to create. Must be one of cat_wallet, did_wallet, nft_wallet, or pool_wallet ``` +, did_wallet, nft_wallet, or pool_wallet +
`nft_wallet` Parameters: | Flag | Type | Required | Description | -| :----- | :----- | :------- | :----------------------------------------------------------------- | +|:------ |:------ |:-------- |:------------------------------------------------------------------ | | did_id | STRING | False | Associate a DID with the new NFT wallet | | name | STRING | False | The name of the wallet to create or modify [Default: `NFT Wallet`] | @@ -1080,11 +1081,11 @@ Response: `pool_wallet` Parameters: -| Flag | Type | Required | Description | -| :---------------------- | :------ | :------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| mode | STRING | True | Must be either `new` of `recovery`. Must be either `new` of `recovery`. However, `recovery` has not been implemented, so currently (version 1.6) it will automatically fail | +| Flag | Type | Required | Description | +|:------------------------- |:------- |:-------- |:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| mode | STRING | True | Must be either `new` of `recovery`. Must be either `new` of `recovery`. However, `recovery` has not been implemented, so currently (version 1.6) it will automatically fail | | initial_target_state | STRING | True | This info should be sent from the daemon. This info should be sent from the daemon. `PoolState` is a type that is serialized to the blockchain to track the state of the user's pool singleton `target_puzzle_hash` is either the pool address, or the self-pooling address that pool rewards will be paid to. `target_puzzle_hash` is NOT the `p2_singleton` puzzle that block rewards are sent to. The `p2_singleton` address is the initial address, and the `target_puzzle_hash` is the final destination. `relative_lock_height` is zero when in `SELF_POOLING` state `target_puzzle_hash` is NOT the `p2_singleton` puzzle that block rewards are sent to. The `p2_singleton` address is the initial address, and the `target_puzzle_hash` is the final destination. `relative_lock_height` is zero when in `SELF_POOLING` state | -| p2_singleton_delayed_ph | STRING | True\* | \*Required if `mode` is `new`. This is the puzzle hash to which payouts will go | +| p2_singleton_delayed_ph | STRING | True\* | \*Required if `mode` is `new`. This is the puzzle hash to which payouts will go | | p2_singleton_delay_time | INTEGER | False | The time (in seconds) to delay payments [Default: None ] | --- @@ -1098,34 +1099,34 @@ Response: Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :----------- | :------ | :------- | :----------------------------------------------------------------------- | +|:------------ |:------- |:-------- |:------------------------------------------------------------------------ | | include_data | BOOLEAN | False | Set to `true` to include all coin info for this wallet [Default: `true`] | | type | INTEGER | False | The type of wallet to retrieve. See below for valid types | Valid wallet types (the `type` parameter) include the following integers: -| Name | type | -| :--------------- | ---: | -| STANDARD_WALLET | 0 | -| ATOMIC_SWAP | 2 | -| AUTHORIZED_PAYEE | 3 | -| MULTI_SIG | 4 | -| CUSTODY | 5 | -| CAT | 6 | -| RECOVERABLE | 7 | -| DECENTRALIZED_ID | 8 | -| POOLING_WALLET | 9 | -| NFT | 10 | -| DATA_LAYER | 11 | +| Name | type | +|:------------------ | ----:| +| STANDARD_WALLET | 0 | +| ATOMIC_SWAP | 2 | +| AUTHORIZED_PAYEE | 3 | +| MULTI_SIG | 4 | +| CUSTODY | 5 | +| CAT | 6 | +| RECOVERABLE | 7 | +| DECENTRALIZED_ID | 8 | +| POOLING_WALLET | 9 | +| NFT | 10 | +| DATA_LAYER | 11 | | DATA_LAYER_OFFER | 12 | -| VC | 13 | +| VC | 13 | More types may be added in the future. More types may be added in the future. See [wallet_types.py](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/wallet/util/wallet_types.py) for an up-to-date list of valid types. @@ -1195,6 +1196,418 @@ Response: ## Wallet +### `combine_coins` + +Functionality: Combine coins (typically used for combining dust). Functionality: Combine coins (typically used for combining dust). The maximum number of coins that can be combined within a single transaction is 500. + +Usage: chia rpc wallet [OPTIONS] combine_coins [REQUEST] + +Options: + +| Short Command | Long Command | Type | Required | Description | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | +| -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | +| -h | --help | None | False | Show a help message and exit | + +Request Parameters: + +| Flag | Type | Required | Description | +|:-------------------- |:---------- |:-------- |:------------------------------------------------------------------------------------------------------------------- | +| wallet_id | TEXT | True | The wallet ID for the origin of the transaction | +| number_of_coins | INTEGER | True | The number of coins to combine [Default: combine all coins, up to `coin_num_limit`] | +| largest_first | BOOLEAN | False | Set to `True` to prioritize combining the largest coins first [Default: False] | +| target_coin_ids | TEXT ARRAY | False | Only combine these coins [Default: Disabled] | +| target_coin_amount | INTEGER | False | Select coins until this amount (in XCH or CAT) is reached. Combine all selected coins into one coin [Default: None] | +| coin_num_limit | INTEGER | False | Combine up to this many coins [Default: 500] | +| fee | INTEGER | False | An optional blockchain fee, in mojos | + +:::warning + +This RPC was introduced in version 2.4.4. In that version, the `number_of_coins` is mandatory. If you do not include this parameter, you will receive an error such as + +``` +Request failed: RPC response failure: {"error": "This should be impossible to hit and is just for < 3.10 compatibility", "success": false +``` + +This requirement will be removed in a future version of Chia. + +::: + +:::info + +If `number_of_coins` is used (as is the requirement in 2.4.4), it must be: + +- At least `2` +- At most `coin_num_limit` + +If `target_coin_ids` is used, its length must not be larger than `number_of_coins`. + +::: + +:::warning + +It is not recommended to increase the value of `coin_num_limit` to a value higher than the default limit of 500 coins. Beyond this amount, it may be difficult to fit this transaction into a block, in which case the transaction could be stuck in the mempool for a long time. + +::: + +
+ +Example 1 + +For this example, combine as many coins as are required until a target of 2 trillion mojos is reached. Include a blockchain fee of 25 million mojos: + +```json +chia rpc wallet combine_coins '{"wallet_id": 1, "target_coin_amount": 2000000000000, "number_of_coins": 2, "fee": 25000000}' +``` + +Response: + +```json +{ + "success": true, + "transactions": [ + { + "additions": [ + { + "amount": 2000000000000, + "parent_coin_info": "0xce6aebc114e29636f89c8802dbfb90292fb6d1b219a48b96b9acff60bd074cb0", + "puzzle_hash": "0x07fb005e60a3f7a9b60db37378351ee638da4408a8af199e48f03401970b530a" + }, + { + "amount": 1499975000000, + "parent_coin_info": "0xce6aebc114e29636f89c8802dbfb90292fb6d1b219a48b96b9acff60bd074cb0", + "puzzle_hash": "0x995a7a233a03264ab4dd39a35988c2dacbfee855a02fd7afa87bb7b5165a8d01" + } + ], + "amount": 2000000000000, + "confirmed": false, + "confirmed_at_height": 0, + "created_at_time": 1729051793, + "fee_amount": 25000000, + "memos": {}, + "name": "0xf70323c86ac3a4d0e6608aa14ce4a5e55876119670338d1b5c5012029ca0b129", + "removals": [ + { + "amount": 1750000000000, + "parent_coin_info": "0x37a90eb5185a9c4439a91ddc98bbadce00000000000000000000000000073a96", + "puzzle_hash": "0x6c479d3f54b92f19461e75f2148c09424aedbaa14ad57e9b9a723f73e0220f7e" + }, + { + "amount": 1750000000000, + "parent_coin_info": "0x37a90eb5185a9c4439a91ddc98bbadce00000000000000000000000000064729", + "puzzle_hash": "0x6c479d3f54b92f19461e75f2148c09424aedbaa14ad57e9b9a723f73e0220f7e" + } + ], + "sent": 0, + "sent_to": [], + "spend_bundle": { + "aggregated_signature": "0x8ff23c4e47376574f3bd95d77b32b92d2f130cbc470220a700aba16a38ff43e1d3204714c267a1a662956170ed55a4f102a78be9b23ef82fe36bd6060f16c927710bf1c00753cbd5f50a833bfe388ed4f5b7b1f425b9dababdd4dc6143cccc2d", + "coin_spends": [ + { + "coin": { + "amount": 1750000000000, + "parent_coin_info": "0x37a90eb5185a9c4439a91ddc98bbadce00000000000000000000000000073a96", + "puzzle_hash": "0x6c479d3f54b92f19461e75f2148c09424aedbaa14ad57e9b9a723f73e0220f7e" + }, + "puzzle_reveal": "0xff02ffff01ff02ffff01ff02ffff03ff0bffff01ff02ffff03ffff09ff05ffff1dff0bffff1effff0bff0bffff02ff06ffff04ff02ffff04ff17ff8080808080808080ffff01ff02ff17ff2f80ffff01ff088080ff0180ffff01ff04ffff04ff04ffff04ff05ffff04ffff02ff06ffff04ff02ffff04ff17ff80808080ff80808080ffff02ff17ff2f808080ff0180ffff04ffff01ff32ff02ffff03ffff07ff0580ffff01ff0bffff0102ffff02ff06ffff04ff02ffff04ff09ff80808080ffff02ff06ffff04ff02ffff04ff0dff8080808080ffff01ff0bffff0101ff058080ff0180ff018080ffff04ffff01b0b323951e45840af4678ca35f5c165448aa16f28f1ef2a36248ce95b07e0ca3e0fd34b994e8ededb388ffc42d562c15e7ff018080", + "solution": "0xff80ffff01ffff3cffa0d89fca1f312b007dbf754554df992ec65b4bde3f3fd32a5911427d8f27e5348380ffff33ffa007fb005e60a3f7a9b60db37378351ee638da4408a8af199e48f03401970b530aff8601d1a94a200080ffff33ffa0995a7a233a03264ab4dd39a35988c2dacbfee855a02fd7afa87bb7b5165a8d01ff86015d3d7a1fc080ffff34ff84017d78408080ff8080" + }, + { + "coin": { + "amount": 1750000000000, + "parent_coin_info": "0x37a90eb5185a9c4439a91ddc98bbadce00000000000000000000000000064729", + "puzzle_hash": "0x6c479d3f54b92f19461e75f2148c09424aedbaa14ad57e9b9a723f73e0220f7e" + }, + "puzzle_reveal": "0xff02ffff01ff02ffff01ff02ffff03ff0bffff01ff02ffff03ffff09ff05ffff1dff0bffff1effff0bff0bffff02ff06ffff04ff02ffff04ff17ff8080808080808080ffff01ff02ff17ff2f80ffff01ff088080ff0180ffff01ff04ffff04ff04ffff04ff05ffff04ffff02ff06ffff04ff02ffff04ff17ff80808080ff80808080ffff02ff17ff2f808080ff0180ffff04ffff01ff32ff02ffff03ffff07ff0580ffff01ff0bffff0102ffff02ff06ffff04ff02ffff04ff09ff80808080ffff02ff06ffff04ff02ffff04ff0dff8080808080ffff01ff0bffff0101ff058080ff0180ff018080ffff04ffff01b0b323951e45840af4678ca35f5c165448aa16f28f1ef2a36248ce95b07e0ca3e0fd34b994e8ededb388ffc42d562c15e7ff018080", + "solution": "0xff80ffff01ffff3dffa0d69deaf403b27a05db5de7d7d806851a4c2c366970d0525eeaa0cceb68db54c98080ff8080" + } + ] + }, + "to_address": "txch1qlasqhnq50m6ndsdkdehsdg7ucud53qg4zh3n8jg7q6qr9ct2v9q502alx", + "to_puzzle_hash": "0x07fb005e60a3f7a9b60db37378351ee638da4408a8af199e48f03401970b530a", + "trade_id": null, + "type": 1, + "valid_times": { + "max_blocks_after_created": null, + "max_height": null, + "max_secs_after_created": null, + "max_time": null, + "min_blocks_since_created": null, + "min_height": null, + "min_secs_since_created": null, + "min_time": null + }, + "wallet_id": 1 + } + ], + "unsigned_transactions": [ + { + "signing_instructions": { + "key_hints": { + "path_hints": [ + { + "path": [12381, 8444, 2, 2], + "root_fingerprint": "0xbd7ea085" + }, + { + "path": [12381, 8444, 2, 2], + "root_fingerprint": "0xbd7ea085" + } + ], + "sum_hints": [ + { + "final_pubkey": "0xb323951e45840af4678ca35f5c165448aa16f28f1ef2a36248ce95b07e0ca3e0fd34b994e8ededb388ffc42d562c15e7", + "fingerprints": ["0xd6ec6f98"], + "synthetic_offset": "0x62466ba455dba328aa65267cd279ac1166dfc3235ec42401b0d3a31e2e2560ef" + }, + { + "final_pubkey": "0xb323951e45840af4678ca35f5c165448aa16f28f1ef2a36248ce95b07e0ca3e0fd34b994e8ededb388ffc42d562c15e7", + "fingerprints": ["0xd6ec6f98"], + "synthetic_offset": "0x62466ba455dba328aa65267cd279ac1166dfc3235ec42401b0d3a31e2e2560ef" + } + ] + }, + "targets": [ + { + "fingerprint": "0xef8ee89b", + "hook": "0x6f9091ee790a5f0bdd0f0e195eb725b8f9f7c90b2babdf12f9f38e7c1ef8ec3f", + "message": "0x19d169826bbb058b178cc88eb66903744c0dcbbf95a0da5ba08ebe900e0bf5b9ce6aebc114e29636f89c8802dbfb90292fb6d1b219a48b96b9acff60bd074cb037a90eb5185a9c4439a91ddc98bbadce7b4feba060d50116a067de66bf236615" + }, + { + "fingerprint": "0xef8ee89b", + "hook": "0xd1ffd65d4bcbc7806e5e8c4c8f1ca371f59755941e869d8efdaf1f9b7aafe204", + "message": "0xc29e05735d405a2c09b3702205ac6c7c0c0c1549c4bd33b450b95b577399714cfa4f4c7c2b8cfa8fd0d8319a59f95a9fd19e459049f96571672854459298a52337a90eb5185a9c4439a91ddc98bbadce7b4feba060d50116a067de66bf236615" + } + ] + }, + "transaction_info": { + "spends": [ + { + "coin": { + "amount": 1750000000000, + "parent_coin_id": "0x37a90eb5185a9c4439a91ddc98bbadce00000000000000000000000000073a96", + "puzzle_hash": "0x6c479d3f54b92f19461e75f2148c09424aedbaa14ad57e9b9a723f73e0220f7e" + }, + "puzzle": "0xff02ffff01ff02ffff01ff02ffff03ff0bffff01ff02ffff03ffff09ff05ffff1dff0bffff1effff0bff0bffff02ff06ffff04ff02ffff04ff17ff8080808080808080ffff01ff02ff17ff2f80ffff01ff088080ff0180ffff01ff04ffff04ff04ffff04ff05ffff04ffff02ff06ffff04ff02ffff04ff17ff80808080ff80808080ffff02ff17ff2f808080ff0180ffff04ffff01ff32ff02ffff03ffff07ff0580ffff01ff0bffff0102ffff02ff06ffff04ff02ffff04ff09ff80808080ffff02ff06ffff04ff02ffff04ff0dff8080808080ffff01ff0bffff0101ff058080ff0180ff018080ffff04ffff01b0b323951e45840af4678ca35f5c165448aa16f28f1ef2a36248ce95b07e0ca3e0fd34b994e8ededb388ffc42d562c15e7ff018080", + "solution": "0xff80ffff01ffff3cffa0d89fca1f312b007dbf754554df992ec65b4bde3f3fd32a5911427d8f27e5348380ffff33ffa007fb005e60a3f7a9b60db37378351ee638da4408a8af199e48f03401970b530aff8601d1a94a200080ffff33ffa0995a7a233a03264ab4dd39a35988c2dacbfee855a02fd7afa87bb7b5165a8d01ff86015d3d7a1fc080ffff34ff84017d78408080ff8080" + }, + { + "coin": { + "amount": 1750000000000, + "parent_coin_id": "0x37a90eb5185a9c4439a91ddc98bbadce00000000000000000000000000064729", + "puzzle_hash": "0x6c479d3f54b92f19461e75f2148c09424aedbaa14ad57e9b9a723f73e0220f7e" + }, + "puzzle": "0xff02ffff01ff02ffff01ff02ffff03ff0bffff01ff02ffff03ffff09ff05ffff1dff0bffff1effff0bff0bffff02ff06ffff04ff02ffff04ff17ff8080808080808080ffff01ff02ff17ff2f80ffff01ff088080ff0180ffff01ff04ffff04ff04ffff04ff05ffff04ffff02ff06ffff04ff02ffff04ff17ff80808080ff80808080ffff02ff17ff2f808080ff0180ffff04ffff01ff32ff02ffff03ffff07ff0580ffff01ff0bffff0102ffff02ff06ffff04ff02ffff04ff09ff80808080ffff02ff06ffff04ff02ffff04ff0dff8080808080ffff01ff0bffff0101ff058080ff0180ff018080ffff04ffff01b0b323951e45840af4678ca35f5c165448aa16f28f1ef2a36248ce95b07e0ca3e0fd34b994e8ededb388ffc42d562c15e7ff018080", + "solution": "0xff80ffff01ffff3dffa0d69deaf403b27a05db5de7d7d806851a4c2c366970d0525eeaa0cceb68db54c98080ff8080" + } + ] + } + } + ] +} +``` + +
+ +
+Example 2 + +First, list some coins to combine. The following command will list all coins in the wallet. (It is also possible to obtain a more nuanced listing by running the [list](/wallet-cli/#list) command): + +```json +chia rpc wallet get_coin_records +``` + +Response (truncated): + +```json +{ + { + "amount": 749996911173, + "coinbase": false, + "confirmed_height": 1472824, + "id": "0x067919e0dacb16541141acab9128b321b06325f14683f953acb30719c04db5b3", + "metadata": null, + "parent_coin_info": "0x9430666326f06c68a05e1714550181ba81edf88c142a955f65a9f33b8d0adaf4", + "puzzle_hash": "0x338860ddc5bdb23266884c827261913d7b01b349d511f1d084b983041b37f7b7", + "spent_height": 0, + "type": 0, + "wallet_identifier": { + "id": 1, + "type": 0 + } + }, + { + "amount": 749900000000, + "coinbase": false, + "confirmed_height": 1476378, + "id": "0x535899f5466073d26cab78b48313887a74a368112dd75f23f44837cb9fdde672", + "metadata": null, + "parent_coin_info": "0x7bf7cda4bbde8a105f19705f6bb8adcf67b4b9e70b13dbd616858de8a874531c", + "puzzle_hash": "0xed82e472025b0463f75ccf9958d8149249c7530d33d54d9f6cee72208b0da095", + "spent_height": 0, + "type": 0, + "wallet_identifier": { + "id": 1, + "type": 0 + } + } + ], + "success": true, + "total_count": null +} +``` + +Next, combine these coins, including an optional blockchain fee: + +```json +chia rpc wallet combine_coins '{"wallet_id": 1, "target_coin_ids": ["0x067919e0dacb16541141acab9128b321b06325f14683f953acb30719c04db5b3", "0x535899f5466073d26cab78b48313887a74a368112dd75f23f44837cb9fdde672"], "number_of_coins": 2, "fee": 25000000}' +``` + +Response: + +```json +{ + "success": true, + "transactions": [ + { + "additions": [ + { + "amount": 1499871911173, + "parent_coin_info": "0x535899f5466073d26cab78b48313887a74a368112dd75f23f44837cb9fdde672", + "puzzle_hash": "0x995a7a233a03264ab4dd39a35988c2dacbfee855a02fd7afa87bb7b5165a8d01" + } + ], + "amount": 1499871911173, + "confirmed": false, + "confirmed_at_height": 0, + "created_at_time": 1729056595, + "fee_amount": 25000000, + "memos": {}, + "name": "0xb9fd063d9f5f036614fc63ddea0e80692133ec002511adb275de3ef519676016", + "removals": [ + { + "amount": 749900000000, + "parent_coin_info": "0x7bf7cda4bbde8a105f19705f6bb8adcf67b4b9e70b13dbd616858de8a874531c", + "puzzle_hash": "0xed82e472025b0463f75ccf9958d8149249c7530d33d54d9f6cee72208b0da095" + }, + { + "amount": 749996911173, + "parent_coin_info": "0x9430666326f06c68a05e1714550181ba81edf88c142a955f65a9f33b8d0adaf4", + "puzzle_hash": "0x338860ddc5bdb23266884c827261913d7b01b349d511f1d084b983041b37f7b7" + } + ], + "sent": 0, + "sent_to": [], + "spend_bundle": { + "aggregated_signature": "0x9201f05d60390fa174d06ed47de17f88ce5545e6d7f3fe9b545f6575e1eccadabe241f86d60e723c7d8e4d9f86b3cce701407b364734b37ebec86ccdc320dfdd4c7a307f223104b11317d7468454a060217e8c58c4497b51cf3550ce8159498a", + "coin_spends": [ + { + "coin": { + "amount": 749900000000, + "parent_coin_info": "0x7bf7cda4bbde8a105f19705f6bb8adcf67b4b9e70b13dbd616858de8a874531c", + "puzzle_hash": "0xed82e472025b0463f75ccf9958d8149249c7530d33d54d9f6cee72208b0da095" + }, + "puzzle_reveal": "0xff02ffff01ff02ffff01ff02ffff03ff0bffff01ff02ffff03ffff09ff05ffff1dff0bffff1effff0bff0bffff02ff06ffff04ff02ffff04ff17ff8080808080808080ffff01ff02ff17ff2f80ffff01ff088080ff0180ffff01ff04ffff04ff04ffff04ff05ffff04ffff02ff06ffff04ff02ffff04ff17ff80808080ff80808080ffff02ff17ff2f808080ff0180ffff04ffff01ff32ff02ffff03ffff07ff0580ffff01ff0bffff0102ffff02ff06ffff04ff02ffff04ff09ff80808080ffff02ff06ffff04ff02ffff04ff0dff8080808080ffff01ff0bffff0101ff058080ff0180ff018080ffff04ffff01b0a9bb633b5e2bae69050559cc4d73b00fb70dc799212a2a85a58197db494961904db6920255458853c69e1541261d30eaff018080", + "solution": "0xff80ffff01ffff3cffa08bdb9e90270132820a0df9be7d8cac26ef7f7915945c9ead1db419101279c78d80ffff33ffa0995a7a233a03264ab4dd39a35988c2dacbfee855a02fd7afa87bb7b5165a8d01ff86015d37551d0580ffff34ff84017d78408080ff8080" + }, + { + "coin": { + "amount": 749996911173, + "parent_coin_info": "0x9430666326f06c68a05e1714550181ba81edf88c142a955f65a9f33b8d0adaf4", + "puzzle_hash": "0x338860ddc5bdb23266884c827261913d7b01b349d511f1d084b983041b37f7b7" + }, + "puzzle_reveal": "0xff02ffff01ff02ffff01ff02ffff03ff0bffff01ff02ffff03ffff09ff05ffff1dff0bffff1effff0bff0bffff02ff06ffff04ff02ffff04ff17ff8080808080808080ffff01ff02ff17ff2f80ffff01ff088080ff0180ffff01ff04ffff04ff04ffff04ff05ffff04ffff02ff06ffff04ff02ffff04ff17ff80808080ff80808080ffff02ff17ff2f808080ff0180ffff04ffff01ff32ff02ffff03ffff07ff0580ffff01ff0bffff0102ffff02ff06ffff04ff02ffff04ff09ff80808080ffff02ff06ffff04ff02ffff04ff0dff8080808080ffff01ff0bffff0101ff058080ff0180ff018080ffff04ffff01b0873ff760e5ce9f0d95e886534ba2a2ca270ccbd8592e321be783f9a61bcabc11cbbaaf1b9bd3363382bfb99587bd7d96ff018080", + "solution": "0xff80ffff01ffff3dffa01981ce537fda696b952fae321d45a2e208f78ef0b64f45ce2780b62eca36d9028080ff8080" + } + ] + }, + "to_address": "txch1n9d85ge6qvny4dxa8x34nzxzmt9la6z45qha0tag0wmm29j635qsqqjv8x", + "to_puzzle_hash": "0x995a7a233a03264ab4dd39a35988c2dacbfee855a02fd7afa87bb7b5165a8d01", + "trade_id": null, + "type": 1, + "valid_times": { + "max_blocks_after_created": null, + "max_height": null, + "max_secs_after_created": null, + "max_time": null, + "min_blocks_since_created": null, + "min_height": null, + "min_secs_since_created": null, + "min_time": null + }, + "wallet_id": 1 + } + ], + "unsigned_transactions": [ + { + "signing_instructions": { + "key_hints": { + "path_hints": [ + { + "path": [12381, 8444, 2, 130], + "root_fingerprint": "0xbd7ea085" + }, + { + "path": [12381, 8444, 2, 129], + "root_fingerprint": "0xbd7ea085" + } + ], + "sum_hints": [ + { + "final_pubkey": "0xa9bb633b5e2bae69050559cc4d73b00fb70dc799212a2a85a58197db494961904db6920255458853c69e1541261d30ea", + "fingerprints": ["0xbef0af90"], + "synthetic_offset": "0x60dc1ea2a3afd38a8b1867cc94048e1c14c76eb78980cb1a6b369e144ca6d9c4" + }, + { + "final_pubkey": "0x873ff760e5ce9f0d95e886534ba2a2ca270ccbd8592e321be783f9a61bcabc11cbbaaf1b9bd3363382bfb99587bd7d96", + "fingerprints": ["0x47dc97ec"], + "synthetic_offset": "0x6405f8cd2c7c8556d8535392ee94ea27e5a2e25590083160bd073febdef940c4" + } + ] + }, + "targets": [ + { + "fingerprint": "0x378e2d58", + "hook": "0x2f47b6231d4dae6682e77e49c3ae5e530cd4a91e379b3bf127a3f28c257727fd", + "message": "0xd239320b4737281e46ed7f6252ecc69d988e8d2e0e5f4bd93319fe5840c464d7535899f5466073d26cab78b48313887a74a368112dd75f23f44837cb9fdde67237a90eb5185a9c4439a91ddc98bbadce7b4feba060d50116a067de66bf236615" + }, + { + "fingerprint": "0x68970b70", + "hook": "0x96eb4015b002d0e99036c110f58506844080180e8acf59761b79dda30a64b0d3", + "message": "0x9745f4a78a3f47ab1198a7c1d5e02c7bea6547fe23d96fe1b6eeca50c82b152c067919e0dacb16541141acab9128b321b06325f14683f953acb30719c04db5b337a90eb5185a9c4439a91ddc98bbadce7b4feba060d50116a067de66bf236615" + } + ] + }, + "transaction_info": { + "spends": [ + { + "coin": { + "amount": 749900000000, + "parent_coin_id": "0x7bf7cda4bbde8a105f19705f6bb8adcf67b4b9e70b13dbd616858de8a874531c", + "puzzle_hash": "0xed82e472025b0463f75ccf9958d8149249c7530d33d54d9f6cee72208b0da095" + }, + "puzzle": "0xff02ffff01ff02ffff01ff02ffff03ff0bffff01ff02ffff03ffff09ff05ffff1dff0bffff1effff0bff0bffff02ff06ffff04ff02ffff04ff17ff8080808080808080ffff01ff02ff17ff2f80ffff01ff088080ff0180ffff01ff04ffff04ff04ffff04ff05ffff04ffff02ff06ffff04ff02ffff04ff17ff80808080ff80808080ffff02ff17ff2f808080ff0180ffff04ffff01ff32ff02ffff03ffff07ff0580ffff01ff0bffff0102ffff02ff06ffff04ff02ffff04ff09ff80808080ffff02ff06ffff04ff02ffff04ff0dff8080808080ffff01ff0bffff0101ff058080ff0180ff018080ffff04ffff01b0a9bb633b5e2bae69050559cc4d73b00fb70dc799212a2a85a58197db494961904db6920255458853c69e1541261d30eaff018080", + "solution": "0xff80ffff01ffff3cffa08bdb9e90270132820a0df9be7d8cac26ef7f7915945c9ead1db419101279c78d80ffff33ffa0995a7a233a03264ab4dd39a35988c2dacbfee855a02fd7afa87bb7b5165a8d01ff86015d37551d0580ffff34ff84017d78408080ff8080" + }, + { + "coin": { + "amount": 749996911173, + "parent_coin_id": "0x9430666326f06c68a05e1714550181ba81edf88c142a955f65a9f33b8d0adaf4", + "puzzle_hash": "0x338860ddc5bdb23266884c827261913d7b01b349d511f1d084b983041b37f7b7" + }, + "puzzle": "0xff02ffff01ff02ffff01ff02ffff03ff0bffff01ff02ffff03ffff09ff05ffff1dff0bffff1effff0bff0bffff02ff06ffff04ff02ffff04ff17ff8080808080808080ffff01ff02ff17ff2f80ffff01ff088080ff0180ffff01ff04ffff04ff04ffff04ff05ffff04ffff02ff06ffff04ff02ffff04ff17ff80808080ff80808080ffff02ff17ff2f808080ff0180ffff04ffff01ff32ff02ffff03ffff07ff0580ffff01ff0bffff0102ffff02ff06ffff04ff02ffff04ff09ff80808080ffff02ff06ffff04ff02ffff04ff0dff8080808080ffff01ff0bffff0101ff058080ff0180ff018080ffff04ffff01b0873ff760e5ce9f0d95e886534ba2a2ca270ccbd8592e321be783f9a61bcabc11cbbaaf1b9bd3363382bfb99587bd7d96ff018080", + "solution": "0xff80ffff01ffff3dffa01981ce537fda696b952fae321d45a2e208f78ef0b64f45ce2780b62eca36d9028080ff8080" + } + ] + } + } + ] +} +``` + +
+ ### `create_signed_transaction` 功能：从给定的钱包创建一个签名的交易 @@ -1204,24 +1617,24 @@ Response: Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: -| Flag | Type | Required | Description | -| :------------------- | :----------- | :------- | :----------------------------------------------------------------------------------------- | -| wallet_id | TEXT | True | The wallet ID for the origin of the transaction | -| additions | TEXT ARRAY | True | A list of puzzle hashes and amounts to be included | +| Flag | Type | Required | Description | +|:---------------------- |:------------ |:-------- |:------------------------------------------------------------------------------------------ | +| wallet_id | TEXT | True | The wallet ID for the origin of the transaction | +| additions | TEXT ARRAY | True | A list of puzzle hashes and amounts to be included | | min_coin_amount | NUMBER | False | The minimum coin amount to send [Default: 0] | | max_coin_amount | NUMBER | False | The maximum coin amount to send [Default: 0] | | exclude_coin_amounts | NUMBER ARRAY | False | A list of coin amounts to exclude | -| coins | TEXT ARRAY | True | A list of coins to include | -| exclude_coins | TEXT ARRAY | True | A list of coins to exclude | -| coin_announcements | TEXT ARRAY | False | A list of coin announcements, which includes `coin_id`, `message`, and `morph_bytes` | -| puzzle_announcements | TEXT ARRAY | False | A list of puzzle announcements, which includes `puzzle_hash`, `message`, and `morph_bytes` | -| fee | NUMBER | False | An optional blockchain fee, in mojos | +| coins | TEXT ARRAY | True | A list of coins to include | +| exclude_coins | TEXT ARRAY | True | A list of coins to exclude | +| coin_announcements | TEXT ARRAY | False | A list of coin announcements, which includes `coin_id`, `message`, and `morph_bytes` | +| puzzle_announcements | TEXT ARRAY | False | A list of puzzle announcements, which includes `puzzle_hash`, `message`, and `morph_bytes` | +| fee | NUMBER | False | An optional blockchain fee, in mojos | --- @@ -1234,14 +1647,14 @@ Request Parameters: Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :--- | :------- | :------------------------------------------------------------------ | +|:------------- |:------------ |:---- |:-------- |:------------------------------------------------------------------- | | -j | --json-file | TEXT | False | Instead of REQUEST, provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Parameter | Required | Description | -| :-------- | :------- | :------------------------------------------------------------------------------------------------------------------------- | +|:--------- |:-------- |:-------------------------------------------------------------------------------------------------------------------------- | | ids | False | Set to delete notifications only from the specified IDs. \[Default: delete from all IDs\] \[Default: delete from all IDs\] |
@@ -1272,14 +1685,14 @@ Response: Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :-------- | :----- | :------- | :----------------------------------------------------- | +|:--------- |:------ |:-------- |:------------------------------------------------------ | | wallet_id | NUMBER | True | The ID of the wallet from which to delete transactions |
@@ -1310,14 +1723,14 @@ Response: Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :---- | :----- | :------- | :----------------------------------------------------------------------------------------- | +|:----- |:------ |:-------- |:------------------------------------------------------------------------------------------ | | index | NUMBER | True | The new derivation index. The new derivation index. Must be larger than the previous index | Note: The derivation index is the minimum number of addresses the wallet will examine. It's not possible to decrease this number. It's not possible to decrease this number. @@ -1351,7 +1764,7 @@ Usage: chia rpc wallet [OPTIONS] get_coin_records [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | @@ -1405,17 +1818,17 @@ Response: Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: -| Flag | Type | Required | Description | -| :------------------ | :--------- | :------- | :-------------------------------------------------- | -| names | TEXT ARRAY | True | A list of coin names from which to retrieve records | -| start_height | NUMBER | False | The block height at which to start the query | -| end_height | NUMBER | False | The block height at which to end the query | +| Flag | Type | Required | Description | +|:--------------------- |:---------- |:-------- |:--------------------------------------------------- | +| names | TEXT ARRAY | True | A list of coin names from which to retrieve records | +| start_height | NUMBER | False | The block height at which to start the query | +| end_height | NUMBER | False | The block height at which to end the query | | include_spent_coins | BOOLEAN | False | Include spent coins in the result [Default: false] |
@@ -1459,7 +1872,7 @@ Response: Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | @@ -1494,7 +1907,7 @@ Response: Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | @@ -1533,14 +1946,14 @@ Response: Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :---------- | :------ | :------- | :----------------------------------------------------------------------------- | +|:----------- |:------- |:-------- |:------------------------------------------------------------------------------ | | wallet_id | TEXT | True | The ID of the wallet from which to obtain the next address | | new_address | BOOLEAN | True | If `true`, then create a new address, else display the latest existing address | @@ -1574,14 +1987,14 @@ Response: Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :--- | :------- | :------------------------------------------------------------------ | +|:------------- |:------------ |:---- |:-------- |:------------------------------------------------------------------- | | -j | --json-file | TEXT | False | Instead of REQUEST, provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Parameter | Required | Description | -| :-------- | :------- | :---------------------------------------------------------------------------------------------------------------------------------- | +|:--------- |:-------- |:----------------------------------------------------------------------------------------------------------------------------------- | | ids | False | Set to receive notifications only from the specified IDs. \[Default: receive from all IDs\] \[Default: receive from all IDs\] | | start | False | The number corresponding to the first notification to list. \[Default: the first notification\] \[Default: the first notification\] | | end | False | The number corresponding to the last notification to list. \[Default: the last notification\] \[Default: the last notification\] | @@ -1623,19 +2036,19 @@ Response: Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: -| Flag | Type | Required | Description | -| :-------------------- | :----------- | :------- | :------------------------------------------------------------------- | -| wallet_id | NUMBER | True | The ID of the wallet from which to display coins | +| Flag | Type | Required | Description | +|:----------------------- |:------------ |:-------- |:-------------------------------------------------------------------- | +| wallet_id | NUMBER | True | The ID of the wallet from which to display coins | | min_coin_amount | NUMBER | False | The smallest coin to be selected in this query [Default: No minimum] | | max_coin_amount | NUMBER | False | The largest coin to be selected in this query [Default: No maximum] | | excluded_coin_amounts | NUMBER ARRAY | False | A list of coin amounts to exclude | -| excluded_coins | TEXT ARRAY | False | A list of coins to exclude | +| excluded_coins | TEXT ARRAY | False | A list of coins to exclude | | excluded_coin_ids | TEXT ARRAY | False | A list of coin IDs to exclude |
@@ -1683,14 +2096,14 @@ Response: Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :------------- | :--- | :------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------- | +|:-------------- |:---- |:-------- |:----------------------------------------------------------------------------------------------------------------------------------------------------------------- | | transaction_id | TEXT | True | The ID of the transaction to obtain. The ID of the transaction to obtain. This is listed as `name` in the output of the [get_transactions](#get_transactions) RPC |
@@ -1701,10 +2114,8 @@ The transaction history is not deterministic due to heuristics we use to counter - Offers are split into multiple transactions on the corresponding wallets - Transactions of one Offer do not share the same id`s. To match them up, it is best to keep the offer files - The transaction time is a rough estimate. When an offer is accepted, the individual transactions of one offer can/will have slightly differing transaction times -- For your offers which were accepted by a 3rd Party , the incoming coins are beeing marked as incoming transaction, not as incoming trade -- When cancelling offers, the cancellation Transactions are beeing shown as transaction, not as trade -For accurate records, you should keep a local record of transactions (TXs) and the Offer files made. -
+- For your offers which were accepted by a 3rd Party , the incoming coins are being marked as incoming transaction, not as incoming trade +- When cancelling offers, the cancellation Transactions are being shown as transaction, not as trade For accurate records, you should keep a local record of transactions (TXs) and the Offer files made.
Example @@ -1766,14 +2177,14 @@ Response: Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :--------- | :------ | :------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +|:---------- |:------- |:-------- |:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | wallet_id | NUMBER | True | The Wallet ID of the wallet from which to obtain transactions | | start | NUMBER | False | The sequence number of the first transaction to show [Default: 0] | | end | NUMBER | False | The sequence number of the last transaction to show [Default: 50] | @@ -1783,8 +2194,7 @@ Request Parameters:
Notes about transactions -By default, the function lists the oldest transactions first. This is recommended for building a transaction history due to pagination. -If reverse is set to true, it lists the newest transactions first. This is most useful for fetching recent transactions. +By default, the function lists the oldest transactions first. This is recommended for building a transaction history due to pagination. If reverse is set to true, it lists the newest transactions first. This is most useful for fetching recent transactions. The transaction history is not deterministic due to heuristics we use to counter privacy features of the blockchain. This means, a couple of details cannot be fetched fully: @@ -1793,10 +2203,8 @@ The transaction history is not deterministic due to heuristics we use to counter - Offers are split into multiple transactions on the corresponding wallets - Transactions of one Offer do not share the same id`s. To match them up, it is best to keep the offer files - The transaction time is a rough estimate. When an offer is accepted, the individual transactions of one offer can/will have slightly differing transaction times -- For your offers which were accepted by a 3rd Party , the incoming coins are beeing marked as incoming transaction, not as incoming trade -- When cancelling offers, the cancellation Transactions are beeing shown as transaction, not as trade -For accurate records, you should keep a local record of transactions (TXs) and the Offer files made. -
+- For your offers which were accepted by a 3rd Party , the incoming coins are being marked as incoming transaction, not as incoming trade +- When cancelling offers, the cancellation Transactions are being shown as transaction, not as trade For accurate records, you should keep a local record of transactions (TXs) and the Offer files made.
Example 1: List a single XCH transaction @@ -2032,14 +2440,14 @@ Response: Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :-------- | :--- | :------- | :------------------------------------------------------- | +|:--------- |:---- |:-------- |:-------------------------------------------------------- | | wallet_id | TEXT | True | The wallet ID from which to obtain the transaction count |
@@ -2072,14 +2480,14 @@ Response: Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :--- | :------- | :------------------------------------------------------------------ | +|:------------- |:------------ |:---- |:-------- |:------------------------------------------------------------------- | | -j | --json-file | TEXT | False | Instead of REQUEST, provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Parameter | TYPE | Required | Description | -| :------------- | :----- | :------- | :------------------------------------------------------- | +|:-------------- |:------ |:-------- |:-------------------------------------------------------- | | transaction_id | STRING | True | The ID of the transaction for which to retrieve the memo |
@@ -2115,14 +2523,14 @@ Response: Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :-------- | :----- | :------- | :----------------------------------------------------------- | +|:--------- |:------ |:-------- |:------------------------------------------------------------ | | wallet_id | NUMBER | True | The Wallet ID of the wallet from which to obtain the balance |
@@ -2165,14 +2573,14 @@ Functionality: Obtain the balance (and related info) from one or more wallets Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :--------- | :--- | :------- | :----------------------------------------------------------------------------------------- | +|:---------- |:---- |:-------- |:------------------------------------------------------------------------------------------ | | wallet_ids | LIST | False | A list of Wallet IDs from which to obtain the balance [Default: list info for all wallets] |
@@ -2231,20 +2639,20 @@ Response: Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: -| Flag | Type | Required | Description | -| :-------------------- | :----------- | :------- | :------------------------------------------------------------------- | -| wallet_id | NUMBER | True | The ID of the wallet from which to select coins | -| amount | NUMBER | True | The number of mojos to select | +| Flag | Type | Required | Description | +|:----------------------- |:------------ |:-------- |:-------------------------------------------------------------------- | +| wallet_id | NUMBER | True | The ID of the wallet from which to select coins | +| amount | NUMBER | True | The number of mojos to select | | min_coin_amount | NUMBER | False | The smallest coin to be selected in this query [Default: No minimum] | | max_coin_amount | NUMBER | False | The largest coin to be selected in this query [Default: No maximum] | | excluded_coin_amounts | NUMBER ARRAY | False | A list of coin amounts to exclude | -| excluded_coins | TEXT ARRAY | False | A list of coins to exclude | +| excluded_coins | TEXT ARRAY | False | A list of coins to exclude |
Example 1 @@ -2300,14 +2708,14 @@ Request failed: {'error': 'Transaction for 1000 is greater than spendable balanc Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :--- | :------- | :------------------------------------------------------------------ | +|:------------- |:------------ |:---- |:-------- |:------------------------------------------------------------------- | | -j | --json-file | TEXT | False | Instead of REQUEST, provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Parameter | TYPE | Required | Description | -| :-------- | :--------- | :------- | :-------------------------------------------------- | +|:--------- |:---------- |:-------- |:--------------------------------------------------- | | target | HEX STRING | True | The puzzle hash you would like to send a message to | | message | HEX STRING | True | The hex-encoded message you would like to send | | amount | NUMBER | True | The number of mojos to include with this message | @@ -2425,6 +2833,8 @@ Result: ```bash { + "nft_info": { + "chain_info": "((117 \"https://nftstorage.link/ipfs/bafybeic32cwe43voxoybnwbayy7bedv4ip5tqho4jfol3xmtd62vscfoqa/78.jpg\" \"ipfs://bafybeic32cwe43voxoybnwbayy7bedv4ip5tqho4jfol3xmtd62vscfoqa/78.jpg\") (104 . 0x1a9152787d8374ececa0bf070b7a10e91162ada15964404d52232152f25b8b7a) (28021 \"https://nftstorage.link/ipfs/bafybeic32cwe43voxoybnwbayy7bedv4ip5tqho4jfol3xmtd62vscfoqa/metadata.json\" \"ipfs://bafybeic32cwe43voxoybnwbayy7bedv4ip5tqho4jfol3xmtd62vscfoqa/metadata.json\") (27765) (29550 . 1) (29556 . 1) (28008 . { "nft_info": { "chain_info": "((117 \"https://nftstorage.link/ipfs/bafybeic32cwe43voxoybnwbayy7bedv4ip5tqho4jfol3xmtd62vscfoqa/78.jpg\" \"ipfs://bafybeic32cwe43voxoybnwbayy7bedv4ip5tqho4jfol3xmtd62vscfoqa/78.jpg\") (104 . 0x1a9152787d8374ececa0bf070b7a10e91162ada15964404d52232152f25b8b7a) (28021 \"https://nftstorage.link/ipfs/bafybeic32cwe43voxoybnwbayy7bedv4ip5tqho4jfol3xmtd62vscfoqa/metadata.json\" \"ipfs://bafybeic32cwe43voxoybnwbayy7bedv4ip5tqho4jfol3xmtd62vscfoqa/metadata.json\") (27765) (29550 . 1) (29556 . 1) (28008 . 0xfdfe889a579916f8f75dcfff809eee44fc844df5fa92aecd2d562578e7e69a24))", "data_hash": "0x1a9152787d8374ececa0bf070b7a10e91162ada15964404d52232152f25b8b7a", @@ -2476,8 +2886,7 @@ The `ph` for the message payload can be any puzzlehash in your key derivation. O xch1ta7zjqqtaw9wyfnawl3z84a26vexr3qtmp7jq6gx4vpzl792sf9qddsacl ``` -This address still needs to be converted into a puzzlehash. One way to accomplish this is with an online converter, such as the one available from [spacescan](https://www.spacescan.io/tools/puzzlehashconverter). -Another option is to use the `decode` command from the [chia-dev-tools](https://github.com/Chia-Network/chia-dev-tools) repository: +This address still needs to be converted into a puzzlehash. This address still needs to be converted into a puzzlehash. One way to accomplish this is with an online converter, such as the one available from [spacescan](https://www.spacescan.io/tools/puzzlehashconverter). Another option is to use the `decode` command from the [chia-dev-tools](https://github.com/Chia-Network/chia-dev-tools) repository: Another option is to use the `decode` command from the [chia-dev-tools](https://github.com/Chia-Network/chia-dev-tools) repository: ```json cdv decode xch1ta7zjqqtaw9wyfnawl3z84a26vexr3qtmp7jq6gx4vpzl792sf9qddsacl @@ -2599,24 +3008,24 @@ This command will create a Message Coin on the blockchain. This command will cre Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: -| Flag | Type | Required | Description | -| :------------------- | :----------- | :------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| wallet_id | TEXT | True | The wallet ID for the origin of the transaction | -| address | TEXT | True | The destination address | -| amount | NUMBER | True | The number of mojos to send | -| fee | NUMBER | False | An optional blockchain fee, in mojos | -| memos | TEXT ARRAY | False | An optional array of memos to be sent with the transaction | +| Flag | Type | Required | Description | +|:---------------------- |:------------ |:-------- |:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| wallet_id | TEXT | True | The wallet ID for the origin of the transaction | +| address | TEXT | True | The destination address | +| amount | NUMBER | True | The number of mojos to send | +| fee | NUMBER | False | An optional blockchain fee, in mojos | +| memos | TEXT ARRAY | False | An optional array of memos to be sent with the transaction | | min_coin_amount | NUMBER | False | The minimum coin amount to send [Default: 0] | | max_coin_amount | NUMBER | False | The maximum coin amount to send [Default: 0] | | exclude_coin_amounts | NUMBER ARRAY | False | A list of coin amounts to exclude | | exclude_coin_ids | TEXT ARRAY | False | A list of coin IDs to exclude | -| reuse_puzhash | BOOLEAN | False | If `true`, will not generate a new puzzle hash / address for this transaction only. Note that setting this parameter to `true` will override the global default setting from config.yaml | +| reuse_puzhash | BOOLEAN | False | If `true`, will not generate a new puzzle hash / address for this transaction only. Note that setting this parameter to `true` will override the global default setting from config.yaml |
Example @@ -2698,45 +3107,235 @@ Response: Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: -| Flag | Type | Required | Description | -| :-------- | :--------- | :------- | :--------------------------------------------------------- | -| wallet_id | TEXT | True | The wallet ID for the origin of the transaction | -| address | TEXT | True | The destination address | -| amount | NUMBER | True | The number of mojos to send | -| fee | NUMBER | False | An optional blockchain fee, in mojos | -| memos | TEXT ARRAY | False | An optional array of memos to be sent with the transaction | -| additions | TEXT ARRAY | True | A list of puzzle hashes and amounts to be included | - ---- +| Flag | Type | Required | Description | +|:--------- |:---------- |:-------- |:------------------------------------------------------------------ | +| wallet_id | TEXT | True | The wallet ID for the origin of the transaction | +| additions | TEXT ARRAY | True | A list of puzzle hashes, amounts, and memos to be included | +| coins | TEXT ARRAY | False | Optional declaration of coins to be used | +| fee | NUMBER | False | An optional blockchain fee, in mojos | +| push | BOOLEAN | False | Option to push the transaction to the chain or not (default: true) | -### `sign_message_by_address` +
+Example -功能：使用XCH 地址签名消息，不会产生链上交易 +```json +chia rpc wallet send_transaction_multi '{"wallet_id": 1, "additions": [{"amount": 1000, "puzzle_hash": "0xd826f3ef83e1752771426f90eadb24e42a78948cb7f747da85c05daab1b1e156"},{"amount": 500, "puzzle_hash": "0x45d4b5bd3f1e2c28483cae0eab27921adabff3300cb7d1241ba1a9628727197d", "memos": ["hello", "world"]}],"fee": 100}' +``` -用法： chia rpc wallet [OPTIONS] sign_message_by_address [REQUEST] +Response: +````mdx-code-block + ```json + { + "success": true, + "transaction": { + "additions": [ + { + "amount": 500, + "parent_coin_info": "0x45b30dd00437cdc24b508e1beae38fb11536e40ef1acf03f50a825d84e8dec94", + "puzzle_hash": "0x45d4b5bd3f1e2c28483cae0eab27921adabff3300cb7d1241ba1a9628727197d" + }, + { + "amount": 1000, + "parent_coin_info": "0x45b30dd00437cdc24b508e1beae38fb11536e40ef1acf03f50a825d84e8dec94", + "puzzle_hash": "0xd826f3ef83e1752771426f90eadb24e42a78948cb7f747da85c05daab1b1e156" + }, + { + "amount": 21999981853856, + "parent_coin_info": "0x45b30dd00437cdc24b508e1beae38fb11536e40ef1acf03f50a825d84e8dec94", + "puzzle_hash": "0xe32e50011a2f5f6af81db9b56c500b84c67429340a9b7b37d4505f0f51fc9450" + } + ], + "amount": 1500, + "confirmed": false, + "confirmed_at_height": 0, + "created_at_time": 1730235776, + "fee_amount": 100, + "memos": { + "899c65593cb6bb0d515ac34c5e334287872f92ebcb2273ac0f0914efd6f0cabf": "776f726c64" + }, + "name": "0xcc3d1668094e7643de772c5b9de0927508f9402fbb4cb66b4161a34b043c5bfa", + "removals": [ + { + "amount": 21999981855456, + "parent_coin_info": "0xedee4defe510196869f53da7877236e56a0b097640b48c1b6c1a20bb92257a16", + "puzzle_hash": "0x58d4fa1f9b0069a41119662f38457ac2ff35ddf74b9fd01762e3da2c97112d3e" + } + ], + "sent": 0, + "sent_to": [], + "spend_bundle": { + "aggregated_signature": "0x86c593c8156e9c3b7a038b6e945975058dd98e4598d24bbb750b2a3f5aa44439af2370dc736478cdd07249bb0ce8575c174b2cf451655ea45f132502b955d63372d3cb1d6c293c7ad567fc38d54c76cc289bc4ffadbe2a7103a45984dd72a160", + "coin_spends": [ + { + "coin": { + "amount": 21999981855456, + "parent_coin_info": "0xedee4defe510196869f53da7877236e56a0b097640b48c1b6c1a20bb92257a16", + "puzzle_hash": "0x58d4fa1f9b0069a41119662f38457ac2ff35ddf74b9fd01762e3da2c97112d3e" + }, + "puzzle_reveal": "0xff02ffff01ff02ffff01ff02ffff03ff0bffff01ff02ffff03ffff09ff05ffff1dff0bffff1effff0bff0bffff02ff06ffff04ff02ffff04ff17ff8080808080808080ffff01ff02ff17ff2f80ffff01ff088080ff0180ffff01ff04ffff04ff04ffff04ff05ffff04ffff02ff06ffff04ff02ffff04ff17ff80808080ff80808080ffff02ff17ff2f808080ff0180ffff04ffff01ff32ff02ffff03ffff07ff0580ffff01ff0bffff0102ffff02ff06ffff04ff02ffff04ff09ff80808080ffff02ff06ffff04ff02ffff04ff0dff8080808080ffff01ff0bffff0101ff058080ff0180ff018080ffff04ffff01b08b3488cda8b3a32bcb74058bfb10c93a642d987908e6aec880dc85bf81b4b872b9f2cc6e08df73f62019ff593a2de1fdff018080", + "solution": "0xff80ffff01ffff3cffa03fb274324e854698e253364b3f76011ab98bb3b170a0a2633fb6aac19be3512480ffff33ffa045d4b5bd3f1e2c28483cae0eab27921adabff3300cb7d1241ba1a9628727197dff8201f4ffff8568656c6c6fff85776f726c648080ffff33ffa0d826f3ef83e1752771426f90eadb24e42a78948cb7f747da85c05daab1b1e156ff8203e880ffff33ffa0e32e50011a2f5f6af81db9b56c500b84c67429340a9b7b37d4505f0f51fc9450ff861402451a7ca080ffff34ff648080ff8080" + } + ] + }, + "to_address": "txch1mqn08muru96jwu2zd7gw4keyus4839yvklm50k59cpw64vd3u9tqghkcyg", + "to_puzzle_hash": "0xd826f3ef83e1752771426f90eadb24e42a78948cb7f747da85c05daab1b1e156", + "trade_id": null, + "type": 1, + "valid_times": { + "max_blocks_after_created": null, + "max_height": null, + "max_secs_after_created": null, + "max_time": null, + "min_blocks_since_created": null, + "min_height": null, + "min_secs_since_created": null, + "min_time": null + }, + "wallet_id": 1 + }, + "transaction_id": "0xcc3d1668094e7643de772c5b9de0927508f9402fbb4cb66b4161a34b043c5bfa", + "transactions": [ + { + "additions": [ + { + "amount": 500, + "parent_coin_info": "0x45b30dd00437cdc24b508e1beae38fb11536e40ef1acf03f50a825d84e8dec94", + "puzzle_hash": "0x45d4b5bd3f1e2c28483cae0eab27921adabff3300cb7d1241ba1a9628727197d" + }, + { + "amount": 1000, + "parent_coin_info": "0x45b30dd00437cdc24b508e1beae38fb11536e40ef1acf03f50a825d84e8dec94", + "puzzle_hash": "0xd826f3ef83e1752771426f90eadb24e42a78948cb7f747da85c05daab1b1e156" + }, + { + "amount": 21999981853856, + "parent_coin_info": "0x45b30dd00437cdc24b508e1beae38fb11536e40ef1acf03f50a825d84e8dec94", + "puzzle_hash": "0xe32e50011a2f5f6af81db9b56c500b84c67429340a9b7b37d4505f0f51fc9450" + } + ], + "amount": 1500, + "confirmed": false, + "confirmed_at_height": 0, + "created_at_time": 1730235776, + "fee_amount": 100, + "memos": { + "899c65593cb6bb0d515ac34c5e334287872f92ebcb2273ac0f0914efd6f0cabf": "776f726c64" + }, + "name": "0xcc3d1668094e7643de772c5b9de0927508f9402fbb4cb66b4161a34b043c5bfa", + "removals": [ + { + "amount": 21999981855456, + "parent_coin_info": "0xedee4defe510196869f53da7877236e56a0b097640b48c1b6c1a20bb92257a16", + "puzzle_hash": "0x58d4fa1f9b0069a41119662f38457ac2ff35ddf74b9fd01762e3da2c97112d3e" + } + ], + "sent": 0, + "sent_to": [], + "spend_bundle": { + "aggregated_signature": "0x86c593c8156e9c3b7a038b6e945975058dd98e4598d24bbb750b2a3f5aa44439af2370dc736478cdd07249bb0ce8575c174b2cf451655ea45f132502b955d63372d3cb1d6c293c7ad567fc38d54c76cc289bc4ffadbe2a7103a45984dd72a160", + "coin_spends": [ + { + "coin": { + "amount": 21999981855456, + "parent_coin_info": "0xedee4defe510196869f53da7877236e56a0b097640b48c1b6c1a20bb92257a16", + "puzzle_hash": "0x58d4fa1f9b0069a41119662f38457ac2ff35ddf74b9fd01762e3da2c97112d3e" + }, + "puzzle_reveal": "0xff02ffff01ff02ffff01ff02ffff03ff0bffff01ff02ffff03ffff09ff05ffff1dff0bffff1effff0bff0bffff02ff06ffff04ff02ffff04ff17ff8080808080808080ffff01ff02ff17ff2f80ffff01ff088080ff0180ffff01ff04ffff04ff04ffff04ff05ffff04ffff02ff06ffff04ff02ffff04ff17ff80808080ff80808080ffff02ff17ff2f808080ff0180ffff04ffff01ff32ff02ffff03ffff07ff0580ffff01ff0bffff0102ffff02ff06ffff04ff02ffff04ff09ff80808080ffff02ff06ffff04ff02ffff04ff0dff8080808080ffff01ff0bffff0101ff058080ff0180ff018080ffff04ffff01b08b3488cda8b3a32bcb74058bfb10c93a642d987908e6aec880dc85bf81b4b872b9f2cc6e08df73f62019ff593a2de1fdff018080", + "solution": "0xff80ffff01ffff3cffa03fb274324e854698e253364b3f76011ab98bb3b170a0a2633fb6aac19be3512480ffff33ffa045d4b5bd3f1e2c28483cae0eab27921adabff3300cb7d1241ba1a9628727197dff8201f4ffff8568656c6c6fff85776f726c648080ffff33ffa0d826f3ef83e1752771426f90eadb24e42a78948cb7f747da85c05daab1b1e156ff8203e880ffff33ffa0e32e50011a2f5f6af81db9b56c500b84c67429340a9b7b37d4505f0f51fc9450ff861402451a7ca080ffff34ff648080ff8080" + } + ] + }, + "to_address": "txch1mqn08muru96jwu2zd7gw4keyus4839yvklm50k59cpw64vd3u9tqghkcyg", + "to_puzzle_hash": "0xd826f3ef83e1752771426f90eadb24e42a78948cb7f747da85c05daab1b1e156", + "trade_id": null, + "type": 1, + "valid_times": { + "max_blocks_after_created": null, + "max_height": null, + "max_secs_after_created": null, + "max_time": null, + "min_blocks_since_created": null, + "min_height": null, + "min_secs_since_created": null, + "min_time": null + }, + "wallet_id": 1 + } + ], + "unsigned_transactions": [ + { + "signing_instructions": { + "key_hints": { + "path_hints": [ + { + "path": [ + 12381, + 8444, + 2, + 19 + ], + "root_fingerprint": "0x428c4870" + } + ], + "sum_hints": [ + { + "final_pubkey": "0x8b3488cda8b3a32bcb74058bfb10c93a642d987908e6aec880dc85bf81b4b872b9f2cc6e08df73f62019ff593a2de1fd", + "fingerprints": [ + "0x619bc5cd" + ], + "synthetic_offset": "0x64771976abb4a834675485d405228f1d42de0fe66ff8a15fcccb3edc5318ffed" + } + ] + }, + "targets": [ + { + "fingerprint": "0xb995704b", + "hook": "0x5164cb7113616036c959df00ffa45f0a06e1f1c8d04ac3c811b0f20f591c6d26", + "message": "0x45c51f68a927c0a5cab76e23821c14ed48508a03680d0f2b8171110fd424a38145b30dd00437cdc24b508e1beae38fb11536e40ef1acf03f50a825d84e8dec9437a90eb5185a9c4439a91ddc98bbadce7b4feba060d50116a067de66bf236615" + } + ] + }, + "transaction_info": { + "spends": [ + { + "coin": { + "amount": 21999981855456, + "parent_coin_id": "0xedee4defe510196869f53da7877236e56a0b097640b48c1b6c1a20bb92257a16", + "puzzle_hash": "0x58d4fa1f9b0069a41119662f38457ac2ff35ddf74b9fd01762e3da2c97112d3e" + }, + "puzzle": "0xff02ffff01ff02ffff01ff02ffff03ff0bffff01ff02ffff03ffff09ff05ffff1dff0bffff1effff0bff0bffff02ff06ffff04ff02ffff04ff17ff8080808080808080ffff01ff02ff17ff2f80ffff01ff088080ff0180ffff01ff04ffff04ff04ffff04ff05ffff04ffff02ff06ffff04ff02ffff04ff17ff80808080ff80808080ffff02ff17ff2f808080ff0180ffff04ffff01ff32ff02ffff03ffff07ff0580ffff01ff0bffff0102ffff02ff06ffff04ff02ffff04ff09ff80808080ffff02ff06ffff04ff02ffff04ff0dff8080808080ffff01ff0bffff0101ff058080ff0180ff018080ffff04ffff01b08b3488cda8b3a32bcb74058bfb10c93a642d987908e6aec880dc85bf81b4b872b9f2cc6e08df73f62019ff593a2de1fdff018080", + "solution": "0xff80ffff01ffff3cffa03fb274324e854698e253364b3f76011ab98bb3b170a0a2633fb6aac19be3512480ffff33ffa045d4b5bd3f1e2c28483cae0eab27921adabff3300cb7d1241ba1a9628727197dff8201f4ffff8568656c6c6fff85776f726c648080ffff33ffa0d826f3ef83e1752771426f90eadb24e42a78948cb7f747da85c05daab1b1e156ff8203e880ffff33ffa0e32e50011a2f5f6af81db9b56c500b84c67429340a9b7b37d4505f0f51fc9450ff861402451a7ca080ffff34ff648080ff8080" + } + ] + } + } + ] + } + ``` +```` +
+--- +### `sign_message_by_address` +Functionality: Sign a message using an XCH address without incurring an on-chain transaction +Usage: chia rpc wallet [OPTIONS] sign_message_by_address [REQUEST] Options: - | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :--- | :------- | :------------------------------------------------------------------ | +|:------------- |:------------ |:---- |:-------- |:------------------------------------------------------------------- | | -j | --json-file | TEXT | False | Instead of REQUEST, provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | - Request Parameters: - | Parameter | TYPE | Required | Description | -| :-------- | :----- | :------- | :---------------------------------------------------------------------------------------------------- | +|:--------- |:------ |:-------- |:----------------------------------------------------------------------------------------------------- | | address | STRING | True | The address to use for signing. The address to use for signing. Must possess the key for this address | | message | STRING | True | The message to include with the signature | - -
-Example +
Example ```json chia rpc wallet sign_message_by_address '{"address":"xch1q94gd4hd62ecx08d0kuagmp5cr8umrwtcvatfupmd7uyzhuf4c4sy2zd46", "message":"test"}' @@ -2758,21 +3357,21 @@ Response: ### `sign_message_by_id` -功能：使用DID或者NFT的ID签名消息，不会产生链上交易 +Functionality: Sign a message using a DID or NFT ID without incurring an on-chain transaction -用法： chia rpc wallet [OPTIONS] sign_message_by_id [REQUEST] +Usage: chia rpc wallet [OPTIONS] sign_message_by_id [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :--- | :------- | :------------------------------------------------------------------ | +|:------------- |:------------ |:---- |:-------- |:------------------------------------------------------------------- | | -j | --json-file | TEXT | False | Instead of REQUEST, provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Parameter | TYPE | Required | Description | -| :-------- | :----- | :------- | :------------------------------------------------------------------------------------------------------ | +|:--------- |:------ |:-------- |:------------------------------------------------------------------------------------------------------- | | id | STRING | True | The DID or NFT ID to use for signing. Must possess the key for this ID Must possess the key for this ID | | message | STRING | True | The message to include with the signature | @@ -2806,24 +3405,24 @@ Usage: chia rpc wallet [OPTIONS] spend_clawback_coins [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :--- | :------- | :------------------------------------------------------------------ | +|:------------- |:------------ |:---- |:-------- |:------------------------------------------------------------------- | | -j | --json-file | TEXT | False | Instead of REQUEST, provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: -| Flag | Type | Required | Description | -| :--------- | :----------- | :------- | :----------------------------------------------------------------------------------------------------------------- | -| coin_ids | STRING ARRAY | True | List of coin IDs to be spent | +| Flag | Type | Required | Description | +|:---------- |:------------ |:-------- |:-------------------------------------------------------------------------------------------------------------------- | +| coin_ids | STRING ARRAY | True | List of coin IDs to be spent | | batch_size | NUMBER | False | The number of coins to spend per bundle, [Default: `batch_size` obtainable from [get_auto_claim](#get_auto_claim)] | -| fee | NUMBER | False | An optional blockchain fee, in mojos | +| fee | NUMBER | False | An optional blockchain fee, in mojos | When examining the on-chain metadata for a transaction, a coin with `"type": 6` is a clawback coin to be received by this wallet, and a coin with `"type": 7` is a clawback coin sent from this wallet.
Example -First, list a clawback transaction. First, list a clawback transaction. For this example, we will specify the `to_address`. +First, list a clawback transaction. For this example, we will specify the `to_address`. Alternatively, you could search for coins with `"type": 6` (receive) or `"type": 7` (send), and `"spent": false`. @@ -3053,30 +3652,238 @@ chia rpc wallet get_transaction '{"transaction_id": "66f7fd75bb4a2408d219d89f858 --- +### `split_coins` + +Functionality: Split one coin into one or more new coins + +Usage: chia rpc wallet [OPTIONS] split_coins [REQUEST] + +Options: + +| Short Command | Long Command | Type | Required | Description | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | +| -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | +| -h | --help | None | False | Show a help message and exit | + +Request Parameters: + +| Flag | Type | Required | Description | +|:----------------- |:------- |:-------- |:---------------------------------------------------------------------------------------- | +| wallet_id | TEXT | True | The wallet ID for the origin of the transaction | +| target_coin_id | TEXT | True | The ID of the coin to split | +| number_of_coins | INTEGER | True | The number of new coins to create, excluding the remainder coin (minimum 1, maximum 500) | +| amount_per_coin | INTEGER | True | The amount of each newly created coin, in XCH | +| fee | INTEGER | False | An optional blockchain fee, in mojos | + +:::info + +This command requires a single coin to be specified for splitting. The maximum number of new coins is 500. These coins will be of equal value, and the original coin must contain sufficient funds for the splitting to occur. If any value remains after splitting, this will be stored in a new coin. + +For example, if you split a coin worth 10 XCH, using `"number_of_coins": 3` and `"amount_per_coin": 1`, then you will end up with three new coins worth 1 XCH each, along with another coin (the remainder of the original coin) worth 7 XCH. + +When splitting a CAT, `amount_per_coin` refers to the CAT value, where 1 CAT is 1000 mojos. + +Keep in mind that (by default) the dust filter will be activated if you have over 200 coins worth one million mojos in your wallet. Therefore, if you split a coin into more than 200 coins worth less than one million mojos, not all of them will show up in your wallet unless you modify or disable the dust filter (see the above link for instructions). + +The minimum number of new coins is 1. "Splitting" one coin into one new coin could be useful because a second new coin will be created with the remaining value. + +::: + +
+ +Example + +Split a coin into three new coins of 100 mojos apiece, plus a remainder coin. Include a blockchain fee of 25 million mojos. + +```json + chia rpc wallet split_coins '{"wallet_id": 1, "target_coin_id": "0x0451adca5edd164d524fea976792b73e8f745b8210fa8f890fca34a3d258a8d7", "number_of_coins": 3, "amount_per_coin": 100, "fee": 25000000}' +``` + +Response: + +```json +{ + "success": true, + "transactions": [ + { + "additions": [ + { + "amount": 100, + "parent_coin_info": "0x89901362b3263b039feab8912ddf4410e77bf121e0cc20a741ae2a0e5cd638cd", + "puzzle_hash": "0x14139b3a24dbbb296cbf202b955c00a797eeec7c6456298a6b54e94d2ca715a0" + }, + { + "amount": 100, + "parent_coin_info": "0x89901362b3263b039feab8912ddf4410e77bf121e0cc20a741ae2a0e5cd638cd", + "puzzle_hash": "0xe14a645e1d46353efe96d177dd57ad5f35d77aa9abe19b2c512368a1481abd81" + }, + { + "amount": 100, + "parent_coin_info": "0x89901362b3263b039feab8912ddf4410e77bf121e0cc20a741ae2a0e5cd638cd", + "puzzle_hash": "0x27c0cd35e650b1aa8e2889694f0c164f2b9383c42f91946251df2aca50501417" + }, + { + "amount": 1749975004700, + "parent_coin_info": "0x89901362b3263b039feab8912ddf4410e77bf121e0cc20a741ae2a0e5cd638cd", + "puzzle_hash": "0x07fb005e60a3f7a9b60db37378351ee638da4408a8af199e48f03401970b530a" + } + ], + "amount": 300, + "confirmed": false, + "confirmed_at_height": 0, + "created_at_time": 1728973966, + "fee_amount": 25000000, + "memos": {}, + "name": "0x865f0996c4b49e57db1035ce8f37aa38159913042d76b6d9b0678a2af80316a0", + "removals": [ + { + "amount": 1750000000000, + "parent_coin_info": "0x37a90eb5185a9c4439a91ddc98bbadce0000000000000000000000000006cdfd", + "puzzle_hash": "0x6c479d3f54b92f19461e75f2148c09424aedbaa14ad57e9b9a723f73e0220f7e" + }, + { + "amount": 5000, + "parent_coin_info": "0x7b049f25fb03e2659586031737a6da353577cc787b54bfa093e5bd6b76583867", + "puzzle_hash": "0x63cbf170899e4ba334b3c6dacce90f2fb11b7edb34d00bedf9b9824e0643dbbd" + } + ], + "sent": 0, + "sent_to": [], + "spend_bundle": { + "aggregated_signature": "0x8a75afa050ba31a232183917fb6dadfce7aec22f9976144ac3389601b9be0c74aed6911dda706de6542d22c69ebbd0f904c8c9d4a14baee6169778f3d6d61f8600e6580805cc0af1bb7aeac05e72d6edbce9116abb15a054e0b1f54f9d5b914f", + "coin_spends": [ + { + "coin": { + "amount": 1750000000000, + "parent_coin_info": "0x37a90eb5185a9c4439a91ddc98bbadce0000000000000000000000000006cdfd", + "puzzle_hash": "0x6c479d3f54b92f19461e75f2148c09424aedbaa14ad57e9b9a723f73e0220f7e" + }, + "puzzle_reveal": "0xff02ffff01ff02ffff01ff02ffff03ff0bffff01ff02ffff03ffff09ff05ffff1dff0bffff1effff0bff0bffff02ff06ffff04ff02ffff04ff17ff8080808080808080ffff01ff02ff17ff2f80ffff01ff088080ff0180ffff01ff04ffff04ff04ffff04ff05ffff04ffff02ff06ffff04ff02ffff04ff17ff80808080ff80808080ffff02ff17ff2f808080ff0180ffff04ffff01ff32ff02ffff03ffff07ff0580ffff01ff0bffff0102ffff02ff06ffff04ff02ffff04ff09ff80808080ffff02ff06ffff04ff02ffff04ff0dff8080808080ffff01ff0bffff0101ff058080ff0180ff018080ffff04ffff01b0b323951e45840af4678ca35f5c165448aa16f28f1ef2a36248ce95b07e0ca3e0fd34b994e8ededb388ffc42d562c15e7ff018080", + "solution": "0xff80ffff01ffff3cffa06dc403b674658a51d0a84d4c0d798d84f072e5f0d807f7f29628a76c7ce046ed80ffff33ffa014139b3a24dbbb296cbf202b955c00a797eeec7c6456298a6b54e94d2ca715a0ff6480ffff33ffa0e14a645e1d46353efe96d177dd57ad5f35d77aa9abe19b2c512368a1481abd81ff6480ffff33ffa027c0cd35e650b1aa8e2889694f0c164f2b9383c42f91946251df2aca50501417ff6480ffff33ffa007fb005e60a3f7a9b60db37378351ee638da4408a8af199e48f03401970b530aff86019772a3761c80ffff34ff84017d78408080ff8080" + }, + { + "coin": { + "amount": 5000, + "parent_coin_info": "0x7b049f25fb03e2659586031737a6da353577cc787b54bfa093e5bd6b76583867", + "puzzle_hash": "0x63cbf170899e4ba334b3c6dacce90f2fb11b7edb34d00bedf9b9824e0643dbbd" + }, + "puzzle_reveal": "0xff02ffff01ff02ffff01ff02ffff03ff0bffff01ff02ffff03ffff09ff05ffff1dff0bffff1effff0bff0bffff02ff06ffff04ff02ffff04ff17ff8080808080808080ffff01ff02ff17ff2f80ffff01ff088080ff0180ffff01ff04ffff04ff04ffff04ff05ffff04ffff02ff06ffff04ff02ffff04ff17ff80808080ff80808080ffff02ff17ff2f808080ff0180ffff04ffff01ff32ff02ffff03ffff07ff0580ffff01ff0bffff0102ffff02ff06ffff04ff02ffff04ff09ff80808080ffff02ff06ffff04ff02ffff04ff0dff8080808080ffff01ff0bffff0101ff058080ff0180ff018080ffff04ffff01b0b7109039d38c18535bf90fafe62721b69a8112b6ee8ea625486877a08e55be4e4dc6362ec9e8edf2c94f438862c4aa5aff018080", + "solution": "0xff80ffff01ffff3dffa0c08cc1020b24e6e5a3ab563107e467c7fb232ac0bacae4e1db888777423adc638080ff8080" + } + ] + }, + "to_address": "txch1ylqv6d0x2zc64r3g39557rqkfu4e8q7y97gegcj3mu4v55zszsts3q7np5", + "to_puzzle_hash": "0x27c0cd35e650b1aa8e2889694f0c164f2b9383c42f91946251df2aca50501417", + "trade_id": null, + "type": 1, + "valid_times": { + "max_blocks_after_created": null, + "max_height": null, + "max_secs_after_created": null, + "max_time": null, + "min_blocks_since_created": null, + "min_height": null, + "min_secs_since_created": null, + "min_time": null + }, + "wallet_id": 1 + } + ], + "unsigned_transactions": [ + { + "signing_instructions": { + "key_hints": { + "path_hints": [ + { + "path": [12381, 8444, 2, 2], + "root_fingerprint": "0xbd7ea085" + }, + { + "path": [12381, 8444, 2, 126], + "root_fingerprint": "0xbd7ea085" + } + ], + "sum_hints": [ + { + "final_pubkey": "0xb323951e45840af4678ca35f5c165448aa16f28f1ef2a36248ce95b07e0ca3e0fd34b994e8ededb388ffc42d562c15e7", + "fingerprints": ["0xd6ec6f98"], + "synthetic_offset": "0x62466ba455dba328aa65267cd279ac1166dfc3235ec42401b0d3a31e2e2560ef" + }, + { + "final_pubkey": "0xb7109039d38c18535bf90fafe62721b69a8112b6ee8ea625486877a08e55be4e4dc6362ec9e8edf2c94f438862c4aa5a", + "fingerprints": ["0xc5c2e33e"], + "synthetic_offset": "0x200c5c9f4f35cb688d04b54ef9ee1d17292ac7b05eb26338b6a058f1f5f0d820" + } + ] + }, + "targets": [ + { + "fingerprint": "0xef8ee89b", + "hook": "0xadb951ec17c76b6460c7feec45a0408d232405ce9fb53d781ba7c1a9d003e758", + "message": "0xe59c695d61b21821a57c204d26bb2fe113dcaa774c9f7f50112bf38dce5a148489901362b3263b039feab8912ddf4410e77bf121e0cc20a741ae2a0e5cd638cd37a90eb5185a9c4439a91ddc98bbadce7b4feba060d50116a067de66bf236615" + }, + { + "fingerprint": "0xdd5f5807", + "hook": "0x9767d510677768fcd41d89fd3df68d5b9f8f9bc8359beea52acbfec8800f48bd", + "message": "0x6ab4496b04f3df23cc373bdc1063b56461b28b65e5aa0c8c9ec42d5b818823af0451adca5edd164d524fea976792b73e8f745b8210fa8f890fca34a3d258a8d737a90eb5185a9c4439a91ddc98bbadce7b4feba060d50116a067de66bf236615" + } + ] + }, + "transaction_info": { + "spends": [ + { + "coin": { + "amount": 1750000000000, + "parent_coin_id": "0x37a90eb5185a9c4439a91ddc98bbadce0000000000000000000000000006cdfd", + "puzzle_hash": "0x6c479d3f54b92f19461e75f2148c09424aedbaa14ad57e9b9a723f73e0220f7e" + }, + "puzzle": "0xff02ffff01ff02ffff01ff02ffff03ff0bffff01ff02ffff03ffff09ff05ffff1dff0bffff1effff0bff0bffff02ff06ffff04ff02ffff04ff17ff8080808080808080ffff01ff02ff17ff2f80ffff01ff088080ff0180ffff01ff04ffff04ff04ffff04ff05ffff04ffff02ff06ffff04ff02ffff04ff17ff80808080ff80808080ffff02ff17ff2f808080ff0180ffff04ffff01ff32ff02ffff03ffff07ff0580ffff01ff0bffff0102ffff02ff06ffff04ff02ffff04ff09ff80808080ffff02ff06ffff04ff02ffff04ff0dff8080808080ffff01ff0bffff0101ff058080ff0180ff018080ffff04ffff01b0b323951e45840af4678ca35f5c165448aa16f28f1ef2a36248ce95b07e0ca3e0fd34b994e8ededb388ffc42d562c15e7ff018080", + "solution": "0xff80ffff01ffff3cffa06dc403b674658a51d0a84d4c0d798d84f072e5f0d807f7f29628a76c7ce046ed80ffff33ffa014139b3a24dbbb296cbf202b955c00a797eeec7c6456298a6b54e94d2ca715a0ff6480ffff33ffa0e14a645e1d46353efe96d177dd57ad5f35d77aa9abe19b2c512368a1481abd81ff6480ffff33ffa027c0cd35e650b1aa8e2889694f0c164f2b9383c42f91946251df2aca50501417ff6480ffff33ffa007fb005e60a3f7a9b60db37378351ee638da4408a8af199e48f03401970b530aff86019772a3761c80ffff34ff84017d78408080ff8080" + }, + { + "coin": { + "amount": 5000, + "parent_coin_id": "0x7b049f25fb03e2659586031737a6da353577cc787b54bfa093e5bd6b76583867", + "puzzle_hash": "0x63cbf170899e4ba334b3c6dacce90f2fb11b7edb34d00bedf9b9824e0643dbbd" + }, + "puzzle": "0xff02ffff01ff02ffff01ff02ffff03ff0bffff01ff02ffff03ffff09ff05ffff1dff0bffff1effff0bff0bffff02ff06ffff04ff02ffff04ff17ff8080808080808080ffff01ff02ff17ff2f80ffff01ff088080ff0180ffff01ff04ffff04ff04ffff04ff05ffff04ffff02ff06ffff04ff02ffff04ff17ff80808080ff80808080ffff02ff17ff2f808080ff0180ffff04ffff01ff32ff02ffff03ffff07ff0580ffff01ff0bffff0102ffff02ff06ffff04ff02ffff04ff09ff80808080ffff02ff06ffff04ff02ffff04ff0dff8080808080ffff01ff0bffff0101ff058080ff0180ff018080ffff04ffff01b0b7109039d38c18535bf90fafe62721b69a8112b6ee8ea625486877a08e55be4e4dc6362ec9e8edf2c94f438862c4aa5aff018080", + "solution": "0xff80ffff01ffff3dffa0c08cc1020b24e6e5a3ab563107e467c7fb232ac0bacae4e1db888777423adc638080ff8080" + } + ] + } + } + ] +} +``` + +
+ +--- + ### `verify_signature` -功能： Given a public key, message and signature, verify if it is valid. +Functionality: Given a public key, message and signature, verify if it is valid. -用法： chia rpc wallet [OPTIONS] verify_signature [REQUEST] +Usage: chia rpc wallet [OPTIONS] verify_signature [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: -| Flag | Type | Required | Description | -| :----------- | :--- | :------- | :------------------------------------------------------------------------------------------------ | +| Flag | Type | Required | Description | +|:------------ |:---- |:-------- |:--------------------------------------------------------------------------------------------------- | | signing_mode | TEXT | False | Specify the type of signature to verify \[Default: BLS with hex input\] (see below for more info) | -| pubkey | TEXT | True | The public key of the signature to verify | -| message | TEXT | True | The message to verify | -| signature | TEXT | True | The signature to verify | -| address | TEXT | True | The address, which must be derived from `pubkey` | +| pubkey | TEXT | True | The public key of the signature to verify | +| message | TEXT | True | The message to verify | +| signature | TEXT | True | The signature to verify | +| address | TEXT | True | The address, which must be derived from `pubkey` | -The signing mode strings are [stored in an enum](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/types/signing_mode.py). As of Chia 2.0.0, valid signing mode strings include: As of Chia 2.0.0, valid signing mode strings include: +The signing mode strings are [stored in an enum](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/types/signing_mode.py). As of Chia 2.0.0, valid signing mode strings include: - `BLS_SIG_BLS12381G2_XMD:SHA-256_SSWU_RO_AUG:hexinput_` - Default signing mode @@ -3098,21 +3905,21 @@ The signing mode strings are [stored in an enum](https://github.com/Chia-Network ### `cancel_offer` -功能： Cancel an offer +Functionality: Cancel an offer Usage: chia rpc wallet [OPTIONS] cancel_offer [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :------- | :------ | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +|:-------- |:------- |:-------- |:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | secure | BOOLEAN | True | Set to `true` to cancel on the blockchain by spending the coin(s) being offered; set to `false` to cancel in the wallet only. If `false`, the offer could still be taken if it has been shared If `false`, the offer could still be taken if it has been shared | | trade_id | TEXT | True | The ID of the offer to cancel | | fee | NUMBER | False | An optional blockchain fee, in mojos | @@ -3138,21 +3945,21 @@ Response: ### `cancel_offers` -功能： Cancel all offers, with the option to cancel only offers for a specific asset class +Functionality: Cancel all offers, with the option to cancel only offers for a specific asset class Usage: chia rpc wallet [OPTIONS] cancel_offers [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :--------- | :------ | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +|:---------- |:------- |:-------- |:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | secure | BOOLEAN | True | Set to `true` to cancel on the blockchain by spending the coin(s) being offered; set to `false` to cancel in the wallet only. If `false`, the offer could still be taken if it has been shared If `false`, the offer could still be taken if it has been shared | | batch_fee | NUMBER | False | The fee, in mojos, to add to each batch cancellation [Default: 0] | | batch_size | NUMBER | False | The number of offers to cancel in each batch [Default: 5] | @@ -3180,21 +3987,21 @@ Response: ### `cat_asset_id_to_name` -功能： Retrieve a CAT's name from its ID +Functionality: Retrieve a CAT's name from its ID -用法： chia rpc wallet [OPTIONS] cat_asset_id_to_name [REQUEST] +Usage: chia rpc wallet [OPTIONS] cat_asset_id_to_name [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :------- | :--- | :------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +|:-------- |:---- |:-------- |:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | asset_id | TEXT | True | The ID of the CAT whose name you would like to retrieve. The ID of the CAT whose name you would like to retrieve. This CAT must be listed in your `DEFAULT_CATS`, ie the CATs your wallet recognizes |
@@ -3220,21 +4027,21 @@ Response: ### `cat_get_asset_id` -功能： Retrieve the asset ID from a CAT wallet +Functionality: Retrieve the asset ID from a CAT wallet -用法： chia rpc wallet [OPTIONS] cat_get_asset_id [REQUEST] +Usage: chia rpc wallet [OPTIONS] cat_get_asset_id [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :-------- | :----- | :------- | :----------------------------------------------------------- | +|:--------- |:------ |:-------- |:------------------------------------------------------------ | | wallet_id | NUMBER | True | The wallet ID of the CAT whose ID you would like to retrieve |
@@ -3260,21 +4067,21 @@ Response: ### `cat_get_name` -功能： Get the name of a CAT associated with a wallet ID +Functionality: Get the name of a CAT associated with a wallet ID -用法： chia rpc wallet [OPTIONS] cat_get_name [REQUEST] +Usage: chia rpc wallet [OPTIONS] cat_get_name [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :-------- | :----- | :------- | :------------------------------------------------------------- | +|:--------- |:------ |:-------- |:-------------------------------------------------------------- | | wallet_id | NUMBER | True | The wallet ID of the CAT whose name you would like to retrieve |
@@ -3300,21 +4107,21 @@ Response: ### `cat_set_name` -功能： Rename a CAT wallet +Functionality: Rename a CAT wallet -用法： chia rpc wallet [OPTIONS] cat_set_name [REQUEST] +Usage: chia rpc wallet [OPTIONS] cat_set_name [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :-------- | :----- | :------- | :------------------------------------------------------- | +|:--------- |:------ |:-------- |:-------------------------------------------------------- | | wallet_id | NUMBER | True | The ID of the wallet whose name you would like to change | | name | TEXT | True | The new name for the wallet | @@ -3340,36 +4147,36 @@ Response: ### `cat_spend` -功能： Send CAT funds to another wallet +Functionality: Send CAT funds to another wallet -用法： chia rpc wallet [OPTIONS] cat_spend [REQUEST] +Usage: chia rpc wallet [OPTIONS] cat_spend [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: -| Flag | Type | Required | Description | -| :------------------- | :----------- | :------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| wallet_id | TEXT | True | The wallet ID for the origin of the transaction | -| additions | TEXT ARRAY | True\* | \*Must include either `additions` or `amount`. A list of puzzle hashes and amounts to be included | -| amount | NUMBER | True\* | \*Must include either `additions` or `amount`. The number of mojos to send | -| inner_address | TEXT | True | The destination address | -| memos | TEXT ARRAY | False | An optional array of memos to be sent with the transaction | -| coins | TEXT ARRAY | False | A list of coins to include in the spend | -| min_coin_amount | NUMBER | False | The minimum coin amount to send [Default: 0] | -| max_coin_amount | NUMBER | False | The maximum coin amount to send [Default: 0] | -| exclude_coin_amounts | NUMBER ARRAY | False | A list of coin amounts to exclude | -| exclude_coin_ids | TEXT ARRAY | False | A list of coin IDs to exclude | -| fee | NUMBER | False | An optional blockchain fee, in mojos | -| extra_delta | TEXT | False\* | The CAT's `extra_delta` parameter; \*If specified, then `tail_reveal` and `tail_solution` must also be specified | -| tail_reveal | TEXT | False\* | The CAT's `tail_reveal` parameter; \*If specified, then `extra_delta` and `tail_solution` must also be specified | -| tail_solution | TEXT | False\* | The CAT's `tail_solution` parameter; \*If specified, then `extra_delta` and `tail_reveal` must also be specified | -| reuse_puzhash | BOOLEAN | False | If `true`, will not generate a new puzzle hash / address for this transaction only. Note that setting this parameter to `true` will override the global default setting from config.yaml | +| Flag | Type | Required | Description | +|:---------------------- |:------------ |:--------- |:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| wallet_id | TEXT | True | The wallet ID for the origin of the transaction | +| additions | TEXT ARRAY | True\* | \*Must include either `additions` or `amount`. A list of puzzle hashes and amounts to be included | +| amount | NUMBER | True\* | \*Must include either `additions` or `amount`. The number of mojos to send | +| inner_address | TEXT | True | The destination address | +| memos | TEXT ARRAY | False | An optional array of memos to be sent with the transaction | +| coins | TEXT ARRAY | False | A list of coins to include in the spend | +| min_coin_amount | NUMBER | False | The minimum coin amount to send [Default: 0] | +| max_coin_amount | NUMBER | False | The maximum coin amount to send [Default: 0] | +| exclude_coin_amounts | NUMBER ARRAY | False | A list of coin amounts to exclude | +| exclude_coin_ids | TEXT ARRAY | False | A list of coin IDs to exclude | +| fee | NUMBER | False | An optional blockchain fee, in mojos | +| extra_delta | TEXT | False\* | The CAT's `extra_delta` parameter; \*If specified, then `tail_reveal` and `tail_solution` must also be specified | +| tail_reveal | TEXT | False\* | The CAT's `tail_reveal` parameter; \*If specified, then `extra_delta` and `tail_solution` must also be specified | +| tail_solution | TEXT | False\* | The CAT's `tail_solution` parameter; \*If specified, then `extra_delta` and `tail_reveal` must also be specified | +| reuse_puzhash | BOOLEAN | False | If `true`, will not generate a new puzzle hash / address for this transaction only. Note that setting this parameter to `true` will override the global default setting from config.yaml |
Example @@ -3463,21 +4270,21 @@ Response: ### `check_offer_validity` -功能： Check if an offer is valid +Functionality: Check if an offer is valid Usage: chia rpc wallet [OPTIONS] check_offer_validity [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :---- | :--- | :------- | :--------------------------------- | +|:----- |:---- |:-------- |:---------------------------------- | | offer | TEXT | True | The contents of the offer to check |
@@ -3502,57 +4309,57 @@ Response: ### `create_offer_for_ids` -功能： Create a new offer +Functionality: Create a new offer Usage: chia rpc wallet [OPTIONS] create_offer_for_ids [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: -| Flag | Type | Required | Description | -| :-------------- | :------ | :------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| offer | TEXT | True | The offer to create | -| validate_only | BOOLEAN | False | Only validate the offer instead of creating it [Default: false] | -| driver_dict | DICT | True | A dictionary of keys and values associated with the offer | +| Flag | Type | Required | Description | +|:----------------- |:------- |:-------- |:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| offer | TEXT | True | The offer to create | +| validate_only | BOOLEAN | False | Only validate the offer instead of creating it [Default: false] | +| driver_dict | DICT | True | A dictionary of keys and values associated with the offer | | min_coin_amount | NUMBER | False | The minimum coin amount to select for the offer [Default: none] | | max_coin_amount | NUMBER | False | The maximum coin amount to select for the offer [Default: none] | -| solver | TEXT | False | A marshalled solver | -| fee | NUMBER | False | An optional blockchain fee, in mojos | -| reuse_puzhash | BOOLEAN | False | If `true`, will not generate a new puzzle hash / address for this transaction only. Note that setting this parameter to `true` will override the global default setting from config.yaml | +| solver | TEXT | False | A marshalled solver | +| fee | NUMBER | False | An optional blockchain fee, in mojos | +| reuse_puzhash | BOOLEAN | False | If `true`, will not generate a new puzzle hash / address for this transaction only. Note that setting this parameter to `true` will override the global default setting from config.yaml | --- ### `get_all_offers` -功能： Show the details of all offers for this wallet +Functionality: Show the details of all offers for this wallet Usage: chia rpc wallet [OPTIONS] get_all_offers [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: -| Flag | Type | Required | Description | -| :------------------- | :------ | :------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| start | NUMBER | False | The sequence number of the first offer to show [Default: 0] | -| end | NUMBER | False | The sequence number of the last offer to show [Default: 10] | +| Flag | Type | Required | Description | +|:---------------------- |:------- |:-------- |:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| start | NUMBER | False | The sequence number of the first offer to show [Default: 0] | +| end | NUMBER | False | The sequence number of the last offer to show [Default: 10] | | exclude_my_offers | BOOLEAN | False | Set to `true` to exclude offers you originated [Default: false] | | exclude_taken_offers | BOOLEAN | False | Set to `true` to exclude offers that have already been taken [Default: false] | -| include_completed | BOOLEAN | False | Set to `true` to include offers that have been taken [Default: false] | -| sort_key | NUMBER | False | Specify the key for sorting, [sort_keys members](https://github.com/Chia-Network/chia-blockchain/blob/5f6c336e757534d3a36b1a03612e05b412a18c61/chia/wallet/transaction_sorting.py#L6) [Default: `confirmed_at_height`] | -| reverse | BOOLEAN | False | Set to `true` to sort the results in reverse order [Default: false] | -| file_contents | BOOLEAN | False | Set to `true` to display the contents of each offer [Default: false] | +| include_completed | BOOLEAN | False | Set to `true` to include offers that have been taken [Default: false] | +| sort_key | NUMBER | False | Specify the key for sorting, [sort_keys members](https://github.com/Chia-Network/chia-blockchain/blob/5f6c336e757534d3a36b1a03612e05b412a18c61/chia/wallet/transaction_sorting.py#L6) [Default: `confirmed_at_height`] | +| reverse | BOOLEAN | False | Set to `true` to sort the results in reverse order [Default: false] | +| file_contents | BOOLEAN | False | Set to `true` to display the contents of each offer [Default: false] |
Example @@ -3614,14 +4421,14 @@ Response: ### `get_cat_list` -功能： Return the default CAT list +Functionality: Return the default CAT list -用法： chia rpc wallet [OPTIONS] get_cat_list [REQUEST] +Usage: chia rpc wallet [OPTIONS] get_cat_list [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | @@ -3672,21 +4479,21 @@ Response: ### `get_offer` -功能： Show the details of one offer +Functionality: Show the details of one offer Usage: chia rpc wallet [OPTIONS] get_offer [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :------------ | :--- | :------- | :------------------------------------------------------------------------------------------------------------------------------- | +|:------------- |:---- |:-------- |:-------------------------------------------------------------------------------------------------------------------------------- | | trade_id | TEXT | True | The offer's ID | | file_contents | TEXT | False | The contents of the offer. The contents of the offer. Required if the offer's info is not stored in the database for this wallet | @@ -3754,14 +4561,14 @@ Response: ### `get_offers_count` -功能： Obtain the number of offers from the current wallet +Functionality: Obtain the number of offers from the current wallet 用法： chia rpc wallet [OPTIONS] get_offers_count [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | @@ -3791,21 +4598,21 @@ Response: ### `get_offer_summary` -功能： Show a summary of an offer +Functionality: Show a summary of an offer Usage: chia rpc wallet [OPTIONS] get_offer_summary [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :------- | :------ | :------- | :---------------------------------------------------------- | +|:-------- |:------- |:-------- |:----------------------------------------------------------- | | offer | TEXT | True | The offer for which to retrieve a summary | | advanced | BOOLEAN | False | Set to `true` to show a detailed summary [Default: `false`] | @@ -3845,14 +4652,14 @@ Response: ### `get_stray_cats` -功能： Get a list of all unacknowledged CATs +Functionality: Get a list of all unacknowledged CATs -用法： chia rpc wallet [OPTIONS] get_stray_cats [REQUEST] +Usage: chia rpc wallet [OPTIONS] get_stray_cats [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | @@ -3880,27 +4687,27 @@ Response: ### `take_offer` -功能： Take an offer +Functionality: Take an offer Usage: chia rpc wallet [OPTIONS] take_offer [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: -| Flag | Type | Required | Description | -| :-------------- | :------ | :------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| offer | TEXT | True | The offer to create | +| Flag | Type | Required | Description | +|:----------------- |:------- |:-------- |:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| offer | TEXT | True | The offer to create | | min_coin_amount | NUMBER | False | The minimum coin amount to select for taking the offer [Default: none] | | max_coin_amount | NUMBER | False | The maximum coin amount to select for taking the offer [Default: none] | -| solver | TEXT | False | A marshalled solver | -| fee | NUMBER | False | An optional blockchain fee, in mojos | -| reuse_puzhash | BOOLEAN | False | If `true`, will not generate a new puzzle hash / address for this transaction only. Note that setting this parameter to `true` will override the global default setting from config.yaml | +| solver | TEXT | False | A marshalled solver | +| fee | NUMBER | False | An optional blockchain fee, in mojos | +| reuse_puzhash | BOOLEAN | False | If `true`, will not generate a new puzzle hash / address for this transaction only. Note that setting this parameter to `true` will override the global default setting from config.yaml |
Example @@ -3988,24 +4795,24 @@ See our [NFT RPC](/nft-rpc) page. ### `pw_absorb_rewards` -功能： Absorb unspent coinbase rewards to a pool wallet +Functionality: Absorb unspent coinbase rewards to a pool wallet -用法： chia rpc wallet [OPTIONS] pw_absorb_rewards [REQUEST] +Usage: chia rpc wallet [OPTIONS] pw_absorb_rewards [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: -| Flag | Type | Required | Description | -| :--------------- | :----- | :------- | :-------------------------------------------------------------------------------------------------- | -| wallet_id | NUMBER | True | The Wallet ID to which to absorb funds (must be of type `POOLING_WALLET`) | +| Flag | Type | Required | Description | +|:------------------ |:------ |:-------- |:--------------------------------------------------------------------------------------------------- | +| wallet_id | NUMBER | True | The Wallet ID to which to absorb funds (must be of type `POOLING_WALLET`) | | max_spends_in_tx | NUMBER | False | The maximum number of reward transactions to roll into the absorb transaction [Default: no maximum] | -| fee | NUMBER | False | An optional blockchain fee, in mojos | +| fee | NUMBER | False | An optional blockchain fee, in mojos | :::note @@ -4017,26 +4824,26 @@ This RPC will only succeed if the wallet has accumulated unspent coinbase reward ### `pw_join_pool` -功能： Join a pool +Functionality: Join a pool -用法： chia rpc wallet [OPTIONS] pw_join_pool [REQUEST] +Usage: chia rpc wallet [OPTIONS] pw_join_pool [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: -| Flag | Type | Required | Description | -| :------------------- | :----- | :------- | :--------------------------------------------------------------------------------------------- | -| wallet_id | NUMBER | True | The Wallet ID to use to join the pool (must be of type `POOLING_WALLET`) | -| target_puzzlehash | TEXT | True | This is the target of where rewards will be sent to from the singleton. Controlled by the pool | -| pool_url | TEXT | True | The URL of the pool to join | +| Flag | Type | Required | Description | +|:---------------------- |:------ |:-------- |:---------------------------------------------------------------------------------------------- | +| wallet_id | NUMBER | True | The Wallet ID to use to join the pool (must be of type `POOLING_WALLET`) | +| target_puzzlehash | TEXT | True | This is the target of where rewards will be sent to from the singleton. Controlled by the pool | +| pool_url | TEXT | True | The URL of the pool to join | | relative_lock_height | NUMBER | True | The number of blocks required to wait when attempting to leave the pool | -| fee | NUMBER | False | An optional blockchain fee, in mojos | +| fee | NUMBER | False | An optional blockchain fee, in mojos |
Example @@ -4167,21 +4974,21 @@ Response: ### `pw_self_pool` -功能： Leave a pool and begin self-pooling +Functionality: Leave a pool and begin self-pooling -用法： chia rpc wallet [OPTIONS] pw_self_pool [REQUEST] +Usage: chia rpc wallet [OPTIONS] pw_self_pool [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :-------- | :----- | :------- | :----------------------------------------------------------------------- | +|:--------- |:------ |:-------- |:------------------------------------------------------------------------ | | wallet_id | NUMBER | True | The Wallet ID to use for self-pooling (must be of type `POOLING_WALLET`) | | fee | NUMBER | False | An optional blockchain fee, in mojos | @@ -4320,21 +5127,21 @@ Response: ### `pw_status` -功能： Obtain the status of a pooling wallet +Functionality: Obtain the status of a pooling wallet -用法： chia rpc wallet [OPTIONS] pw_status [REQUEST] +Usage: chia rpc wallet [OPTIONS] pw_status [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :-------- | :----- | :------- | :------------------------------------------------------------------------------ | +|:--------- |:------ |:-------- |:------------------------------------------------------------------------------- | | wallet_id | NUMBER | True | The Wallet ID for which to obtain the status (must be of type `POOLING_WALLET`) |
@@ -4382,21 +5189,21 @@ Response: ### `create_new_dl` -功能： Create a new DataLayer wallet +Functionality: Create a new DataLayer wallet -用法： chia rpc wallet [OPTIONS] create_new_dl [REQUEST] +Usage: chia rpc wallet [OPTIONS] create_new_dl [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :--- | :----- | :------- | :-------------------------------------- | +|:---- |:------ |:-------- |:--------------------------------------- | | root | TEXT | True | The root hash of an existing data store | | fee | NUMBER | False | An optional blockchain fee, in mojos | @@ -4534,21 +5341,21 @@ Response: ### `dl_delete_mirror` -功能： Remove an existing mirror for a specific singleton +Functionality: Remove an existing mirror for a specific singleton -用法： chia rpc wallet [OPTIONS] dl_delete_mirror [REQUEST] +Usage: chia rpc wallet [OPTIONS] dl_delete_mirror [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :------ | :----- | :------- | :------------------------------------ | +|:------- |:------ |:-------- |:------------------------------------- | | coin_id | TEXT | True | The `coin_id` of the mirror to delete | | fee | NUMBER | False | An optional blockchain fee, in mojos | @@ -4619,21 +5426,21 @@ Response: ### `dl_get_mirrors` -功能： Get all of the mirrors for a specific singleton +Functionality: Get all of the mirrors for a specific singleton -用法： chia rpc wallet [OPTIONS] dl_get_mirrors [REQUEST] +Usage: chia rpc wallet [OPTIONS] dl_get_mirrors [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :---------- | :--- | :------- | :-------------------------------------- | +|:----------- |:---- |:-------- |:--------------------------------------- | | launcher_id | TEXT | True | The launcher ID of the DataLayer wallet |
@@ -4666,21 +5473,21 @@ Response: ### `dl_history` -功能： Show the history of a data store +Functionality: Show the history of a data store -用法： chia rpc wallet [OPTIONS] dl_history [REQUEST] +Usage: chia rpc wallet [OPTIONS] dl_history [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :------------- | :----- | :------- | :----------------------------------------------------------- | +|:-------------- |:------ |:-------- |:------------------------------------------------------------ | | launcher_id | TEXT | True | The launcher ID of the DataLayer wallet | | min_generation | NUMBER | False | The first generation of singleton to show [Default: none] | | max_generation | NUMBER | False | The last generation of the singleton to show [Default: none] | @@ -4740,21 +5547,21 @@ Response: ### `dl_latest_singleton` -功能： Get the singleton record for the latest singleton of a launcher ID +Functionality: Get the singleton record for the latest singleton of a launcher ID -用法： chia rpc wallet [OPTIONS] dl_latest_singleton [REQUEST] +Usage: chia rpc wallet [OPTIONS] dl_latest_singleton [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :------------- | :------ | :------- | :----------------------------------------------------- | +|:-------------- |:------- |:-------- |:------------------------------------------------------ | | launcher_id | TEXT | True | The launcher ID of the DataLayer wallet | | only_confirmed | BOOLEAN | False | Only show the latest confirmed record [Default: false] | @@ -4794,21 +5601,21 @@ Response: ### `dl_new_mirror` -功能： Add a new on chain message for a specific singleton +Functionality: Add a new on chain message for a specific singleton -用法： chia rpc wallet [OPTIONS] dl_new_mirror [REQUEST] +Usage: chia rpc wallet [OPTIONS] dl_new_mirror [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :---------- | :--------- | :------- | :------------------------------------------------------------------------------------------------------------------------------ | +|:----------- |:---------- |:-------- |:------------------------------------------------------------------------------------------------------------------------------- | | launcher_id | TEXT | True | The launcher ID of the DataLayer wallet | | urls | TEXT ARRAY | True | A list of URLs to be used for the mirror | | amount | NUMBER | True | The value of the mirror (in mojos) to spend to create the mirror. In theory, mirrors with a higher `amount` will be prioritized | @@ -4888,14 +5695,14 @@ Response: ### `dl_owned_singletons` -功能： Get all owned singleton records +Functionality: Get all owned singleton records -用法： chia rpc wallet [OPTIONS] dl_owned_singletons [REQUEST] +Usage: chia rpc wallet [OPTIONS] dl_owned_singletons [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | @@ -4955,21 +5762,21 @@ Response: ### `dl_singletons_by_root` -功能： Get the singleton records that contain the specified root +Functionality: Get the singleton records that contain the specified root -用法： chia rpc wallet [OPTIONS] dl_singletons_by_root [REQUEST] +Usage: chia rpc wallet [OPTIONS] dl_singletons_by_root [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :---------- | :--- | :------- | :-------------------------------------- | +|:----------- |:---- |:-------- |:--------------------------------------- | | launcher_id | TEXT | True | The launcher ID of the DataLayer wallet | | root | TEXT | True | The root hash of an existing data store | @@ -5011,21 +5818,21 @@ Response: ### `dl_stop_tracking` -功能： Stop tracking a DataStore +Functionality: Stop tracking a DataStore -用法： chia rpc wallet [OPTIONS] dl_stop_tracking [REQUEST] +Usage: chia rpc wallet [OPTIONS] dl_stop_tracking [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :---------- | :--- | :------- | :-------------------------------------- | +|:----------- |:---- |:-------- |:--------------------------------------- | | launcher_id | TEXT | True | The launcher ID of the DataLayer wallet |
@@ -5049,21 +5856,21 @@ Response: ### `dl_track_new` -功能： Begin tracking a DataStore +Functionality: Begin tracking a DataStore -用法： chia rpc wallet [OPTIONS] dl_track_new [REQUEST] +Usage: chia rpc wallet [OPTIONS] dl_track_new [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :---------- | :--- | :------- | :-------------------------------------- | +|:----------- |:---- |:-------- |:--------------------------------------- | | launcher_id | TEXT | True | The launcher ID of the DataLayer wallet |
@@ -5087,42 +5894,42 @@ Response: ### `dl_update_multiple` -功能： Update multiple singletons with new merkle roots +Functionality: Update multiple singletons with new merkle roots -用法： chia rpc wallet [OPTIONS] dl_update_multiple [REQUEST] +Usage: chia rpc wallet [OPTIONS] dl_update_multiple [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :------ | :--------- | :------- | :------------------------------------------ | +|:------- |:---------- |:-------- |:------------------------------------------- | | updates | TEXT ARRAY | True | A list of launcher IDs and hashes to update | --- ### `dl_update_root` -功能： Update the root of a data store to the given new root +Functionality: Update the root of a data store to the given new root -用法： chia rpc wallet [OPTIONS] dl_update_root [REQUEST] +Usage: chia rpc wallet [OPTIONS] dl_update_root [REQUEST] Options: | Short Command | Long Command | Type | Required | Description | -| :------------ | :----------- | :------- | :------- | :------------------------------------------------------------------------------------ | +|:------------- |:------------ |:-------- |:-------- |:------------------------------------------------------------------------------------- | | -j | --json-file | FILENAME | False | Optionally instead of REQUEST you can provide a json file containing the request data | | -h | --help | None | False | Show a help message and exit | Request Parameters: | Flag | Type | Required | Description | -| :---------- | :----- | :------- | :-------------------------------------- | +|:----------- |:------ |:-------- |:--------------------------------------- | | launcher_id | TEXT | True | The launcher ID of the DataLayer wallet | | new_root | TEXT | True | The new root hash of the data store | | fee | NUMBER | False | An optional blockchain fee, in mojos | @@ -5212,7 +6019,7 @@ Note: Inherited from RPC Server Request Parameters: | Flag | Type | Required | Description | -| :------ | :--- | :------- | :--------------------------------------------------------------- | +|:------- |:---- |:-------- |:---------------------------------------------------------------- | | node_id | TEXT | True | The hex ID of the node to close, obtainable from get_connections |
@@ -5435,7 +6242,7 @@ Note: Inherited from RPC Server Request Parameters: | Flag | Type | Required | Description | -| :--- | :------ | :------- | :--------------------------------------------------- | +|:---- |:------- |:-------- |:---------------------------------------------------- | | host | TEXT | True | The IP or URL of the node to connect to | | port | INTEGER | True | The port through which to connect to the remote node | diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/troubleshooting/checking-farm-health.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/troubleshooting/checking-farm-health.md new file mode 100644 index 0000000000..96fe372b0d --- /dev/null +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/troubleshooting/checking-farm-health.md @@ -0,0 +1,165 @@ +--- +title: Checking Farm Health +slug: /checking-farm-health +--- + +> "Is my farm working?" + +It's one of the most common questions farmers ask themselves. It's one of the most common questions farmers ask themselves. This is understandable -- it is possible for those with small- and medium-size farms to go weeks or months without winning a block reward, even if everything is working properly. + +The easiest mitigation against this anxiety is to [join a pool](/pool-farming). Your pool will occasionally send you partial challenges in order to estimate your farm's size. If everything is working properly, your pool will report a size for your farm that comes close to its actual size. + +Beyond joining a pool, there are a few other things you can do to make sure your farm is working properly, whether you use the GUI or the CLI. + +## GUI health + +The new Farm and Harvest panels in 2.0 make it easy to get an overview of your farm's health. + +### Farm panel + +
+ Farm panel +
+
+ +Here is how to interpret each of the statistics in the above image: + +#### Farm Health + +- **Sync status** -- Shows whether your full node is synced. +- **Plots passing filter** -- Shows whether the "correct" number of plots are passing the [plot filter](/faq#what-is-the-plot-filter-and-why-didnt-my-plot-pass-it). The popup, as shown in the above image, contains several stats. As long as the numbers next to `Total plots passing filter` and `Expected Total plots passing filter` are similar, this aspect of your farm is working properly. +- **Missing signage points** -- Chia's consensus is designed such that 64 [signage points](/signage-and-infusion-points) are broadcast every 10 minutes, or 9216 signage points per day. You are ineligible to win a block at any missed signage points. It is normal to miss a few signage points per day, for example due to a temporary outage in your local network. However, if you miss 100 or more signage points per day, there is likely something wrong. The two most common causes for this are that your harvester is overwhelmed (fix this by moving some HDDs to another harvester), or that your network is experiencing frequent outages. +- **Stale partials** -- Your pool will send partial challenges to your node in order to estimate how much space you are contributing. If your node doesn't respond to a partial challenge quickly, it will be considered "stale". Just as with missing signage points, an occasional stale partial is nothing to worry about. If you experience a frequent number of stale partials, the causes and solutions tend to be the same as with missing signage points. + +#### Netspace + +- **Total Netspace** -- This shows an estimate of the total amount of space on Chia's entire network. +- **Farming Space** -- This is hidden behind the popup dialog in the above image. It is your local node's contribution of space to the network. + +#### Farming Rewards + +- **Estimated Time to Win** -- This is only an estimation of when you will create your next block, based on the percentage of the total netspace you are contributing. You have a 50% chance of winning sooner than this, and a 50% chance of winning later. It is not uncommon for 5x this amount of time to elapse between block wins, even if your farm is set up perfectly. Also keep in mind that the probability that you will win the next block does not increase as more time elapses. The Gambler's Fallacy applies here. +- **Estimated daily XCH** -- The formula for this is `(1 day / Estimated Time to Win) * block reward`. If you join a pool, this is roughly how much you should receive each day. However, you need to account for pool fees, as well as the fact that 1/8 of the reward goes directly to the farmer. +- **Estimated monthly XCH** -- Same as above, but taken as a monthly estimate. + +#### Pooling Health + +- **Valid Partials** -- Partial proofs your node has successfully returned to your pool, expressed as both a number and a percentage. See above for more info on partials. +- **Stale Partials** -- The percent and number of partials your node has failed to return on time. +- **Invalid partials** -- The percent and number of partials your node has returned that were invalid. +- **Missing partials** -- The percent and number of partials your node has failed to return. + +#### Last Attempted Proof + +- **Plots Passed Filter** -- At each signage point, a certain number of your plots will pass the plot filter. The numerator indicates the number of plots that are eligible to play in that specific Proof of Space lottery. For small farms, this number is often 0. The denominator indicates your farm's total number of plots. +- **Proofs Found** -- The number of valid proofs found at that signage point. If you are not in a pool, a number greater than 0 indicates that you have successfully found a proof and will likely win a block reward at the next transaction block. If you are in a pool, a number greater than 0 likely means that a valid partial proof was found and will be returned to your pool. + +### Harvest panel + +
+ Harvest panel +
+
+ +In the above image: + +- **Total farm size raw** -- The actual amount of space your farm is contributing to the network. +- **Total farm size effective** -- The amount of space your farm is effectively contributing, with uncompressed (C0) plots as the baseline. For example, if your farm consists entirely of C3 plots, according to the [plot compression table](/plotting-compression#compression-table), your farm's effective size should be 20% larger than its actual size. If you are using plots with a mixture of compression levels, the effective size of each of your plots will be taken into account in this number's calculation. + +## CLI Health + +### Check if your farm thinks it's farming + +Before going further, please make sure whether your farm actually considers itself to be farming. There's a good chance that you might not since you are still syncing blocks. There's a good chance that you might not since you are still syncing blocks. + +To check the status of your farm, `../activate` as usual and then type `chia farm summary`. 如果输出的第一行看起来像这样： + +``` +Farming status: Farming +``` + +..那么您就知道没有发生更严重的错误。 + +### 更改日志输出级别 + +To get detailed information about how your farm operates, you need to set the log-level of your farmer to `INFO`. For this you need to edit the Chia config under `~/.chia/mainnet/config`. 需要查找文件中类似于以下内容的部分： + +``` +farmer: + logging: &id001 + log_filename: log/debug.log + log_level: INFO + log_stdout: false +``` + +If `log_level` has any other value than `INFO`, change it to `INFO` accordingly and save the file. + +### 检查是否有地块通过了初筛 + +The most important metric to look out for is, whether your plots are passing the plot filter on your harvesting machines. 在通常的设置中，这涉及查看~/.chia/mainnet/log目录下的日志，在某些回合中，农场机器是否将地块标记为可进行耕种（eligible for farming）。 In a usual setup, this involves checking the logs under `~/.chia/mainnet/log` to see if at least for some rounds, plots are marked as **eligible for farming** by the harvester. + +Your `~/.chia/mainnet/log` directory may look like this: + +``` +username@chia-farmer:~/.chia/mainnet/log$ tree +. +├── debug.log +├── debug.log.1 +├── debug.log.2 +├── debug.log.3 +├── debug.log.4 +├── debug.log.5 +├── debug.log.6 +└── debug.log.7 + +0 directories, 8 files +``` + +Each log file contains log information about all the services ran by Chia. 如果运行的是一个全节点，这些日志可能会很复杂。 如果运行的是一个全节点，这些日志可能会很复杂。 We're only interested whether or not plots pass the plot filter. 可以通过运行以下命令来检查： 可以通过运行以下命令来检查： + +```bash +cat debug.log | grep "[0-9] plots were eligible for farming" +``` + +The `cat` command is a \*nix program to get content of a file. With the pipe operator `|`we "pipe" the output to another program called `grep` which can filter textual input. We filter for `"[0-9] plots were eligible for farming"` to see if we already had eligible plots. + +示例输出可能如下所示： + +``` +09:55:43.847 harvester src.harvester.harvester : INFO 1 plots were eligible for farming 2d8b1c58a0... Found 0 proofs. Time: 0.13772 s. Total 100 plots +09:55:52.737 harvester src.harvester.harvester : INFO 3 plots were eligible for farming 2d8b1c58a0... Found 0 proofs. Time: 0.43679 s. Total 100 plots +09:56:01.646 harvester src.harvester.harvester : INFO 2 plots were eligible for farming 2d8b1c58a0... Found 0 proofs. Time: 0.14055 s. Total 100 plots +``` + +**If you are seeing output like above here, this is already good!** + +这意味着有地块已经通过了初筛，您的农场似乎正在按预期工作。 Do this for each log file to see whether or not you had any outages or whether something went wrong. + +### 检查找到的证明 + +If you have had eligible plots in the past, there's a chance that you might have already found a proof, but it didn't get accepted by the network. + +**Please keep in mind that finding a proof does not constitute to winning a plot (getting a payout). Even if you find a proof, it needs to compete with other proofs and win to actually receive a reward.** + +To check whether you have already found proofs, you can run the same command as before, but with a different filter: + +```bash +cat debug.log | grep "Found [1-9] proofs" +``` + +可能的结果如下所示： + +``` +12:30:01.492 harvester src.harvester.harvester : INFO 1 plots were eligible for farming 23d3a7c90f... Found 1 proofs. Time: 0.57000 s. Total 100 plots +``` + +If you do this for all your log files and get a result, **great!** This means your farm is 100% working as expected. 可能还没有赢得一个区块，但已经接近成功了一次或多次！ + +### Can a Double NAT scenario impact my farm's ability to send valid proofs to the network? + +是也不是。 Double NAT, while quirky, should work due to Chia's uPnP support. 然而，您可能无法通过这种方式将区块发送给其他节点。 然而，您可能无法通过这种方式将区块发送给其他节点。 "双重NAT"场景发生在客户端（收割机或节点）位于进行了两次NAT的网络内。 +通常涉及客户端位于两个路由器后面，而不是一个，如下图所示： + +Internet --> Router --> Router --> Client + +某些网络设置可能会影响全节点参与耕种（farming）的能力。 只要日志中没有明显的指示耕种（farming）无法正常工作的迹象（特别是与网络相关的ERROR、WARNING标签），这种情况不太可能发生。 diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/troubleshooting/farming-faq.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/troubleshooting/farming-faq.md new file mode 100644 index 0000000000..a84a03e142 --- /dev/null +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/troubleshooting/farming-faq.md @@ -0,0 +1,64 @@ +--- +title: Farming FAQ +slug: /farming-faq +--- + +## 如何判断 Chia 耕种(Farming) 是否正常运行？ + +如果是首次使用 Chia 并想知道软件是否正常工作时，以下是一些建议，可以帮助到你。 + +首先，需要修改配置以进行额外的日志记录。 The configurations can be found in `config.yaml`. This file is located in `chia/mainnet/config.yaml`. + +The location of the `.chia` folder varies, On windows you'll want to look in `C:/Users/your username)/.chia/mainnet/config.yaml`. On Mac, this file is located in `/Users/(your username)/.chia/mainnet/config/config.yaml`. + +在修改配置之前，请关闭 Chia。 Open `config.yaml` and edit the first `log_level`, setting it `INFO` instead of `WARNING`. 保存文件。 + +现在，重新启动 Chia。 等待20分钟让它运行。 + +在 Chia 运行时打开日志文件，将看到额外的消息。 You can find `debug.log` in the `log` directory right next to `config` directory accessed earlier. + +日志文件包含许多信息。 一旦日志填满了 20mb，将创建另一个日志文件。 如果有太多日志文件，可以删除其中一些。 + +Inside what you are looking for are these lines: + +``` +_07:02:41.663 harvester src.harvester.harvester : INFO 1 plots were eligible for farming f53c496e80... Found 0 proofs. Time: 0.00500 s. Total 8 plots_ +``` + +这表示 Chia 正在工作。 初筛系统有2个部分。 Chia 发现1个地块通过了第一部分，现在它会查看内部是否有一个预先计算的“证明”，可以在最快的时间内进行交易（2-3秒）。 如果它在您的地块中保留了一个证明，那么您就赢了。 许多时候它会显示 0 个证明。 但是它意味着已经在正常工作了。 这是运气和时间的因素。 在该行的末尾，它将指示软件包含了多少地块。 + +:::info +Another way to ensure your farm is operational is checking against a pool. 定期收到的部分币会给您带来安心。 相比之下，独自耕种可能需要等待数天、数周或数月才能获胜，而在此期间您会一直在想是否正确设置了一切。 Checkout [pool-farming](/pool-farming). +::: + +## 日志文件中的正常信息是什么？ + +以下是日志文件中的正常信息副本： + +--- + +_9:32:00.322 full_node full_node_server : INFO \<- new_signage_point_or_end_of_sub_slot from peer 68b376e5846696df3510822ea527d0899ac6183f261e8858119235cd24903720 193.91.103.92._- + +--- + +_9:32:00.278 farmer farmer_server : INFO \<- new_signage_point from peer 62d37909657e183dcd702b66d0e694474f907361f5981eceaba00878e84419c4 127.0.0.1._ + +--- + +_09:32:01.806 full_node full_node_server : INFO -> respond_peers to peer 202.185.44.200 e5b7f06ba6ece8698917e0e22971aef8602972de81efe379d693b2baa0dffc24._ + +--- + +_09:32:08.063 full_node full_node_server : INFO -> request_signage_point_or_end_of_sub_slot to peer 74.138.106.114 b567363c3a96c13366ef2dbff2e080da77f310875a8beda7c1c07246173c3a06._ + +--- + +_09:32:08.202 harvester harvester_server : INFO \<- new_signage_point_harvester from peer 5bfd9af9bc76270cf76746255db9a435dca56b9adb37f5d1daec71e3c699c807 192.168.0.44._ + +--- + +_09:32:08.211 harvester src.harvester.harvester : INFO 0 plots were eligible for farming fec1fff66e... Found 0 proofs. Time: 0.00200 s. Total 8 plots._ + +--- + +最后一行显示在当前时间 09:32:08.211 有 8 个地块正在进行耕种，其中 0 个地块符合条件。 这仍然意味着软件已识别出地块并正在进行耕种。 diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/troubleshooting/logging-reference.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/troubleshooting/logging-reference.md index 7df449d267..10679a38fa 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/troubleshooting/logging-reference.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/troubleshooting/logging-reference.md @@ -3,15 +3,18 @@ title: Logging Reference slug: /troubleshooting/logging-reference --- +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + Chia blockchain nodes consist of several components that each handle different aspects of farming, harvesting, the wallet and general management of a node. Each component creates entries in a single log file `debug.log`. ## Log file Location: -| OS | Location | -| ------- | ---------------------------------------------------------------------------------- | -| Linux | `~/.chia/mainnet/log/debug.log` | -| Windows | `%systemdrive% %homepath% \.chia\mainnet\debug.log` (`C:\Users\\.chia…`) | -| MacOS | `/Users//.chia/mainnet/log/debug.log` | +| OS | Location | +| ------- | ------------------------------------------------------------------------------------------------------- | +| Linux | `~/.chia/mainnet/log/debug.log` | +| Windows | `$env:USERPROFILE\.chia\mainnet\log\debug.log` (`C:\Users\\.chia…`) | +| MacOS | `$HOME/.chia/mainnet/log/debug.log` (`/Users//.chia…`) | ## Log File Management: @@ -37,17 +40,17 @@ Change the `log_level` to `INFO`, save the file, and restart the node. ## Node Components: -| Component | Function | -| ---------------- | ----------------------------------------------- | -| farmer_server | Signage stuff about signs and things | -| harvester_server | Gathers and shares plot information | -| timelord_server | Manages Verifiable Delay Functions for the node | -| wallet_server | Controls wallet functions | +| Component | Function | +| ---------------------------------------------------------- | ----------------------------------------------- | +| farmer_server | Signage stuff about signs and things | +| harvester_server | Gathers and shares plot information | +| timelord_server | Manages Verifiable Delay Functions for the node | +| wallet_server | Controls wallet functions | | full_node_server | This component manages the node | ## Log Message Format: -| Field | 内容 | +| Field | 内容 | | ----------------- | -------------------------------- | | Date/time | in ISO format, in local timezone | | Node Component | see the list above | @@ -73,70 +76,179 @@ Another log message you will see is `Updated Wallet peak to height x, weight y` ## Other Normal Log Messages: -| Component | Message | Direction | Destination | Cross component | Comment | -| ----------------- | ------------------------------------------------ | --------- | ----------- | -------------------- | ------- | -| mempool_manager | add_spendbundle took x seconds | | | | | -| mempool_manager | It took x to pre validate transaction | | | | | -| full_node | Added unfinished_block x, not farmed by us | | | | | -| full_node | Already compactified block: | | | | | -| full_node | Duplicate compact proof. Height: x | | | | | -| full_node | Finished signage point x/64: | | | | | -| full_node | Scanning the blockchain for uncompact blocks. | | | | | -| full_node | Updated peak to height x | | | | | -| full_node_server | new_compact_vdf | to/from | peer | | | -| full_node_server | new_peak | to/from | peer | | | -| full_node_server | new_peak_timelord | to | localhost | from timelord_server | | -| full_node_server | new_peak_wallet | to | localhost | from wallet_server | | -| full_node_server | new_signage_point | to | localhost | from farmer_server | | -| full_node_server | new_signage_point_or_end_of_sub_slot | to/from | peer | | | -| full_node_server | new_transaction | to/from | peer | | | -| full_node_server | new_unfinished_block | to/from | peer | | | -| full_node_server | new_unfinished_block_timelord | to/from | localhost | | | -| full_node_server | request_block | to/from | peer | | | -| full_node_server | request_block_header | from | localhost | to wallet_server | | -| full_node_server | request_compact_vdf | to/from | peer | | | -| full_node_server | request_compact_proof_of_time | to | localhost | from timelord_server | | -| full_node_server | request_signage_point_or_end_of_sub_slot | to/from | peer | | | -| full_node_server | request_transaction | to/from | peer | | | -| full_node_server | request_unfinished_block | to/from | peer | | | -| full_node_server | respond_block | to/from | peer | | | -| full_node_server | respond_compact_vdf | to/from | peer | | | -| full_node_server | respond_signage_point | to/from | peer | | | -| full_node_server | respond_transaction | to/from | peer | | | -| full_node_server | respond_unfinished_block | to/from | peer | | | -| wallet_server | request_block_header | to | localhost | from full_node | | -| wallet_server | respond_block_header | from | localhost | to full_node | | -| wallet_server | new_peak_wallet | from | localhost | to full_node | | -| wallet_blockchain | Updated Wallet peak to height x, weight y | | | | | -| timelord_server | new_peak_timelord | from | localhost | to full_node | | -| timelord_server | new_unfinished_block_timelord | from | localhost | to full_node | | -| timelord_launcher | VDF client x: VDF Client: Discriminant = | | | | | -| VDF Client | Sending Proof, Sent Proof, Stopped everything! | | | | | -| harvester_server | farming_info | to/from | localhost | | | -| harvester_server | new_signage_point_harvester | from | localhost | to farmer_server | | -| harvester | x plots were eligible for farming | | | | | -| plot_tools | Loaded a total of x plots of size y in z seconds | | | | | -| plot_tools | Searching directories | | | | | -| farmer_server | new_signage_point | from | localhost | to full_node | | -| farmer_server | farming_info | from | localhost | to full_node | | -| farmer_server | new_signage_point_harvester | to | localhost | from harvester | | - -| Source | Level | Message | Description | -| ----------------------------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| daemon asyncio | ERROR | Task exception was never retrieved future: ` exception=ValueError('list.remove(x): x not in list')>` | | -| full_node asyncio | ERROR | SSL error in data received protocol: `` | | -| full_node full_node_server | ERROR | Exception: Failed to fetch block `N` from \{'host': `IP ADDRESS`, 'port': 8444\}, timed out, \{'host': `IP ADDRESS`, 'port': 8444\}. | Peer disconnected, other peer connections will take over | -| full_node full_node_server | ERROR | Exception: ``, closing connection None. | Peer disconnected | -| full_node full_node_server | WARNING | [Errno 32] Broken pipe `IP Address` | Peer disconnected | -| full_node full_node_server | WARNING | Cannot write to closing transport `IP Address` | Peer disconnected | -| harvester src.plotting.plot_tools | WARNING | Not farming plot `plotfilename`. Size is `filesize` GiB, but expected at least: 99.06 GiB. We assume the file is being copied. | Periodic scan for new plots have discovered partial file - OK if you are in the middle of copying a file | -| harvester src.plotting.plot_tools | WARNING | Directory: `Dir1` does not exist. | One of your monitored plot folders is no longer accessible - eg external drive offline - if permanent remove from GUI or `chia plots remove -d ` | -| harvester src.plotting.plot_tools | WARNING | Have multiple copies of the plot `plotfilename`, not adding it. | | -| harvester src.plotting.plot_tools | INFO | Not checking subdirectory `Dir1/directory`, subdirectories not added by default | | -| full_node full_node_server | INFO | Connection closed: `IP Address`, node id: `hex` | Peer disconnected | -| full_node src.full_node.full_node | INFO | ⏲️ Finished signage point `N`/64: `hex` | | -| full_node src.full_node.full_node | INFO | Added unfinished_block `hex`, not farmed | | -| harvester src.plotting.plot_tools | INFO | Searching directories [`Dir1`,`Dir2`] | | -| harvester src.plotting.plot_tools | INFO | Loaded a total of `N` plots of size `size` TiB, in `time` seconds | | -| harvester src.harvester.harvester | INFO | `X` plots were eligible for farming `hex`... Found `Y` proofs. Time: `Time` s. Total `Z` plots | This is a vital message and should be seen at regular intervals. Note that `Time` is ideally < 1s. If drive is in sleep mode, may show ~10 seconds, and should be prevented | -| wallet src.wallet.wallet_blockchain | INFO | 💰 Updated wallet peak to height `HEIGHT`, weight `WEIGHT`, | | +| Component | Message | Direction | Destination | Cross component | +| ---------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------- | ----------- | ----------------------------------------- | +| mempool_manager | add_spendbundle took x seconds | | | | +| mempool_manager | It took x to pre validate transaction | | | | +| full_node | Added unfinished_block x, not farmed by us | | | | +| full_node | Already compactified block: | | | | +| full_node | Duplicate compact proof. Height: x | | | | +| full_node | Finished signage point x/64: | | | | +| full_node | Scanning the blockchain for uncompact blocks. | | | | +| full_node | Updated peak to height x | | | | +| full_node_server | new_compact_vdf | to/from | peer | | +| full_node_server | new_peak | to/from | peer | | +| full_node_server | new_peak_timelord | to | localhost | from timelord_server | +| full_node_server | new_peak_wallet | to | localhost | from wallet_server | +| full_node_server | new_signage_point | to | localhost | from farmer_server | +| full_node_server | new_signage_point_or_end_of_sub_slot | to/from | peer | | +| full_node_server | new_transaction | to/from | peer | | +| full_node_server | new_unfinished_block | to/from | peer | | +| full_node_server | new_unfinished_block_timelord | to/from | localhost | | +| full_node_server | request_block | to/from | peer | | +| full_node_server | request_block_header | from | localhost | to wallet_server | +| full_node_server | request_compact_vdf | to/from | peer | | +| full_node_server | request_compact_proof_of_time | to | localhost | from timelord_server | +| full_node_server | request_signage_point_or_end_of_sub_slot | to/from | peer | | +| full_node_server | request_transaction | to/from | peer | | +| full_node_server | request_unfinished_block | to/from | peer | | +| full_node_server | respond_block | to/from | peer | | +| full_node_server | respond_compact_vdf | to/from | peer | | +| full_node_server | respond_signage_point | to/from | peer | | +| full_node_server | respond_transaction | to/from | peer | | +| full_node_server | respond_unfinished_block | to/from | peer | | +| wallet_server | request_block_header | to | localhost | from full_node | +| wallet_server | respond_block_header | from | localhost | to full_node | +| wallet_server | new_peak_wallet | from | localhost | to full_node | +| wallet_blockchain | Updated Wallet peak to height x, weight y | | | | +| timelord_server | new_peak_timelord | from | localhost | to full_node | +| timelord_server | new_unfinished_block_timelord | from | localhost | to full_node | +| timelord_launcher | VDF client x: VDF Client: Discriminant = | | | | +| VDF Client | Sending Proof, Sent Proof, Stopped everything! | | | | +| harvester_server | farming_info | to/from | localhost | | +| harvester_server | new_signage_point_harvester | from | localhost | to farmer_server | +| harvester | x plots were eligible for farming | | | | +| plot_tools | Loaded a total of x plots of size y in z seconds | | | | +| plot_tools | Searching directories | | | | +| farmer_server | new_signage_point | from | localhost | to full_node | +| farmer_server | farming_info | from | localhost | to full_node | +| farmer_server | new_signage_point_harvester | to | localhost | from harvester | + +| Source | Level | Message | Description | +| -------------------------------------------------------------------------------------------------------------------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| daemon asyncio | ERROR | Task exception was never retrieved future: ` exception=ValueError('list.remove(x): x not in list')>` | | +| full_node asyncio | ERROR | SSL error in data received protocol: `` | | +| full_node full_node_server | ERROR | Exception: Failed to fetch block `N` from \{'host': `IP ADDRESS`, 'port': 8444\}, timed out, \{'host': `IP ADDRESS`, 'port': 8444\}. | Peer disconnected, other peer connections will take over | +| full_node full_node_server | ERROR | Exception: ``, closing connection None. | Peer disconnected | +| full_node full_node_server | WARNING | [Errno 32] Broken pipe `IP Address` | Peer disconnected | +| full_node full_node_server | WARNING | Cannot write to closing transport `IP Address` | Peer disconnected | +| harvester src.plotting.plot_tools | WARNING | Not farming plot `plotfilename`. Size is `filesize` GiB, but expected at least: 99.06 GiB. We assume the file is being copied. | Periodic scan for new plots have discovered partial file - OK if you are in the middle of copying a file | +| harvester src.plotting.plot_tools | WARNING | Directory: `Dir1` does not exist. | One of your monitored plot folders is no longer accessible - eg external drive offline - if permanent remove from GUI or `chia plots remove -d ` | +| harvester src.plotting.plot_tools | WARNING | Have multiple copies of the plot `plotfilename`, not adding it. | | +| harvester src.plotting.plot_tools | INFO | Not checking subdirectory `Dir1/directory`, subdirectories not added by default | | +| full_node full_node_server | INFO | Connection closed: `IP Address`, node id: `hex` | Peer disconnected | +| full_node src.full_node.full_node | INFO | ⏲️ Finished signage point `N`/64: `hex` | | +| full_node src.full_node.full_node | INFO | Added unfinished_block `hex`, not farmed | | +| harvester src.plotting.plot_tools | INFO | Searching directories [`Dir1`,`Dir2`] | | +| harvester src.plotting.plot_tools | INFO | Loaded a total of `N` plots of size `size` TiB, in `time` seconds | | +| harvester src.harvester.harvester | INFO | `X` plots were eligible for farming `hex`... Found `Y` proofs. Time: `Time` s. Total `Z` plots | This is a vital message and should be seen at regular intervals. Note that `Time` is ideally < 1s. If drive is in sleep mode, may show ~10 seconds, and should be prevented | +| wallet src.wallet.wallet_blockchain | INFO | 💰 Updated wallet peak to height `HEIGHT`, weight `WEIGHT`, | | + +## Log Search Commands + + + +### search linux or mac logs + +:::info +The below strings are an example of what can be used to search for specific log lines but they are not all-inclusive.\ +You can also use strings from any other log lines in the below command to search for other lines, just make sure you have the correct log level setting for the line that is being searched. +::: + +Functionality: Output log lines that contain the string in terminal + +Usage: `find "$HOME/.chia/mainnet/log" -type f -exec grep -Hn "[STRING]" {} \;` + +Options: + +| String | Minimum Required Log Level | Description | +| --------------- | -------------------------- | ---------------------------------------------------- | +| `ing service` | INFO | Outputs all starting and stopping services log lines | +| `: ERROR` | ERROR | Outputs all error log lines | +| `: WARNING` | WARNING | Outputs all warning log lines | +| `proofs. Time:` | INFO | Outputs all proof check log lines | + +
+Example + +Request: + +```bash +find "$HOME/.chia/mainnet/log" -type f -exec grep -Hn "ing service" {} \; +``` + +Response: + +:::info +The below output contains the `[file_path]:[log_line]:[timestamp] [service] [service] : [log_level] [log_information]`. + +The chia client automatically rotates log files so pay close attention to the file name at the end of the file path if you want to open the file and look for the logs. +::: + +``` +/Users/[username]/.chia/mainnet/log/debug.log:41432:2024-07-26T10:03:21.794 wallet wallet : INFO Starting service wallet ... +/Users/[username]/.chia/mainnet/log/debug.log:41437:2024-07-26T10:06:21.177 wallet wallet : INFO Stopping service wallet at port None ... +``` + +
+ +--- + + + + +### search windows logs + +:::info +The below strings are an example of what can be used to search for specific log lines but they are not all-inclusive.\ +You can also use strings from any other log lines in the below command to search for other lines, just make sure you have the correct log level setting for the line that is being searched. +::: + +Functionality: Output log lines that contain the string in powershell + +Usage: `Get-ChildItem -Path $env:USERPROFILE\.chia\mainnet\log\ -recurse | Select-String -Pattern "[STRING]"` + +Options: + +| String | Minimum Required Log Level | Description | +| --------------- | -------------------------- | ---------------------------------------------------- | +| `ing service` | INFO | Outputs all starting and stopping services log lines | +| `: ERROR` | ERROR | Outputs all error log lines | +| `: WARNING` | WARNING | Outputs all warning log lines | +| `proofs. Time:` | INFO | Outputs all proof check log lines | + +
+Example + +Request: + +```bash +Get-ChildItem -Path $env:USERPROFILE\.chia\mainnet\log\ -recurse | Select-String -Pattern "ing service" +``` + +Response: + +:::info +The below output contains the `[file_path]:[log_line]:[timestamp] [service] [service] : [log_level] [log_information]`. + +The chia client automatically rotates log files so pay close attention to the file name at the end of the file path if you want to open the file and look for the logs. +::: + +``` +C:\Users\[USERNAME]\.chia\mainnet +.chia\mainnet\log\debug.log:21:2024-07-26T10:03:21.794 wallet wallet : INFO Starting service wallet ... +.chia\mainnet\log\debug.log:10042:2024-07-26T10:06:21.177 wallet wallet : INFO Stopping service wallet at port None ... +``` + +
+ +--- + + + diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/troubleshooting/node-syncing.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/troubleshooting/node-syncing.md index 1a0771251e..b13bd8552b 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/troubleshooting/node-syncing.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/troubleshooting/node-syncing.md @@ -6,27 +6,27 @@ slug: /troubleshooting/node-syncing import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -Forwarding port 8444 can solve many sync issues and it also helps improve Chia's overall network health. +Port forwarding port 8444 can solve many sync issues and helps improve Chia's network health. -Port 8444 is the [port](https://en.wikipedia.org/wiki/Port_%28computer_networking%29) through which other Chia nodes can communicate with your node. When you set up port forwarding on port 8444, the Chia software on your computer can easily communicate with other nodes and sync the Chia blockchain faster. +Port 8444 is the [port](https://en.wikipedia.org/wiki/Port_%28computer_networking%29) through which other Chia computers can communicate with your PC. When you set up port forwarding on port 8444, the Chia software on your computer can quickly talk to other PCs, link up, and start downloading and syncing with the Chia blockchain. -The network is undergoing rapid growth and expansion. Many newly arriving Chia nodes do not open port 8444, resulting in additional stress to the network. Therefore, it is strongly recommended that you enable port forwarding. +The network is undergoing rapid growth and expansion. Many of the newly arrived Chia peers (computers) do not open up port 8444. Therefore, it is strongly recommended that you enable port forwarding. -Use [this port checker](https://portchecker.co/) to check if you have port forwarding configured correctly. +Use [this port checker](https://portchecker.co/) to check if your router's port 8444 is closed. ## Port Forwarding Settings Port forwarding is done on your router. How you set it up depends on your router's make and model. Look through your router's manual or just search for "`` how to port forward" to get started. -When you enable port forwarding, you are allowing any system on the Internet to connect to your Chia node through port 8444 to the Chia software. +When you port forward you want to allow outside IP addresses to connect to your main node (computer) through port 8444 to the Chia software. Most routers will ask you from where you are allowing and to what you are connecting to. You want to set up port forwarding to allow any outside connection to connect to the IP address of your main node on your network through port 8444. Router manufacturers might call the settings different things, but the concept is always the same: Outside computers connecting through port 8444 to your computer. Here are the settings most routers will ask for: - Set connection type to _TCP_ or _TCP & UDP_ -- Destination (or forwarding) IP address - This is your main node (computer) IP address on your internal network; search online on how to do this for your type of computer. If you search for "what is my IP address" it will give you your external IP address, this is not the one you want. -- Originating (or from) IP address - Set this to all or sometimes just an asterisk may be used `*` +- Destination (or Forwarding) IP address - This is your main node (computer) IP address on your internal network; search online on how to do this for your type of computer. If you search for "what is my IP address" it will give you your external IP address, this is not the one you want. +- Originating (or From) IP address - Set this to all or sometimes just an asterisk may be used `*` ## Why forward port 8444? @@ -48,46 +48,50 @@ values={[ - - Mainnet Introducer: `introducer.chia.net:8444` +``` +- Mainnet Introducer: `introducer.chia.net:8444` - Note: please only use the CNI operated nodes as a last resort for connecting to peers, these nodes might be running different client versions and are not intended to be used as trusted full nodes. - - CNI Operated Full Node: `node.chia.net` +Note: please only use the CNI operated nodes as a last resort for connecting to peers, these nodes might be running different client versions and are not intended to be used as trusted full nodes. +- CNI Operated Full Node: `node.chia.net` - Additionally, you can also visit either of the below websites that are frequently updated with available nodes listening on port 8444: - - [ChiaNodes.com](https://ChiaNodes.com) - - [chia.keva.app](https://chia.keva.app) +Additionally, you can also visit either of the below websites that are frequently updated with available nodes listening on port 8444: +- [ChiaNodes.com](https://ChiaNodes.com) +- [chia.keva.app](https://chia.keva.app) +``` - - DNS Introducer: `dns-introducer-testnet11.chia.net` - - Legacy Introducer: `introducer-testnet11.chia.net:58444` +``` +- DNS Introducer: `dns-introducer-testnet11.chia.net` +- Legacy Introducer: `introducer-testnet11.chia.net:58444` - Note: please only use the CNI operated nodes as a last resort for connecting to peers, these nodes might be running different client versions and are not intended to be used as trusted full nodes. - - CNI Operated Full Node: `testnet11-node.chia.net` +Note: please only use the CNI operated nodes as a last resort for connecting to peers, these nodes might be running different client versions and are not intended to be used as trusted full nodes. +- CNI Operated Full Node: `testnet11-node.chia.net` +``` -Nodes (IPs) from these sites can be added in the GUI from the Full Node tab, select the Full Node button in the top right corner and then choose "Connect to Other Peers". You can also add nodes via the CLI with the command `chia peer full_node -a PEER_ADDRESS:PORT` where `PORT` will typically be 8444. +Nodes (IPs) from these sites can be added in the GUI from the Full Node tab, select the Full Node button in the top right corner and then choose "Connect to Other Peers". These can be added in the GUI via the button, or via the CLI with `chia show -a PEER_ADDRESS:PORT` where `PORT` will usually be 8444. ## Detailed explanation -A regular pc can communicate out with endless ports-- if the user is sending a signal out -- pc opens a port -- signal goes out, pc closes the port. Chia uses port 8444 as instant verified communication. So an open port can allow instant communication and start the blockchain sync. Signal comes in on port 8444- that Chia pc is verified, then both user's pc, opens their own "communication ports ex port 8421" and that new user can now sync and now they are linked together forming part of Chia mesh. +A regular pc can communicate **out** with endless ports-- if the user is sending a signal out -- pc opens a port -- signal goes out, pc closes the port. Chia uses port 8444 as instant verified communication. So an open port can allow instant communication and start the blockchain sync. Signal comes in on port 8444- that Chia pc is verified, then **both** user's pc, opens their own "communication ports ex port 8421" and that new user can now sync and now they are linked together forming part of Chia mesh. If the users port 8444 is closed, the users pc has to start sending multiple signals out and hope that a pc with open port 8444 will link with them, then the sync starts. (1) pc can only link up a few pc and with so many other Chia users coming on board, they all have to wait. Keep in mind, Chia is built on a mesh network, the blockchain is shared among all the users, not from central pc. ## Dealing With Carrier-Grade NAT -Have you opened port 8444 on your router but still not getting connections? With the exhaustion of the IPv4 network space, it's increasingly common for ISPs to use [Carrier-Grade NAT](https://en.wikipedia.org/wiki/Carrier-grade_NAT) (CGN, CG-NAT, NAT444) by placing multiple customers behind a single IP address. In this case, even if you open 8444 on your router, other nodes will not be able to connect to you. There are a couple options: +Opened port 8444 on your router but still not getting connections? With the exhaustion of the IPv4 space, it's increasingly common for ISPs to use [Carrier-Grade NAT](https://en.wikipedia.org/wiki/Carrier-grade_NAT) (CGN, CG-NAT, NAT444) to put multiple customers behind a single IP address. In this case, even if you open 8444 on your router, other nodes will not be able to connect to you. There are a couple options: -1. Ask your ISP for a dedicated IP address. They'll probably want more money and may require you to upgrade to a "business" plan. +1. Ask your ISP for a dedicated IP address. They'll probably want more money, and may require you to upgrade to a "business" plan. -2. Establish a VPN tunnel through the NAT to a cloud server with a public IP address. It's easier than it sounds and can cost as little as $3-5 a month for a cheap cloud server (some common cloud server providers: AWS, GCP, Digital Ocean, Vultr, Hetzner, Linode). When selecting a provider and server size, pay careful attention to bandwidth; a Chia fullnode isn't too demanding, but can require several GB per day. 1 TB per month is typical of lower-cost VPSs and should be plenty (do keep an eye on it though, bandwidth overage costs can be expensive!). +2. Establish a VPN tunnel through the NAT to a cloud server with a public IP address. It's easier than it sounds, and can cost as little as $3-5 a month for a cheap cloud server (some common cloud server providers: AWS, GCP, Digital Ocean, Vultr, Hetzner, Linode). When selecting a provider and server size, pay careful attention to bandwidth; a Chia fullnode isn't too demanding, but can require several GB per day. 1 TB per month is typical of lower-cost VPSs and should be plenty (do keep an eye on it though, bandwidth overage costs can be expensive!). Setting up a VPN used to be a daunting task, but [Wireguard](https://www.wireguard.com) has greatly simplified it. The summary is you run Wireguard on both your home server and the cloud server: -- the cloud server is configured to listen for VPN connections from your home server and route all traffic incoming on 8444 to your home server, while also routing outgoing traffic from your home server to the internet. +- the cloud server is configured to listen for VPN connections from your home server, and route all traffic incoming on 8444 to your home server, while also routing outgoing traffic from your home server to the internet. - the home server is configured to route all internet traffic (but not local) through the cloud server, while periodically sending a "keepalive" packet to ensure the connection stays open. Here is a more detailed write-up with [example wireguard configuration](https://www.kmr.me/posts/wireguard/). diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/walletconnect/general.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/walletconnect/general.md index 7ed073feb5..20dd3d20d9 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/walletconnect/general.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/walletconnect/general.md @@ -250,25 +250,25 @@ Gets the current sync status of the wallet. ### TransactionRecord -| Parameter | Type | Description | -| ------------------- | --------------------------------------------------------------------------- | -------------------------------------- | -| `confirmedAtHeight` | `number` | Block height the tx was confirmed. | -| `createdAtTime` | `number` | The timestamp when the tx was created. | -| `toPuzzleHash` | `string` | The destination puzzle hash. | -| `amount` | `number` | The amount sent in mojos. | -| `feeAmount` | `number` | The transaction fee in mojos. | -| `confirmed` | `boolean` | Whether the tx was confirmed. | -| `sent` | `number` | Number of peers the tx was sent to. | -| `sentTo` | [`Peer[]`](/walletconnect-commands#peer) | The peers the tx has been sent to. | -| `spendBundle` | [SpendBundle](/walletconnect-commands#spendbundle) | null | The associated spend bundle. | -| `additions` | [`Coin[]`](/walletconnect-commands#coin) | Created coins in the block. | -| `removals` | [`Coin[]`](/walletconnect-commands#coin) | Spent coins in the block. | -| `walletId` | `number` | The wallet id. | -| `toAddress` | `string` | The bech32m encoded `to_puzzle_hash`. | -| `trade_id` | string | null | | -| `type` | [`TransactionType`](/walletconnect-commands#transactiontype) | The type of transaction. | -| `name` | `string` | The transaction's id. | -| `memos` | `Memo[]` | The memos associated with the tx. | +| Parameter | Type | Description | +| ------------------- | ------------------------------------------------------------ | -------------------------------------- | +| `confirmedAtHeight` | `number` | Block height the tx was confirmed. | +| `createdAtTime` | `number` | The timestamp when the tx was created. | +| `toPuzzleHash` | `string` | The destination puzzle hash. | +| `amount` | `number` | The amount sent in mojos. | +| `feeAmount` | `number` | The transaction fee in mojos. | +| `confirmed` | `boolean` | Whether the tx was confirmed. | +| `sent` | `number` | Number of peers the tx was sent to. | +| `sentTo` | [`Peer[]`](/walletconnect-commands#peer) | The peers the tx has been sent to. | +| `spendBundle` | [SpendBundle](/walletconnect-commands#spendbundle) | null | The associated spend bundle. | +| `additions` | [`Coin[]`](/walletconnect-commands#coin) | Created coins in the block. | +| `removals` | [`Coin[]`](/walletconnect-commands#coin) | Spent coins in the block. | +| `walletId` | `number` | The wallet id. | +| `toAddress` | `string` | The bech32m encoded `to_puzzle_hash`. | +| `trade_id` | string | null | | +| `type` | [`TransactionType`](/walletconnect-commands#transactiontype) | The type of transaction. | +| `name` | `string` | The transaction's id. | +| `memos` | `Memo[]` | The memos associated with the tx. | ### TransactionType @@ -293,7 +293,7 @@ This is a tuple with the following parameters. | ---------------------------- | ------------------------------------------------------------ | -------------------------- | | `peerId` _(item 1)_ | `string` | Peer id. | | `inclusionStatus` _(item 2)_ | [`InclusionStatus`](/walletconnect-commands#inclusionstatus) | Inclusion status. | -| `errorMessage` _(item 3)_ | string | null | Error message, if present. | +| `errorMessage` _(item 3)_ | string | null | Error message, if present. | ### InclusionStatus diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/walletconnect/nfts.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/walletconnect/nfts.md index 54a4832434..a0f160a5ea 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/walletconnect/nfts.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/walletconnect/nfts.md @@ -34,17 +34,17 @@ The output is an object of type [`NftInfo`](#nftinfo). ### `chia_mintNFT` -| Parameter | Type | Description | -| -------------------------------- | ------------------------------- | ------------------------------------- | -| `walletId` | `number` | NFT wallet id. | +| Parameter | Type | Description | +| -------------------------------- | ------------------------- | ------------------------------------- | +| `walletId` | `number` | NFT wallet id. | | `royaltyAddress` _(optional)_ | string | null | Address royalty is sent to. | | `royaltyPercentage` _(optional)_ | number | null | Creator royalty percent. (1000 = 1%) | | `targetAddress` _(optional)_ | string | null | Address NFT is sent to upon mint. | -| `uris` | `string[]` | List of NFT content URIs. | -| `hash` | `string` | Hash of the NFT content. | -| `metaUris` | `string[]` | List of metadata URIs. | +| `uris` | `string[]` | List of NFT content URIs. | +| `hash` | `string` | Hash of the NFT content. | +| `metaUris` | `string[]` | List of metadata URIs. | | `metaHash` _(optional)_ | string | null | Hash of the metadata. | -| `licenseUris` | `string[]` | List of the license URIs. | +| `licenseUris` | `string[]` | List of the license URIs. | | `licenseHash` _(optional)_ | string | null | Hash of the license. | | `editionNumber` _(optional)_ | number | null | Number of the current NFT in edition. | | `editionTotal` _(optional)_ | number | null | How many NFTs in the current edition. | @@ -74,7 +74,7 @@ The output is an object of type [`NftInfo`](#nftinfo). | Parameter | Type | Description | | --------------------- | ---------------------------------------------------- | --------------------- | -| `walletId` | number | number[] | NFT wallet id(s). | +| `walletId` | number | number[] | NFT wallet id(s). | | `spendBundle` | [`SpendBundle`](/walletconnect-commands#spendbundle) | Created spend bundle. | | `txNum?` _(optional)_ | `number` | Transaction number. | @@ -116,32 +116,32 @@ Sets the owner DID associated with a given NFT. ### NFTInfo -| Parameter | Type | Description | -| --------------------------- | ------------------------------- | -------------------------------------- | -| `nftId` | `string` | The NFT id. | -| `launcherId` | `string` | The launcher id. | -| `nftCoinId` | `string` | The current coin id. | -| `nftCoinConfirmationHeight` | `number` | Current NFT coin confirmation height | +| Parameter | Type | Description | +| --------------------------- | -------------------------- | -------------------------------------- | +| `nftId` | `string` | The NFT id. | +| `launcherId` | `string` | The launcher id. | +| `nftCoinId` | `string` | The current coin id. | +| `nftCoinConfirmationHeight` | `number` | Current NFT coin confirmation height | | `ownerDid` | string | null | The owner DID. | | `royaltyPercentage` | number | null | Creator royalty percent. (1000 = 1%) | | `royaltyPuzzleHash` | string | null | Puzzle hash royalty is sent to. | -| `royaltyAddress` | `string` | Address royalty is sent to. | -| `targetAddress` | `string` | Address NFT is sent to upon mint. | -| `uris` | `string[]` | List of NFT content URIs. | -| `hash` | `string` | Hash of the NFT content. | -| `metaUris` | `string[]` | List of metadata URIs. | -| `metaHash` | `string` | Hash of the metadata. | -| `licenseUris` | `string[]` | List of the license URIs. | -| `licenseHash` | `string` | Hash of the license. | -| `editionTotal` | `number` | How many NFTs in the current edition. | -| `editionNumber` | `number` | Number of the current NFT in edition. | -| `updaterPuzhash` | `string` | Puzzle hash of the metadata updater. | -| `chainInfo` | `string` | Information saved on the chain. | -| `mintHeight` | `number` | Block height when the NFT was minted. | -| `supportsDid` | `boolean` | Whether the inner puzzle supports DID. | -| `p2Address` | `string` | The innermost puzzle hash of the NFT. | -| `pendingTransaction` | `boolean` | Whether the NFT is pending for a tx. | +| `royaltyAddress` | `string` | Address royalty is sent to. | +| `targetAddress` | `string` | Address NFT is sent to upon mint. | +| `uris` | `string[]` | List of NFT content URIs. | +| `hash` | `string` | Hash of the NFT content. | +| `metaUris` | `string[]` | List of metadata URIs. | +| `metaHash` | `string` | Hash of the metadata. | +| `licenseUris` | `string[]` | List of the license URIs. | +| `licenseHash` | `string` | Hash of the license. | +| `editionTotal` | `number` | How many NFTs in the current edition. | +| `editionNumber` | `number` | Number of the current NFT in edition. | +| `updaterPuzhash` | `string` | Puzzle hash of the metadata updater. | +| `chainInfo` | `string` | Information saved on the chain. | +| `mintHeight` | `number` | Block height when the NFT was minted. | +| `supportsDid` | `boolean` | Whether the inner puzzle supports DID. | +| `p2Address` | `string` | The innermost puzzle hash of the NFT. | +| `pendingTransaction` | `boolean` | Whether the NFT is pending for a tx. | | `didId` | string | null | The DID used during an NFT mint. | | `minterDid` | string | null | The minter DID. | -| `launcherPuzhash` | `string` | Singleton launcher puzzle hash. | +| `launcherPuzhash` | `string` | Singleton launcher puzzle hash. | | `offChainMetadata` | string | null | Serialized off-chain metadata. | diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/walletconnect/offers.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/walletconnect/offers.md index 85a8783eff..456bbc0e98 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/walletconnect/offers.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/walletconnect/offers.md @@ -155,17 +155,17 @@ Creates an offer for wallet ids. | Parameter | Type | Description | | ------------------ | -------------------------------------------------- | -------------------------------------------- | -| `acceptedAtTime` | number | null | Timestamp when the trade was accepted. | +| `acceptedAtTime` | number | null | Timestamp when the trade was accepted. | | `coinsOfInterest` | [`Coin[]`](/walletconnect-commands#coin) | Coins involved in trade. | | `confirmedAtIndex` | `number` | Confirmation block index. | | `createdAtTime` | `number` | Timestamp when the trade was created. | | `isMyOffer` | `boolean` | Whether this is the wallet's own offer. | -| `pending` | `Record` | Pending amounts. | +| `pending` | `Record` | Pending amounts. | | `sent` | `number` | Number of peers the transaction was sent to. | | `sentTo` | [`Peer[]`](/walletconnect-commands#peer) | Peers the transaction was sent to. | | `status` | [`TradeStatus`](/walletconnect-offers#tradestatus) | Trade status. | | `summary` | `any` | Trade summary metadata. | -| `takenOffer` | string | null | Taken bech32m encoded offer data. | +| `takenOffer` | string | null | Taken bech32m encoded offer data. | | `tradeId` | `string` | Trade id. | | `_offerData` | `string` | Bech32m encoded offer data. |