Merge pull request #267 from sCrypt-Inc/transferable

add Transferable api doc
sCrypt-Inc · May 26, 2024 · 9882368 · 9882368
2 parents 2e6c55e + 5a4eb7b
commit 9882368
Show file tree

Hide file tree

Showing 16 changed files with 155 additions and 54 deletions.
diff --git a/open-api/btc.yaml b/open-api/btc.yaml
@@ -105,10 +105,12 @@ paths:
                     wallet: bc1qhuv3dhpnm0wktasd3v0kt6e4aqfqsd0uhfdu7d
                     overall_balance: '8712082383523010000000000'
                     available_balance: '8712082383523010000000000'
+                    transferable_balance: '0'
                   - pkscript: 002042135392c4b08a5d7194640340976513b2b100a3e4f50d56fbd70099c633b81e
                     wallet: bc1qggf48ykykz996uv5vsp5p9m9zwetzq9run6s64hm6uqfn33nhq0ql9t85q
                     overall_balance: '1681390956909560000000000'
                     available_balance: '6038956909560000000000'
+                    transferable_balance: '1675352000000000000000000'
         '400':
           description: Bad Request
         '401':
@@ -149,7 +151,53 @@ paths:
                 statusCode: 0
                 data:
                   overall_balance: '502730000000000000000'
-                  available_balance: '0'
+                  available_balance: '502730000000000000000'
+                  transferable_balance: '0'
+        '400':
+          description: Bad Request
+        '401':
+          description: Unauthorized
+      security:
+        - bearerAuth: []
+  /btc/{network}/brc20/{ticker}/addresses/{address}/transferable:
+    get:
+      tags:
+        - BRC-20
+      description: Get BRC-20 transferable inscriptions by address and ticker.
+      operationId: Get transferable BRC-20 inscriptions
+      parameters:
+        - name: network
+          in: path
+          description: BTC chain network (mainnet | testnet | signet)
+          required: true
+          schema:
+            type: string
+        - name: ticker
+          in: path
+          description: BRC-20 ticker
+          required: true
+          schema:
+            type: string
+        - name: address
+          in: path
+          description: BTC address
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          description: successful operation
+          content:
+            application/json:
+              example:
+                statusCode: 0
+                data:
+                  - tick: good
+                  - inscription_id: eaec96ce4374e66eff53d2d5cc22fbd76c06f8ec0ab1f17ee1bfc2333286360di0
+                  - current_holder_pkscript: a914af9ac77b46c4f94a92e0fd831e6d17e1915cbfc087
+                  - current_holder_wallet: 2N9Fjf6wvNoHv3N8NXncw26zQPZM5CxmkoY
+                  - amount: "1000000000000000000"
+                  - genesis_height: 2817428
         '400':
           description: Bad Request
         '401':
@@ -198,12 +246,15 @@ paths:
                   - ticker: ordi
                     overall_balance: '502730000000000000000'
                     available_balance: '0'
+                    transferable_balance: '0'
                   - ticker: maga
                     overall_balance: '10500000000000000000000'
                     available_balance: '0'
+                    transferable_balance: '0'
                   - ticker: ordg
                     overall_balance: '666000000000000000000'
                     available_balance: '0'
+                    transferable_balance: '0'
         '400':
           description: Bad Request
         '401':

diff --git a/open-api/btc/get-address-brc-20-balance-list.api.mdx b/open-api/btc/get-address-brc-20-balance-list.api.mdx
@@ -5,7 +5,7 @@ description: "Get BRC-20 balance list by address."
 sidebar_label: "Get Address BRC-20 Balance List"
 hide_title: true
 hide_table_of_contents: true
