Protocol Documentation

Table of Contents

TxResponse

Error は GRPC Error Code で返す

API

TxGate は Client から Transaction を受け取る

Write は Transaction を受け付ける。
受け取った Transaction は ProposalTxQueue に挿入した後、他のPeerに伝搬する。

InvalidArgument (code = 3) : One of following conditions:
 1 ) StatelessValidator で落ちる場合
AlreadyExist (code = 6) : One of following conditions:
 1 ) 既に同じ Transaction を受け取っていた場合

Read は Query を受け付ける。
受け取った Query の規則に従ってデータを取得し Peer の署名を添付した QueryResponse を返す。

InvalidArgument (code = 3) : One of following conditions:
 1 ) Verify で落ちる場合
 2 ) Validate で落ちる場合
NotFound (code = 5) : One of following conditions:
 1 ) 検索結果が見つからなかった場合

ConsensusResponse

Error は GRPC Error Code で返す

PropagateBlockRequest

PropagateBlock において伝搬する側が送信するデータである。

伝搬する Block。最初に Block を送信する。 

伝搬する Block が持っている Transaction。Block を送信した後に順番に送信する。 

PropagateBlockResponse

PropagateBlock において伝搬される側が送信するデータである。

Block を正しく受け取ったことを伝搬する側に伝えるために署名を送信する。 

Consensus

ConsensusGate は合意形成に使用する rpc を定義する。

これを使用するのは合意形成に参加するPeerのみである。

PropagateTx は Client から受け取った Transaction を自分以外の Peer に伝搬させる。
Context には送信者の署名をつける。

InvalidArgument (code = 3) : One of following conditions:
 1 ) StatelessValidator で落ちる場合
PermissionDenied (code = 7) : One of following conditions:
 1 ) Context の 署名の主がPeerでない場合

PropagateBlock は Commit する block と txList を自分以外の Peer に伝搬させる。
Context には送信者の署名をつける

InvalidArgument (code = 3) : One of following conditions:
 1 ) Block is nil.
 2 ) Block Verify failed.
 3 ) Transaction is nil.
 4 ) Transaction Verify failed.
 AlreadyExist (code = 6) : One of following conditions:
 1 ) Block is already exist in block queue.
 PermissionDenied (code = 7) : One of following conditions:
 1 ) Context の 署名の主がPeerでない場合

Account

アカウントを表すオブジェクト。

アカウントを特定するユニークなアドレス。 

アカウントの表示名。 

アカウントを操作するための鍵の列。 

アカウントを操作するために必要最小限の鍵の数。 

アカウントの保有する基軸通貨の数。 

アカウントが信頼しているピアのアドレス。 

ActivatePeer

ActivatePeer は Peer を active 状態にする。

TargetId は AccountId(PeerId) を指定する。

Active 状態の Peer は合意形成に参加できる。

AddBalance

AddBalance は targetId の balance を増やす。

TargetId は AccountId を指定する。

増やす balance の量。 

AddObject

AddObject は TargetId で指定した Storage に Object を追加する。（list or dict)

TargetId は WalletId を指定する。

Storage 内の要素を指定するためのキー値。 

指定した List Object に追加する Object。 

AddPeer

AddPeer はネットワークに Peer を追加する。

TargetId は AccountId(PeerId) を指定する。

Peer にアクセスするためのグローバルアドレス。 

Peer を操作するための公開鍵。 

AddPublicKeys

AddPublicKey は TragetId で指定したアカウントに鍵を追加する。

TargetId は AccountId を指定する。

アカウントに登録する公開鍵のリスト。 

Address

Proskenion 上のオブジェクトにアクセスするためのオブジェクト。

BanPeer

BanPeer は Peer を使用禁止にする。

TargetId は AccountId(PeerId) を指定する。

Ban された Peer は金輪際合意形成/同期に参加できない。

Block

Block の構造。

Payload を現在のラウンドにおけるリーダーが署名したもの。 

