Skip to content

Commit 80924f2

Browse files
authored
Docusaurus v3 upgrade preparation (stellar#405)
* updates to npm packages to most recent docusaurus v2 versions * generating new api docs with upgrade packages * update node version in github runner * updated lockfile * pin jackspeak package resolution to a "working" version * use a mermaid diagram for the ledger headers page * fix some curly bracket syntax in the list of operations * fix markdown parsing issues in `software-versions.mdx` * fix markdown link definitions in openrpc README file * update to node v18 * remove old gitpod config * update tsconfig file * updgrade to react 18 * extend docusaurus tsconfig file, also * remove unused redocusaurus plugin * upgrade to typescript v5 * regenerate AP api docs
1 parent 0048ec5 commit 80924f2

File tree

117 files changed

+6494
-5648
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

117 files changed

+6494
-5648
lines changed

.github/workflows/main.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ name: Format MDX and Lint
22

33
on:
44
pull_request:
5-
branches:
5+
branches:
66
- main
77

88
workflow_dispatch:
@@ -18,7 +18,7 @@ jobs:
1818
- name: Setup Node
1919
uses: actions/setup-node@v3
2020
with:
21-
node-version: '16'
21+
node-version: '18'
2222
cache: 'yarn'
2323
cache-dependency-path: '**/yarn.lock'
2424

.gitpod.yml

-28
This file was deleted.

.npmrc

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
engine-strict=true

.nvmrc

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
v18

Dockerfile

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ ENV DEBIAN_FRONTEND=noninteractive
99
ENV INLINE_RUNTIME_CHUNK=false
1010
RUN apt-get update && apt-get install --no-install-recommends -y gpg curl git make ca-certificates apt-transport-https && \
1111
curl -sSL https://deb.nodesource.com/gpgkey/nodesource-repo.gpg.key|gpg --dearmor >/etc/apt/trusted.gpg.d/nodesource-key.gpg && \
12-
echo "deb https://deb.nodesource.com/node_16.x nodistro main" | tee /etc/apt/sources.list.d/nodesource.list && \
12+
echo "deb https://deb.nodesource.com/node_18.x nodistro main" | tee /etc/apt/sources.list.d/nodesource.list && \
1313
curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg |gpg --dearmor >/etc/apt/trusted.gpg.d/yarnpkg.gpg && \
1414
echo "deb https://dl.yarnpkg.com/debian/ stable main" | tee /etc/apt/sources.list.d/yarn.list && \
1515
apt-get update && apt-get install -y nodejs yarn && apt-get clean

docs/learn/encyclopedia/ledger-headers.mdx

+7-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,13 @@ title: Ledger Headers
44

55
Every ledger has a header that references the data in that ledger and the previous ledger. These references are cryptographic hashes of the content which behave like pointers in typical data structures but with added security guarantees. Think of a historical ledger chain as a linked list of ledger headers:
66

7-
[Genesis] <---- [LedgerHeader_1] <----- <---- [LedgerHeader_n]
7+
```mermaid
8+
stateDiagram
9+
direction LR
10+
Genesis --> LedgerHeader_1
11+
LedgerHeader_1 --> ...
12+
... --> LedgerHeader_n
13+
```
814

915
The genesis ledger has a sequence number of 1. The ledger directly following a ledger with sequence number n has a sequence number of n+1.
1016

docs/learn/fundamentals/list-of-operations.mdx

+7-7
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ Learn more about passive sell offers: [Liquidity on Stellar: SDEX and Liquidity
148148
| Selling | asset | Asset the offer creator is selling. |
149149
| Buying | asset | Asset the offer creator is buying. |
150150
| Amount | integer | Amount of `buying` being bought. Set to `0` if you want to delete an existing offer. |
151-
| Price | {numerator, denominator} | Price of 1 unit of `buying` in terms of `selling`. For example, if you wanted to buy 30 XLM and sell 5 BTC, the price would be {5,30}. |
151+
| Price | \{numerator, denominator} | Price of 1 unit of `buying` in terms of `selling`. For example, if you wanted to buy 30 XLM and sell 5 BTC, the price would be {5,30}. |
152152
| Offer ID | unsigned integer | The ID of the offer. `0` for new offer. Set to existing offer ID to update or delete. |
153153

154154
**Possible errors**:
@@ -182,7 +182,7 @@ Learn more about passive sell offers: [Liquidity on Stellar: SDEX and Liquidity
182182
| Selling | asset | Asset the offer creator is selling. |
183183
| Buying | asset | Asset the offer creator is buying. |
184184
| Amount | integer | Amount of `selling` being sold. Set to `0` if you want to delete an existing offer. |
185-
| Price | {numerator, denominator} | Price of 1 unit of `selling` in terms of `buying`. For example, if you wanted to sell 30 XLM and buy 5 BTC, the price would be {5,30}. |
185+
| Price | \{numerator, denominator} | Price of 1 unit of `selling` in terms of `buying`. For example, if you wanted to sell 30 XLM and buy 5 BTC, the price would be {5,30}. |
186186
| Offer ID | unsigned integer | The ID of the offer. `0` for new offer. Set to existing offer ID to update or delete. |
187187

188188
**Possible errors**:
@@ -216,7 +216,7 @@ Learn more about passive sell offers: [Liquidity on Stellar: SDEX and Liquidity
216216
| Selling | asset | Asset the offer creator is selling. |
217217
| Buying | asset | Asset the offer creator is buying. |
218218
| Amount | integer | Amount of `selling` being sold. |
219-
| Price | {numerator, denominator} | Price of 1 unit of `selling` in terms of `buying`. For example, if you wanted to sell 30 XLM and buy 5 BTC, the price would be {5,30}. |
219+
| Price | \{numerator, denominator} | Price of 1 unit of `selling` in terms of `buying`. For example, if you wanted to sell 30 XLM and buy 5 BTC, the price would be {5,30}. |
220220

221221
**Possible errors**:
222222

@@ -256,7 +256,7 @@ Learn more about signers operations and key weight: [Signature and Multisignatur
256256
| Medium threshold | integer | A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have [a medium threshold](../encyclopedia/signatures-multisig). |
257257
| High threshold | integer | A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have [a high threshold](../encyclopedia/signatures-multisig). |
258258
| Home domain | string | Sets the home domain of an account. See [Federation](../encyclopedia/federation.mdx). |
259-
| Signer | {Public Key, weight} | Add, update, or remove a signer from an account. Signer weight is a number from 0-255 (inclusive). The signer is deleted if the weight is 0. |
259+
| Signer | \{Public Key, weight} | Add, update, or remove a signer from an account. Signer weight is a number from 0-255 (inclusive). The signer is deleted if the weight is 0. |
260260

261261
**Possible errors**:
262262

@@ -511,7 +511,7 @@ Or
511511

512512
| Union Type | Parameters | Type | Description |
513513
| --- | --- | --- | --- |
514-
| REVOKE_SPONSORSHIP_SIGNER | Signer | {account ID, Signer Key} | Signer that may have its sponsorship modified. |
514+
| REVOKE_SPONSORSHIP_SIGNER | Signer | \{account ID, Signer Key} | Signer that may have its sponsorship modified. |
515515

516516
**Possible errors**:
517517

@@ -621,8 +621,8 @@ Learn more about liquidity pools: [Liquidity Pools Encyclopedia Entry](../encycl
621621
| Liquidity Pool ID | liquidityPoolID | The PoolID for the Liquidity Pool to deposit into. |
622622
| Max Amount A | integer | Maximum amount of first asset to deposit. |
623623
| Max Amount B | integer | Maximum amount of second asset to deposit. |
624-
| Min Price | {numerator, denominator} | Minimum depositA/depositB. |
625-
| Max Price | {numerator, denominator} | Maximum depositA/depositB. |
624+
| Min Price | \{numerator, denominator} | Minimum depositA/depositB. |
625+
| Max Price | \{numerator, denominator} | Maximum depositA/depositB. |
626626

627627
**Possible errors**:
628628

docs/reference/software-versions.mdx

+6-6
Original file line numberDiff line numberDiff line change
@@ -593,7 +593,7 @@ Release candidates are software releases that are also released to the [Testnet]
593593
- Add fn to expose max expiration available
594594
- Update rust-version
595595
- fix(snapshot): set entry expiration info in set_ledger_info
596-
- Add SDK support for Address<->strkey conversions.
596+
- Add SDK support for Address/StrKey conversions.
597597
- bump env and xdr for state exp rename
598598
- bump env
599599
- Feature: expose rem_euclid functions and add 128/256 bit conversions
@@ -671,7 +671,7 @@ Release candidates are software releases that are also released to the [Testnet]
671671
- Fix datarace in bufferedResponseWriter.WriteOut
672672
- Fix upsert bug in DB cache
673673
- Fix ledger entry visibility bug
674-
- Fix unwrap() errors in libpreflight due to bugs in the Go<->Rust interface
674+
- Fix unwrap() errors in libpreflight due to bugs in the Go/Rust interface
675675
- Fix simulation sequence number for bump/restore operations
676676
- Improve missing command line arguments message
677677
- Fix caching of GetLatestLedgerSequence
@@ -1031,7 +1031,7 @@ The Soroban RPC version for Preview 11 is presently in Stellar's unstable and te
10311031
- Fix comparisons
10321032
- Rename rawval to val
10331033
- Enforce readonly footprint on bump
1034-
- Add host functions for {u,i}256 arithmetics
1034+
- Add host functions for `{u,i}256` arithmetics
10351035
- More raw to val
10361036
- Support Timepoint, Duration
10371037
- Bump xdr
@@ -1042,11 +1042,11 @@ The Soroban RPC version for Preview 11 is presently in Stellar's unstable and te
10421042
- Bump xdr for rename
10431043
- Add host function for bumping contract instance
10441044
- Implement contract instance storage in Soroban host.
1045-
- Change [IU]256 arithmetic host functions to take *Val not *Object.
1045+
- Change `[IU]256` arithmetic host functions to take *Val not *Object.
10461046
- Replace increase and decrease functions with approve
10471047
- Expose bumps
10481048
- Fix calibration tests
1049-
- Change [IU]256 [from,to]\_bytes functions to work with Val
1049+
- Change `[IU]256` `[from,to]_bytes` functions to work with Val
10501050
- Bump wasmi version
10511051

10521052
#### Soroban Rust SDK
@@ -1289,7 +1289,7 @@ See https://github.com/stellar/rs-soroban-env/releases v0.0.13 and v0.0.14 for m
12891289
- Error on UDT enums with 0-element tuple variants
12901290
- Allow xlm balance updates
12911291
- Fix vec insert
1292-
- Adapt SDK to changes to {Try,}{From,Into}Val in env crates
1292+
- Adapt SDK to changes to `{Try,From,Into}Val` in env crates
12931293
- Fix vec pop_front
12941294
- Use better storage error in tests
12951295
- Adapt to introduction of Env::Error

network/anchor-platform/callbacks/del-customer.api.mdx

+13-5
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: "The request for this endpoint is identical to the"
55
sidebar_label: "Delete Customer Data"
66
hide_title: true
77
hide_table_of_contents: true
8-
api: {"tags":["Customers","SEP-12","SEP-31"],"description":"The request for this endpoint is identical to the\n[`DELETE /customer`](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#customer-delete)\nrequest defined in SEP-12.\n\nDelete the customer's data or queue the customers data for deletion.\n","operationId":"delCustomer","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true}],"responses":{"204":{"description":"Success."},"404":{"description":"Customer not found.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"id":{"type":"string"}},"required":["error"],"title":"Error"}}}}},"method":"delete","path":"/customer/{id}","info":{"version":"2.0.0","description":"The Synchronous Callbacks API specification for the Stellar Anchor Platform project.\n\nThe Synchronous Callbacks API defines requests made by the Platform while it is processing a request from a client application. The\nanchor's responses to these requests affect the Platform responses to the client application.\n","title":"Synchronous Callbacks API"},"postman":{"name":"Delete Customer Data","description":{"content":"The request for this endpoint is identical to the\n[`DELETE /customer`](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#customer-delete)\nrequest defined in SEP-12.\n\nDelete the customer's data or queue the customers data for deletion.\n","type":"text/plain"},"url":{"path":["customer",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE"}}
8+
api: eJztVMFu2zAM/RWBO6wDXDvtdvKtWHMosEOxdqckwBSJqbXJkirS2wLD/z7Qdtqmy/YF88U2RYrk43vsgfUDQb2Cjx1xbDETFHC3vD2/uJw/3l/ApgCLZLJL7GKAGu4bVBkfOyRWu5gVN44UBpuiC6wcKWcxsDPaK46KG1yH1dfr5afl/VJVZs70dXPWMCeqq+rBcdNtSxPbihi91/nwPk85cjTRV1sft1WriTFXaCLtibGtCNP5YnFxWbb2zeHic4seGd+tw6FGizsX0CoX1NRbuQ7rcD26SXnqEPqWlNWsVczqscPu+HA+k4bHDC6Gch2ggJgwa/m9sVCDRX8AEwpIOusWWYCtVz04gS9pbqCAoFuEGpyFAsg02Gqoe+B9EitxduEBhgKkCZfRQs25w2EjFkoxEJL4Xy4+yOt4QHedMUhUSvyHUw6HClWIMsIu2BIKMDEwBhZ3nZJ3Zuyq+kYS0/9ZZNx+Q8PSZRYM2E0lYc4xn+zF2RPmox5Xc/SmAHbsxW85GgZ5CmiRmzjDjIwjwtxADU+8qnpnByjAhV2UbD8w09T0ZbkoF3CKzHf7YJocQ+xIfdTeb7X5Turq9kZRQuN2MxIz2VHdTexUV8E0Matbr3kXc6tSjoLISK9/3ztRkg4yItVqi2q7H69/uu9n4zwqN2oq5SgzdeFB6Wf15dgqrYx3GFi9GFqp7kV2eizwreSZOTMrkvA5td7t0PBx5tf+p1KM5D9M6a+tytxTJG71SKKZ9bP4nnh4rVm/Hk3/TMj/K+d45cwSYvzFVfLaBUG5y15AmwSxAvO8hWpnRVFNJJaTvt9qwi/ZD4OYHzvMe6hXmwJ+6Oz0Vga66sE6km8L9U57wn9M5+zzLOB36m/FzUYd9iBpfCd/UMB33E9LcNgMBTSoLeYx+3RwZQwmfhHyx2KSjfi0FaaJwzD8BvmUZss=
99
sidebar_class_name: "delete api-method"
1010
info_path: network/anchor-platform/callbacks/synchronous-callbacks-api
1111
custom_edit_url: null
@@ -16,15 +16,21 @@ import { SepBadge } from "@site/src/components/SepBadge";
1616
<SepBadge tags={"Customers,SEP-12,SEP-31"}/>
1717

1818
import ApiTabs from "@theme/ApiTabs";
19+
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
20+
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
21+
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
1922
import MimeTabs from "@theme/MimeTabs";
2023
import ParamsItem from "@theme/ParamsItem";
2124
import ResponseSamples from "@theme/ResponseSamples";
2225
import SchemaItem from "@theme/SchemaItem";
2326
import SchemaTabs from "@theme/SchemaTabs";
24-
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
27+
import Markdown from "@theme/Markdown";
28+
import OperationTabs from "@theme/OperationTabs";
2529
import TabItem from "@theme/TabItem";
2630

27-
## Delete Customer Data
31+
<h1 className={"openapi__heading"}>Delete Customer Data</h1>
32+
33+
<MethodEndpoint method={"delete"} path={"/customer/{id}"}></MethodEndpoint>
2834

2935

3036

@@ -35,12 +41,14 @@ request defined in SEP-12.
3541
Delete the customer's data or queue the customers data for deletion.
3642

3743

38-
<details style={{"marginBottom":"1rem"}} data-collapsed={false} open={true}><summary style={{}}><strong>Path Parameters</strong></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"path","name":"id","schema":{"type":"string"},"required":true}}></ParamsItem></ul></div></details><div><ApiTabs><TabItem label={"204"} value={"204"}><div>
44+
## Request
45+
46+
<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={{"in":"path","name":"id","schema":{"type":"string"},"required":true}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"204"} value={"204"}><div>
3947

4048
Success.
4149

4250
</div><div></div></TabItem><TabItem label={"404"} value={"404"}><div>
4351

4452
Customer not found.
4553

46-
</div><div><MimeTabs schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs><TabItem label={"Schema"} value={"Schema"}><details style={{}} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"string\",\n \"id\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div>
54+
</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"}}><SchemaItem collapsible={false} name={"error"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"string\",\n \"id\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>

0 commit comments

Comments
 (0)