add details

sCrypt-Inc · Jun 18, 2024 · 3720f76 · 3720f76
1 parent 6edd221
commit 3720f76
Show file tree

Hide file tree

Showing 35 changed files with 170 additions and 144 deletions.
diff --git a/open-api/btc.yaml b/open-api/btc.yaml
@@ -1226,6 +1226,13 @@ paths:
           required: true
           schema:
             type: string
+        - name: details
+          in: query
+          description: Return Order Details
+          required: false
+          schema:
+            type: string
+            example: "1"
       responses:
         '200':
           description: Successful operation
@@ -1234,15 +1241,31 @@ paths:
               example:
                 statusCode: 0
                 data:
-                  desc: Mint amax
-                  status: processing
-                  payAmount: 940960
-                  payAddress: tb1pzt8gjsrclj2lxl6clkkrqud6mlmecca6wyvlkxnhcaael2x6hhwshx2yck
+                  desc: Etch GOATOKKMMM•KKKG•HHH•AA
+                  status: succeeded
+                  payAmount: 113046
+                  payAddress: tb1p4yg23c5n6t5s44vclh309lgewu0cqmzzlh22c7ehzwfwhzj36y8q7eh74x
                   postage: 546
-                  receiveAddress: 2N9Fjf6wvNoHv3N8NXncw26zQPZM5CxmkoY
+                  receiveAddress: tb1ppresfm876y9ddn3fgw2zr0wj0pl3zanslje9nfpznq3kc90q46rqmnne43
                   feeRate: 500
-                  type: brc20_mint
-                  payTx: e5c0f04b12bd79e1a7cd044ef5ef22e1b06a0eb5e9f48b4d2a596d197804c3ed
+                  type: runes_etch
+                  payTx: 2338324efd71552c85c8a3903c6f2c960ab804cd6ed294ff12effd81be848608
+                  details:
+                    id: 2821647:742
+                    name: GOATOKKMMM•KKKG•HHH•AA
+                    divisibility: null
+                    symbol: null
+                    premine: null
+                    amount: 1
+                    cap: 21000
+                    startHeight: null
+                    endHeight: null
+                    endOffset: null
+                    revealTx:
+                      txId: f1127254c92ef9e9a716963b472bffbb03c8a64296e5e776a2fe53a0d0d2806c
+                      status: confirmed
+                    dataURL: data:text/plain;base64,YXNkZmFzZGZ2dnZ2dnZ2dnZ2dnZ2dnZ2dnZ2dmFzZGZhc2Rm
+                    confirmations: 143
         '400':
           description: Bad Request
         '401':
@@ -1739,6 +1762,9 @@ components:
           type: integer
         endOffset:
           type: integer
+        dataURL:
+          type: string
+          example: data:text/plain;base64,YXNkZmFzZGZ2dnZ2dnZ2dnZ2dnZ2dnZ2dnZ2dmFzZGZhc2Rm
       required:
           - name
           - amount

diff --git a/open-api/btc/deploy-a-brc-20-token.api.mdx b/open-api/btc/deploy-a-brc-20-token.api.mdx
@@ -5,7 +5,7 @@ description: "Create order to deploy a brc20 token."
 sidebar_label: "Deploy a brc20 token"
 hide_title: true
 hide_table_of_contents: true
