quorum_sdk 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 575ecf478b2a506d1370cb46615bfb67c0a96385b9bcce97576172520cf55fa0
-  data.tar.gz: 8dbf6f2cf9ce014419a02a13895320dbfe75d6ef550ae37319025bd566cc8143
+  metadata.gz: 245e92c9c15874d6bb256ed440cd35022e5957d5b8ab29e259a53d4453df1a0e
+  data.tar.gz: 1c2fc0cb78d949eafc39b25f7d5f8c74b8c2ca48cf1b7fc035cfb64ad6cef92e
 SHA512:
-  metadata.gz: 75e151a940633aa6c2fcdd7ad2005642aa096c3763109ae55b965055973ea09347da4aa2f9fab0228b2809a9a5d49882542327ffbed63422c94fb3f6b006138e
-  data.tar.gz: cfac31d64825054781e16e6dfb9a5fb3cca5bae0598a7114272d574b5750b1695f6e63fcf0a01c76c7ad17be28d080eae2f2bac864598c9f087125b85b4bd002
+  metadata.gz: 93a857d4eb6197c52b83447640c146d9818723eebdc8102552e5140fc32c939316c6c0f546bf203d4e0d5dd458be37d2a0afef957d1fd2d74b8fe71bec5d4ef6
+  data.tar.gz: c48771075369a6b8d27c7ddc04a9593fe782a4a1189c069271535a8d5d2830d4c64f25604a0530fb84b415840625bfec73df30c5332c9aa4e0990508b7cfc810

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    quorum_sdk (0.2.0)
+    quorum_sdk (0.3.0)
       activesupport (~> 7)
       addressable (~> 2)
       bcrypt (~> 3.1)

data/README.md

@@ -10,21 +10,13 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
     $ gem install quorum_sdk
 
-## Usage
+## LightNode Usage
 
 ### Initilize
 
 ```ruby
 # Initilize by seed url
-rum = QuorumSdk::API.new seed_url: "rum://...."
-
-# Initilize by config
-rum = QuorumSdk::API.new(
-    gropu_id: '',
-    gropu_name: '',
-    cipher_key: '',
-    chain_urls: ['', '']
-)
+node = QuorumSdk::Node.new seed: "rum://...."
 ```
 
 ### Send a trx
@@ -44,10 +36,10 @@ account = QuorumSdk::Account.new
 # account = QuorumSdk::Account.new priv: private_key
 
 # build trx
-trx = rum.build_trx data: msg, private_key: account.private_hex
+trx = node.build_trx data: msg, private_key: account.private_hex
 
 # push trx to chain
-rum.send_trx trx
+node.send_trx trx
 # output: { trx_id: '...' }
 
 ```
@@ -69,18 +61,32 @@ activity = { type: 'Create', object: note }
 trx = rum.build_trx data: activity, private_key: account.private_hex
 
 # push trx to chain
-rum.send_trx trx
+node.send_trx trx
 # output: { trx_id: '...' }
 
-# list Trx on chain
-rum.list_trx
+# list Trx in the group on chain
+node.list_trx
 # output: [{ trx_id: '...', Data: { type: 'Create', object: { type: 'Note', name: 'A title', content: 'Something awesome' }}}]
 
 ```
 
-### Proto
+## FullNode Usage
 
-Check all available proto types in [chain_pb.rb](./lib/proto/chain_pb.rb) and [activity_stream_pb.rb](./lib/proto/activity_stream_pb.rb).
+### Initilize
+
+```ruby
+chain = QuorumSdk::Chain.new chain_url: 'http://127.0.0.1:8002', jwt: ''
+
+# list joined groups
+chain.groups
+
+# network
+chain.network
+```
+
+## Proto
+
+Check all available proto types in [chain_pb.rb](./lib/proto/chain_pb.rb).
 
 ## Development
 

data/lib/proto/chain.proto

