Merge pull request #93 from scalar-labs/scalardl/japanese-docs-transl…

…ations AUTO: Docs repo sync - ScalarDL - Add Japanese docs
scalar-labs · Feb 26, 2024 · 1f1af9c · 1f1af9c
2 parents d9cb1f5 + b23290f
commit 1f1af9c
Show file tree

Hide file tree

Showing 38,429 changed files with 12,168,353 additions and 76 deletions.
diff --git a/_data/navigation.yml b/_data/navigation.yml
diff --git a/docs/3.4/applications/escrow-payment/README.md b/docs/3.4/applications/escrow-payment/README.md
@@ -1,5 +1,3 @@
-{% include scalardl/end-of-support.html %}
-
 # ScalarDL Escrow payment CLI
 
 The following is a simple Java CLI application to try out and test [ScalarDL](https://github.com/scalar-labs/scalardl). PicoCLI is used as a CLI framework.

diff --git a/docs/3.4/applications/simple-bank-account/README.md b/docs/3.4/applications/simple-bank-account/README.md
@@ -1,5 +1,3 @@
-{% include scalardl/end-of-support.html %}
-
 # A simple bank account application
 
 ## Overview

diff --git a/docs/3.4/applications/simple-bank-account/docs/api_endpoints.md b/docs/3.4/applications/simple-bank-account/docs/api_endpoints.md
@@ -1,5 +1,3 @@
-{% include scalardl/end-of-support.html %}
-
 # API endpoints
 
 ## `GET v1/accounts`

diff --git a/docs/3.4/authentication.md b/docs/3.4/authentication.md
@@ -1,5 +1,3 @@
-{% include scalardl/end-of-support.html %}
-
 # ScalarDL Authentication Guide
 
 This document explains the ScalarDL authentication mechanism and how to use it properly. 

diff --git a/docs/3.4/backup-restore.md b/docs/3.4/backup-restore.md
@@ -1,5 +1,3 @@
-{% include scalardl/end-of-support.html %}
-
 # A Guide on How to Backup and Restore Data in ScalarDL
 
 Since ScalarDL uses ScalarDB that provides transaction capability on top of non-transactional (possibly transactional) databases non-invasively,

diff --git a/docs/3.4/ca/caclient-getting-started.md b/docs/3.4/ca/caclient-getting-started.md
@@ -1,5 +1,3 @@
-{% include scalardl/end-of-support.html %}
-
 # How to get a certificate
 
 This document describes how to get a certificate to enroll in ScalarDL network.

diff --git a/docs/3.4/ca/caserver-getting-started.md b/docs/3.4/ca/caserver-getting-started.md
@@ -1,5 +1,3 @@
-{% include scalardl/end-of-support.html %}
-
 # How to start CA sever with CFSSL
 
 This document describes how to start CA server with CFSSL.

diff --git a/docs/3.4/compatibility.md b/docs/3.4/compatibility.md
@@ -1,5 +1,3 @@
-{% include scalardl/end-of-support.html %}
-
 # ScalarDL Compatibility Matrix
 
 This document shows ScalarDL Ledger and Auditor compatibility with the ScalarDL Java Client SDK.

diff --git a/docs/3.4/design.md b/docs/3.4/design.md
@@ -1,5 +1,3 @@
-{% include scalardl/end-of-support.html %}
-
 # ScalarDL Design Document
 
 For details about the design and implementation of ScalarDL, please see the following documents, which we presented at the VLDB 2022 conference:

diff --git a/docs/3.4/getting-started-auditor.md b/docs/3.4/getting-started-auditor.md
@@ -1,5 +1,3 @@
-{% include scalardl/end-of-support.html %}
-
 # Getting Started with ScalarDL Auditor
 
 This document explains how to get started with ScalarDL Auditor.

diff --git a/docs/3.4/getting-started.md b/docs/3.4/getting-started.md
@@ -1,5 +1,3 @@
-{% include scalardl/end-of-support.html %}
-
 # Getting Started with ScalarDL
 
 This document explains how to get started with ScalarDL by running your first simple contract using the Client SDK.

diff --git a/docs/3.4/how-to-handle-errors.md b/docs/3.4/how-to-handle-errors.md
@@ -1,5 +1,3 @@
-{% include scalardl/end-of-support.html %}
-
 # A Guide on How to Handle Errors in ScalarDL
 
 This document sets out some guidelines for handling errors in ScalarDL.

diff --git a/docs/3.4/how-to-use-proof.md b/docs/3.4/how-to-use-proof.md
@@ -1,5 +1,3 @@
-{% include scalardl/end-of-support.html %}
-
 # A Guide on How to Use Asset Proofs in ScalarDL
 
 This document sets out some guidelines for using Asset Proofs in ScalarDL.

diff --git a/docs/3.4/how-to-write-contract.md b/docs/3.4/how-to-write-contract.md
@@ -1,5 +1,3 @@
-{% include scalardl/end-of-support.html %}
-
 # A Guide on How to Write a Good Contract for ScalarDL
 
 This document sets out some guidelines for writing contracts for ScalarDL.

diff --git a/docs/3.4/how-to-write-function.md b/docs/3.4/how-to-write-function.md
@@ -1,5 +1,3 @@
-{% include scalardl/end-of-support.html %}
-
 # A Guide on How to Write Function for ScalarDL
 
 This document sets out some guidelines for writing functions for ScalarDL.

diff --git a/docs/3.4/implementation.md b/docs/3.4/implementation.md
@@ -1,5 +1,3 @@
-{% include scalardl/end-of-support.html %}
-
 # ScalarDL Implementation
 
 ScalarDL is scalable and practical Byzantine fault detection middleware for transactional database systems, which achieves correctness, scalability, and database agnosticism.

diff --git a/docs/3.4/index.md b/docs/3.4/index.md
@@ -1,5 +1,3 @@
-{% include scalardl/end-of-support.html %}
-
 # ScalarDL: Byzantine Fault Detection Middleware for Transactional Database Systems
 
 ScalarDL is scalable and practical Byzantine fault detection middleware for transactional database systems that achieves correctness, scalability, and database agnosticism.

diff --git a/docs/3.4/installation-with-docker.md b/docs/3.4/installation-with-docker.md
@@ -1,5 +1,3 @@
-{% include scalardl/end-of-support.html %}
-
 # How to install ScalarDL in your local environment with Docker
 
 This document shows how to set up a local environment that runs ScalarDL

diff --git a/docs/3.4/javadoc/2.1.1/index.md b/docs/3.4/javadoc/2.1.1/index.md
@@ -1,5 +1,3 @@
-{% include scalardl/end-of-support.html %}
-
 * [client](./client)
 * [common](./common)
 * [ledger](./ledger)

diff --git a/docs/3.4/javadoc/2.2.0/index.md b/docs/3.4/javadoc/2.2.0/index.md
@@ -1,5 +1,3 @@
-{% include scalardl/end-of-support.html %}
-
 * [client](./client)
 * [common](./common)
 * [ledger](./ledger)

diff --git a/docs/3.4/javadoc/3.0.0/index.md b/docs/3.4/javadoc/3.0.0/index.md
@@ -1,5 +1,3 @@
-{% include scalardl/end-of-support.html %}
-
 * [auditor](./auditor)
 * [client](./client)
 * [common](./common)

diff --git a/docs/3.4/javadoc/3.0.2/index.md b/docs/3.4/javadoc/3.0.2/index.md
@@ -1,5 +1,3 @@
-{% include scalardl/end-of-support.html %}
-
 * [auditor](./auditor)
 * [client](./client)
 * [common](./common)

diff --git a/docs/3.4/javadoc/3.1.0/index.md b/docs/3.4/javadoc/3.1.0/index.md
@@ -1,5 +1,3 @@
-{% include scalardl/end-of-support.html %}
-
 * [auditor](./auditor)
 * [bfd](./bfd)
 * [client](./client)

diff --git a/docs/3.4/javadoc/3.2.0/index.md b/docs/3.4/javadoc/3.2.0/index.md
@@ -1,5 +1,3 @@
-{% include scalardl/end-of-support.html %}
-
 * [auditor](./auditor)
 * [client](./client)
 * [common](./common)

diff --git a/docs/3.4/javadoc/3.3.0/index.md b/docs/3.4/javadoc/3.3.0/index.md
@@ -1,5 +1,3 @@
-{% include scalardl/end-of-support.html %}
-
 * [auditor](./auditor)
 * [client](./client)
 * [common](./common)

diff --git a/docs/3.4/javadoc/index.md b/docs/3.4/javadoc/index.md
@@ -1,5 +1,3 @@
-{% include scalardl/end-of-support.html %}
-
 # Scalar DL Javadoc
 
 * [latest](./latest/index.md)

diff --git a/docs/3.4/scalardl-benchmarks/README.md b/docs/3.4/scalardl-benchmarks/README.md
@@ -1,5 +1,3 @@
-{% include scalardl/end-of-support.html %}
-
 # ScalarDL Benchmarks
 
 This repository contains benchmark programs for ScalarDL.

diff --git a/docs/3.4/scalardl-go-client-sdk/README.md b/docs/3.4/scalardl-go-client-sdk/README.md
@@ -1,5 +1,3 @@
-{% include scalardl/end-of-support.html %}
-
 # Scalar DL Go Client SDK
 This module is for developing applications that interact with [Scalar DL](https://github.com/scalar-labs/scalardl) networks.
 

diff --git a/docs/3.4/scalardl-java-client-sdk/README.md b/docs/3.4/scalardl-java-client-sdk/README.md
@@ -1,5 +1,3 @@
-{% include scalardl/end-of-support.html %}
-
 ## Scalar DL Java Client SDK
 
 This is a client-side Java library to interact with [Scalar DL](https://github.com/scalar-labs/scalardl) network.

diff --git a/docs/3.4/scalardl-javascript-sdk-base/README.md b/docs/3.4/scalardl-javascript-sdk-base/README.md
@@ -1,5 +1,3 @@
-{% include scalardl/end-of-support.html %}
-
 [![CircleCI](https://circleci.com/gh/scalar-labs/scalardl-javascript-sdk-base/tree/master.svg?style=svg)](https://circleci.com/gh/scalar-labs/scalardl-javascript-sdk-base/tree/master)
 
 NPM package `@scalar-labs/scalardl-javascript-sdk-base` is the common part for package [@scalar-labs/scalardl-web-client-sdk](https://github.com/scalar-labs/scalardl-web-client-sdk) and [@scalar-labs/scalardl-node-client-sdk](https://github.com/scalar-labs/scalardl-node-client-sdk).

diff --git a/docs/3.4/scalardl-node-client-sdk/README.md b/docs/3.4/scalardl-node-client-sdk/README.md
@@ -1,5 +1,3 @@
-{% include scalardl/end-of-support.html %}
-
 # Scalar DL Node Client SDK
 
 This is a library for Node.js applications by which the applications can interact with a [Scalar DL](https://github.com/scalar-labs/scalardl) network.

diff --git a/docs/3.4/scalardl-web-client-sdk/README.md b/docs/3.4/scalardl-web-client-sdk/README.md
@@ -1,5 +1,3 @@
-{% include scalardl/end-of-support.html %}
-
 ## Scalar DL Web Client SDK
 
 This is a library for web applications by which the applications can interact with a [Scalar DL](https://github.com/scalar-labs/scalardl) network.

diff --git a/docs/3.4/schema-loader.md b/docs/3.4/schema-loader.md
@@ -1,5 +1,3 @@
-{% include scalardl/end-of-support.html %}
-
 # ScalarDL Schema Loader
 
 A Docker image that loads the database schemas of ScalarDL using [Schema Tool for Scalar DB](https://github.com/scalar-labs/scalardb/tree/master/schema-loader/).

diff --git a/docs/3.4/sdks.md b/docs/3.4/sdks.md
@@ -1,5 +1,3 @@
-{% include scalardl/end-of-support.html %}
-
 # SDKs for ScalarDL
 
 The following is a list of SDKs for ScalarDL:

diff --git a/docs/3.4/troubleshooting-guide.md b/docs/3.4/troubleshooting-guide.md
@@ -1,5 +1,3 @@
-{% include scalardl/end-of-support.html %}
-
 # Troubleshooting Guide
 
 # Introduction

diff --git a/docs/ja-jp/3.4/applications/escrow-payment/.gitattributes b/docs/ja-jp/3.4/applications/escrow-payment/.gitattributes
@@ -0,0 +1,6 @@
+#
+# https://help.github.com/articles/dealing-with-line-endings/
+#
+# These are explicitly windows files and should use crlf
+*.bat           text eol=crlf
+
diff --git a/docs/ja-jp/3.4/applications/escrow-payment/.gitignore b/docs/ja-jp/3.4/applications/escrow-payment/.gitignore
@@ -0,0 +1,36 @@
+# Compiled class file
+*.class
+
+# Log file
+*.log
+
+# BlueJ files
+*.ctxt
+
+# Mobile Tools for Java (J2ME)
+.mtj.tmp/
+
+# Package Files #
+*.jar
+*.war
+*.nar
+*.ear
+*.zip
+*.tar.gz
+*.rar
+
+# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
+hs_err_pid*
+
+# custom
+cfssl
+build
+.idea
+
+
+# Ignore Gradle project-specific cache directory
+.gradle
+
+.settings/
+bin/
+
diff --git a/docs/ja-jp/3.4/applications/escrow-payment/Makefile b/docs/ja-jp/3.4/applications/escrow-payment/Makefile
@@ -0,0 +1,75 @@
+SHELL := /bin/bash
+
+##### BUILD
+.PHONY: build
+build:
+	@echo "Building ScalarDL escrow demo CLI"
+	@./gradlew build
+
+#### ScalarDL
+.PHONY: register-cert assemble register-contracts clear register-all
+
+register-all: register-cert register-contracts
+
+register-cert:
+	@echo "Registering certificate ..."
+	@client/bin/register-cert --properties client.properties
+
+assemble: clear
+	@echo "Building contracts ..."
+	@./gradlew assemble
+
+register-contracts: assemble
+	@echo "Registering contracts ..."
+	@client/bin/register-contract --properties client.properties --contract-id AddAccount_foo --contract-binary-name com.ypeckstadt.escrow.contract.account.AddAccount --contract-class-file build/classes/java/main/com/ypeckstadt/escrow/contract/account/AddAccount.class
+	@client/bin/register-contract --properties client.properties --contract-id AddItem_foo --contract-binary-name com.ypeckstadt.escrow.contract.item.AddItem --contract-class-file build/classes/java/main/com/ypeckstadt/escrow/contract/item/AddItem.class
+	@client/bin/register-contract --properties client.properties --contract-id AddOrder_foo --contract-binary-name com.ypeckstadt.escrow.contract.order.AddOrder --contract-class-file build/classes/java/main/com/ypeckstadt/escrow/contract/order/AddOrder.class
+	@client/bin/register-contract --properties client.properties --contract-id CancelOrder_foo --contract-binary-name com.ypeckstadt.escrow.contract.order.CancelOrder --contract-class-file build/classes/java/main/com/ypeckstadt/escrow/contract/order/CancelOrder.class
+	@client/bin/register-contract --properties client.properties --contract-id ChargeAccount_foo --contract-binary-name com.ypeckstadt.escrow.contract.account.ChargeAccount --contract-class-file build/classes/java/main/com/ypeckstadt/escrow/contract/account/ChargeAccount.class
+	@client/bin/register-contract --properties client.properties --contract-id SetOrderToReceivedStatus_foo --contract-binary-name com.ypeckstadt.escrow.contract.order.SetOrderToReceivedStatus --contract-class-file build/classes/java/main/com/ypeckstadt/escrow/contract/order/SetOrderToReceivedStatus.class
+	@client/bin/register-contract --properties client.properties --contract-id SetOrderToShippedStatus_foo --contract-binary-name com.ypeckstadt.escrow.contract.order.SetOrderToShippedStatus --contract-class-file build/classes/java/main/com/ypeckstadt/escrow/contract/order/SetOrderToShippedStatus.class
+	@client/bin/register-contract --properties client.properties --contract-id ViewAccountHistory_foo --contract-binary-name com.ypeckstadt.escrow.contract.account.ViewAccountHistory --contract-class-file build/classes/java/main/com/ypeckstadt/escrow/contract/account/ViewAccountHistory.class
+	@client/bin/register-contract --properties client.properties --contract-id ViewItem_foo --contract-binary-name com.ypeckstadt.escrow.contract.item.ViewItem --contract-class-file build/classes/java/main/com/ypeckstadt/escrow/contract/item/ViewItem.class
+	@client/bin/register-contract --properties client.properties --contract-id DebitEscrowAccount_foo --contract-binary-name com.ypeckstadt.escrow.contract.account.DebitEscrowAccount --contract-class-file build/classes/java/main/com/ypeckstadt/escrow/contract/account/DebitEscrowAccount.class
+	@client/bin/register-contract --properties client.properties --contract-id CreditEscrowAccount_foo --contract-binary-name com.ypeckstadt.escrow.contract.account.CreditEscrowAccount --contract-class-file build/classes/java/main/com/ypeckstadt/escrow/contract/account/CreditEscrowAccount.class
+	@client/bin/register-contract --properties client.properties --contract-id CreditAccount_foo --contract-binary-name com.ypeckstadt.escrow.contract.account.CreditAccount --contract-class-file build/classes/java/main/com/ypeckstadt/escrow/contract/account/CreditAccount.class
+	@client/bin/register-contract --properties client.properties --contract-id DebitAccount_foo --contract-binary-name com.ypeckstadt.escrow.contract.account.DebitAccount --contract-class-file build/classes/java/main/com/ypeckstadt/escrow/contract/account/DebitAccount.class
+	@client/bin/register-contract --properties client.properties --contract-id ViewOrderHistory_foo --contract-binary-name com.ypeckstadt.escrow.contract.order.ViewOrderHistory --contract-class-file build/classes/java/main/com/ypeckstadt/escrow/contract/order/ViewOrderHistory.class
+	@client/bin/register-contract --properties client.properties --contract-id ViewEscrowAccountHistory_foo --contract-binary-name com.ypeckstadt.escrow.contract.escrowAccount.ViewEscrowAccountHistory --contract-class-file build/classes/java/main/com/ypeckstadt/escrow/contract/escrowAccount/ViewEscrowAccountHistory.class
+
+clear:
+	@rm -rf build
+
+
+#### Scenario test
+.PHONY: run-complete-order-scenario run-cancel-order-scenario all
+run-complete-order-scenario:
+	@./gradlew run --args="account add -id buyer_1 -n Alfred"
+	@./gradlew run --args="account add -id seller_1 -n Yves"
+	@./gradlew run --args="account charge -id buyer_1 -a 5000"
+	@./gradlew run --args="item add -id item_1 -n bicycle -p 6000 -s seller_1"
+	@./gradlew run --args="order add -id order_1 -b buyer_1 -i item_1"
+	@./gradlew run --args="account charge -id buyer_1 -a 5000"
+	@./gradlew run --args="order add -id order_1 -b buyer_1 -i item_1"
+	@./gradlew run --args="order shipped -id order_1 -s seller_1"
+	@./gradlew run --args="order received -id order_1 -b buyer_1"
+	@./gradlew run --args="order view -id order_1"
+	@./gradlew run --args="account view -id buyer_1"
+	@./gradlew run --args="account view -id seller_1"
+	@./gradlew run --args="escrow view -b buyer_1 -s seller_1"
+
+run-cancel-order-scenario:
+	@./gradlew run --args="account add -id buyer_1 -n Alfred"
+	@./gradlew run --args="account add -id seller_1 -n Yves"
+	@./gradlew run --args="account charge -id buyer_1 -a 50000"
+	@./gradlew run --args="item add -id item_1 -n bicycle -p 10000 -s seller_1"
+	@./gradlew run --args="order add -id order_1 -b buyer_1 -i item_1"
+	@./gradlew run --args="account view -id buyer_1"
+	@./gradlew run --args="order cancel -id order_1 -a buyer_1"
+	@./gradlew run --args="order view -id order_1"
+	@./gradlew run --args="account view -id buyer_1"
+
+
+
+
+