Overview

This topic describes all the messages defined by the ADAPT messaging protocol. The prefix of each message name indicates the source and destination of the message:

b2w - ADAPT message broker to ADAPT wrapper
d2w - ADAPT backup data storage to ADAPT wrapper
w2b - ADAPT wrapper to ADAPT message broker
w2d - ADAPT wrapper to ADAPT backup data storage

b2w_exec_transaction

Description

When the broker receives the w2b_transaction message from the wrapper owning the source packet, it sends this message to the wrapper owning the target packet. This messages is a copy of the w2b_transaction message with an exception of the message name.

Direction

From: broker

To: wrapper

Instance

( "body_wrapper"->
  ( "body"->
    ( "envlp"->
      ( "body"->("name"->"::module_name::transaction_name","targ"->5,),
        "from"->"BCDBA48CAA24A5B35B8C6AD1C92FA9EB299837B68561C0E8E4BBBC89F9003A3B","ip_document"->"ip document",
        "to"->"BCDBA48CAA24A5B35B8C6AD1C92FA9EB299837B68561C0E8E4BBBC89F9003A3B",
      ),
    ),
    "from"->"BCDBA48CAA24A5B35B8C6AD1C92FA9EB299837B68561C0E8E4BBBC89F9003A3B","message_hash"->%%NIL,"nonce"->%%NIL,
    "to"->"BCDBA48CAA24A5B35B8C6AD1C92FA9EB299837B68561C0E8E4BBBC89F9003A3B",
  ),
  "msg_type_id"->"b2w_exec_transaction","protocol_version"->(0->0,1->1,),
)

b2w_init

Description

The broker sends this message to the wrapper as soon as the broker registers a new web socket connection.

Direction

From: broker

To: wrapper

Instance

( "body_wrapper"->("body"->%%NIL,"from"->%%NIL,"message_hash"->%%NIL,"nonce"->%%NIL,"to"->%%NIL,),"msg_type_id"->"b2w_init",
  "protocol_version"->(0->0,1->1,),
)

b2w_reg_ok

Description

This message is a registration confirmation from the broker to the wrapper.

Direction

From: broker

To: wrapper

Instance

( "body_wrapper"->
  ( "body"->%%NIL,"from"->%%NIL,"message_hash"->0x20F6C90D162716BE7176A326A6367CDF960184769A1C3832ACFF704B23EC76B0,
    "nonce"->%%NIL,"to"->"BCDBA48CAA24A5B35B8C6AD1C92FA9EB299837B68561C0E8E4BBBC89F9003A3B",
  ),
  "msg_type_id"->"b2w_reg_ok","protocol_version"->(0->0,1->1,),
)

d2w_backup_data

Description

The d2w_backup_data message is sent by the data storage in a response to the w2d_request_backup_data message. This message contains the backup data, which is the most recent (relative to the state the packet should be backed up to) snapshot state stored in the data storage and the transaction chain leading from the state of the snapshot to the final state.

Direction

From: data storage

To: wrapper

Instance