@@ -5,10 +5,9 @@ package quorum.pb;
 option go_package = "github.com/rumsystem/quorum/pkg/pb";
 
 enum PackageType {
-    TRX      = 0;
-    BLOCK    = 1;
-    SNAPSHOT = 2;
-    HBB      = 3;
+    TRX             = 0;
+    BLOCK           = 1;
+    HBB             = 2;
 }
 
 message Package {
@@ -16,27 +15,9 @@ message Package {
     bytes       Data = 2;
 }
 
-enum TrxType {
-  POST               = 0; // post to group
-  SCHEMA             = 2; // group schema
-  PRODUCER           = 3; // update group producer
-  ANNOUNCE           = 4; // self announce, producer or user)  
-  REQ_BLOCK_FORWARD  = 5; // request next block 
-  REQ_BLOCK_BACKWARD = 6; // request previous block
-  REQ_BLOCK_RESP     = 7; // response request next block
-  BLOCK_SYNCED       = 8; // block for producer to sync (old block)
-  BLOCK_PRODUCED     = 9; // block for producer to merge (newly produced block)
-  USER               = 10; // update group user
-  ASK_PEERID         = 11; // ask owner/producer peerid
-  ASK_PEERID_RESP    = 12; // response ask peerid
-  CHAIN_CONFIG       = 13; // predefined chain configuration
-  APP_CONFIG         = 14; // group app customized configuration
-}
-
 enum AnnounceType {
    AS_USER     = 0;
    AS_PRODUCER = 1;
-   AS_USER_ENCRYPT  = 2;
 }
 
 enum ApproveType {
@@ -55,129 +36,78 @@ enum TrxStroageType {
     CACHE = 1;
 }
 
-message Trx {
-    string  TrxId        = 1;
-    TrxType Type         = 2;    
-    string  GroupId      = 3;
-    bytes   Data         = 4; 
-    int64   TimeStamp    = 5;
-    string  Version      = 6;
-    int64   Expired      = 7;
-    int64   ResendCount  = 8;
-    int64   Nonce        = 9;
-    string  SenderPubkey = 10;  
-    bytes   SenderSign   = 11;
-    TrxStroageType StorageType = 12;
-}
-
-message Block {
-    string   BlockId        = 1;
-    string   GroupId        = 2;
-    string   PrevBlockId    = 3;       
-    bytes    PreviousHash   = 4;     
-    repeated Trx Trxs       = 5; 
-    string   ProducerPubKey = 6;   
-    bytes    Hash           = 7;      
-    bytes    Signature      = 8;
-    int64    TimeStamp      = 9; 
-}
-
-message Snapshot {
-    string   SnapshotId                 = 1;
-    string   SnapshotPackageId          = 2;
-    int64    TotalCount                 = 3;
-    string   GroupId                    = 4;    
-    int64    Nonce                      = 5;
-    repeated SnapshotItem SnapshotItems = 6;
-    string   SenderPubkey               = 7;
-    bytes    Singature                  = 8;
-    int64    TimeStamp                  = 9;
-    int64    HighestHeight              = 10;
-    string   HighestBlockId             = 11;
-    bytes    ItemsHash                  = 12;
-}
-
-message SnapshotItem {
-    string           SnapshotItemId = 1;
-    SnapShotItemType Type           = 2;
-    bytes            Data           = 3; 
-}
-
-enum SnapShotItemType {
-    SNAPSHOT_APP_CONFIG   = 0;    //app_config item
-    SNAPSHOT_CHAIN_CONFIG = 1;    //chain_config item
-    SNAPSHOT_PRODUCER     = 2;    //producer item
-    SNAPSHOT_USER         = 3;    //user item
-    SNAPSHOT_ANNOUNCE     = 4;    //announce item
-}
-
-message SnapShotTag {
-    int64  TimeStamp                  = 1;
-    int64  HighestHeight              = 2;
-    string HighestBlockId             = 3;
-    bytes  ItemsHash                  = 4;
-    int64  Nonce                      = 5;   
-    string SnapshotPackageId          = 6;
-    string SenderPubkey               = 7;
-}
-
-message BlockDbChunk {
-    string   BlockId           = 1;
-    Block    BlockItem         = 2;
-    string   ParentBlockId     = 3;
-    repeated string SubBlockId = 4;
-    int64    Height            = 6;
-}
-
-message ReqBlock {
-    string BlockId = 1; //block id
-    string GroupId = 2; //group id
-    string UserId  = 3; //requester
-}
-
-message BlockSynced {
-    Block BlockItem = 1;
+enum TrxType {
+    POST               = 0; // post to group
+    ANNOUNCE           = 1; // producer or user self announce
+    PRODUCER           = 2; // owner update group producer
+    USER               = 3; // owner update group user
+    REQ_BLOCK          = 4; // request block 
+    REQ_BLOCK_RESP     = 5; // response request block
+    CHAIN_CONFIG       = 6; // chain configuration
+    APP_CONFIG         = 7; // app configuration
 }
 
-message AskPeerId {
-    string GroupId     = 1;   
-    string UserPeerId  = 2;
-    string UserPubkey  = 3;
-    string UserSign    = 4;
-    string Memo        = 5;    
+message Trx {
+    string         TrxId        = 1;
+    TrxType        Type         = 2;    
+    string         GroupId      = 3;
+    bytes          Data         = 4; 
+    int64          TimeStamp    = 5;
+    string         Version      = 6;
+    int64          Expired      = 7;
+    int64          ResendCount  = 8;
+    string         SenderPubkey = 10;  
+    bytes          SenderSign   = 11;
+    TrxStroageType StorageType  = 12;
+    reserved 9; 
+}
+
+message Block {    
+    string      GroupId            = 1;     
+    uint64      BlockId            = 2;     
+    uint64      Epoch              = 3;  
+    bytes       PrevHash           = 4;  
+    string      ProducerPubkey     = 5;
+    repeated    Trx Trxs           = 6;    
+    bool        Sudo               = 7;    
+    int64       TimeStamp          = 8;       
+    bytes       BlockHash          = 9;
+    bytes       ProducerSign       = 10;        
 }
 
-message AskPeerIdResp {
-    string GroupId           = 1;   
-    string RespPeerId        = 2;
-    string RespPeerPubkey    = 3;
-    string RespSign          = 4;
-    bool   IsDirectConnected = 5;
+message ReqBlock {
+    string GroupId       = 1; //group id
+    uint64 FromBlock     = 2; //from which block
+    int32  BlksRequested = 3; //how many blocks requested, "-1" means many as possible
+    string ReqPubkey     = 4; //requester pubkey
 }
 
-message BlockProduced {
-    Block BlockItem = 1;
+message BlocksBundle {
+    repeated Block Blocks = 1;
 }
 
 enum ReqBlkResult {
-    BLOCK_IN_TRX = 0;    //block data in trx
-    BLOCK_NOT_FOUND = 1; //block not found
+    BLOCK_IN_RESP         = 0; //"block(s) in resp and I may have more"
+    BLOCK_IN_RESP_ON_TOP  = 1; //"block(s) in resp and I have no more block(when get req)" 
+    BLOCK_NOT_FOUND       = 2; //"no block in resp and I don't have the requested block"
 }
 
 message ReqBlockResp {
-    ReqBlkResult Result          = 1;
-    string       ProviderPubkey  = 2;
-    string       RequesterPubkey = 3;
-    string       GroupId         = 4;  
-    string       BlockId         = 5;    
-    bytes        Block           = 6;
+    string       GroupId         = 1;   
+    string       RequesterPubkey = 2;
+    string       ProviderPubkey  = 3;
+    ReqBlkResult Result          = 4;        
+    uint64       FromBlock       = 5;
+    int32        BlksRequested   = 6;     
+    int32        BlksProvided    = 7;
+    BlocksBundle Blocks          = 8;
 }
 
 message PostItem {
-    string TrxId           = 1;
-    string PublisherPubkey = 2;
-    bytes  Content         = 3;
-    int64  TimeStamp       = 4;
+    string TrxId        = 1;
+    string SenderPubkey = 2;
+    bytes  Content      = 3;
+    int64  TimeStamp    = 4;
 }
 
 message ProducerItem {
@@ -185,12 +115,16 @@ message ProducerItem {
    string     ProducerPubkey      = 2;
    string     GroupOwnerPubkey    = 3;   
    string     GroupOwnerSign      = 4;
-   int64      TimeStamp           = 5;    
-   ActionType Action              = 6;
-   int64      BlockProduced       = 7;
+   ActionType Action              = 5;
+   int64      WithnessBlocks      = 6;
+   int64      TimeStamp           = 7;       
    string     Memo                = 8;
 }
 
+message BFTProducerBundleItem {
+    repeated ProducerItem Producers = 1;
+}
+
 message UserItem {
    string     GroupId             = 1;
    string     UserPubkey          = 2;
@@ -216,40 +150,28 @@ message AnnounceItem {
     string       Memo               = 11;
 }
 
-message SchemaItem {
-    string       GroupId          = 1;    
-    string       GroupOwnerPubkey = 2;
-    string       GroupOwnerSign   = 3;    
-    string       Type             = 4;    
-    string       Rule             = 5;
-    int64        TimeStamp        = 6;    
-    ActionType   Action           = 7;
-}
-
 enum GroupEncryptType {
-    PUBLIC   = 0; //public group
-    PRIVATE  = 1; //private group
+    PUBLIC   = 0;
+    PRIVATE  = 1;
 }
 
 enum GroupConsenseType {
-    POA = 0;    //proof of authen
+    POA = 0;
     POS = 1;
 }
 
 message GroupItem {
-    string GroupId                 = 1;
-    string GroupName               = 2;
-    string OwnerPubKey             = 3;
-    string UserSignPubkey          = 4;
-    string UserEncryptPubkey       = 5;
-    int64  LastUpdate              = 6;
-    int64  HighestHeight           = 7;
-    string HighestBlockId          = 8;
-    Block  GenesisBlock            = 9;
-    GroupEncryptType EncryptType   = 10;
-    GroupConsenseType ConsenseType = 11;
-    string CipherKey               = 12;
-    string AppKey                  = 13;
+    string            GroupId                 = 1;
+    string            GroupName               = 2;
+    string            OwnerPubKey             = 3;
+    string            UserSignPubkey          = 4;
+    string            UserEncryptPubkey       = 5;
+    int64             LastUpdate              = 6;
+    Block             GenesisBlock            = 7;
+    GroupEncryptType  EncryptType   = 8;
+    GroupConsenseType ConsenseType = 9;
+    string            CipherKey               = 10;
+    string            AppKey                  = 11;
 }
 
 enum RoleV0 {
@@ -294,23 +216,6 @@ message SetTrxAuthModeItem {
     TrxAuthMode Mode = 2;
 }
 
-message GroupItemV0 {
-    string GroupId                 = 1;
-    string GroupName               = 2;
-    string OwnerPubKey             = 3;
-    string UserSignPubkey          = 4;
-    string UserEncryptPubkey       = 5;
-    RoleV0 UserRole                = 6;
-    int64  LastUpdate              = 7;
-    int64  HighestHeight           = 8;
-    string HighestBlockId          = 9;
-    Block  GenesisBlock            = 10;
-    GroupEncryptType EncryptType   = 11;
-    GroupConsenseType ConsenseType = 12;
-    string CipherKey               = 13;
-    string AppKey                  = 14;
-}
-
 enum AppConfigType {
     INT    = 0;
     BOOL   = 1;
@@ -329,93 +234,123 @@ message AppConfigItem{
     int64         TimeStamp   = 9;
 }
 
-message PSPing {
-    int32 Seqnum        = 1;
-    bool  IsResp        = 2;
-    int64 TimeStamp     = 3;
-    bytes Payload       = 4;
-}
-
 message GroupSeed {
-    Block  GenesisBlock = 1;
-    string GroupId  = 2;
-    string GroupName = 3;
-    string OwnerPubkey = 4;
+    Block  GenesisBlock   = 1;
+    string GroupId        = 2;
+    string GroupName      = 3;
+    string OwnerPubkey    = 4;
     string ConsensusType  = 5;
     string EncryptionType = 6;
-    string CipherKey = 7;
-    string AppKey = 8;
-    string Signature = 9;
+    string CipherKey      = 7;
+    string AppKey         = 8;
+    string Signature      = 9;
 }
 
 message NodeSDKGroupItem {
-    GroupItem Group         = 1;
-    string   EncryptAlias   = 2;
-    string   SignAlias      = 3;
-    repeated string ApiUrl  = 4;
-    string   GroupSeed      = 5;
+    GroupItem Group          = 1;
+    string    EncryptAlias   = 2;
+    string    SignAlias      = 3;
+    repeated  string ApiUrl  = 4;
+    string    GroupSeed      = 5;
 }
 
-enum HBBMsgType {
-    AGREEMENT = 0;
-    BROADCAST = 1;
+message HBTrxBundle {
+    repeated Trx Trxs = 1;
+}  
+
+message HBMsgv1 {
+    string           MsgId       = 1;   
+    uint64           Epoch       = 2;
+    HBMsgPayloadType PayloadType = 3;   // RBC or BBA
+    bytes            Payload     = 4; 
 }
 
-message HBMsg {
-    string      MsgId   = 1;
-    HBBMsgType  MsgType = 2;
-    bytes       Payload = 3;
+enum HBMsgPayloadType {
+    RBC = 0;    
+    BBA = 1;
 }
 
-enum BroadcastMsgType {
-    PROOF = 0;
-    READY = 1;
+// RBC
+message RBCMsg {
+    RBCMsgType Type    = 1;   //INIT_PROPOSE / PROOF / READY
+    bytes      Payload = 2;
 }
 
-message HBTrxBundle {
-    repeated Trx Trxs = 1;
+enum RBCMsgType {
+    INIT_PROPOSE = 0;
+    ECHO         = 1;
+    READY        = 2;
 }
 
-message BroadcastMsg {
-    string           SenderPubkey = 1;
-    BroadcastMsgType Type         = 2;
-    int64            Epoch        = 3;
-    bytes            Payload      = 4;
+message InitPropose {
+    bytes          RootHash         = 1;
+    repeated bytes Proof            = 2;
+    int64          Index            = 3;
+    int64          Leaves           = 4;
+    int64          OriginalDataSize = 5;    
+    string         RecvNodePubkey   = 6;    //producer which should handle this ecc data shard
+    string         ProposerPubkey   = 7;    //producer which make this propose (part of ecc shards)
+    bytes          ProposerSign     = 8;    //signature of producer made this propose
 }
 
-message Proof{
-    bytes          RootHash       = 1;
-    repeated bytes Proof          = 2;
-    int64          Index          = 3;
-    int64          Leaves         = 4;
-    bytes          ProposerPubkey = 5;
-    bytes          ProposerSign   = 6;
+message Echo { 
+    bytes          RootHash               = 1;
+    repeated bytes Proof                  = 2;
+    int64          Index                  = 3;
+    int64          Leaves                 = 4;
+    int64          OriginalDataSize       = 5;   
+    string         OriginalProposerPubkey = 6;  //producer make this original input
+    string         EchoProviderPubkey     = 7;  //producer which broadcast this Echo
+    bytes          EchoProviderSign       = 8;  //signature of producer broadcast this Echo
 }
 
 message Ready {
-    bytes RootHash       = 1;
-    bytes ProoferPubkey  = 2;
-    bytes ProposerPubkey = 3;
-    bytes ProposerSign   = 4;
+    bytes  RootHash               = 1;
+    string OriginalProposerPubkey = 2;
+    string ReadyProviderPubkey    = 3;
+    bytes  ReadyProviderSign      = 4;
 }
 
-enum AgreementMsgType {
-    BVAL  = 0;
-    AUX   = 1;
+// BBA
+message BBAMsg {
+    BBAMsgType Type       = 1; //BVAL or AUX
+    bytes      Payload    = 2;
 }
 
-message AgreementMsg {
-    AgreementMsgType  Type       = 1;
-    string            ProposerId = 2;
-    string            SenderId   = 3;
-    int64             Epoch      = 4;
-    bytes             Payload    = 5;
+enum BBAMsgType {
+    BVAL  = 0;
+    AUX   = 1;
 }
 
 message Bval {
-    bool Value = 1;
+    string     ProposerId   = 1;
+    string     SenderPubkey = 2;
+    int64      Epoch        = 3;
+    bool       Value        = 4;
 }
 
 message Aux {
-    bool Value = 1;
+    string     ProposerId   = 1;
+    string     SenderPubkey = 2;
+    uint64     Epoch        = 3;    
+    bool       Value        = 4;
 }
+
+//old proto msg
+message GroupItemV0 {
+    string GroupId                 = 1;
+    string GroupName               = 2;
+    string OwnerPubKey             = 3;
+    string UserSignPubkey          = 4;
+    string UserEncryptPubkey       = 5;
+    RoleV0 UserRole                = 6;
+    int64  LastUpdate              = 7;
+    int64  HighestHeight           = 8;
+    string HighestBlockId          = 9;
+    Block  GenesisBlock            = 10;
+    GroupEncryptType EncryptType   = 11;
+    GroupConsenseType ConsenseType = 12;
+    string CipherKey               = 13;
+    string AppKey                  = 14;
+}
+