-api: eJydVmFv20YM/SsHfmoBNXayNQOEYVgcbEWKAR0yF/2QGgMt0dYtpzvlSDn1PP33gZIsO463xvUXSz4e3zvee6Q3ILhkSO9gcnv95mIMswRy4izaSmzwkMI7EtOtmTk69BkZZ1nMfG0wzyMxn0ECoaKIuuMm7/dcdYvbvZN+72+WBRKoMGJJQlGxN+CxJEjBkzyGeA8JWIWuUAo45DOZXpusQOtNH21elWi9JzH/GCGW7ont0pO8hgQiPdQ2Ug6pxJoS4KygEiHdgKwrRWWJ1i+haZKBSH+yrxLZxX0LirOllS3GQ01x/QykwqX1S7ON3KEs0PExGF+Xc4pPYMJiwfQynCH0BKCZRnMVPBPr+sV4rF9P83OdZcS8qJ0ZpAIJZMELedF4rCpns3Zh9Bfrpg3QFywrR/rIglLzdcgJ0nECOQq2yhGb3VPUU8bcqhBXFNG5P3utQgpvxxc/fDc++EACuELrcO5oL3YMWrchZ4lLPJrzfPz2MOPLs4aYL49mvby8PCXnrGmaJoHvj9V7grm5pYeaWKCNOX8e89FjLUWI9m/KVTDAlNXRyrot7JwwUryqpYD0bqa3XJIUQe29pM7CugSjuWSjTe/FZjSP2cV41PuCeLTpH5tRz13NwhRXW+vX0UEKhUjF6WgUKvJvsLJnnMV1JWc2jFbnoOhbcn+oEDul7VMcdKmZoNervndBkPQPv4ZYokAK7z9N20NbvwjtdiuqNLjxEkNeZ3sKxaxVKJVoXavlqgpRfh4oaoX1PF1ZV+fP3DUtyPC1RpsPFXlz9fuNqWJY2ZzYkM+rYL2wWYRosPWJehF9bkr0nTFXGG2o2SBXlAmbsNg2Vgn35DkxH2JuPTo21g/QnLRZbmtPbII3k+n12Wf/2d+IQefCI5ucVuTUkWwkmEgSLa3I5CRoHeVGq6MFs8EbnIdajBKwC5sNwEVwOcUeanvJiUE2j+Scfksw1gtFzMQ8Win2KRp18sByyM4tT62b1oo815HYtBqgvkZGihjqZWHef5qa7nKNCpq89H3kTC+mCiwltu2k74dfn05Pbm+z61IvHIa9EoW+yKhyaL3yaHW+6V1zB3PJIIF0N/Fa46jZt9bR5d18GdwzS6AILJpjs5kj08fomkZ/7jq7eiq3rO1i173/80AH8+Uo83ta7w2rFbpaY9qedjLQMGD+B2mI2UHN9CVaxTrxgK9u+0n22pz8z+Eox/5H9Ot9hlvu2/s8rTgHJHe3/g0MtpubWZNAQZjrzLnb9KtXWUbVfm2fjd0nnf7dL1OV5NMOe9BRuzF8jNOPk86VU+0UPw0M28bRja9/ARW5jX8=
+api: eJytVm1vGzcM/iuEPrWAGzvZmgHGMCwOtiLDgA6Zi35ojUG+o31aZEmVeE69m/97yXvzS7y1LpovPkkkn0fUQzKVIr1MavxOTe5vX1yN1GygckxZNIGMd2qsXiFBcwZzbbXLEKxJBPMN6DyPmNKFGigfMGrxuMtbn5vmsPOdtL6/sy/bBx31CgmjYFfK8YL9HNKjjw98bgQ6aCrUMZ/J9BayQhsHrTU8W/GKF/AvECZqvpJZ8sdzdo/4oTQRmRfFEgcqZQWutBpXijZBUBNF45Zqux30RNqbfZbIzu5rUKxZGeowPpQYN09Agl6yF3SWO5SFtukUjCtXc4wHMH6xSPhlOL3pGUAzsU7Bu4RJzq9GI/k5jJ/KLONELUoLvVQYJvOO0JHY6xCsyeqD4d9JnCqFH/UqWJTPRJrKdOtzXo2YvSZdK4dM9sA0+JYxNyLENUe39q9Wq3zwcnT1w3ejoz+21GttrJ5b3LOVfYrapQVHOT6SlPZwK73UJ+EuRy+Pwb4JIN9veRLw+vr6G8HNtvw3UN+fesCJzuGeRcEFpmqby6c2b5wuqfDR/MPCkUgJszIa2tQvNUcdMd6wBS9nIhtuAIWXfrHEpifIkRrOKRtWbXFvh/OYXY2GbaFhGlbtJ5803KX6EsZ110vKaDlKQRTSeDhktbkXOpgLJroJdGH8cH2pBL0j96cou5HuPsVe6BJJtQUg68aId5qPX31caVaw+u3ttL60cQtfuxsS6ao7R9HnZbYneZ3VkueCMrYujhB8pJ97ipJhuU+TVuZ7XK7TAiHdijW85gvCzR93EKJfGzYDdHnwxlGChY+g68KT4tYuh5V2TaWvdTS+TKBTwIxN/aLr1OQf0KUBvOaCclz8YFwPzdsS5b50jOMdcA+8eO/euzsCFqV/TJDjGq2UeOJAEJG7Hu/wNvFdMQfJjiSMg4Ge+5JACJiFyXrgwtuc/Ruo7pF5leARrZVfjsz3YwlnBI+Gin2KIK2hZ9lHTzVPyZvkinFKFhHUGsA2R0BF9OWyAH5JaB4XRNDcoNrGdCEPE3wiTqM8YNtgPz/uDl6v2rW9L5yurRIJP9IwWJ52wqPWedVWzTvFVcOW490IrQtH+kBXOnK8G1h99XApFHwliVFVc53wTbTbrWw3o0JqKjdJ2sVuHPznhY4G1knmD7jZm35rbUuxqdvd2UD9xPofpN5mBzWTRTSCdeYFn923o/E5nP2vyEmO7aZ2m32GHffuPc9LzhHJ3at/BYPOmccDKwV1LuOIU9ac3nDphP3cPpnjB53+1S9TkeRhhz3qqM1cP8Xpx0lTlVPpFD/1DOvG0YyvT3CQqTM=
 sidebar_class_name: "get api-method"
 info_path: open-api/btc/introduction
 custom_edit_url: null
