Merge branch 'main' into refresh-classic-guides

Author: JFWooten4

.gitignore

@@ -23,6 +23,8 @@ yarn-error.log*
 
 *.info.mdx
 
+.tool-versions
+
 # non-production openrpc.json files
 /openrpc/*openrpc.json
 

README.md

@@ -2,8 +2,6 @@
 
 Welcome to the official home repository for [Documentation][docs] for the [Stellar network][stellar].
 
-If you're here for the Deep Dive Docs Bounty, please navigate to the bottom of this page for all relevant information: [Deep Dive Docs Bounty](#welcome-to-the-deep-dive-docs-bounty-).
-
 ## Table of Contents <!-- omit in toc -->
 
 - [Contributing](#contributing)
@@ -234,7 +232,7 @@ const CODE_LANGS = {
 };
 ```
 
-**Remember that this is a community; we build together! 💪 Our code of conduct is [here](https://www.stellar.org/community/code-of-conduct) and our Privacy Policy is [here](https://www.stellar.org/privacy-policy).**
+**Remember that this is a community; we build together! 🫱🏻‍🫲🏽 Our code of conduct is [here](https://www.stellar.org/community/code-of-conduct) and our Privacy Policy is [here](https://www.stellar.org/privacy-policy).**
 
 [docs]: https://developers.stellar.org/docs
 [api]: https://developers.stellar.org/api

ap_versioned_docs/version-2.10/admin-guide/events/getting-started.mdx

@@ -3,6 +3,26 @@ title: Getting Started
 sidebar_position: 10
 ---
 
-Anchor Platform provides an event service that allows your business application and client applications such as wallets to receive updates about transaction updates via HTTP webhooks without the need to poll the transactions API.
+Anchor Platform provides an event service that sends HTTP webhook notifications to:
 
-By integrating with the event service, you or your clients will be able to receive updates about the status of transactions, including when they are submitted, completed, and failed as well as any quotes created.
+**Business Servers**
+
+- Transaction status changes
+- Quote updates
+- Customer KYC status changes
+
+Event schemas for business servers are defined in the [API reference](/platforms/anchor-platform/next/api-reference/callbacks/post-event).
+
+**Client Applications**
+
+- Transaction status changes affecting their users
+- Customer KYC status changes affecting their users
+
+_Event schemas for client applications are defined in their respective SEPs:_
+
+- [SEP-6 Transaction Events](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0006.md#single-historical-transaction)
+- [SEP-12 Customer Events](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#response)
+- [SEP-24 Transaction Events](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0024.md#single-historical-transaction)
+- [SEP-31 Transaction Events](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0031.md#get-transaction)
+
+This eliminates the need for business servers and client applications to continuously poll the APIs for updates.

ap_versioned_docs/version-2.10/admin-guide/events/integration.mdx

@@ -67,9 +67,9 @@ The event service can be used to send events to client and business server callb
 
 ### As a Client Application
 
-Client applications can receive updates whenever the `status` of a SEP transaction changes.
+Client applications can receive updates about their users' transactions and customer information. The schema of the event data will depend on the type of event being sent.
 
-To receive events as a client application, you will need to expose a callback URL that the event service can send events to. The event service will send a POST request to this endpoint with the event data in the request body.
+To receive events as a client application, you will need to expose callback URLs that the event service can send events to. The event service will send a POST request to this endpoint with the event data in the request body. The schema of the event data will depend on the type of event being sent. Anchor Platform allows unique endpoints to be configured by event type.
 
 Anchor Platform will only send events to clients listed in the client configuration. See the [client configuration documentation][clients-config] for more information.
 
@@ -78,6 +78,7 @@ Anchor Platform will only send events to clients listed in the client configurat
 Anchor Platform signs the callback requests it sends to client applications. The signature is included in the `Signature` header of the request. The callback URL signature specification can be found in the corresponding SEP protocol specifications.
 
 - [SEP-0006](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0006.md#url-callback-signature)
+- [SEP-0012](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#callback-post-request)
 - [SEP-0024](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0024.md#url-callback-signature)
 - [SEP-0031](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0031.md#url-callback-signature)
 

ap_versioned_docs/version-2.10/admin-guide/sep24/integration.mdx

@@ -29,8 +29,18 @@ This is done by making JSON-RPC requests to the Platform API's endpoint. JSON-RP
 
 The Anchor Platform JSON-RPC API is designed to notify the platform about changes in the status of the transaction. Given that, the API will be called every time a user or the anchor takes any action that progresses the transaction status in the flow.
 
+Communication from the Anchor Platform about transaction updates, customer updates, and quote creation is handled through the event service. This is an optional feature that needs to be configured separately from the SEP-6 integration. For more information, see [Event Handling][event-handling].
+
 You can find out more about transaction flow and statuses in the [SEP-24 protocol document][sep-24]
 
+## Callbacks
+
+The Anchor Platform relies on the business server to provide and store information about quotes.
+
+### Quotes and Fees
+
+To support the exchange of non-equivalent assets, the Anchor Platform exposes a SEP-38 compliant API to provide quotes for the exchange. The quote API is used to provide the user with the expected amount of the asset they will receive in exchange for the asset they are sending. The quote API is also used to provide the user with the expected fees for the transaction. Therefore, your business server must implement the [rate API][rate-callback] to provide quotes to the Anchor Platform.
+
 ## Securing Platform API
 
 <Security />
@@ -1006,4 +1016,6 @@ Works in the same manner as for the deposit flow. For more details, see [Transac
 
 [sep-9]: https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0009.md
 [sep-24]: https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0024.md
+[event-handling]: /ap_versioned_docs/version-2.10/admin-guide/events/README.mdx
+[rate-callback]: /ap_versioned_docs/version-2.10/api-reference/callbacks/README.mdx
 [json-rpc-methods]: ../../api-reference/platform/rpc/methods/README.mdx

ap_versioned_docs/version-2.10/admin-guide/sep6/integration.mdx

@@ -30,9 +30,21 @@ This is done by making JSON-RPC requests to the Platform API's endpoint. JSON-RP
 
 The Anchor Platform JSON-RPC API is designed to notify the platform about changes in the status of the transaction. Given that, the API will be called every time a user or the anchor takes any action that progresses the transaction status in the flow.
 
+Communication from the Anchor Platform about transaction updates, customer updates, and quote creation is handled through the event service. This is an optional feature that needs to be configured separately from the SEP-6 integration. For more information, see [Event Handling][event-handling].
+
 You can find out more about transaction flow and statuses in the [SEP-6 protocol document][sep-6].
 
-[sep-6]: https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0006.md
+## Callbacks
+
+The Anchor Platform relies on the business server to provide and store information about customers and quotes.
+
+### Customer Information
+
+The Anchor Platform does not store customer information. Instead, it forwards all SEP-12 customer requests to the business server. The business server is responsible for storing and managing this information. Therefore, your business server must implement the [customer APIs][customer-callback] to handle KYC updates.
+
+### Quotes and Fees
+
+To support the exchange of non-equivalent assets, the Anchor Platform exposes a SEP-38 compliant API to provide quotes for the exchange. The quote API is used to provide the user with the expected amount of the asset they will receive in exchange for the asset they are sending. The quote API is also used to provide the user with the expected fees for the transaction. Therefore, your business server must implement the [rate API][rate-callback] to provide quotes to the Anchor Platform.
 
 ## Securing Platform API
 
@@ -972,4 +984,8 @@ Works in the same manner as for the deposit flow. For more details, see [Transac
 
 <Observer />
 
+[sep-6]: https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0006.md
+[event-handling]: /ap_versioned_docs/version-2.10/admin-guide/events/README.mdx
+[customer-callback]: /ap_versioned_docs/version-2.10/api-reference/callbacks/README.mdx
+[rate-callback]: /ap_versioned_docs/version-2.10/api-reference/callbacks/README.mdx
 [get-transactions]: ../../api-reference/platform/transactions/get-transactions.api.mdx

ap_versioned_docs/version-2.11/admin-guide/events/getting-started.mdx

@@ -3,6 +3,26 @@ title: Getting Started
 sidebar_position: 10
 ---
 
-Anchor Platform provides an event service that allows your business application and client applications such as wallets to receive updates about transaction updates via HTTP webhooks without the need to poll the transactions API.
+Anchor Platform provides an event service that sends HTTP webhook notifications to:
 
-By integrating with the event service, you or your clients will be able to receive updates about the status of transactions, including when they are submitted, completed, and failed as well as any quotes created.
+**Business Servers**
+
+- Transaction status changes
+- Quote updates
+- Customer KYC status changes
+
+Event schemas for business servers are defined in the [API reference](/platforms/anchor-platform/next/api-reference/callbacks/post-event).
+
+**Client Applications**
+
+- Transaction status changes affecting their users
+- Customer KYC status changes affecting their users
+
+_Event schemas for client applications are defined in their respective SEPs:_
+
+- [SEP-6 Transaction Events](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0006.md#single-historical-transaction)
+- [SEP-12 Customer Events](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#response)
+- [SEP-24 Transaction Events](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0024.md#single-historical-transaction)
+- [SEP-31 Transaction Events](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0031.md#get-transaction)
+
+This eliminates the need for business servers and client applications to continuously poll the APIs for updates.

ap_versioned_docs/version-2.11/admin-guide/events/integration.mdx

@@ -67,9 +67,9 @@ The event service can be used to send events to client and business server callb
 
 ### As a Client Application
 
-Client applications can receive updates whenever the `status` of a SEP transaction changes.
+Client applications can receive updates about their users' transactions and customer information. The schema of the event data will depend on the type of event being sent.
 
-To receive events as a client application, you will need to expose a callback URL that the event service can send events to. The event service will send a POST request to this endpoint with the event data in the request body.
+To receive events as a client application, you will need to expose callback URLs that the event service can send events to. The event service will send a POST request to this endpoint with the event data in the request body. The schema of the event data will depend on the type of event being sent. Anchor Platform allows unique endpoints to be configured by event type.
 
 Anchor Platform will only send events to clients listed in the client configuration. See the [client configuration documentation][clients-config] for more information.
 
@@ -78,6 +78,7 @@ Anchor Platform will only send events to clients listed in the client configurat
 Anchor Platform signs the callback requests it sends to client applications. The signature is included in the `Signature` header of the request. The callback URL signature specification can be found in the corresponding SEP protocol specifications.
 
 - [SEP-0006](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0006.md#url-callback-signature)
+- [SEP-0012](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#callback-post-request)
 - [SEP-0024](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0024.md#url-callback-signature)
 - [SEP-0031](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0031.md#url-callback-signature)
 

ap_versioned_docs/version-2.11/admin-guide/sep24/integration.mdx

@@ -29,8 +29,18 @@ This is done by making JSON-RPC requests to the Platform API's endpoint. JSON-RP
 
 The Anchor Platform JSON-RPC API is designed to notify the platform about changes in the status of the transaction. Given that, the API will be called every time a user or the anchor takes any action that progresses the transaction status in the flow.
 
+Communication from the Anchor Platform about transaction updates, customer updates, and quote creation is handled through the event service. This is an optional feature that needs to be configured separately from the SEP-6 integration. For more information, see [Event Handling][event-handling].
+
 You can find out more about transaction flow and statuses in the [SEP-24 protocol document][sep-24]
 
+## Callbacks
+
+The Anchor Platform relies on the business server to provide and store information about quotes.
+
+### Quotes and Fees
+
+To support the exchange of non-equivalent assets, the Anchor Platform exposes a SEP-38 compliant API to provide quotes for the exchange. The quote API is used to provide the user with the expected amount of the asset they will receive in exchange for the asset they are sending. The quote API is also used to provide the user with the expected fees for the transaction. Therefore, your business server must implement the [rate API][rate-callback] to provide quotes to the Anchor Platform.
+
 ## Securing Platform API
 
 <Security />
@@ -1006,4 +1016,6 @@ Works in the same manner as for the deposit flow. For more details, see [Transac
 
 [sep-9]: https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0009.md
 [sep-24]: https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0024.md
+[event-handling]: /ap_versioned_docs/version-2.11/admin-guide/events/README.mdx
+[rate-callback]: /ap_versioned_docs/version-2.11/api-reference/callbacks/README.mdx
 [json-rpc-methods]: ../../api-reference/platform/rpc/methods/README.mdx

ap_versioned_docs/version-2.11/admin-guide/sep6/integration.mdx

@@ -30,9 +30,21 @@ This is done by making JSON-RPC requests to the Platform API's endpoint. JSON-RP
 
 The Anchor Platform JSON-RPC API is designed to notify the platform about changes in the status of the transaction. Given that, the API will be called every time a user or the anchor takes any action that progresses the transaction status in the flow.
 
+Communication from the Anchor Platform about transaction updates, customer updates, and quote creation is handled through the event service. This is an optional feature that needs to be configured separately from the SEP-6 integration. For more information, see [Event Handling][event-handling].
+
 You can find out more about transaction flow and statuses in the [SEP-6 protocol document][sep-6].
 
-[sep-6]: https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0006.md
+## Callbacks
+
+The Anchor Platform relies on the business server to provide and store information about customers and quotes.
+
+### Customer Information
+
+The Anchor Platform does not store customer information. Instead, it forwards all SEP-12 customer requests to the business server. The business server is responsible for storing and managing this information. Therefore, your business server must implement the [customer APIs][customer-callback] to handle KYC updates.
+
+### Quotes and Fees
+
+To support the exchange of non-equivalent assets, the Anchor Platform exposes a SEP-38 compliant API to provide quotes for the exchange. The quote API is used to provide the user with the expected amount of the asset they will receive in exchange for the asset they are sending. The quote API is also used to provide the user with the expected fees for the transaction. Therefore, your business server must implement the [rate API][rate-callback] to provide quotes to the Anchor Platform.
 
 ## Securing Platform API
 
@@ -972,4 +984,8 @@ Works in the same manner as for the deposit flow. For more details, see [Transac
 
 <Observer />
 
+[sep-6]: https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0006.md
+[event-handling]: /ap_versioned_docs/version-2.11/admin-guide/events/README.mdx
+[customer-callback]: /ap_versioned_docs/version-2.11/api-reference/callbacks/README.mdx
+[rate-callback]: /ap_versioned_docs/version-2.11/api-reference/callbacks/README.mdx
 [get-transactions]: ../../api-reference/platform/transactions/get-transactions.api.mdx

ap_versioned_docs/version-2.8/admin-guide/events/getting-started.mdx

@@ -3,6 +3,26 @@ title: Getting Started
 sidebar_position: 10
 ---
 
-Anchor Platform provides an event service that allows your business application and client applications such as wallets to receive updates about transaction updates via HTTP webhooks without the need to poll the transactions API.
+Anchor Platform provides an event service that sends HTTP webhook notifications to:
 
-By integrating with the event service, you or your clients will be able to receive updates about the status of transactions, including when they are submitted, completed, and failed as well as any quotes created.
+**Business Servers**
+
+- Transaction status changes
+- Quote updates
+- Customer KYC status changes
+
+Event schemas for business servers are defined in the [API reference](/ap_versioned_docs/version-2.8/api-reference/callbacks/post-event.api.mdx).
+
+**Client Applications**
+
+- Transaction status changes affecting their users
+- Customer KYC status changes affecting their users
+
+_Event schemas for client applications are defined in their respective SEPs:_
+
+- [SEP-6 Transaction Events](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0006.md#single-historical-transaction)
+- [SEP-12 Customer Events](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#response)
+- [SEP-24 Transaction Events](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0024.md#single-historical-transaction)
+- [SEP-31 Transaction Events](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0031.md#get-transaction)
+
+This eliminates the need for business servers and client applications to continuously poll the APIs for updates.