From c15416bc9bc8b9f541c1fbdd2f4d135778d2001d Mon Sep 17 00:00:00 2001 From: Xiaohui Date: Wed, 17 Jul 2024 16:40:40 -0700 Subject: [PATCH] fix broken link --- docs/advanced/sighash-type.md | 2 +- docs/bitcoin-basics/bitcoin-basics.md | 2 +- docs/how-to-publish-a-contract.md | 2 +- docs/how-to-write-a-contract/built-ins.md | 6 +++--- docs/how-to-write-a-contract/stateful-contract.md | 2 +- docs/tutorials/hello-world.md | 4 ++-- open-api/btc-blockchain/get-address-balance.api.mdx | 6 +++--- .../btc-blockchain/get-address-transaction-history.api.mdx | 6 +++--- open-api/btc-blockchain/get-address-utxo.api.mdx | 6 +++--- open-api/btc-blockchain/get-transaction-summary.api.mdx | 6 +++--- open-api/btc-token/deploy-a-brc-20-token.api.mdx | 6 +++--- open-api/btc-token/etch-a-rune.api.mdx | 6 +++--- open-api/btc-token/get-address-brc-20-balance-list.api.mdx | 6 +++--- open-api/btc-token/get-address-brc-20-balance.api.mdx | 6 +++--- open-api/btc-token/get-address-runes-balance-list.api.mdx | 6 +++--- open-api/btc-token/get-address-runes-balance.api.mdx | 6 +++--- open-api/btc-token/get-address-runes-history.api.mdx | 6 +++--- open-api/btc-token/get-address-runes-utxo-list.api.mdx | 6 +++--- open-api/btc-token/get-address-runes-utxo.api.mdx | 6 +++--- open-api/btc-token/get-bitmap-info.api.mdx | 6 +++--- open-api/btc-token/get-bitmap-list-by-address.api.mdx | 6 +++--- open-api/btc-token/get-bitmap-list.api.mdx | 6 +++--- open-api/btc-token/get-brc-20-holders.api.mdx | 6 +++--- open-api/btc-token/get-brc-20-ticker-info.api.mdx | 6 +++--- open-api/btc-token/get-inscription-content.api.mdx | 6 +++--- open-api/btc-token/get-inscription-info-by-address.api.mdx | 6 +++--- open-api/btc-token/get-inscription-info-by-outpoint.api.mdx | 6 +++--- open-api/btc-token/get-inscription-info.api.mdx | 6 +++--- open-api/btc-token/get-order-info.api.mdx | 6 +++--- open-api/btc-token/get-outpoint-runes-balance-list.api.mdx | 6 +++--- open-api/btc-token/get-runes-holders.api.mdx | 6 +++--- open-api/btc-token/get-runes-info.api.mdx | 6 +++--- open-api/btc-token/get-sns-name-info.api.mdx | 6 +++--- open-api/btc-token/get-sns-name-list-by-address.api.mdx | 6 +++--- open-api/btc-token/get-sns-name-list-by-namespace.api.mdx | 6 +++--- open-api/btc-token/get-sns-name-list.api.mdx | 6 +++--- .../btc-token/get-transferable-brc-20-inscriptions.api.mdx | 6 +++--- open-api/btc-token/inscribe-inscriptions.api.mdx | 6 +++--- open-api/btc-token/mint-a-brc-20-token.api.mdx | 6 +++--- open-api/btc-token/mint-a-rune.api.mdx | 6 +++--- open-api/btc-token/pay-brc-20-minting-order.api.mdx | 6 +++--- open-api/btc-token/pay-deploying-order.api.mdx | 6 +++--- open-api/btc-token/pay-etching-order.api.mdx | 6 +++--- open-api/btc-token/pay-inscribing-order.api.mdx | 6 +++--- open-api/btc-token/pay-minting-order.api.mdx | 6 +++--- open-api/btc-token/pay-transfering-order.api.mdx | 6 +++--- open-api/btc-token/transfer-a-brc-20-token.api.mdx | 6 +++--- 47 files changed, 132 insertions(+), 132 deletions(-) diff --git a/docs/advanced/sighash-type.md b/docs/advanced/sighash-type.md index cf38da660..14a47f01a 100644 --- a/docs/advanced/sighash-type.md +++ b/docs/advanced/sighash-type.md @@ -153,7 +153,7 @@ Sighash here only affects contracts that access `ScriptContext` in their public Let us use the [Counter](../how-to-write-a-contract/stateful-contract.md) contract as an example. It simply records how many times it has been called since deployment. -Noted that the `@method` [decorator](../how-to-write-a-contract/how-to-write-a-contract.md#method-decorator) takes a sighash type as a parameter, whose default is `ALL`. According to the [doc](../how-to-write-a-contract/scriptcontext.md#sighash-type), `hashOutputs` is the double SHA256 of the serialization of **all outputs** when the sighash type is `ALL`. The [default calling transaction builder](../how-to-deploy-and-call-a-contract/how-to-customize-a-contract-tx.md#default-1) adds a change output when necessary. That's why we need to add a change output when building outputs of the spending transaction in the public method: we need to build all the outputs that are included in `hashOutputs`. Otherwise, contract call will fail. +Noted that the `@method` [decorator](../how-to-write-a-contract/basics#method-decorator) takes a sighash type as a parameter, whose default is `ALL`. According to the [doc](../how-to-write-a-contract/scriptcontext.md#sighash-type), `hashOutputs` is the double SHA256 of the serialization of **all outputs** when the sighash type is `ALL`. The [default calling transaction builder](../how-to-deploy-and-call-a-contract/how-to-customize-a-contract-tx.md#default-1) adds a change output when necessary. That's why we need to add a change output when building outputs of the spending transaction in the public method: we need to build all the outputs that are included in `hashOutputs`. Otherwise, contract call will fail. The following [transaction](https://test.whatsonchain.com/tx/845f22b728deb23acacbc6f58f23ffde9c3e2be976e08c57f2bdcb417e3eacc5) is a contract calling transaction of `Counter`. As you can see, it contains two outputs: one for the new state, the other for change. diff --git a/docs/bitcoin-basics/bitcoin-basics.md b/docs/bitcoin-basics/bitcoin-basics.md index e32d61e80..18b743d0d 100644 --- a/docs/bitcoin-basics/bitcoin-basics.md +++ b/docs/bitcoin-basics/bitcoin-basics.md @@ -5,7 +5,7 @@ sidebar_position: 1 If you are new to Bitcoin development, we recommend exploring the resources listed in this section. While not a required prerequisite, going over these guides will help you develop a better understanding of key concepts and make it easier to begin developing sCrypt smart contracts. -If you are already familiar with the basics of Bitcoin, feel free to skip ahead to the [How to Write a Contract](../how-to-write-a-contract/how-to-write-a-contract.md) section. +If you are already familiar with Bitcoin, feel free to skip ahead to the [Basics](../how-to-write-a-contract/basics.md) section. ## Resources diff --git a/docs/how-to-publish-a-contract.md b/docs/how-to-publish-a-contract.md index f04926b8c..21842f17d 100644 --- a/docs/how-to-publish-a-contract.md +++ b/docs/how-to-publish-a-contract.md @@ -43,7 +43,7 @@ class MyLib extends SmartContractLib { } ``` -A smart contract library can be declared as a class that extends `SmartContractLib`. It may also have `@prop`s and `@method`s like smart contracts which have the same rules [introduced before](./how-to-write-a-contract). A smart contract library can be used within `@method`s like this: +A smart contract library can be declared as a class that extends `SmartContractLib`. It may also have `@prop`s and `@method`s like smart contracts which have the same rules [introduced before](./how-to-write-a-contract/basics.md). A smart contract library can be used within `@method`s like this: ```ts class MyContract extends SmartContract { diff --git a/docs/how-to-write-a-contract/built-ins.md b/docs/how-to-write-a-contract/built-ins.md index 5c7eb5cdf..f2889bc56 100644 --- a/docs/how-to-write-a-contract/built-ins.md +++ b/docs/how-to-write-a-contract/built-ins.md @@ -23,7 +23,7 @@ assert(false, 'hello') // throws Error('Execution failed, hello') - `fill(value: T, length: number): T[length] ` Returns an `FixedArray` with all `size` elements set to `value`, where `value` can be any type. :::note -`length` must be a [compiled-time constant](./how-to-write-a-contract.md#compile-time-constant). +`length` must be a [compiled-time constant](./basics#compile-time-constant). ::: @@ -118,7 +118,7 @@ len(s2) // 5 - `reverseByteString(b: ByteString, size: number): ByteString` Returns reversed bytes of `b` which is of `size` bytes. It is often useful when converting a number between little-endian and big-endian. :::note -`size` must be a [compiled-time constant](./how-to-write-a-contract.md#compile-time-constant). +`size` must be a [compiled-time constant](./basics#compile-time-constant). ::: ```ts @@ -595,7 +595,7 @@ Utils.buildOpreturnScript(data) // '006a0b68656c6c6f20776f726c64' #### On-chain -The main difference between `HashedMap` and other data types we’ve [previously introduced](../how-to-write-a-contract/#data-types) is that it does NOT store raw data (i.e., keys and values) in the contract on the blockchain. It stores their hashed values instead, to minimize on-chain storage, which is expensive. +The main difference between `HashedMap` and other data types we’ve [previously introduced](./basics#data-types) is that it does NOT store raw data (i.e., keys and values) in the contract on the blockchain. It stores their hashed values instead, to minimize on-chain storage, which is expensive. These guidelines must be followed when using `HashedMap` in a contract `@method`, i.e., on-chain context. diff --git a/docs/how-to-write-a-contract/stateful-contract.md b/docs/how-to-write-a-contract/stateful-contract.md index 944d15cfa..c3c4f6916 100644 --- a/docs/how-to-write-a-contract/stateful-contract.md +++ b/docs/how-to-write-a-contract/stateful-contract.md @@ -38,7 +38,7 @@ Let's take a look at the contract source file `/src/contracts/counter.ts`. ### Stateful properties -As shown [before](how-to-write-a-contract.md#properties), a `@prop(true)` decorator is used to make a property part of the contract stateful, meaning it can be mutated when the contract gets called. +As shown [before](basics#properties), a `@prop(true)` decorator is used to make a property part of the contract stateful, meaning it can be mutated when the contract gets called. ```ts @prop(true) diff --git a/docs/tutorials/hello-world.md b/docs/tutorials/hello-world.md index 39578a77d..1d09ff573 100644 --- a/docs/tutorials/hello-world.md +++ b/docs/tutorials/hello-world.md @@ -50,8 +50,8 @@ This `Helloworld` contract stores the sha256 hash of a message in the contract p Now let’s look at what is in the smart contract. - `SmartContract`: all smart contracts must extend the `SmartContract` base class. -- `@prop`: the [`@prop` decorator](../how-to-write-a-contract/how-to-write-a-contract.md#properties) marks a contract property. -- `@method`: the [`@method` decorator](../how-to-write-a-contract/how-to-write-a-contract.md#method-decorator) marks a contract method. A [public method](../how-to-write-a-contract/#public-methods) is an entry point to a contract. +- `@prop`: the [`@prop` decorator](../how-to-write-a-contract/basics#properties) marks a contract property. +- `@method`: the [`@method` decorator](../how-to-write-a-contract/basics#method-decorator) marks a contract method. A [public method](../how-to-write-a-contract/basics#public-methods) is an entry point to a contract. - `assert`: throws an error and makes the method call fail if its first argument is `false`. Here it ensures the passed message hashed to the expected digest. ## Compile Contract diff --git a/open-api/btc-blockchain/get-address-balance.api.mdx b/open-api/btc-blockchain/get-address-balance.api.mdx index 031db8c09..fb05aa7c2 100644 --- a/open-api/btc-blockchain/get-address-balance.api.mdx +++ b/open-api/btc-blockchain/get-address-balance.api.mdx @@ -32,13 +32,13 @@ import TabItem from "@theme/TabItem"; Get balance of an address. -## Request -

Path Parameters

+ +
successful operation -
Schema
    any
+
Bad Request diff --git a/open-api/btc-blockchain/get-address-transaction-history.api.mdx b/open-api/btc-blockchain/get-address-transaction-history.api.mdx index 533ec504a..8fefade9f 100644 --- a/open-api/btc-blockchain/get-address-transaction-history.api.mdx +++ b/open-api/btc-blockchain/get-address-transaction-history.api.mdx @@ -32,13 +32,13 @@ import TabItem from "@theme/TabItem"; Get transaction history of an address. -## Request -

Path Parameters

+ +
successful operation -
Schema
    any
+
Bad Request diff --git a/open-api/btc-blockchain/get-address-utxo.api.mdx b/open-api/btc-blockchain/get-address-utxo.api.mdx index b667fbe66..b8562d7bf 100644 --- a/open-api/btc-blockchain/get-address-utxo.api.mdx +++ b/open-api/btc-blockchain/get-address-utxo.api.mdx @@ -32,13 +32,13 @@ import TabItem from "@theme/TabItem"; Get UTXO of an address. -## Request -

Path Parameters

+ +
successful operation -
Schema
    any
+
Bad Request diff --git a/open-api/btc-blockchain/get-transaction-summary.api.mdx b/open-api/btc-blockchain/get-transaction-summary.api.mdx index 6a0fc19bf..64f69716a 100644 --- a/open-api/btc-blockchain/get-transaction-summary.api.mdx +++ b/open-api/btc-blockchain/get-transaction-summary.api.mdx @@ -32,13 +32,13 @@ import TabItem from "@theme/TabItem"; Get the summary of a transaction. -## Request -

Path Parameters

+ +
successful operation -
Schema
    any
+
Bad Request diff --git a/open-api/btc-token/deploy-a-brc-20-token.api.mdx b/open-api/btc-token/deploy-a-brc-20-token.api.mdx index d83507b36..3f3b92e32 100644 --- a/open-api/btc-token/deploy-a-brc-20-token.api.mdx +++ b/open-api/btc-token/deploy-a-brc-20-token.api.mdx @@ -32,9 +32,9 @@ import TabItem from "@theme/TabItem"; Create order to deploy a brc20 token. -## Request -

Path Parameters

Body

required
+ +

Body

required
Parameters to deploy a brc20 token @@ -42,7 +42,7 @@ Parameters to deploy a brc20 token Successful operation -
Schema
    any
+
Bad Request diff --git a/open-api/btc-token/etch-a-rune.api.mdx b/open-api/btc-token/etch-a-rune.api.mdx index b748b2884..4ff7b8085 100644 --- a/open-api/btc-token/etch-a-rune.api.mdx +++ b/open-api/btc-token/etch-a-rune.api.mdx @@ -32,9 +32,9 @@ import TabItem from "@theme/TabItem"; Create order to etch a rune. -## Request -

Path Parameters

Body

required
+ +

Body

required
Create a order to etch @@ -42,7 +42,7 @@ Create a order to etch Successful operation -
Schema
    any
+
Bad Request diff --git a/open-api/btc-token/get-address-brc-20-balance-list.api.mdx b/open-api/btc-token/get-address-brc-20-balance-list.api.mdx index 9884eaf31..0c24770aa 100644 --- a/open-api/btc-token/get-address-brc-20-balance-list.api.mdx +++ b/open-api/btc-token/get-address-brc-20-balance-list.api.mdx @@ -32,13 +32,13 @@ import TabItem from "@theme/TabItem"; Get BRC-20 balance list by address. -## Request -

Path Parameters

Query Parameters

+ +
successful operation -
Schema
    any
+
Bad Request diff --git a/open-api/btc-token/get-address-brc-20-balance.api.mdx b/open-api/btc-token/get-address-brc-20-balance.api.mdx index 125774988..7f94f1a3e 100644 --- a/open-api/btc-token/get-address-brc-20-balance.api.mdx +++ b/open-api/btc-token/get-address-brc-20-balance.api.mdx @@ -32,13 +32,13 @@ import TabItem from "@theme/TabItem"; Get BRC-20 balance by address and ticker. -## Request -

Path Parameters

+ +
successful operation -
Schema
    any
+
Bad Request diff --git a/open-api/btc-token/get-address-runes-balance-list.api.mdx b/open-api/btc-token/get-address-runes-balance-list.api.mdx index d09ef7aa0..a015ba8b2 100644 --- a/open-api/btc-token/get-address-runes-balance-list.api.mdx +++ b/open-api/btc-token/get-address-runes-balance-list.api.mdx @@ -32,13 +32,13 @@ import TabItem from "@theme/TabItem"; Get runes balance list by address -## Request -

Path Parameters

Query Parameters

+ +
Successful operation -
Schema
    any
+
Bad Request diff --git a/open-api/btc-token/get-address-runes-balance.api.mdx b/open-api/btc-token/get-address-runes-balance.api.mdx index 79a66edb4..38867822f 100644 --- a/open-api/btc-token/get-address-runes-balance.api.mdx +++ b/open-api/btc-token/get-address-runes-balance.api.mdx @@ -32,13 +32,13 @@ import TabItem from "@theme/TabItem"; Get rune balance by address and rune name or ID. -## Request -

Path Parameters

Query Parameters

+ +
Successful operation -
Schema
    any
+
Bad Request diff --git a/open-api/btc-token/get-address-runes-history.api.mdx b/open-api/btc-token/get-address-runes-history.api.mdx index 6778f1ab4..7b146a483 100644 --- a/open-api/btc-token/get-address-runes-history.api.mdx +++ b/open-api/btc-token/get-address-runes-history.api.mdx @@ -32,13 +32,13 @@ import TabItem from "@theme/TabItem"; Get runes address history -## Request -

Path Parameters

Query Parameters

+ +
Successful operation -
Schema
    any
+
Bad Request diff --git a/open-api/btc-token/get-address-runes-utxo-list.api.mdx b/open-api/btc-token/get-address-runes-utxo-list.api.mdx index 4e7a4de87..ba1c7bd4b 100644 --- a/open-api/btc-token/get-address-runes-utxo-list.api.mdx +++ b/open-api/btc-token/get-address-runes-utxo-list.api.mdx @@ -32,13 +32,13 @@ import TabItem from "@theme/TabItem"; Get runes UTXO list by address -## Request -

Path Parameters

Query Parameters

+ +
Successful operation -
Schema
    any
+
Bad Request diff --git a/open-api/btc-token/get-address-runes-utxo.api.mdx b/open-api/btc-token/get-address-runes-utxo.api.mdx index dcdd4b8b3..8a67a214b 100644 --- a/open-api/btc-token/get-address-runes-utxo.api.mdx +++ b/open-api/btc-token/get-address-runes-utxo.api.mdx @@ -32,13 +32,13 @@ import TabItem from "@theme/TabItem"; Get rune UTXO by address and rune name or ID. -## Request -

Path Parameters

Query Parameters

+ +
Successful operation -
Schema
    any
+
Bad Request diff --git a/open-api/btc-token/get-bitmap-info.api.mdx b/open-api/btc-token/get-bitmap-info.api.mdx index c5b8ccdd4..508fd36a0 100644 --- a/open-api/btc-token/get-bitmap-info.api.mdx +++ b/open-api/btc-token/get-bitmap-info.api.mdx @@ -32,13 +32,13 @@ import TabItem from "@theme/TabItem"; Get bitmap info by number or inscription ID. -## Request -

Path Parameters

+ +
Successful operation -
Schema
    any
+
Bad Request diff --git a/open-api/btc-token/get-bitmap-list-by-address.api.mdx b/open-api/btc-token/get-bitmap-list-by-address.api.mdx index a0e4f04a1..b6ed62b5c 100644 --- a/open-api/btc-token/get-bitmap-list-by-address.api.mdx +++ b/open-api/btc-token/get-bitmap-list-by-address.api.mdx @@ -32,13 +32,13 @@ import TabItem from "@theme/TabItem"; Get bitmap list by address. -## Request -

Path Parameters

Query Parameters

+ +
Successful operation -
Schema
    any
+
Bad Request diff --git a/open-api/btc-token/get-bitmap-list.api.mdx b/open-api/btc-token/get-bitmap-list.api.mdx index da0de1f29..72af75c2d 100644 --- a/open-api/btc-token/get-bitmap-list.api.mdx +++ b/open-api/btc-token/get-bitmap-list.api.mdx @@ -32,13 +32,13 @@ import TabItem from "@theme/TabItem"; Get bitmap list. -## Request -

Path Parameters

Query Parameters

+ +
Successful operation -
Schema
    any
+
Bad Request diff --git a/open-api/btc-token/get-brc-20-holders.api.mdx b/open-api/btc-token/get-brc-20-holders.api.mdx index cb4c3912f..f015911fd 100644 --- a/open-api/btc-token/get-brc-20-holders.api.mdx +++ b/open-api/btc-token/get-brc-20-holders.api.mdx @@ -32,13 +32,13 @@ import TabItem from "@theme/TabItem"; Get the holders of BRC-20 by ticker. -## Request -

Path Parameters

Query Parameters

+ +
successful operation -
Schema
    any
+
Bad Request diff --git a/open-api/btc-token/get-brc-20-ticker-info.api.mdx b/open-api/btc-token/get-brc-20-ticker-info.api.mdx index 31dfdff75..9bff0a9ab 100644 --- a/open-api/btc-token/get-brc-20-ticker-info.api.mdx +++ b/open-api/btc-token/get-brc-20-ticker-info.api.mdx @@ -32,13 +32,13 @@ import TabItem from "@theme/TabItem"; Get the infomation of BRC-20 by ticker. -## Request -

Path Parameters

+ +
successful operation -
Schema
    any
+
Bad Request diff --git a/open-api/btc-token/get-inscription-content.api.mdx b/open-api/btc-token/get-inscription-content.api.mdx index b966e8225..4a7a2ed90 100644 --- a/open-api/btc-token/get-inscription-content.api.mdx +++ b/open-api/btc-token/get-inscription-content.api.mdx @@ -32,13 +32,13 @@ import TabItem from "@theme/TabItem"; Get Ordinals inscription content info by inscription ID. -## Request -

Path Parameters

+ +
Successful operation -
Schema
    any
Schema
    any
Schema
    any
"} language={"xml"}>
Schema
    any
Schema
    any
Schema
    any
Schema
    any
Schema
    any
Schema
    any
Schema
    any
Schema
    any
+
Bad Request diff --git a/open-api/btc-token/get-inscription-info-by-address.api.mdx b/open-api/btc-token/get-inscription-info-by-address.api.mdx index fc5fcee11..78f0945fb 100644 --- a/open-api/btc-token/get-inscription-info-by-address.api.mdx +++ b/open-api/btc-token/get-inscription-info-by-address.api.mdx @@ -32,13 +32,13 @@ import TabItem from "@theme/TabItem"; Get Ordinals inscription info by owner address. -## Request -

Path Parameters

+ +
Successful operation -
Schema
    any
+
Bad Request diff --git a/open-api/btc-token/get-inscription-info-by-outpoint.api.mdx b/open-api/btc-token/get-inscription-info-by-outpoint.api.mdx index 126a0bcbd..fd2fac122 100644 --- a/open-api/btc-token/get-inscription-info-by-outpoint.api.mdx +++ b/open-api/btc-token/get-inscription-info-by-outpoint.api.mdx @@ -32,13 +32,13 @@ import TabItem from "@theme/TabItem"; Get Ordinals inscription info by outpoint. -## Request -

Path Parameters

+ +
Successful operation -
Schema
    any
+
Bad Request diff --git a/open-api/btc-token/get-inscription-info.api.mdx b/open-api/btc-token/get-inscription-info.api.mdx index 8de8c1270..e217aa550 100644 --- a/open-api/btc-token/get-inscription-info.api.mdx +++ b/open-api/btc-token/get-inscription-info.api.mdx @@ -32,13 +32,13 @@ import TabItem from "@theme/TabItem"; Get Ordinals inscription info by inscription ID. -## Request -

Path Parameters

+ +
Successful operation -
Schema
    any
+
Bad Request diff --git a/open-api/btc-token/get-order-info.api.mdx b/open-api/btc-token/get-order-info.api.mdx index a509eaaf5..5a3afbe6f 100644 --- a/open-api/btc-token/get-order-info.api.mdx +++ b/open-api/btc-token/get-order-info.api.mdx @@ -32,13 +32,13 @@ import TabItem from "@theme/TabItem"; Get order info by order id. -## Request -

Path Parameters

Query Parameters

+ +
Successful operation -
Schema
    any
+
Bad Request diff --git a/open-api/btc-token/get-outpoint-runes-balance-list.api.mdx b/open-api/btc-token/get-outpoint-runes-balance-list.api.mdx index 8ad894f69..75f442932 100644 --- a/open-api/btc-token/get-outpoint-runes-balance-list.api.mdx +++ b/open-api/btc-token/get-outpoint-runes-balance-list.api.mdx @@ -32,13 +32,13 @@ import TabItem from "@theme/TabItem"; Get runes balance list by transaction outpoint. -## Request -

Path Parameters

+ +
Successful operation -
Schema
    any
+
Bad Request diff --git a/open-api/btc-token/get-runes-holders.api.mdx b/open-api/btc-token/get-runes-holders.api.mdx index dd4f7f398..692bafc06 100644 --- a/open-api/btc-token/get-runes-holders.api.mdx +++ b/open-api/btc-token/get-runes-holders.api.mdx @@ -32,13 +32,13 @@ import TabItem from "@theme/TabItem"; Get rune holders by Rune name or ID. -## Request -

Path Parameters

Query Parameters

+ +
Successful operation -
Schema
    any
+
Bad Request diff --git a/open-api/btc-token/get-runes-info.api.mdx b/open-api/btc-token/get-runes-info.api.mdx index cd9c8590b..007c413f4 100644 --- a/open-api/btc-token/get-runes-info.api.mdx +++ b/open-api/btc-token/get-runes-info.api.mdx @@ -32,13 +32,13 @@ import TabItem from "@theme/TabItem"; Get rune info by rune name or ID. -## Request -

Path Parameters

+ +
Successful operation -
Schema
    any
+
Bad Request diff --git a/open-api/btc-token/get-sns-name-info.api.mdx b/open-api/btc-token/get-sns-name-info.api.mdx index da2852e2c..65089bcbd 100644 --- a/open-api/btc-token/get-sns-name-info.api.mdx +++ b/open-api/btc-token/get-sns-name-info.api.mdx @@ -32,13 +32,13 @@ import TabItem from "@theme/TabItem"; Get SNS name info by name or inscription ID. -## Request -

Path Parameters

+ +
Successful operation -
Schema
    any
+
Bad Request diff --git a/open-api/btc-token/get-sns-name-list-by-address.api.mdx b/open-api/btc-token/get-sns-name-list-by-address.api.mdx index b0fe67d00..00ac5631b 100644 --- a/open-api/btc-token/get-sns-name-list-by-address.api.mdx +++ b/open-api/btc-token/get-sns-name-list-by-address.api.mdx @@ -32,13 +32,13 @@ import TabItem from "@theme/TabItem"; Get sns name list by address. -## Request -

Path Parameters

Query Parameters

+ +
Successful operation -
Schema
    any
+
Bad Request diff --git a/open-api/btc-token/get-sns-name-list-by-namespace.api.mdx b/open-api/btc-token/get-sns-name-list-by-namespace.api.mdx index 1e19286b0..39a699dd4 100644 --- a/open-api/btc-token/get-sns-name-list-by-namespace.api.mdx +++ b/open-api/btc-token/get-sns-name-list-by-namespace.api.mdx @@ -32,13 +32,13 @@ import TabItem from "@theme/TabItem"; Get sns name list by namespace. -## Request -

Path Parameters

Query Parameters

+ +
Successful operation -
Schema
    any
+
Bad Request diff --git a/open-api/btc-token/get-sns-name-list.api.mdx b/open-api/btc-token/get-sns-name-list.api.mdx index 97490045f..5f80822a6 100644 --- a/open-api/btc-token/get-sns-name-list.api.mdx +++ b/open-api/btc-token/get-sns-name-list.api.mdx @@ -32,13 +32,13 @@ import TabItem from "@theme/TabItem"; Get sns name list. -## Request -

Path Parameters

Query Parameters

+ +
Successful operation -
Schema
    any
+
Bad Request diff --git a/open-api/btc-token/get-transferable-brc-20-inscriptions.api.mdx b/open-api/btc-token/get-transferable-brc-20-inscriptions.api.mdx index 5e131d641..e7a26938f 100644 --- a/open-api/btc-token/get-transferable-brc-20-inscriptions.api.mdx +++ b/open-api/btc-token/get-transferable-brc-20-inscriptions.api.mdx @@ -32,13 +32,13 @@ import TabItem from "@theme/TabItem"; Get BRC-20 transferable inscriptions by address and ticker. -## Request -

Path Parameters

+ +
successful operation -
Schema
    any
+
Bad Request diff --git a/open-api/btc-token/inscribe-inscriptions.api.mdx b/open-api/btc-token/inscribe-inscriptions.api.mdx index 2a6260f5e..4415b84d1 100644 --- a/open-api/btc-token/inscribe-inscriptions.api.mdx +++ b/open-api/btc-token/inscribe-inscriptions.api.mdx @@ -32,9 +32,9 @@ import TabItem from "@theme/TabItem"; Create order to inscribe inscriptions. -## Request -

Path Parameters

Body

required
+ +

Body

required
Parameters to inscribe inscriptions. @@ -42,7 +42,7 @@ Parameters to inscribe inscriptions. Successful operation -
Schema
    any
+
Bad Request diff --git a/open-api/btc-token/mint-a-brc-20-token.api.mdx b/open-api/btc-token/mint-a-brc-20-token.api.mdx index 154ef9336..48667e81e 100644 --- a/open-api/btc-token/mint-a-brc-20-token.api.mdx +++ b/open-api/btc-token/mint-a-brc-20-token.api.mdx @@ -32,9 +32,9 @@ import TabItem from "@theme/TabItem"; Create order to mint a brc20 token. -## Request -

Path Parameters

Body

required
+ +

Body

required
Parameters to mint a brc20 token @@ -42,7 +42,7 @@ Parameters to mint a brc20 token Successful operation -
Schema
    any
+
Bad Request diff --git a/open-api/btc-token/mint-a-rune.api.mdx b/open-api/btc-token/mint-a-rune.api.mdx index fed057130..81a896d6e 100644 --- a/open-api/btc-token/mint-a-rune.api.mdx +++ b/open-api/btc-token/mint-a-rune.api.mdx @@ -32,9 +32,9 @@ import TabItem from "@theme/TabItem"; Create order to mint rune. -## Request -

Path Parameters

Body

required
+ +

Body

required
Create a order to mint rune @@ -42,7 +42,7 @@ Create a order to mint rune Successful operation -
Schema
    any
+
Bad Request diff --git a/open-api/btc-token/pay-brc-20-minting-order.api.mdx b/open-api/btc-token/pay-brc-20-minting-order.api.mdx index 17aad97f9..16e9289a6 100644 --- a/open-api/btc-token/pay-brc-20-minting-order.api.mdx +++ b/open-api/btc-token/pay-brc-20-minting-order.api.mdx @@ -32,9 +32,9 @@ import TabItem from "@theme/TabItem"; Pay the order that mint a brc20 token. -## Request -

Path Parameters

Body

required
+ +

Body

required
Pay a brc20 minting order @@ -42,7 +42,7 @@ Pay a brc20 minting order Successful operation -
Schema
    any
+
Bad Request diff --git a/open-api/btc-token/pay-deploying-order.api.mdx b/open-api/btc-token/pay-deploying-order.api.mdx index bcbdc4f5b..198bf115a 100644 --- a/open-api/btc-token/pay-deploying-order.api.mdx +++ b/open-api/btc-token/pay-deploying-order.api.mdx @@ -32,9 +32,9 @@ import TabItem from "@theme/TabItem"; Pay the order that deploy a brc20 token. -## Request -

Path Parameters

Body

required
+ +

Body

required
Pay a deploying order @@ -42,7 +42,7 @@ Pay a deploying order Successful operation -
Schema
    any
+
Bad Request diff --git a/open-api/btc-token/pay-etching-order.api.mdx b/open-api/btc-token/pay-etching-order.api.mdx index af01390de..d96c34885 100644 --- a/open-api/btc-token/pay-etching-order.api.mdx +++ b/open-api/btc-token/pay-etching-order.api.mdx @@ -32,9 +32,9 @@ import TabItem from "@theme/TabItem"; Pay the order that etch a rune. -## Request -

Path Parameters

Body

required
+ +

Body

required
Pay a etching order @@ -42,7 +42,7 @@ Pay a etching order Successful operation -
Schema
    any
+
Bad Request diff --git a/open-api/btc-token/pay-inscribing-order.api.mdx b/open-api/btc-token/pay-inscribing-order.api.mdx index e442e5d58..d393d7ff6 100644 --- a/open-api/btc-token/pay-inscribing-order.api.mdx +++ b/open-api/btc-token/pay-inscribing-order.api.mdx @@ -32,9 +32,9 @@ import TabItem from "@theme/TabItem"; Pay the order that inscribe inscriptions. -## Request -

Path Parameters

Body

required
+ +

Body

required
Pay a inscribing order @@ -42,7 +42,7 @@ Pay a inscribing order Successful operation -
Schema
    any
+
Bad Request diff --git a/open-api/btc-token/pay-minting-order.api.mdx b/open-api/btc-token/pay-minting-order.api.mdx index 1e7698ffd..a3f53465e 100644 --- a/open-api/btc-token/pay-minting-order.api.mdx +++ b/open-api/btc-token/pay-minting-order.api.mdx @@ -32,9 +32,9 @@ import TabItem from "@theme/TabItem"; Pay the order that mint a rune. -## Request -

Path Parameters

Body

required
+ +

Body

required
Pay a minting order @@ -42,7 +42,7 @@ Pay a minting order Successful operation -
Schema
    any
+
Bad Request diff --git a/open-api/btc-token/pay-transfering-order.api.mdx b/open-api/btc-token/pay-transfering-order.api.mdx index 9cb1c864e..22b15308b 100644 --- a/open-api/btc-token/pay-transfering-order.api.mdx +++ b/open-api/btc-token/pay-transfering-order.api.mdx @@ -32,9 +32,9 @@ import TabItem from "@theme/TabItem"; Pay the order that transfer a brc20 token. -## Request -

Path Parameters

Body

required
+ +

Body

required
Pay a transfering order @@ -42,7 +42,7 @@ Pay a transfering order Successful operation -
Schema
    any
+
Bad Request diff --git a/open-api/btc-token/transfer-a-brc-20-token.api.mdx b/open-api/btc-token/transfer-a-brc-20-token.api.mdx index 9ba00762a..f2bb41241 100644 --- a/open-api/btc-token/transfer-a-brc-20-token.api.mdx +++ b/open-api/btc-token/transfer-a-brc-20-token.api.mdx @@ -32,9 +32,9 @@ import TabItem from "@theme/TabItem"; Create order to transfer a brc20 token. -## Request -

Path Parameters

Body

required
+ +

Body

required
Parameters to transfer a brc20 token @@ -42,7 +42,7 @@ Parameters to transfer a brc20 token Successful operation -
Schema
    any
+
Bad Request