( "body_wrapper"->
  ( "body"->
    ( "packet_data"->0xABCD,
      "transaction_chain"->
      [ 
        ( "request_data_encrypted"->
          |SX1-ENCRYPTED_DATA|2B060100E0010000438D6762B2EDBD9209B657AF4D081DBA8165124268C46F68EAB3704CB550D4EB8B9C370FBA5868E2DB9CADED9F53C58FC055000D2D3B851AF5F5BF21AE8A792E142157DE551F79C353659F15804B0026E6BC0FBACA9A130742C65F2D748230E57E6D57CD83CA2EEE927283C84912FADB9DCE4ADE2FF8330CAB54B1242DA37D8DB0C2DE8F0635163628A923CE433D354A739F278D30B9A1E68EBC1B2F0DE2D1FAB351601507E62994B576F76F27600C9CF1A7EF9B134F0ED692B260FCC478D6363E2BCDCC30FD1E6E0A44090F0A6A90EA9DD71AC2873B38D7659A0CD6974F747A99B544966C21BA8B2F89C13B1177FBA5813B747BA1A000AF80AA10E2FBE5728E70D9B3FEE3D4FC9B2C2B7E7D5448BBE7C1E2D55FA9C6FE6436164B228224B49DD50D01AC31E8C85D198982BCC14D28D8A903BF2C86D9C1F4279DF6DF602246DB9AD78C14D9639483E6B5FCD0AFAEA6583B4C7D92287F980DA965736B1FC17981569D6801FFBA7109ADFE932C1E619775984DBC4597604A4AED4DE5C4907F7F1BBA343D15709BC8EEA70CE3A47C64B30AE51CB26B3CC19E48D6C558CB3160CEC49FD121E8B0D884B7A6AF316FAC7B9CF50FC5B3826A8BDB1195C0B3D136DD472E6A514B80AB95DC2473BDEAAD843E3BCD2CB4F11673BDEAAD843E3BCD2CB4F116,
          "transient_data_encrypted"->
          |SX1-ENCRYPTED_DATA|2B06010000020000C631E770F5B44FC271C1209C965C1FD25A03FBF0903BD43ECA891F6A82F06A60CC00B9CAE0E0F5BD8A010461BDD6FF44BD9D79D14D7391B9F2184E49CD7A53A3755826BC828B53EFEB261C8D69559096F308951472D782A2574500356868CD4DE625036F1271406C97A5C2263B3C14FD28505313B116D99D83DBCCE1BDD482E297E161D4D3CA8E74B967865D30CD04BA792586BA10004759EBD5C6E61B1009EAB498D0890B0159DB620240A0BF7DC0A85F6FFF1EC046B4F832067F0FC65DCA41BF65684F6386A21DBD64B25D3FF7C7CCBCC46C1DF258E98F046C10F4316ECF208E63254E52A20FF9061CE9D688D7F329054AB1C1896D7193765816C367EDE57C8D4BF113EEF2DC80195F256ECE0D554208B98AF4DAC23448B74F8B1572FF41FC6FA748AE81EFDC30566833AC8B46AB92A2810E0B383831AD94BBB845D811863E2C2804A66877503F4A57504465A054B8FAC975FB50B40EE12386871667A7B4D23CE48FCC9A4F8EEF7789ACF14083035E6EA2E04E053407611DDA5547D1A254AC7FECE58F1A7E69743286A0258941FA9E9722AD027D57F4E93990B6399C3F779B0B37C340EF41B1E11480878B9E38905BC6AF34DD306715CD2BC52E89FE84EDA0ED51793FD484CB38A5F92FC53F4CA9354112CD264888DE7AEAD83F6DEE36E02F58EDEA78CE56130173BDEAAD843E3BCD2CB4F11673BDEAAD843E3BCD2CB4F116,
        ),
        ( "request_data_encrypted"->
          |SX1-ENCRYPTED_DATA|2B060100E00100003FEEAECD3EB4B5E593CFB45D11A3C0739AB1BE93A518E06514EE97A3EB8AC0137BF0A494CF347BBD00D9280CF856CDE68D804E99B71B76283771A2C4097A05EE16BA97F94177052B10521CAD2D23A7B3F6E71213AF8ED9A7790AA8704E587E3159B1462C6FF650ED171F8770720E177AD90E435C9AC1ADEE0CED4A0A47EF9BACCABD85807094CF1ACB1BAACDE987648A190328BA0BAB05D36A9D07317F43527592DFFEF16A87A76461FACE66C2F8727851A3FC71A2BA5246F689CCE13FD10B91DA3A626C14DA7E86D04E158217C7530100B1D5AE41DFA3CA74671D890C3000F90D5BFFD94CF8B66028C6ADDC539AACA0B6DD4B15A84CE39CC5AE17D4D32DFB43CC122A76C52D459918EB7910BB5203222E1D26700915E7BDF0BA2CE50ADB8CD1064E05A67A688C29B3B6AAA4FA7DC7DFA769DD9138ED2E7729D6A76567582301156F8C171C11679BE5F2A83A63FBD8B69117701A2DA19935F0D282CDF52B54F662835C2AAF02E9EB337B93966733CA793DF9C2073C6ADC653324C54F6A22C04B1705E2EA5C2D1A4078A923C5D231E00658A140E51BDEB2E510F5B64A02BE613AE4B2023F00D683F50A60ACA53D76A4E3C9B7F5F308FAC470FEFFDAFAA94B1E9F7C3BFE8FEFCC918A73BDEAAD843E3BCD2CB4F11673BDEAAD843E3BCD2CB4F116,
          "transient_data_encrypted"->
          |SX1-ENCRYPTED_DATA|2B06010000020000D2FC5D2512E06F59FD8CB54184939088049CADF5176C878BA3CA6E9F29CCB89A214F0573C89F5FE43DCC4AB153FD0B017786D5495A89826D81D663633A1D7C583293BB028D1652F17F45B8D8A8C29768E95766552A157813170F1A55EC89D45136AFD1BA3FC1FA5786DB1C981C5F23CB6D001D556A10915C39BBBE53A13FBB96CE5AD3E012153BF414D428F7CD2B18D021D1C9E7EF362871746E52B21D44DCBE965F5A3DF8AF483C1D3D0825F14B9AC45FC45B543C6F80FC91097BA2BDA72BA0DB4157E1165463F352A68C436C67DF8F2330F88A2AD3331A68C364AA3B42350CEDCC1585874B948D7640DD7BCD4ED0A725CD9DD6B2E12071B8353CD0ECBF62F7DCE6BA67380B4640F55C0FB658DA0B7372464792596679C6ACB9E9228D2512EF6D3581F4696381F43608344DAE76BB62BF824C81C76A4067B0B0F5C6C29A4240F2271BEF312D0B0E3A83A71DF2624026C705BFC537BFDB2930C83AABBEA341625A3AF3BFB761CBA2604AFD43F77648C7B72804E81A75A2C1E91E5398DF46862DC0E0D2576EA4C2FEC92E13F75B7238CB868FD2C1CBC749C8C3C497D67D96AE23FE413FAE17D205EEBE4F282C11D9CF43BD6C9C7EC8B5768F36465007CB2B39B8AB565CFF941448DDFFA54C8970B112B70EF768BFD59C4D771D87D588270AFF9AD48064904213AF1D73BDEAAD843E3BCD2CB4F11673BDEAAD843E3BCD2CB4F116,
        )
      ],
    ),
    "from"->%%NIL,"message_hash"->0x20F6C90D162716BE7176A326A6367CDF960184769A1C3832ACFF704B23EC76B0,"nonce"->%%NIL,
    "to"->%%NIL,
  ),
  "msg_type_id"->"d2w_backup_data","protocol_version"->(0->0,1->1,),
)

