Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docusaurus v3 upgrade preparation #405

Merged
merged 19 commits into from
Apr 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ name: Format MDX and Lint

on:
pull_request:
branches:
branches:
- main

workflow_dispatch:
Expand All @@ -18,7 +18,7 @@ jobs:
- name: Setup Node
uses: actions/setup-node@v3
with:
node-version: '16'
node-version: '18'
cache: 'yarn'
cache-dependency-path: '**/yarn.lock'

Expand Down
28 changes: 0 additions & 28 deletions .gitpod.yml

This file was deleted.

1 change: 1 addition & 0 deletions .npmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
engine-strict=true
1 change: 1 addition & 0 deletions .nvmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
v18
2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ ENV DEBIAN_FRONTEND=noninteractive
ENV INLINE_RUNTIME_CHUNK=false
RUN apt-get update && apt-get install --no-install-recommends -y gpg curl git make ca-certificates apt-transport-https && \
curl -sSL https://deb.nodesource.com/gpgkey/nodesource-repo.gpg.key|gpg --dearmor >/etc/apt/trusted.gpg.d/nodesource-key.gpg && \
echo "deb https://deb.nodesource.com/node_16.x nodistro main" | tee /etc/apt/sources.list.d/nodesource.list && \
echo "deb https://deb.nodesource.com/node_18.x nodistro main" | tee /etc/apt/sources.list.d/nodesource.list && \
curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg |gpg --dearmor >/etc/apt/trusted.gpg.d/yarnpkg.gpg && \
echo "deb https://dl.yarnpkg.com/debian/ stable main" | tee /etc/apt/sources.list.d/yarn.list && \
apt-get update && apt-get install -y nodejs yarn && apt-get clean
Expand Down
8 changes: 7 additions & 1 deletion docs/learn/encyclopedia/ledger-headers.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,13 @@ title: Ledger Headers

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:

[Genesis] <---- [LedgerHeader_1] <----- … <---- [LedgerHeader_n]
```mermaid
stateDiagram
direction LR
Genesis --> LedgerHeader_1
LedgerHeader_1 --> ...
... --> LedgerHeader_n
```

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.

Expand Down
14 changes: 7 additions & 7 deletions docs/learn/fundamentals/list-of-operations.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ Learn more about passive sell offers: [Liquidity on Stellar: SDEX and Liquidity
| Selling | asset | Asset the offer creator is selling. |
| Buying | asset | Asset the offer creator is buying. |
| Amount | integer | Amount of `buying` being bought. Set to `0` if you want to delete an existing offer. |
| 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}. |
| 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}. |
| Offer ID | unsigned integer | The ID of the offer. `0` for new offer. Set to existing offer ID to update or delete. |

**Possible errors**:
Expand Down Expand Up @@ -182,7 +182,7 @@ Learn more about passive sell offers: [Liquidity on Stellar: SDEX and Liquidity
| Selling | asset | Asset the offer creator is selling. |
| Buying | asset | Asset the offer creator is buying. |
| Amount | integer | Amount of `selling` being sold. Set to `0` if you want to delete an existing offer. |
| 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}. |
| 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}. |
| Offer ID | unsigned integer | The ID of the offer. `0` for new offer. Set to existing offer ID to update or delete. |

**Possible errors**:
Expand Down Expand Up @@ -216,7 +216,7 @@ Learn more about passive sell offers: [Liquidity on Stellar: SDEX and Liquidity
| Selling | asset | Asset the offer creator is selling. |
| Buying | asset | Asset the offer creator is buying. |
| Amount | integer | Amount of `selling` being sold. |
| 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}. |
| 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}. |

**Possible errors**:

Expand Down Expand Up @@ -256,7 +256,7 @@ Learn more about signers operations and key weight: [Signature and Multisignatur
| 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). |
| 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). |
| Home domain | string | Sets the home domain of an account. See [Federation](../encyclopedia/federation.mdx). |
| 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. |
| 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. |

**Possible errors**:

Expand Down Expand Up @@ -511,7 +511,7 @@ Or

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

**Possible errors**:

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

**Possible errors**:

Expand Down
12 changes: 6 additions & 6 deletions docs/reference/software-versions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -593,7 +593,7 @@ Release candidates are software releases that are also released to the [Testnet]
- Add fn to expose max expiration available
- Update rust-version
- fix(snapshot): set entry expiration info in set_ledger_info
- Add SDK support for Address<->strkey conversions.
- Add SDK support for Address/StrKey conversions.
- bump env and xdr for state exp rename
- bump env
- Feature: expose rem_euclid functions and add 128/256 bit conversions
Expand Down Expand Up @@ -671,7 +671,7 @@ Release candidates are software releases that are also released to the [Testnet]
- Fix datarace in bufferedResponseWriter.WriteOut
- Fix upsert bug in DB cache
- Fix ledger entry visibility bug
- Fix unwrap() errors in libpreflight due to bugs in the Go<->Rust interface
- Fix unwrap() errors in libpreflight due to bugs in the Go/Rust interface
- Fix simulation sequence number for bump/restore operations
- Improve missing command line arguments message
- Fix caching of GetLatestLedgerSequence
Expand Down Expand Up @@ -1031,7 +1031,7 @@ The Soroban RPC version for Preview 11 is presently in Stellar's unstable and te
- Fix comparisons
- Rename rawval to val
- Enforce readonly footprint on bump
- Add host functions for {u,i}256 arithmetics
- Add host functions for `{u,i}256` arithmetics
- More raw to val
- Support Timepoint, Duration
- Bump xdr
Expand All @@ -1042,11 +1042,11 @@ The Soroban RPC version for Preview 11 is presently in Stellar's unstable and te
- Bump xdr for rename
- Add host function for bumping contract instance
- Implement contract instance storage in Soroban host.
- Change [IU]256 arithmetic host functions to take *Val not *Object.
- Change `[IU]256` arithmetic host functions to take *Val not *Object.
- Replace increase and decrease functions with approve
- Expose bumps
- Fix calibration tests
- Change [IU]256 [from,to]\_bytes functions to work with Val
- Change `[IU]256` `[from,to]_bytes` functions to work with Val
- Bump wasmi version

#### Soroban Rust SDK
Expand Down Expand Up @@ -1289,7 +1289,7 @@ See https://github.com/stellar/rs-soroban-env/releases v0.0.13 and v0.0.14 for m
- Error on UDT enums with 0-element tuple variants
- Allow xlm balance updates
- Fix vec insert
- Adapt SDK to changes to {Try,}{From,Into}Val in env crates
- Adapt SDK to changes to `{Try,From,Into}Val` in env crates
- Fix vec pop_front
- Use better storage error in tests
- Adapt to introduction of Env::Error
Expand Down
18 changes: 13 additions & 5 deletions network/anchor-platform/callbacks/del-customer.api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: "The request for this endpoint is identical to the"
sidebar_label: "Delete Customer Data"
hide_title: true
hide_table_of_contents: true
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"}}
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=
sidebar_class_name: "delete api-method"
info_path: network/anchor-platform/callbacks/synchronous-callbacks-api
custom_edit_url: null
Expand All @@ -16,15 +16,21 @@ import { SepBadge } from "@site/src/components/SepBadge";
<SepBadge tags={"Customers,SEP-12,SEP-31"}/>

import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

## Delete Customer Data
<h1 className={"openapi__heading"}>Delete Customer Data</h1>

<MethodEndpoint method={"delete"} path={"/customer/{id}"}></MethodEndpoint>



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


<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>
## Request

<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>

Success.

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

Customer not found.

</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>
</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>
Loading
Loading