-api: eJylVk1v2zgQ/SvEnFpAjWU7cWNhsdjY3QXSSwrXRQ+JDzQ1thhLpEKO7Nhe/ffFUIrtJmm6iz1Joobz+d4j90By6SG5hRuXooNZBCl65XRJ2hpIYOxQEgrLfwVZkWKZ262QYu5ULxZkV2jOIAJbopO85zqFBD69YgURlNLJAgkdR9yDkQVCAgZpY90KItAcsZSUwfM0RtOxUJnURrTW4l0htTFI4m9B6Kl583ppkN5DBA4fKu0whYRchRF4lWEhIdkDbUuO6slps4S6njXG6Glk0y1b/Bj6yyHpn9X/SjhlDaEh9ibLMtcq9KZz79nl/mU2dn6PirhFjjtJGj3/dahQr/EqTR16/zL7CPBRFmXOSzTvlqVDvyguPw62wzQ1/cVy09u5eHMfl3l/J43P73FoFuXOPPRXahg/nA/cQ2EMnvehjmCBOJGEJ2G0IVyiO43TjeM6gtJ6kstfmF6cD+oISKvV25lbl2qOn+tC09um3TiO2bSQj28b9hrL+nQ0t8/7eSz5WFGb8FM2TagZr1JwPJqMe3GD70/TG6jrJoYvrfHN0Hpx/BJFXyul0PtFlYsDVeCXODnUswdPkio/tilCEkeQSgr4CcQMnBsMBpeDy+6wN/yoLhaDAQ5S9fGyfxF4tz1AiHHykK6G52p4KbMyNrsLn92vfJWuaSfVbkeL3rqPwyzP2p2FrTjD8/hi2Kubes9fK3EkUzFpmATBpvvS5puRFWXW6R2mYToeVeU0bYMgzFE6dFcVZZDczpiZBVJmuToeT8iH/0FnTqqzb6Wg7oQm+E6gZKdhaEcF4QKO4NZPilO5HBLIiEqfdDq2RPNBlvrMK7ct6UzbzroLdXRql3Q6uVUyz6ynpB/Hl8Fkdkz8K1O5Gfxp+gdsshNo9Ye/GyOI2pe/rCskQQKfv09DQ3j0k6Me/XlEwHMx+L+MPyF8N45POH1xPniibcPNAzUb/rX0e+IY6/bChpJbjlwbcjat1AnIpQogx0Jqbq2vytI6+uPQeXbDY2pgsu6+OAGmGQo/ZmtxU6IRV1+uRensWqfoBZq0tNqQFwvrhAxU02YppElFIY1c8sdaOm0rL6QvUZEXdiFGk/GHJxX3kbhxqTYy90KbQ2gfBS+TyqAX1ojRdHx2Z+7MNQmZ53bjRYprzJnU4YBwSE7jGkWKJHWOqeDu8JC1NULObUWCE9ALrQ6BM5szgptQc5lLo5C/vNhgnvOTrGCFdVKR2GjKTlMULAaHLA/efciT+8a9QuMrh14E3GLbI0GZs9UyE5+/T0UDSMEERUOtFJ1Bq/aFDIrUntk/OeB/GNn+qG7/+hrRkobwkTplLrXh8IGN+5b7tzAnBREkx2tDQ3+mFDsLabB3Rl4jArMImL+8eb+fS4/fXF7XvPxQoWPtmUXA8JBzxu/tHlLt+T2FZCFzj29U9m7Sni/vxX++pLxabbsoDRewlnnFXxDBCrcnl6V6VkeQoeRLGyfc/B03aX2Yso/j7hdHC2tcs+NKKSzpTdtTGf5y83XKjW5vSkU4jsDJDd+B5AYSuIM7CPfBQJ6gW7y+h1yaZRX0BRq/rHbyR7F8Jo6hslf78duoAeuUgfP7oTsNDutZXdf/ACcss7U=
+api: eJylVl1vIjcU/SuWn3YlEiZACKCqasK2UvqSiLDqQ8KD8XgYhxnbsT0QoPz33mtPBvKx2VZVJGJ7ru+Xzzn2jnq2cHR0T29sKiydtWgqHLfSeKkVHdGxFcwLovEr8ZqkwhR6QxiZW95JYGUp1CltUW2EZbjnOoVd3z6wAiPDLCuFFxYj7qiCCRgr4dfaLuG7xIiG+Zy+TeNqOiY8Z1KR2pp8KWEGE/I38cL5OHJyAYOvsN2Kp0paAcl4W4kWdTwXJaOjHfUbg1Gdt1It6H4/i8bg40qnG7R4Hfq2SfpH9X8QjmvlhfLojRlTSB5603506HL3Phs9fxTcY4ssdtJL4fCrFVzIlbhMUyuce599i4pnVpoCl/z8zBgwy8rBRX8zTFPVzRbrztYm68fEFN0tU654FEOVma166i75MHnq9e1TCV3sdem+RTMhJnDYR2EkVLEAWBzFOUsSMDXaAXB+Ynre64Opl3z5eeYALonxC1lK/7kpRE/QtGTPnxt2ouX++Gju3/bzUPKhojrhl2xiqBmu+uD4ajLuJBHf36Y3ECHGcEYrFw+tA4Hfoeiu4hxCZlVBGqrQn+KkqQcg45mv3FinMEuAHswH/ARiBs71+/1Bf3A27Awv+HnW74t+yi8G3fPAu00DIcTJU7oc9vhwwHKTqO25yx+XrkpXfsv4duuzzqorhnmR1ztLXWGGveR82NnHensflXjFUjKJTKLB5uy9zXfFKp9rK7dwIOjJCV5Z6TdBEOaCWWEvwQKmM2QmEC/XWB0eT8gHv9H23PP2rpaCfTs0wbUDJduRoW0ehItiBLt6UZzKFrA79964UbsNB6FOmJGnkOHG+FOp26szSP3YDswKzVmRQ/xRN0kGwWR2SPwOqRwP/jj9BpvohNb6g/NoBCtx8Ie2JYPu0j//moaG4NFPDnr0+wEBb8Xg/zL+iPBAliNOA29faBu52VAz8q+m3wvHULczHUquOXKtvNVpxY9AzngAOaiexNa6yhht/W9N59ENHlOECfT47Q0wzQVxY7QmN3Bu5PL2moBYriSYEaFSo0GBHMm0JSxQDRSBMJWSkim2wMmKWakrR5gzoLWO6IwAmU9eVNy1CNyBUrHCEama0LCMXiaVgjhaEbiJTh/Ug7r2hBWFXju4ElaiQFKHC8IKECNYgWUPtYqUYHfwkMEZYXNdeYIJyEzyJnCuC0RwDDVnBVNQAcwcWYuiwP/gGRXWQh/JWvr8OEWCYtBk2Xh3IU/sG/YK4lSAFRJwK+oeEZ9bXS1yAugjEZAECQqSVEvRKa3VHtqIB1jf2T+44F8d2e6gbv/6GVGTxotn3zYF3PAYPrBxV3P/ngL3wXJ0eDZE+iOl0FlIA70j8qIIAF2Rv7h5t5szJ77bYr/HZeCZRe2BIcKDzRG/IBSpdDgG5ckAD+KTyr5M6vvlK/nPj5QPq60XmcICVqyocAbDpdgcPZb2MzDNBcNHGyYcv45jWidT9HHY/e5qQY2LOy4BB8Z/anssw7c3d1NsdP1SKsN1RC1b4xsIfkf0Af7CezCQJ+gWru8ogHpRBX2h0S+qHXstlm/EMVT2YT9+uYpgnSJwfm26E3EIvdnv/wEnLLO1
 sidebar_class_name: "post api-method"
 info_path: open-api/btc/introduction
 custom_edit_url: null