d2w_code_object

Description

The d2w_code_object message is sent by the data storage in response to the w2d_get_code_object message. This message contains the code object data, which is the compiled MUFL code

Direction

From: data storage

To: wrapper

Instance

( "body_wrapper"->
  ( "body"->
    ( "code_object"->("code_object_data"->0xABCD,
        "code_object_hash"->0x20F6C90D162716BE7176A326A6367CDF960184769A1C3832ACFF704B23EC76B0,),
    ),
    "from"->%%NIL,"message_hash"->0x20F6C90D162716BE7176A326A6367CDF960184769A1C3832ACFF704B23EC76B0,"nonce"->%%NIL,
    "to"->%%NIL,
  ),
  "msg_type_id"->"d2w_code_object","protocol_version"->(0->0,1->1,),
)

d2w_create_packet_confirm

Description

A message from the data storage to the wrapper confirming that the packet has been created.

Direction

From: data storage

To: wrapper

Instance

( "body_wrapper"->
  ( "body"->%%NIL,"from"->%%NIL,"message_hash"->0x20F6C90D162716BE7176A326A6367CDF960184769A1C3832ACFF704B23EC76B0,
    "nonce"->%%NIL,"to"->"BCDBA48CAA24A5B35B8C6AD1C92FA9EB299837B68561C0E8E4BBBC89F9003A3B",
  ),
  "msg_type_id"->"d2w_create_packet_confirm","protocol_version"->(0->0,1->1,),
)

d2w_init

Description

The data storage sends this message to the wrapper as soon as the data storage registers a new web socket connection.

Direction

From: data storage

To: wrapper

Instance

( "body_wrapper"->("body"->%%NIL,"from"->%%NIL,"message_hash"->%%NIL,"nonce"->%%NIL,"to"->%%NIL,),"msg_type_id"->"d2w_init",
  "protocol_version"->(0->0,1->1,),
)

d2w_last_snapshot_state

Description

The d2w_last_snapshot_state message returns a hash of the state of the packet snapshot last known by the data storage.

Direction

From: data storage

To: wrapper

Instance

( "body_wrapper"->
  ( "body"->
    ( "packet_info"->
      ( "packet_id"->"BCDBA48CAA24A5B35B8C6AD1C92FA9EB299837B68561C0E8E4BBBC89F9003A3B",
        "state"->0x20F6C90D162716BE7176A326A6367CDF960184769A1C3832ACFF704B23EC76B0,
      ),
    ),
    "from"->%%NIL,"message_hash"->0x20F6C90D162716BE7176A326A6367CDF960184769A1C3832ACFF704B23EC76B0,"nonce"->%%NIL,
    "to"->"BCDBA48CAA24A5B35B8C6AD1C92FA9EB299837B68561C0E8E4BBBC89F9003A3B",
  ),
  "msg_type_id"->"d2w_last_snapshot_state","protocol_version"->(0->0,1->1,),
)

d2w_last_state

Description

The d2w_last_state message returns a hash of the state of the packet last known by the data storage.

Direction

From: data storage

To: wrapper

Instance

( "body_wrapper"->
  ( "body"->
    ( "packet_info"->
      ( "packet_id"->"BCDBA48CAA24A5B35B8C6AD1C92FA9EB299837B68561C0E8E4BBBC89F9003A3B",
        "state"->0x20F6C90D162716BE7176A326A6367CDF960184769A1C3832ACFF704B23EC76B0,
      ),
    ),
    "from"->%%NIL,"message_hash"->0x20F6C90D162716BE7176A326A6367CDF960184769A1C3832ACFF704B23EC76B0,"nonce"->%%NIL,
    "to"->"BCDBA48CAA24A5B35B8C6AD1C92FA9EB299837B68561C0E8E4BBBC89F9003A3B",
  ),
  "msg_type_id"->"d2w_last_state","protocol_version"->(0->0,1->1,),
)

