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

SoftServe: add Anchor Platform documentation on RPC API and Custody Server #236

Merged
merged 31 commits into from
Oct 12, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
31 commits
Select commit Hold shift + click to select a range
f7b9d28
SDFSOF-122 - Updated SEP24 deposit/withdrawal flows to include inform…
MazurakIhor Aug 15, 2023
82c508c
SDFSOF-122 - Updated SEP31 flows to include information about JSON-RP…
MazurakIhor Aug 15, 2023
ee2b605
SDFSOF-122 - Removed PATCH /transaction from API documentation. Rewor…
MazurakIhor Aug 16, 2023
f8332eb
Update Custody Server documentation
rkharevych Aug 17, 2023
27f2aac
SDFSOF-122 - Added description for JSON-RPC methods
MazurakIhor Aug 21, 2023
ad76647
Add sequence diagrams
rkharevych Aug 21, 2023
11f6a62
Merge branch 'SDFSOF-122' of github.com:MazurakIhor/stellar-docs into…
rkharevych Aug 21, 2023
dd504ae
Update Fireblocks examples
rkharevych Aug 21, 2023
06db458
Fix deposit docs
rkharevych Aug 21, 2023
7f71410
SDFSOF-122 - Improvements of descriptions
MazurakIhor Aug 21, 2023
00a974c
Merge 'origin/SDFSOF-122' into SDFSOF-122
MazurakIhor Aug 21, 2023
fe7fd13
Rename RPC calls and update CodeExamples
rkharevych Aug 22, 2023
b4abf3e
Fix tip
rkharevych Aug 22, 2023
528477e
Fix status name
rkharevych Aug 22, 2023
9e7499c
Update tips
rkharevych Aug 22, 2023
3294a6f
SDFSOF-122 - Reworked RPC request examples to remove hardcoded text.
MazurakIhor Aug 22, 2023
2f2ba73
SDFSOF-122 - Minor fixes
MazurakIhor Aug 22, 2023
876f4e9
SDFSOF-122 - Added open-rpc.json
MazurakIhor Aug 22, 2023
51bea3d
SDFSOF-122 - Adjusted requests and responses. Added links to OpenRpc …
MazurakIhor Aug 22, 2023
a0ef7dd
SDFSOF-122 - Removed PATCH /transactions from documentation.
MazurakIhor Aug 23, 2023
e3d115f
Add sequence diagram definitions
rkharevych Aug 23, 2023
9e57097
SDFSOF-122 - Minor fixes
MazurakIhor Aug 23, 2023
a7e0e55
Merge branch 'main' of github.com:MazurakIhor/stellar-docs into SDFSO…
rkharevych Aug 23, 2023
3e2af3a
Merge branch 'SDFSOF-122' of github.com:MazurakIhor/stellar-docs into…
rkharevych Aug 23, 2023
90ae4f6
SDFSOF-122 - Changed state to status
MazurakIhor Aug 25, 2023
c3dff80
Merge remote-tracking branch 'origin/SDFSOF-122' into SDFSOF-122
MazurakIhor Aug 25, 2023
ae4e868
Add Custody Server API
rkharevych Aug 28, 2023
7dade88
Refactoring
rkharevych Aug 28, 2023
d48cceb
SDFSOF-122 - Updated state transition diagrams
MazurakIhor Aug 29, 2023
5062848
Update Kotlin Reference Server config
rkharevych Aug 31, 2023
23fdbb6
Merge branch 'main' into SDFSOF-122
JakeUrban Sep 13, 2023
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
2 changes: 1 addition & 1 deletion api/anchor-platform/callbacks/get-rates.api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Success.

An object describing the fees added on top of the rate provided via the `price` attribute.

</div><SchemaItem collapsible={false} name={"total"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The total fee to be applied."}}></SchemaItem><SchemaItem collapsible={false} name={"asset"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The asset the fee will be charged in. Must be represented in [Asset Identification Format](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0038.md#asset-identification-format)."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>details</strong><span style={{"opacity":"0.6"}}> object[]</span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the fee, for example `ACH fee`, `Brazilian conciliation fee`, `Service fee`, etc."}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"A text describing the fee."}}></SchemaItem><SchemaItem collapsible={false} name={"amount"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The amount of asset applied. If `fee.details` is provided, `sum(fee.details.amount)` should be equals `fee.total`."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"rate\": {\n \"id\": \"string\",\n \"expires_at\": \"2023-09-13T19:13:14.171Z\",\n \"price\": \"string\",\n \"sell_amount\": \"string\",\n \"buy_amount\": \"string\",\n \"fee\": {\n \"total\": \"string\",\n \"asset\": \"string\",\n \"details\": [\n {\n \"name\": \"string\",\n \"description\": \"string\",\n \"amount\": \"string\"\n }\n ]\n }\n }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"422"} value={"422"}><div>
</div><SchemaItem collapsible={false} name={"total"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The total fee to be applied."}}></SchemaItem><SchemaItem collapsible={false} name={"asset"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The asset the fee will be charged in. Must be represented in [Asset Identification Format](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0038.md#asset-identification-format)."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>details</strong><span style={{"opacity":"0.6"}}> object[]</span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the fee, for example `ACH fee`, `Brazilian conciliation fee`, `Service fee`, etc."}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"A text describing the fee."}}></SchemaItem><SchemaItem collapsible={false} name={"amount"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The amount of asset applied. If `fee.details` is provided, `sum(fee.details.amount)` should be equals `fee.total`."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"rate\": {\n \"id\": \"string\",\n \"expires_at\": \"2023-09-13T22:33:44.957Z\",\n \"price\": \"string\",\n \"sell_amount\": \"string\",\n \"buy_amount\": \"string\",\n \"fee\": {\n \"total\": \"string\",\n \"asset\": \"string\",\n \"details\": [\n {\n \"name\": \"string\",\n \"description\": \"string\",\n \"amount\": \"string\"\n }\n ]\n }\n }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"422"} value={"422"}><div>

Unprocessable Entity. This status should be returned when the anchor understood the request but cannot
return a success response.
Expand Down
Loading