@@ -32,17 +32,17 @@ import TabItem from "@theme/TabItem";
 
 Create order to deploy a brc20 token.
 
+## Request
 
-
-<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>
+<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></ul></div></details><MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>
 
 Parameters to deploy a brc20 token
 
 </div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"receiveAddress"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"tb1ppresfm876y9ddn3fgw2zr0wj0pl3zanslje9nfpznq3kc90q46rqmnne43"}}></SchemaItem><SchemaItem collapsible={false} name={"feeRate"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":100}}></SchemaItem><SchemaItem collapsible={false} name={"postage"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":546}}></SchemaItem><SchemaItem collapsible={false} name={"tick"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"ordi"}}></SchemaItem><SchemaItem collapsible={false} name={"limit"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"1000"}}></SchemaItem><SchemaItem collapsible={false} name={"max"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"21000"}}></SchemaItem></ul></details></TabItem></MimeTabs><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    \"orderId\": \"66686819297c5f66e6dc7835\",\n    \"payAddress\": \"tb1qdk94c98ahp0nz5shjksudvtzaczztf2v3e9hlh\",\n    \"payAmount\": 40592\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    \"orderId\": \"66686819297c5f66e6dc7835\",\n    \"payAddress\": \"tb1qdk94c98ahp0nz5shjksudvtzaczztf2v3e9hlh\",\n    \"payAmount\": 40592\n  }\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Example"} value={"Example"}><ResponseSamples responseExample={"{\n  \"statusCode\": 0,\n  \"data\": {\n    \"orderId\": \"66686819297c5f66e6dc7835\",\n    \"payAddress\": \"tb1qdk94c98ahp0nz5shjksudvtzaczztf2v3e9hlh\",\n    \"payAmount\": 40592\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
 
 Bad Request