d2w_snapshot

Description

A message sent from the data storage in a response to the w2d_read_snapshot message. This message contains packet snapshot data, which is encrypted packet data.

Direction

From: data storage

To: wrapper

Instance

( "body_wrapper"->
  ( "body"->("packet_data"->0xABCD,),"from"->%%NIL,
    "message_hash"->0x20F6C90D162716BE7176A326A6367CDF960184769A1C3832ACFF704B23EC76B0,"nonce"->%%NIL,
    "to"->"BCDBA48CAA24A5B35B8C6AD1C92FA9EB299837B68561C0E8E4BBBC89F9003A3B",
  ),
  "msg_type_id"->"d2w_snapshot","protocol_version"->(0->0,1->1,),
)

d2w_transaction_chain

Description

The d2w_transaction_chain message is sent by the data storage in a response to the w2d_get_transaction_chain message. This message contains the transaction chain (list of encrypted transactions) that leads from the initial state to the final state specified in the w2d_get_transaction_chain message.

Direction

From: data storage

To: wrapper

Instance

( "body_wrapper"->
  ( "body"->
    ( "transaction_chain"->
      [ 
        ( "request_data_encrypted"->
          |SX1-ENCRYPTED_DATA|2B060100E0010000438D6762B2EDBD9209B657AF4D081DBA8165124268C46F68EAB3704CB550D4EB8B9C370FBA5868E2DB9CADED9F53C58FC055000D2D3B851AF5F5BF21AE8A792E142157DE551F79C353659F15804B0026E6BC0FBACA9A130742C65F2D748230E57E6D57CD83CA2EEE927283C84912FADB9DCE4ADE2FF8330CAB54B1242DA37D8DB0C2DE8F0635163628A923CE433D354A739F278D30B9A1E68EBC1B2F0DE2D1FAB351601507E62994B576F76F27600C9CF1A7EF9B134F0ED692B260FCC478D6363E2BCDCC30FD1E6E0A44090F0A6A90EA9DD71AC2873B38D7659A0CD6974F747A99B544966C21BA8B2F89C13B1177FBA5813B747BA1A000AF80AA10E2FBE5728E70D9B3FEE3D4FC9B2C2B7E7D5448BBE7C1E2D55FA9C6FE6436164B228224B49DD50D01AC31E8C85D198982BCC14D28D8A903BF2C86D9C1F4279DF6DF602246DB9AD78C14D9639483E6B5FCD0AFAEA6583B4C7D92287F980DA965736B1FC17981569D6801FFBA7109ADFE932C1E619775984DBC4597604A4AED4DE5C4907F7F1BBA343D15709BC8EEA70CE3A47C64B30AE51CB26B3CC19E48D6C558CB3160CEC49FD121E8B0D884B7A6AF316FAC7B9CF50FC5B3826A8BDB1195C0B3D136DD472E6A514B80AB95DC2473BDEAAD843E3BCD2CB4F11673BDEAAD843E3BCD2CB4F116,
          "transient_data_encrypted"->
          |SX1-ENCRYPTED_DATA|2B06010000020000C631E770F5B44FC271C1209C965C1FD25A03FBF0903BD43ECA891F6A82F06A60CC00B9CAE0E0F5BD8A010461BDD6FF44BD9D79D14D7391B9F2184E49CD7A53A3755826BC828B53EFEB261C8D69559096F308951472D782A2574500356868CD4DE625036F1271406C97A5C2263B3C14FD28505313B116D99D83DBCCE1BDD482E297E161D4D3CA8E74B967865D30CD04BA792586BA10004759EBD5C6E61B1009EAB498D0890B0159DB620240A0BF7DC0A85F6FFF1EC046B4F832067F0FC65DCA41BF65684F6386A21DBD64B25D3FF7C7CCBCC46C1DF258E98F046C10F4316ECF208E63254E52A20FF9061CE9D688D7F329054AB1C1896D7193765816C367EDE57C8D4BF113EEF2DC80195F256ECE0D554208B98AF4DAC23448B74F8B1572FF41FC6FA748AE81EFDC30566833AC8B46AB92A2810E0B383831AD94BBB845D811863E2C2804A66877503F4A57504465A054B8FAC975FB50B40EE12386871667A7B4D23CE48FCC9A4F8EEF7789ACF14083035E6EA2E04E053407611DDA5547D1A254AC7FECE58F1A7E69743286A0258941FA9E9722AD027D57F4E93990B6399C3F779B0B37C340EF41B1E11480878B9E38905BC6AF34DD306715CD2BC52E89FE84EDA0ED51793FD484CB38A5F92FC53F4CA9354112CD264888DE7AEAD83F6DEE36E02F58EDEA78CE56130173BDEAAD843E3BCD2CB4F11673BDEAAD843E3BCD2CB4F116,
        ),
        ( "request_data_encrypted"->
          |SX1-ENCRYPTED_DATA|2B060100E00100003FEEAECD3EB4B5E593CFB45D11A3C0739AB1BE93A518E06514EE97A3EB8AC0137BF0A494CF347BBD00D9280CF856CDE68D804E99B71B76283771A2C4097A05EE16BA97F94177052B10521CAD2D23A7B3F6E71213AF8ED9A7790AA8704E587E3159B1462C6FF650ED171F8770720E177AD90E435C9AC1ADEE0CED4A0A47EF9BACCABD85807094CF1ACB1BAACDE987648A190328BA0BAB05D36A9D07317F43527592DFFEF16A87A76461FACE66C2F8727851A3FC71A2BA5246F689CCE13FD10B91DA3A626C14DA7E86D04E158217C7530100B1D5AE41DFA3CA74671D890C3000F90D5BFFD94CF8B66028C6ADDC539AACA0B6DD4B15A84CE39CC5AE17D4D32DFB43CC122A76C52D459918EB7910BB5203222E1D26700915E7BDF0BA2CE50ADB8CD1064E05A67A688C29B3B6AAA4FA7DC7DFA769DD9138ED2E7729D6A76567582301156F8C171C11679BE5F2A83A63FBD8B69117701A2DA19935F0D282CDF52B54F662835C2AAF02E9EB337B93966733CA793DF9C2073C6ADC653324C54F6A22C04B1705E2EA5C2D1A4078A923C5D231E00658A140E51BDEB2E510F5B64A02BE613AE4B2023F00D683F50A60ACA53D76A4E3C9B7F5F308FAC470FEFFDAFAA94B1E9F7C3BFE8FEFCC918A73BDEAAD843E3BCD2CB4F11673BDEAAD843E3BCD2CB4F116,
          "transient_data_encrypted"->
          |SX1-ENCRYPTED_DATA|2B06010000020000D2FC5D2512E06F59FD8CB54184939088049CADF5176C878BA3CA6E9F29CCB89A214F0573C89F5FE43DCC4AB153FD0B017786D5495A89826D81D663633A1D7C583293BB028D1652F17F45B8D8A8C29768E95766552A157813170F1A55EC89D45136AFD1BA3FC1FA5786DB1C981C5F23CB6D001D556A10915C39BBBE53A13FBB96CE5AD3E012153BF414D428F7CD2B18D021D1C9E7EF362871746E52B21D44DCBE965F5A3DF8AF483C1D3D0825F14B9AC45FC45B543C6F80FC91097BA2BDA72BA0DB4157E1165463F352A68C436C67DF8F2330F88A2AD3331A68C364AA3B42350CEDCC1585874B948D7640DD7BCD4ED0A725CD9DD6B2E12071B8353CD0ECBF62F7DCE6BA67380B4640F55C0FB658DA0B7372464792596679C6ACB9E9228D2512EF6D3581F4696381F43608344DAE76BB62BF824C81C76A4067B0B0F5C6C29A4240F2271BEF312D0B0E3A83A71DF2624026C705BFC537BFDB2930C83AABBEA341625A3AF3BFB761CBA2604AFD43F77648C7B72804E81A75A2C1E91E5398DF46862DC0E0D2576EA4C2FEC92E13F75B7238CB868FD2C1CBC749C8C3C497D67D96AE23FE413FAE17D205EEBE4F282C11D9CF43BD6C9C7EC8B5768F36465007CB2B39B8AB565CFF941448DDFFA54C8970B112B70EF768BFD59C4D771D87D588270AFF9AD48064904213AF1D73BDEAAD843E3BCD2CB4F11673BDEAAD843E3BCD2CB4F116,
        )
      ],
    ),
    "from"->%%NIL,"message_hash"->0x20F6C90D162716BE7176A326A6367CDF960184769A1C3832ACFF704B23EC76B0,"nonce"->%%NIL,
    "to"->"BCDBA48CAA24A5B35B8C6AD1C92FA9EB299837B68561C0E8E4BBBC89F9003A3B",
  ),
  "msg_type_id"->"d2w_transaction_chain","protocol_version"->(0->0,1->1,),
)