Block.Payload

現在のBlockのHeight+1。 

現在の Block のハッシュ値。 

Blockを生成した時間(リーダーがProposalを生成した時間であり、Commitされた時間ではない)。 

Block 実行後の WSV のルートハッシュ値。 

Block 実行後の TxHistory のルートハッシュ値。 

Transaction の集合（列)のハッシュ値。 

現在の Round。 

CheckAndCommitProsl

CheckAndCommitProsl は TargetId で指定した ProSL を検証して妥当であれば適用する。

TargetId は WalletId を指定する。

具体的には variables を引数列として渡して Update ProSL を実行し真を返した時、

新たな incentive or consensus or update アルゴリズムとして実際に適用する。

Update ProSL を実行する際の引数列。 

CheckAndCommitProsl.VariablesEntry

Command

Proskenion を操作するためのプリミティブな命令。

誰の権限で命令を実行するかを AccountId で指定する。 

どの対象に命令を実行するかを指定する。 

Consign

Consign は Account と Peer を紐付ける

TargetId は AccountId を指定する。

アカウントが信頼する Peer の id。 

CreateAccount

CerateAccount は TargetId の アカウントの生成を行う。

TargetId には AccountId を指定する。

アカウントに登録する公開鍵のリスト。 

アカウントの権限を行使するために必要な最小の鍵の数。 

CreateStorage

CreateStorage は定義された Storage を TargetId で指定されたアカウントで実体化する。

TargetId は WalletId を指定する。

DefineStorage

DefineStorage は Storage を定義する。

TargetId は StorageId を指定する。

Storage の key とそのデフォルトの value。 

ForceUpdateStorage

ForceUpdateStorage は TargetId で指定した Storage を強制上書きする。

TargetId は WalletId を指定する。

ForceUpdateStorage は Validate で必ず false が返る。

上書き後の Storage の定義。 

MegaBinaryChunk

