Skip to content

Commit 818933c

Browse files
AUTO: Docs repo sync - ScalarDL (#746)
* AUTO: Sync ScalarDL docs in English to docs site repo * Delete README.mdx * Delete sdks.mdx * Remove SDK section and SDK doc The Java Client SDK doc doesn't provide much value and the contents have recently been referenced in other docs, so it along with the SDK section can be removed for now. * Add Japanese version of write ScalarDL app tutorial --------- Co-authored-by: josh-wong <joshua.wong@scalar-labs.com> Co-authored-by: Josh Wong <23216828+josh-wong@users.noreply.github.com>
1 parent b9bed1d commit 818933c

File tree

7 files changed

+17
-62
lines changed

7 files changed

+17
-62
lines changed

docs/getting-started.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -179,7 +179,7 @@ Select your database, and follow the instructions to deploy ScalarDL Ledger with
179179

180180
## Download the Client SDK
181181

182-
Next, you'll use the ScalarDL client tools and samples in the `scalardl-java-client-sdk` repository to interact with ScalarDL.
182+
Next, you'll use the ScalarDL client tools and samples in the [`scalardl-java-client-sdk`](https://github.com/scalar-labs/scalardl-java-client-sdk) repository to interact with ScalarDL.
183183

184184
Specify a version that is the same as the deployed ScalarDL version and is used for downloading the tools by running the following command:
185185

docs/how-to-write-applications.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ This document explains how to write ScalarDL applications. You will learn how to
1313

1414
## Use the ScalarDL Client SDK
1515

16-
You have two options to interact with ScalarDL: using [commands](scalardl-command-reference.mdx) as shown in the [getting started guide](getting-started.mdx) or using the [Java Client SDK](scalardl-java-client-sdk/README.mdx).
16+
You have two options to interact with ScalarDL: using [commands](scalardl-command-reference.mdx) as shown in the [getting started guide](getting-started.mdx) or using the [Java Client SDK](https://github.com/scalar-labs/scalardl-java-client-sdk).
1717
Using commands is convenient because you don't need to write applications. However, they invoke a process for each execution, which is slow, so they are mainly for quickly testing your contracts. Instead, using the Client SDK is usually recommended when you write ScalarDL-based applications because it is more efficient.
1818

1919
The Client SDK is available on [Maven Central](https://search.maven.org/search?q=a:scalardl-java-client-sdk). You can install it in your application by using a build tool such as Gradle. For example in Gradle, you can add the following dependency to `build.gradle`, replacing `VERSION` with the version of ScalarDL that you want to use.
@@ -135,15 +135,15 @@ Asset Proof in ScalarDL is a set of information about an asset record and used a
135135
136136
#### Benefits of Asset Proof
137137
138-
Since Asset Proof is evidence at the time of execution by Ledger, it is difficult for Ledger to tamper data after the evidence is created because the proofs and Ledger states would be diverged. Thus, making use of Asset Proof appropriately could reduce the risk of data tampering.
138+
Since Asset Proof is evidence at the time of execution by Ledger, it is difficult for Ledger to tamper data after the evidence is created because the Asset Proofs and Ledger states would be diverged. Thus, making use of Asset Proof appropriately could reduce the risk of data tampering.
139139
140140
#### How to access Asset Proof from your applications
141141
142-
You can get <JavadocLink packageName="scalardl-common" path="com/scalar/dl/ledger/asset" className="AssetProof" /> from the result <JavadocLink packageName="scalardl-common" path="com/scalar/dl/ledger/model" className="ContractExecutionResult" /> of the `executeContract` method of the Client SDK. A proof can be validated if it is not tampered and it is from Ledger by verifying the signature.
142+
You can get <JavadocLink packageName="scalardl-common" path="com/scalar/dl/ledger/asset" className="AssetProof" /> from the result <JavadocLink packageName="scalardl-common" path="com/scalar/dl/ledger/model" className="ContractExecutionResult" /> of the `executeContract` method of the Client SDK. An Asset Proof can be validated if it is not tampered and it is from Ledger by verifying the signature.
143143
144-
Storing proofs outside of a domain in which Ledger runs is recommended. This is so that malicious activities in one domain can be detected by the other domain. Storing proofs in cloud storages for ease of management is also worth considering.
144+
Storing Asset Proofs outside of a domain in which Ledger runs is recommended. This is so that malicious activities in one domain can be detected by the other domain. Storing Asset Proofs in cloud storages for ease of management is also worth considering.
145145
146-
The proofs obtained in execution can be used when you do `validateLedger`. `validateLedger` also returns the proof of a specified asset record after doing Ledger-side validation. Then, the client can check if the proof is the same as the one that was previously returned from Ledger.
146+
The Asset Proofs obtained in execution can be used when you do `validateLedger`. `validateLedger` also returns the Asset Proof of a specified asset record after doing Ledger-side validation. Then, the client can check if the Asset Proof is the same as the one that was previously returned from Ledger.
147147
148148
## Use other languages
149149

docs/scalardl-java-client-sdk/README.mdx

Lines changed: 0 additions & 32 deletions
This file was deleted.

docs/sdks.mdx

Lines changed: 0 additions & 12 deletions
This file was deleted.

sidebars.js

Lines changed: 5 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -91,18 +91,6 @@ const sidebars = {
9191
label: 'Develop',
9292
collapsible: true,
9393
items: [
94-
{
95-
type: 'category',
96-
label: 'SDKs',
97-
collapsible: true,
98-
items: [
99-
{
100-
type: 'doc',
101-
id: 'scalardl-java-client-sdk/README',
102-
label: 'ScalarDL Java Client SDK',
103-
},
104-
],
105-
},
10694
{
10795
type: 'doc',
10896
id: 'getting-started-auditor',
@@ -703,6 +691,11 @@ const sidebars = {
703691
id: 'data-modeling',
704692
label: 'データモデリング',
705693
},
694+
{
695+
type: 'doc',
696+
id: 'how-to-write-applications',
697+
label: 'Java でアプリケーションを書く',
698+
},
706699
{
707700
type: 'doc',
708701
id: 'configurations',

versioned_sidebars/version-3.8-sidebars.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@
4141
"getting-started-auditor",
4242
"data-modeling",
4343
"how-to-write-applications",
44+
"how-to-write-applications",
4445
"configurations",
4546
"schema-loader",
4647
"ca/caclient-getting-started",

versioned_sidebars/version-3.9-sidebars.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -633,6 +633,11 @@
633633
"id": "data-modeling",
634634
"label": "データモデリング"
635635
},
636+
{
637+
"type": "doc",
638+
"id": "how-to-write-applications",
639+
"label": "Java でアプリケーションを書く"
640+
},
636641
{
637642
"type": "doc",
638643
"id": "configurations",

0 commit comments

Comments
 (0)