d2w_write_snapshot_confirm

Description

A message from the data storage to the wrapper confirming that the snapshot has been written.

Direction

From: data storage

To: wrapper

Instance

( "body_wrapper"->
  ( "body"->%%NIL,"from"->%%NIL,"message_hash"->0x20F6C90D162716BE7176A326A6367CDF960184769A1C3832ACFF704B23EC76B0,
    "nonce"->%%NIL,"to"->"BCDBA48CAA24A5B35B8C6AD1C92FA9EB299837B68561C0E8E4BBBC89F9003A3B",
  ),
  "msg_type_id"->"d2w_write_snapshot_confirm","protocol_version"->(0->0,1->1,),
)

d2w_write_transaction_confirm

Description

A message from the data storage to the wrapper confirming that the transaction data has been saved.

Direction

From: data storage

To: wrapper

Instance

( "body_wrapper"->
  ( "body"->%%NIL,"from"->%%NIL,"message_hash"->0x20F6C90D162716BE7176A326A6367CDF960184769A1C3832ACFF704B23EC76B0,
    "nonce"->%%NIL,"to"->"BCDBA48CAA24A5B35B8C6AD1C92FA9EB299837B68561C0E8E4BBBC89F9003A3B",
  ),
  "msg_type_id"->"d2w_write_transaction_confirm","protocol_version"->(0->0,1->1,),
)

