Skip to content
This repository was archived by the owner on Jun 22, 2021. It is now read-only.

Commit 48348eb

Browse files
rice2000vcarl
andauthored
Add anchor guide deprecation notice (#555)
* Update readme.md add deprecation warning * Update 2-bridge-server.md add deprecation notice * Update readme.md fix link path * Update 2-bridge-server.md fix link path * Update 3-federation-server.md add deprecation notice * Update 4-compliance-server.md * Update 5-conclusion.md * Update readme.md * Update 2-bridge-server.md * Update 3-federation-server.md * Update 4-compliance-server.md * Update 5-conclusion.md * Use absolute URLs Co-authored-by: Carl Vitullo <vcarl@users.noreply.github.com>
1 parent 49f20e7 commit 48348eb

File tree

5 files changed

+20
-0
lines changed

5 files changed

+20
-0
lines changed

guides/anchor/2-bridge-server.md

+4
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,10 @@ sequence:
55
next: 3-federation-server.md
66
---
77

8+
## Deprecation Notice
9+
10+
This guide explains how to set up a Stellar anchor service using a legacy flow outlined in [SEP-0003](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0003.md). For most use cases, we actually recommend the workflow specified in [SEP-0024](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0024.md). We are working on new documentation that explains that workflow, and it will be ready soon. In the meantime, check the [Basic Anchor Implementation section](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0024.md#basic-anchor-implementation) included in SEP-0024.
11+
812
Stellar.org maintains a [bridge server](https://github.com/stellar/bridge-server/blob/master/readme_bridge.md), which makes it easier to use the federation and compliance servers to send and receive payments. When using the bridge server, the only code you need to write is a private service to receive payment notifications and respond to regulatory checks from the bridge and compliance servers.
913

1014
![Payment flow diagram](assets/anchor-send-payment-basic-bridge.png)

guides/anchor/3-federation-server.md

+3
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@ sequence:
44
previous: 2-bridge-server.md
55
next: 4-compliance-server.md
66
---
7+
## Deprecation Notice
8+
9+
This guide explains how to set up a Stellar anchor service using a legacy flow outlined in [SEP-0003](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0003.md). For most use cases, we actually recommend the workflow specified in [SEP-0024](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0024.md). We are working on new documentation that explains that workflow, and it will be ready soon. In the meantime, check the [Basic Anchor Implementation section](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0024.md#basic-anchor-implementation) included in SEP-0024.
710

811
When testing the bridge server, we added a `memo` to the transaction in order to identify what customer account to credit. However, other people and organizations using Stellar might not know they need to do that. How do they find out?
912

guides/anchor/4-compliance-server.md

+4
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,10 @@ sequence:
55
next: 5-conclusion.md
66
---
77

8+
## Deprecation Notice
9+
10+
This guide explains how to set up a Stellar anchor service using a legacy flow outlined in [SEP-0003](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0003.md). For most use cases, we actually recommend the workflow specified in [SEP-0024](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0024.md). We are working on new documentation that explains that workflow, and it will be ready soon. In the meantime, check the [Basic Anchor Implementation section](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0024.md#basic-anchor-implementation) included in SEP-0024.
11+
812
The task of an anchor is handling regulatory compliance, like Anti-Money Laundering (<abbr title="Anti-Money Laundering">AML</abbr>). To accomplish that, you should use the [Stellar compliance protocol](../compliance-protocol.md), a standard way to exchange compliance information and pre-approve a transaction with another financial institution.
913

1014
You can write your own server that matches the compliance protocol, but Stellar.org also provides a [compliance server](https://github.com/stellar/bridge-server/blob/master/readme_compliance.md) that takes care of most of the work for you.

guides/anchor/5-conclusion.md

+5
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@ sequence:
44
previous: 4-compliance-server.md
55
---
66

7+
## Deprecation Notice
8+
9+
This guide explains how to set up a Stellar anchor service using a legacy flow outlined in [SEP-0003](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0003.md). For most use cases, we actually recommend the workflow specified in [SEP-0024](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0024.md). We are working on new documentation that explains that workflow, and it will be ready soon. In the meantime, check the [Basic Anchor Implementation section](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0024.md#basic-anchor-implementation) included in SEP-0024.
10+
11+
712
Congratulations! If you’ve made it to this point, you should now have a working bridge server, federation server, and compliance server, with the ability to make and receive secure, sanctioned payments on the Stellar network.
813

914
## Testing

guides/anchor/readme.md

+4
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ sequence:
44
next: 2-bridge-server.md
55
---
66

7+
## Deprecation Notice
8+
9+
This guide explains how to set up a Stellar anchor service using a legacy flow outlined in [SEP-0003](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0003.md). For most use cases, we actually recommend the workflow specified in [SEP-0024](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0024.md). We are working on new documentation that explains that workflow, and it will be ready soon. In the meantime, check the [Basic Anchor Implementation section](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0024.md#basic-anchor-implementation) included in SEP-0024.
10+
711
Anchors are entities that people trust to hold their deposits and [issue credits](../issuing-assets.md) into the Stellar network for those deposits. All money transactions in the Stellar network (except lumens) occur in the form of credit issued by anchors, so anchors act as a bridge between existing currencies and the Stellar network. Most anchors are organizations like banks, savings institutions, farmers’ co-ops, central banks, and remittance companies.
812

913
Before continuing, you should be familiar with:

0 commit comments

Comments
 (0)