未実装。 (参考 : https://triple-underscore.github.io/RFC2616-ja.html#section-3.6.1)

全体 

どこから始まるか 

MegaStorage

未実装。

MegaStorage.MetaEntry

Object

Proskenion で扱えるデータ構造をまとめたオブジェクト。

オブジェクトの識別子。 

ObjectDict

オブジェクトの辞書を表すオブジェクト。

文字列をキー値、オブジェクトをバリュー値に持つ辞書。 

ObjectDict.DictEntry

ObjectList

オブジェクトのリストを表すオブジェクト。

オブジェクトの列。 

OrderBy

ソートのキーと順序の識別オブジェクト。

Peer

ピアを表すオブジェクト。

ピアを特定するユニークなアドレス。 

ピアにアクセスするためのグローバルアドレス。(ex. ip:port) 

ピアの公開鍵。 

ピアが同期して活動しているかの真偽値。 

ピアがチェーン上から排斥されているかの真偽値。 

RemovePublicKeys

RemovePublicKey は TargetId で指定したアカウントの鍵を削除する。

TargetId は AccountId を指定する。

アカウントから削除する公開鍵のリスト。 

SetQuorum

SetAccountQuorum は TargetId アカウントの quorum を更新する。

TargetId は AccountId を指定する。

アカウントの権限を行使するために必要な最小の鍵の数。 

Signature

署名を表すオブジェクト。

公開鍵を base64 エンコードしたもの。 

秘密鍵でハッシュ値を署名したもの。 

Storage

ストレージを表すオブジェクト。

ストレージを特定するユニークなアドレス。 

ストレージの中身を表すキーバリューデータ構造。 

Storage.ObjectEntry

SuspendPeer

SuspendPeer は Peer を 非active 状態にする。

TargetId は AccountId(PeerId) を指定する。

非active 状態の Peer は合意形成に参加しない。(Consign の対象にできない）

Transaction

Transaction は Client が送信する取引の内容を記述したものである。

Paylaod をコマンドの操作者達によって署名した Signature のリスト。 

Transaction.Payload

Transaction を生成した時間(UnixTime)。 

Transaction が逐次実行するコマンド列。 

TransferBalance

Transfer Command は送金を行う。

targetId は 送金元の AccountId を示す。

送金先の AccountId。 

送金する balance の量。 

TransferObject

TransferObject は Storage 内の key で指定された要素内の Object を送信する。（list or dict)

TargetId は WalletId を指定する。

Storage 内の要素を指定するためのキー値。 

送信先の AccountId。 

送信する Object の内容（存在しない場合は失敗する）。 

UpdateObject

UpdateObject は Storage 内の Object を更新する。

TargetId は WalletId を指定する。

Storage 内の要素を指定するためのキー値。 

変更後の Object。 

ObjectCode

Object の識別コード。

OrderCode

順序の識別コード。DESC(降順), ASC(昇順)。

AndFormula

AndOperator

AssertOperator

CastOperator

CommandOperator

CommandOperator.ParamsEntry

ConcatOperator

ConditionalFormula

|| 

&& 

! 

== 

!= 

> 

>= 

< 

<= 

DivisionOperator

EachOperator

Deprecated...

ElifOperator

ElseOperator

EqFormula

ErrCatchOperator

GeFormula

GtFormula

IfOperator

IndexedOperator

IsDefinedOperator

LeFormula

LenOperator

ListComprehensionOperator

ListOperator

LtFormula

MapOperator

MapOperator.ObjectEntry

MinusOperator

ModOperator

MultipleOperator

NeFormula

NotFormula

OrFormula

OrOperator

PageRankOperator

List Obejct and each object is Storage Object.
Storage.Id is vertex id.
 toKey is Storage[toKey] = ObjectList<AddressObject>
Allowed edges inputs Storage.Id -> Storage[toKey]...

Output : ObjectList<StorageObject>
         Storage has Id = "Address/outStorageName" and  "rank" = rank. 

PlusOperator

Prosl

ProslOperator

QueryOperator

RequireOperator

ReturnOperator

SetOperator

SliceOperator

return ListObeject[left, right) : left == nil: left is 0, right == nil: right is len(list).

SortOperator

StorageOperator

TxOperator

ValueOperator

ValuedOperator

VariableOperator

VerifyOperator

XorOperator

ErrCode

Query

Query は Proskenion 上のデータを取得するためのフォーマットである。

Payload を Query 発行者が署名したもの。 

Query.Payload

誰の権限で Query を発行するかを AccountId で指定する。 

取得したい要素の名前を指定する。 

取得する Object の型を指定する。 

検索対象となる id を指定する。 

TODO: fromId が範囲指定だった場合、取得した Object に filter をかける条件式を記述する。 

fromId が範囲指定だった場合、取得したリストをソートするルールを指定する。 

fromId が範囲指定だった場合、取得したリストを何番目まで返すかを指定する。 

Query を発行した時間を指定する。 

QueryResponse

QueryResponse は Read RPC の返り値である。

Query で取得したデータ。 

Object を Query を実行した Peer が署名したもの。 

SyncRequest

SynRequest は取得したい BlockChain の先頭のブロックハッシュを渡す。

終了は io.EOF を用いる。

SyncResponse

SyncResponse は Block と Transaction の列を返す。

データベースのロック解除のために空を返す。

空を返されたら Request で再び続きから取得する。

Sync

SyncGate は 同期を行うための通信

Sync は同期したい側が正しいデータを持っている Peer に対して投げるリクエストである。

InvalidArgument (code = 3) : One of following conditions:
  1 ) Block hash is nil.
  2 ) Block Verify failed.
  3 ) Transaction is nil.
  4 ) Transaction Verify failed.
DeadlineExceeded (Code = 4) One fo following conditoins:
  1 ) Timeout stream response.
AlreadyExist (code = 6) : One of following conditions:
  1 ) Block is already exist is blockchain.

Scalar Value Types