w2b_reg

Description

After the wrapper has received the b2w_init message from the broker, it sends the w2b_reg packet registration request to the broker containing packet related information.

Direction

From: wrapper

To: broker

Instance

( "body_wrapper"->
  ( "body"->("ip_document"->"ip document",),"from"->"BCDBA48CAA24A5B35B8C6AD1C92FA9EB299837B68561C0E8E4BBBC89F9003A3B",
    "message_hash"->%%NIL,"nonce"->%%NIL,"to"->%%NIL,
  ),
  "msg_type_id"->"w2b_reg","protocol_version"->(0->0,1->1,),
)

w2b_transaction

Description

This message is sent when a packet needs to send a transaction request to another packet. This message contains the information about both source and target packets and the transaction itself.

Direction

From: wrapper

To: broker

Instance

( "body_wrapper"->
  ( "body"->
    ( "envlp"->
      ( "body"->("name"->"::module_name::transaction_name","targ"->5,),
        "from"->"BCDBA48CAA24A5B35B8C6AD1C92FA9EB299837B68561C0E8E4BBBC89F9003A3B","ip_document"->"ip document",
        "to"->"BCDBA48CAA24A5B35B8C6AD1C92FA9EB299837B68561C0E8E4BBBC89F9003A3B",
      ),
    ),
    "from"->"BCDBA48CAA24A5B35B8C6AD1C92FA9EB299837B68561C0E8E4BBBC89F9003A3B","message_hash"->%%NIL,"nonce"->%%NIL,
    "to"->"BCDBA48CAA24A5B35B8C6AD1C92FA9EB299837B68561C0E8E4BBBC89F9003A3B",
  ),
  "msg_type_id"->"w2b_transaction","protocol_version"->(0->0,1->1,),
)

w2d_create_packet

Description

This message is sent by the wrapper when a new packet is created. The data storage is expected to create a new record for the packet.

Direction

From: wrapper

To: data storage

Instance

( "body_wrapper"->
  ( "body"->
    ( "packet_info"->
      ( "packet_id"->"BCDBA48CAA24A5B35B8C6AD1C92FA9EB299837B68561C0E8E4BBBC89F9003A3B",
        "state"->0x20F6C90D162716BE7176A326A6367CDF960184769A1C3832ACFF704B23EC76B0,
      ),
    ),
    "from"->"BCDBA48CAA24A5B35B8C6AD1C92FA9EB299837B68561C0E8E4BBBC89F9003A3B","message_hash"->%%NIL,"nonce"->%%NIL,
    "to"->%%NIL,
  ),
  "msg_type_id"->"w2d_create_packet","protocol_version"->(0->0,1->1,),
)

w2d_get_code_object

Description

The w2d_get_code_object message is sent by the wrapper when it requires a code object that is not available locally and, thus, must be downloaded from the data storage.

Direction

From: wrapper

To: data storage

Instance

( "body_wrapper"->
  ( "body"->("code_object_hash"->0x20F6C90D162716BE7176A326A6367CDF960184769A1C3832ACFF704B23EC76B0,),"from"->%%NIL,
    "message_hash"->%%NIL,"nonce"->%%NIL,"to"->%%NIL,
  ),
  "msg_type_id"->"w2d_get_code_object","protocol_version"->(0->0,1->1,),
)

w2d_get_last_snapshot_state

Description

The w2d_get_last_snapshot_state message is sent by the wrapper when it needs to get the last state of the packet snapshot saved to the data storage. This message allows the wrapper to find the most recent snapshot, which can be then used for packet backup.

Direction

From: wrapper

To: data storage

Instance