@@ -32,13 +32,13 @@ import TabItem from "@theme/TabItem";
 
 Get BRC-20 balance list by address.
 
+## Request
 
-
-<div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>
+<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"name":"network","in":"path","description":"BTC chain network (mainnet | testnet | signet)","required":true,"schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"address","in":"path","description":"BTC address","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"name":"limit","in":"query","description":"paging limit","required":false,"schema":{"type":"number"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"offset","in":"query","description":"paging offset","required":false,"schema":{"type":"number"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>
 
 successful operation
 
-</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Example"} value={"Example"}><ResponseSamples responseExample={"{\n  \"statusCode\": 0,\n  \"data\": [\n    {\n      \"ticker\": \"ordi\",\n      \"overall_balance\": \"502730000000000000000\",\n      \"available_balance\": \"0\"\n    },\n    {\n      \"ticker\": \"maga\",\n      \"overall_balance\": \"10500000000000000000000\",\n      \"available_balance\": \"0\"\n    },\n    {\n      \"ticker\": \"ordg\",\n      \"overall_balance\": \"666000000000000000000\",\n      \"available_balance\": \"0\"\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
+</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}>any</ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"statusCode\": 0,\n  \"data\": [\n    {\n      \"ticker\": \"ordi\",\n      \"overall_balance\": \"502730000000000000000\",\n      \"available_balance\": \"0\",\n      \"transferable_balance\": \"0\"\n    },\n    {\n      \"ticker\": \"maga\",\n      \"overall_balance\": \"10500000000000000000000\",\n      \"available_balance\": \"0\",\n      \"transferable_balance\": \"0\"\n    },\n    {\n      \"ticker\": \"ordg\",\n      \"overall_balance\": \"666000000000000000000\",\n      \"available_balance\": \"0\",\n      \"transferable_balance\": \"0\"\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Example"} value={"Example"}><ResponseSamples responseExample={"{\n  \"statusCode\": 0,\n  \"data\": [\n    {\n      \"ticker\": \"ordi\",\n      \"overall_balance\": \"502730000000000000000\",\n      \"available_balance\": \"0\",\n      \"transferable_balance\": \"0\"\n    },\n    {\n      \"ticker\": \"maga\",\n      \"overall_balance\": \"10500000000000000000000\",\n      \"available_balance\": \"0\",\n      \"transferable_balance\": \"0\"\n    },\n    {\n      \"ticker\": \"ordg\",\n      \"overall_balance\": \"666000000000000000000\",\n      \"available_balance\": \"0\",\n      \"transferable_balance\": \"0\"\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
 
 Bad Request
 

diff --git a/open-api/btc/get-address-brc-20-balance.api.mdx b/open-api/btc/get-address-brc-20-balance.api.mdx
@@ -5,7 +5,7 @@ description: "Get BRC-20 balance by address and ticker."
 sidebar_label: "Get Address BRC-20 Balance"
 hide_title: true
 hide_table_of_contents: true
-api: eJydVdtu40YM/RWCT7uANnLSFgWEomgctIvsyxapF/uQNQpaoq1pxjOTGcpZV9W/F5Rkxbkg7UYvmguHPMNzyGlRaJOwuMb51cW7sxkuM6w4ldEEMd5hge9ZYNiDFVlyJcNqD1RVkVMCchWIKW84nmCGPnAkPXdZjSfPR7vRw3zwgBkGirRl4ajBW3S0ZSzQsdz5eIMZGo0dSGp8DGi+uICyJuNgtIY3WzLOscA/IJxkGCWzcSxvMcPIt42JXGEhseEMU1nzlrBoUfZBoyaJxm2w67IJyHCnl3EMV5osXxNmTON/3vfe7v9HWapxCt4lTrp/Npvp76Hz1JQlp7RuLEzkYYald8JO1J5CsKbsN/K/kh5qkb/SNljWYRKSJl34irGYZViR9GD8jiNZ++coGSzwh9nZj9/NHn2YIe3IWFpZPrKdYadfht8/h3lOFVzxbcNJsLc5fWrzyVEjtY/mb64045i4bKKRfa+2FVPkeN5IjcX1UjO1Zam9inbD0qtTtzBfSZm3o8y6fBXLs1neDox3+UgKp7wdh10+3kGZShx3B3k30WKBtUhIRZ77wO4dBXOSyrgPcmJ8vjtFhXFA+YeyOtB2jHUiWT3hSL7OByPMxsFvPm5JsMAPnxf97Y1b+/64EaUNL51EXzXlEd1U9nTzlozthRGCj/LLBFFTrfcZ8rs7faLTRc2QLtQaPgZ2cP77JYTod6biBOyq4I2TBGsfgXrRGbfp+8eWHG10sqNofJOAUuBSEvj1oW+Iv2GXMvgYK+PIJjBuCp2y3stV4ziBdzBfXJx8cV/cpQBZ6+8SVLxjq/JOIB4iSzS8Y6hYyFiuQLOjCTPeAa18I6AAzNqUU+Da24rjGOpAcgaU4I6t1b94ME44UilwZ6Q+hghaFhPKyXvqcWreNFfsUhM5Qa8BHnMEUkffbGr48HkBA7mgymYnY1GeKDHBJ9lSX5tjZ3mx+T4grr2v9m9q9qMUhb9KHiwZp0B6obdj/VzjSkrMsLhv630J6dLUNqcq0tX7PjcV0jLD2idRb227osSfou06Xb5tOGo9LzNU5WgP6YutMknHFRZrsolfuO6bq7GbvoVvflWevf64SG6PCso2OsMMb3h/9LrpA/A6kI+enFdgGM++HsKD1+gVAA6Hu2WXYc1UcexZG3bPy5KDHJ178vw86Nbvf12ohB42x0fNsPf+LKaf5kNBLbTIf75PkU4VX9f9C08EGv4=
+api: eJydVduO2zYQ/ZUBnxLAsZxtiwJGEHS9aIPtS4qtgz4ki4KWxha7NMmSI29c1f/eGUqWL1lsE+tFvMzlzMyZYatIr5KaflSzu5tXVxN1P1IVpjKaQMY7NVXvkKC7g4W22pUIiy3oqoqYEmhXAZnyAeNYjZQPGLXo3Va95nUv11uYdRZYNOio10gYxXmrHG9YxSE9+vjA90Z8B021Ogc0m99AWWvjoJeGF2ve8Qb+BcJE3SqZFS9esnrEvxsTkSFRbHCkUlnjWqtpq2gbxGuiaNxK7XajAUgX0/M4upAGyUvc9Gn833gPcl/v5V6EU/AuYZL7q8lEfqfGU1OWbHjZWBiKx15K7wgdibwOwZoyXxR/JVFqFX7W62BRlok0NenGV7ybMHRNGYzfsDFr/+wpw55+mFz9+N3k7GNXeqON1QuLXyFLUbu0ZMun4hOOlr+R+v6pEGe6gjvOGjNDZZnXX8p8cLqh2kfzD2dWLCUsm2hom8m5QB0xXrMEb+8lsczc2gvHV0iZzHKligWVRduzclcsYnk1KdqOILuiryGmou2XLNLFIIVNGDf7bmiiZXM1UUjTouDCuFc6mDEj3gYaG19sXiuBsUf5u5Cgq/Ix1oETYkn1XJF9J8Qn3eIXH9eai61+/WOeozdu6bO6IamyunUUfdWUR+zQZWYHc8/YzKMQfKSfBoiSaomnyy/jPaf1vEZINyIN7zlAuP7tFkL0G8NigK4K3jhKsPQRdOYoszqPm7V2eiWbjY7GNzyDUsCSRf1yP2bIP6BLI3gfK+O0TWDc4JqPxcpd49iPd8DtNf7kPrlbAiasf0xQ4QatdENiQxCRG4pP+Jg4VqxAsiMJY2OgF74hEABmacrBce1txfqdq32ReZfgEa2VP1vm+JjKJcGjofoYIkgXDSgH6ynjlLxJrthPwySCzAHscwRUR9+sauBKQldcEGZzL/c9PJbCBJ+I0ygF7AfRs7P6pHDtYTh809vQU5HwMxXB8sAWIJnobd8/HxX3D0tOD69AbiE5Gqbs0EVyehiLQyNxV9QcnVhr24VO+CHa3U6OeQJE6WdeCnNkhuRmq0ySNXfzkqmCz4T74q4fvi/hmx+hJ8PvD7XbKgFlG9nx8gG3R4+hvBeXgTx7oS7A0OteDuHk8boAwF55d8+iNWpuq1y17vaaWR/oSO+L1+pkWr/7eS4UOh2OZ8MwW38S05tZ11BzafK3hxTJVvDtdv8BLG0oCw==
 sidebar_class_name: "get api-method"
 info_path: open-api/btc/introduction
 custom_edit_url: null
@@ -32,13 +32,13 @@ import TabItem from "@theme/TabItem";
 
 Get BRC-20 balance by address and ticker.
 
+## Request
 
-
-<div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>
+<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"name":"network","in":"path","description":"BTC chain network (mainnet | testnet | signet)","required":true,"schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"ticker","in":"path","description":"BRC-20 ticker","required":true,"schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"address","in":"path","description":"BTC address","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>
 
 successful operation
 
-</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Example"} value={"Example"}><ResponseSamples responseExample={"{\n  \"statusCode\": 0,\n  \"data\": {\n    \"overall_balance\": \"502730000000000000000\",\n    \"available_balance\": \"0\"\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
+</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}>any</ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"statusCode\": 0,\n  \"data\": {\n    \"overall_balance\": \"502730000000000000000\",\n    \"available_balance\": \"502730000000000000000\",\n    \"transferable_balance\": \"0\"\n  }\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Example"} value={"Example"}><ResponseSamples responseExample={"{\n  \"statusCode\": 0,\n  \"data\": {\n    \"overall_balance\": \"502730000000000000000\",\n    \"available_balance\": \"502730000000000000000\",\n    \"transferable_balance\": \"0\"\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
 
 Bad Request