( "body_wrapper"->
  ( "body"->("packet_id"->"BCDBA48CAA24A5B35B8C6AD1C92FA9EB299837B68561C0E8E4BBBC89F9003A3B",),
    "from"->"BCDBA48CAA24A5B35B8C6AD1C92FA9EB299837B68561C0E8E4BBBC89F9003A3B","message_hash"->%%NIL,"nonce"->%%NIL,
    "to"->%%NIL,
  ),
  "msg_type_id"->"w2d_get_last_snapshot_state","protocol_version"->(0->0,1->1,),
)

w2d_get_last_state

Description

This message is sent by the wrapper when it needs to get the last state of the packet saved to the data storage.

Direction

From: wrapper

To: data storage

Instance

( "body_wrapper"->
  ( "body"->("packet_id"->"BCDBA48CAA24A5B35B8C6AD1C92FA9EB299837B68561C0E8E4BBBC89F9003A3B",),
    "from"->"BCDBA48CAA24A5B35B8C6AD1C92FA9EB299837B68561C0E8E4BBBC89F9003A3B","message_hash"->%%NIL,"nonce"->%%NIL,
    "to"->%%NIL,
  ),
  "msg_type_id"->"w2d_get_last_state","protocol_version"->(0->0,1->1,),
)

w2d_get_transaction_chain

Description

The w2d_get_transaction_chain message is sent by the wrapper when it collects the backup data. The wrapper needs to obtain the transaction chain (list of encrypted transactions) that leads from the latest known snapshot state to the state the packet should be backed up to. The message contains the initial state (snapshot state) and the final state (state to back up to).

Direction

From: wrapper

To: data storage

Instance

( "body_wrapper"->
  ( "body"->
    ( "final_state"->0x20F6C90D162716BE7176A326A6367CDF960184769A1C3832ACFF704B23EC76B0,
      "init_state"->0x20F6C90D162716BE7176A326A6367CDF960184769A1C3832ACFF704B23EC76B0,
    ),
    "from"->"BCDBA48CAA24A5B35B8C6AD1C92FA9EB299837B68561C0E8E4BBBC89F9003A3B","message_hash"->%%NIL,"nonce"->%%NIL,
    "to"->%%NIL,
  ),
  "msg_type_id"->"w2d_get_transaction_chain","protocol_version"->(0->0,1->1,),
)

w2d_read_snapshot

Description

This message is a request to read the encrypted packet data (snapshot) from the data storage. This message is very useful in the packet backup process. You can find more information in the ADAPT documentation.

Direction

From: wrapper

To: data storage

Instance

( "body_wrapper"->
  ( "body"->("state"->0x20F6C90D162716BE7176A326A6367CDF960184769A1C3832ACFF704B23EC76B0,),
    "from"->"BCDBA48CAA24A5B35B8C6AD1C92FA9EB299837B68561C0E8E4BBBC89F9003A3B","message_hash"->%%NIL,"nonce"->%%NIL,
    "to"->%%NIL,
  ),
  "msg_type_id"->"w2d_read_snapshot","protocol_version"->(0->0,1->1,),
)

w2d_request_backup_data

Description

The w2d_request_backup_data message is sent by the wrapper when it needs to obtain the backup data. The message contains a packet ID and a state hash the packet should be backed up to.

Direction

From: wrapper

To: data storage

Instance

( "body_wrapper"->
  ( "body"->
    ( "packet_id"->"BCDBA48CAA24A5B35B8C6AD1C92FA9EB299837B68561C0E8E4BBBC89F9003A3B",
      "state"->0x20F6C90D162716BE7176A326A6367CDF960184769A1C3832ACFF704B23EC76B0,
    ),
    "from"->%%NIL,"message_hash"->%%NIL,"nonce"->%%NIL,"to"->%%NIL,
  ),
  "msg_type_id"->"w2d_request_backup_data","protocol_version"->(0->0,1->1,),
)

w2d_write_snapshot

Description

This message is a request to write the encrypted packet data (called snapshot) to the data storage. This message is very useful in the packet backup process. You can find more information in the ADAPT documentation.

Direction

From: wrapper

To: data storage

Instance

( "body_wrapper"->
  ( "body"->
    ( "packet"->
      ( "packet_data"->0xABCD,
        "packet_info"->
        ( "packet_id"->"BCDBA48CAA24A5B35B8C6AD1C92FA9EB299837B68561C0E8E4BBBC89F9003A3B",
          "state"->0x20F6C90D162716BE7176A326A6367CDF960184769A1C3832ACFF704B23EC76B0,
        ),
      ),
    ),
    "from"->"BCDBA48CAA24A5B35B8C6AD1C92FA9EB299837B68561C0E8E4BBBC89F9003A3B","message_hash"->%%NIL,"nonce"->%%NIL,
    "to"->%%NIL,
  ),
  "msg_type_id"->"w2d_write_snapshot","protocol_version"->(0->0,1->1,),
)

w2d_write_transaction

Description

This is a request to the data storage to save the transaction related data in encrypted form, which is transaction name, arguments, entropy and timestamp.

Direction

From: wrapper

To: data storage

Instance

( "body_wrapper"->
  ( "body"->
    ( "packet_info"->
      ( "packet_id"->"BCDBA48CAA24A5B35B8C6AD1C92FA9EB299837B68561C0E8E4BBBC89F9003A3B",
        "state"->0x20F6C90D162716BE7176A326A6367CDF960184769A1C3832ACFF704B23EC76B0,
      ),
      "state_change"->
      ( "final_state_id"->0x20F6C90D162716BE7176A326A6367CDF960184769A1C3832ACFF704B23EC76B0,
        "transaction"->
        ( "request_data_encrypted"->
          |SX1-ENCRYPTED_DATA|2B060100E0010000F131B0ADCF9111BB37DBE45E11331D7FCFB5EB00759E75B82D1F4BF80E3EFB2A3557EB257030F21C63BA3F853BF59E1A1A887B6C57FBFD52F4A9424C4EDF087A42A4BD93F97478991F4A1680B194F1B0C5140CDCF2FC054FE8D5BC64670EEA95ED39958351DE3DD5DC3B921682B42C75BFFBDA8344A886C807A5B71F545A50629FD19932C0613FA1B227C7100C253F1E1F0259553F6E04BB9834E6316D71671AA001F4373AA17F2D135FAC98302920B7CA1AAF9B472CB91705437C01C61A0A7FD9FC9579C976C073FFC63382A7237826983B0A36EA4A0AB9476F013CD261EA0D2C4097ABEBF45F8F277F60E609F015F60C0175852A58660C321DCA7BB45FCDF7A2DB997D4FD1D34F417FFEF7A27CC1BED02DB6B0C4E83AFF9D0B57ED2D69497A6E4EA2ABB64327ECE0A0175BB03BAEABCA94B564AACA4DBBF104F632494E1963C73D9B726DE0471FADC2EA00014DD3A127F4656579EF3132A6429F6AC8F96D19DD97A19974475AE77A74BB54BA4E7A586C7B4AD5BF40D9B6AE718795083C44D3AC6F6E420E84114A08D7B3AF76417D5134172718D68EF7882F264B00EDC98B186C14346EBCA7CC309D58401E283B730A0D50425236F7EA9F7CC83E70A8EB0B28FB9FCE8F8CA271F873BDEAAD843E3BCD2CB4F11673BDEAAD843E3BCD2CB4F116,
          "transient_data_encrypted"->
          |SX1-ENCRYPTED_DATA|2B060100000200007BD08E5070F09B40873D63A27EC306E115A514B1BD2B8979123F593713E4BD703C62384A4DCFC8A3321EE2620E211C67CD22E7EF47B40546CA155DB336DE031FF4A3E08AEFCF499273CFCF0161846E08D25F1621E5BFD50B6E6652D591E6F7E33DED3008BD154A48A144C16D27CEB9B373B6866D7BD40587D71854D41C0758B34B1B9E368AC8D79070B62041DF13C84C032B69B035199ECC6CD1E77956FA33BBD8860C6674CE01C6794BC776E2DAF259A988F54ED7935B6088FD21CAEAF6A78FBEC40CB802BF4ED3C844C4E456824D687B39C2442A0E29204028B58102FB2365E5EFD3091947E0C349850993ED4224414074F41A783D019C925B1DA3FB1E879BDC414545DDD16B176958D625129AE64CC741FC06BEC6CC6621E88B4349A308741D4E461BD4F59F4C37D933F52192E46CAC33B40A55E5B09F1AE43AB0633E5D87B90A8F75FCE52770B7B96A4CFAEDC86496B7F86D1A0F19FFDBD988A2C83737D2547008D32A036CE7E8B4D9342276075ECAA4D5D71C3D0BDDAB3078002D03640023B6AFD72159CBFD8EF19F6E02169B7AA977D3D58DD1B8F57FC134A0C221CC6380E9A27F782EA601A0CFDA0C7909917F7F304E47228BF959DDB588DF51E065BC8866CB59B78CAB3557BAD518730AA1EFD367FBA31354EEC8306A11CF5C0B5ED65E598A0F94B9BF9973BDEAAD843E3BCD2CB4F11673BDEAAD843E3BCD2CB4F116,
        ),
      ),
    ),
    "from"->"BCDBA48CAA24A5B35B8C6AD1C92FA9EB299837B68561C0E8E4BBBC89F9003A3B","message_hash"->%%NIL,"nonce"->%%NIL,
    "to"->%%NIL,
  ),
  "msg_type_id"->"w2d_write_transaction","protocol_version"->(0->0,1->1,),
)