Implementation of jurisdictional agility in BEOS blockchain

Preface: A while back I made an introductory post that described how jurisdictional agility (the ability for blockchain users to choose in which jurisdiction their transaction takes place within a geographically distributed network) functions on the BEOS blockchain. This is a follow-up post that describes how this functionality is implemented in BEOS and is primarily intended for a technical audience (blockchain architects and programmers).

<h1>Management of block producer jurisdictions in BEOS <p dir="auto">BEOS block producers can publish the regions (one or more jurisdictions) in which they are located, and users can specify one or more jurisdictional regions in which their transaction is to be processed. <p dir="auto">A BEOS jurisdiction is defined by a unique id code (uint16), a unique name (a lowercase string of less than 256 characters), and a description (a string of less than 256 characters). Jurisdictions are stored as blockchain state data in two C++ multi-indexes: jurisdiction_dictionary_object and jurisdiction_producer_object. <p dir="auto">BEOS has a default list of jurisdictions for countries based on <a href="https://www.iso.org/iso-3166-country-codes.html" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">ISO 3166 country codes plus the European Union (code 10000) and International Waters (code 10001). Additional jurisdictions can be created by “burning” 1000 BEOS (paid to eosio.null). <p dir="auto">The blockchain software for jurisdictional agility does not know anything about logical associations between jurisdictions. For example, the blockchain does not know that Warsaw is located in Poland. So a block producer (BP) must separately publish that it is in Warsaw, Poland, and the European Union in order to be able to process transactions destined for all three of these jurisdictions. <p dir="auto">A BP can change its jurisdictions in two ways: 1) directly calling the <strong>updateprod action on the eosio.system contract with its set of jurisdiction codes or 2) by calling the <strong>update_jurisdictions action defined in the optional gps plugin. This latter method allows a mobile BP (e.g. a block producer on a ship) to use a gps receiver to get its current coordinates then call update_jurisdictions to convert those geo coordinates into one or more jurisdictions which contain those coordinates. <p dir="auto">If a BP maintains BP nodes in multiple jurisdictions (e.g. a node in the US and a node in China), they should only publish the jurisdiction(s) of the node that will be producing their upcoming block. This adds predictability to users about what jurisdictions are available in the upcoming round of blocks and makes it possible to determine what jurisdiction was used to produce any block based solely on the jurisdiction history published by the block producers. <h1>eosio.system contract actions for managing jurisdictions <p dir="auto">The eosio.system actions below are called by block producers to add new jurisdictions and specify their jurisdictions. <pre><code>void addjurisdict( account_name ram_payer, code_jurisdiction new_code, std::string new_name, std::string new_description ) void updateprod( eosio::jurisdiction_producer data ) <ul> <li><code>addjurisdict - adds a jurisdiction to the jurisdictions dictionary <li><code>updateprod - update jurisdictions for given producer <pre><code>struct jurisdiction_producer { account_name producer; std::vector< code_jurisdiction > jurisdictions; }; <p dir="auto">The <code>eosio.system contract also has special actions that can only be performed by the contract owner. These actions are for blockchain configuration (for example, to configure the initially supported jurisdictions and set the fee for creating new jurisdictions). <pre><code>void addmultijurs(std::vector<new_jurisdic_info> new_jurisdicts) void updatejurfee(asset quantity) void updatejuracc(account_name target_account) <h1>Encoding a Jurisdiction requirement into a BEOS transaction <p dir="auto">The class <code>transaction has the data member <code>extensions_type transaction_extensions. <p dir="auto">where <strong>extensions_type: <code>std::vector<extension_storage> <p dir="auto">Description of <strong>extension_storage <ul> <li><strong>uint16_t - type of data: always <code>0 <li><strong>std::vector - codes of jurisdictions <pre><code>struct extension_storage { uint16_t type; std::vector<char> data; }; <p dir="auto">If <strong>extensions_type is empty, it indicates that the given transaction doesn’t have any required jurisdiction. This is the default behavior. <h1>Jurisdiction API plugin <p dir="auto">The new Jurisdiction API Plugin provides the API calls necessary to support jurisdictional agility. It implements the following API calls: <h2>get_active_jurisdictions <p dir="auto">This method list all jurisdiction currently available in active producer nodes. <p dir="auto">Parameters: <pre><code>{ "limit" : 1000 } <p dir="auto"><code>limit default value is 1000. <p dir="auto">Usage: <ul> <li>Get all active jurisdictions <pre><code>curl -H "CONTENT-TYPE:application/json" --url 127.0.0.1:8888/v1/jurisdiction/get_active_jurisdictions -X POST -d '{}' <ul> <li>Get first 100 active jurisdictions <pre><code>curl -H "CONTENT-TYPE:application/json" --url 127.0.0.1:8888/v1/jurisdiction/get_active_jurisdictions -X POST -d '{"limit" : 100}' <p dir="auto">Return: <pre><code>{ "jurisdictions":[0] } <h2>get_producer_jurisdiction <p dir="auto">This method lists all jurisdictions for a given producer. <p dir="auto">Usage: <p dir="auto"><code>curl -H "CONTENT-TYPE:application/json" --url 127.0.0.1:8888/v1/jurisdiction/get_producer_jurisdiction -X POST -d '{"producer_names":["eosio"]}' <p dir="auto">Return: <pre><code>{ "producer_jurisdictions":[ {"producer":"eosio","jurisdictions":[0]} ] } <h2>get_all_jurisdictions <p dir="auto">This method lists all jurisdiction defined in the system.<br /> Parameters: <pre><code>{ "limit" : 1000, "last_code" : 50 } <p dir="auto"><code>limit and <code>last_code are optional. <code>limit default value is 1000. <code>last_code is to support pagination schemes, you can define a code to start iteration. <h2>Example Usage of API calls: <ul> <li>List all jurisdictions up to query limit (1000). <pre><code>curl -H "CONTENT-TYPE:application/json" --url 127.0.0.1:8888/v1/jurisdiction/get_all_jurisdictions -X POST -d '{}' <ul> <li>List all jurisdictions with to query limit set to 100. <pre><code>curl -H "CONTENT-TYPE:application/json" --url 127.0.0.1:8888/v1/jurisdiction/get_all_jurisdictions -X POST -d '{"limit":100}' <ul> <li>List all jurisdictions with to query limit set to 100 starting from code 50. <pre><code>curl -H "CONTENT-TYPE:application/json" --url 127.0.0.1:8888/v1/jurisdiction/get_all_jurisdictions -X POST -d '{"limit":100, "last_code" : 50}' <p dir="auto">Return: <pre><code>{ "jurisdictions":[ {"code":50,"name":"poland","description":"EAST EUROPE"}, {"code":51,"name":"germany","description":"EAST EUROPE"} ] } <h1>New jurisdiction history API plugin <p dir="auto">This optional plugin was added to track jurisdiction changes by block producers. It is not required for a node that only acts as a block producer, but it should be enabled for an API node. <p dir="auto">To enable the jurisdiction history for block producers, you must add this line to your BEOS node's <code>config.ini: <p dir="auto"><code>enable-jurisdiction-history = true <p dir="auto">The jurisdiction history API supports the API calls described below: <h2>get_all_producer_jurisdiction_for_block <p dir="auto">Returns information about all jurisdictions for every producer for a given block. <p dir="auto">Arguments: <pre><code>{ "block_number" : 1000 } <p dir="auto">The argument <code>block_number is optional. By default, the current head block is used if no block number is specified. <p dir="auto">Returns: <pre><code>{ "producer_jurisdiction_for_block": [{ "producer_name": "beos.proda", "block_with_last_change": 143, "date_changed": "2019-06-17T13:30:55.500", "new_jurisdictions": [1, 2, 3] }, { "producer_name": "beos.prodb", "block_with_last_change": 149, "date_changed": "2019-06-17T13:30:58.500", "new_jurisdictions": [11, 12, 13] }] } <p dir="auto">Curl call example: <pre><code>curl -H "CONTENT-TYPE:application/json" --url 127.0.0.1:8888/v1/jurisdiction_history/get_all_producer_jurisdiction_for_block -X POST -d '{"block_number":2000}' <h2>get_producer_jurisdiction_for_block <p dir="auto">Returns information about the jurisdiction of a given producer for a given block. <p dir="auto">Arguments: <pre><code>{ "producer" : "eosio", "block_number" : 1000 } <p dir="auto">Returns: <pre><code>{ "producer_jurisdiction_for_block" : [ { "producer_name" : "eosio", "block_with_last_change" : 700, "date_changed" : "2019-06-07T09:00", "new_jurisdictions" : [1,2] } ] } <p dir="auto">Curl call example: <pre><code>curl -H "CONTENT-TYPE:application/json" --url 127.0.0.1:8888/v1/jurisdiction_history/get_producer_jurisdiction_for_block -X POST -d '{"producer":"eosio","block_number":1000}' <h2>get_producer_jurisdiction_history <p dir="auto">This method returns the jurisdiction changes for a given producer in a given period of time. <code>from_date and <code>to_date are optional. If <code>from_date is not defined, it is set to the beginning of the epoch. If <code>to_date is not defined, it is set to the current time. <p dir="auto">Arguments: <pre><code>{ "producer" : "eosio", "from_date" : "2019-06-07T09:00", "to_date" : "2019-06-07T10:00" "limit" : 1000 } <p dir="auto"><code>limit field is optional, set by default to 1000. <p dir="auto">Returns: <pre><code>{ "producer_jurisdiction_history" : [ { "producer_name" : "eosio", "block_number" : 700, "date_changed" : "2019-06-07T09:00", "new_jurisdictions" : [1,2] }, { "producer_name" : "eosio", "block_number" : 1200, "date_changed" : "2019-06-07T09:01", "new_jurisdictions" : [3] }, ] } <p dir="auto">Curl call example: <ul> <li>Get all changes in a given time period. <pre><code>curl -H "CONTENT-TYPE:application/json" --url 127.0.0.1:8888/v1/jurisdiction_history/get_producer_jurisdiction_history -X POST -d '{"producer":"eosio","from_date":"2019-06-07T09:00","to_date":"2019-06-07T10:00"}' <ul> <li>Get first 100 changes in a given time period. <pre><code>curl -H "CONTENT-TYPE:application/json" --url 127.0.0.1:8888/v1/jurisdiction_history/get_producer_jurisdiction_history -X POST -d '{"producer":"eosio","from_date":"2019-06-07T09:00","to_date":"2019-06-07T10:00", "limit":100}' <h1>CLEOS (command-line wallet) modifications to support jurisdictional agility <p dir="auto">A new switch has been added to the wallet command <code>cleos push action/transaction/transactions to define in which jurisdiction transaction(s) should be performed: <ul> <li><code>-u,--jurisdictions TEXT - set allowable jurisdiction codes for the transaction (a maximum of 255 allowable jurisdictions can be specified), default is any <h2>Examples using optional jurisdictions switch <p dir="auto">In order to specify in which jurisdiction a transaction should be executed, you need to add the `-u,--jurisdiction switch. Below are some example usages: <p dir="auto"><code>./cleos push action --jurisdictions '[0]' eosio.token transfer '[ "xxx", "yyy", "0.0001 BTS", "HI" ]' -p xxx <p dir="auto"><code>./cleos push action --u '[0]' eosio.token transfer '[ "xxx", "yyy", "0.0001 BTS", "HI" ]' -p xxx <p dir="auto"><code>./cleos push action --jurisdictions '[0,1,2,3,4]' eosio.token transfer '[ "xxx", "yyy", "0.0001 BTS", "HI" ]' -p xxx <p dir="auto"><code>./cleos push action --u '[0,1,2,3,4]' eosio.token transfer '[ "xxx", "yyy", "0.0001 BTS", "HI" ]' -p xxx <p dir="auto">In the examples above, several sets of allowable jurisdictions have been specified: <ul> <li><code>[0] - this transaction will be executed only in jurisdiction <code>0, <li><code>[0,1,2,3,4] - this transaction will be executed in one of the following jurisdictions0,1,2,3,4`. <h2>New <code>get sub-commands <p dir="auto">In order to get information about jurisdictions from <code>cleos, several new <code>get sub-commands have been added: <ul> <li><code>all_jurisdictions - Retrieve all jurisdictions from the blockchain, <li><code>active_jurisdictions - Retrieve active jurisdictions from the blockchain, <li><code>producer_jurisdiction - Retrieve jurisdictions for given producer from the blockchain, <li><code>all_producer_jurisdiction_for_block - Retrieve all jurisdictions for all producer in given block from the blockchain, <li><code>producer_jurisdiction_for_block - Retrieve jurisdictions for producer in given block from the blockchain, <li><code>producer_jurisdiction_history - Retrieve jurisdictions history for producer from the blockchain. <p dir="auto"><strong>Command <code>all_jurisdictions <p dir="auto">This command will retrieve all jurisdictions from the blockchain, for example: <p dir="auto"><code>./cleos get all_jurisdictions <p dir="auto">will return: <pre><code>{ "jurisdictions":[ {"code":0,"name":"poland","description":"EAST EUROPE"}, {"code":1,"name":"germany","description":"EAST EUROPE"} ] } <p dir="auto"><strong>Command <code>active_jurisdictions <p dir="auto">This command will retrieve active jurisdictions from the blockchain, for example: <p dir="auto"><code>./cleos get active_jurisdictions <p dir="auto">will return: <pre><code>{ "jurisdictions":[0] } <p dir="auto"><strong>Command <code>producer_jurisdiction <p dir="auto">This command will retrieve jurisdictions for given producer from the blockchain, for example: <p dir="auto"><code>./cleos get producer_jurisdiction '["eosio"]' <p dir="auto">will return: <pre><code>{ "producer_jurisdictions":[ {"producer":"eosio","jurisdictions":[0]} ] } <p dir="auto"><strong>Command <code>all_producer_jurisdiction_for_block <p dir="auto">This command will retrieve all jurisdictions for all producer in given block from the blockchain, for example: <p dir="auto"><code>./cleos get all_producer_jurisdiction_for_block "1000" <p dir="auto">will return: <pre><code>{ "producer_jurisdiction_for_block": [{ "producer_name": "beos.proda", "block_with_last_change": 143, "date_changed": "2019-06-17T13:30:55.500", "new_jurisdictions": [1, 2, 3] }, { "producer_name": "beos.prodb", "block_with_last_change": 149, "date_changed": "2019-06-17T13:30:58.500", "new_jurisdictions": [11, 12, 13] }] } <p dir="auto"><strong>Command <code>producer_jurisdiction_for_block <p dir="auto">This command will retrieve jurisdictions for producer in given block from the blockchain, for example: <p dir="auto"><code>./cleos get producer_jurisdiction_for_block "eosio" 1000 <p dir="auto">will return: <pre><code>{ "producer_jurisdiction_history" : [ { "producer_name" : "eosio", "block_number" : 700, "date_changed" : "2019-06-07T09:00", "new_jurisdictions" : [1,2] }, { "producer_name" : "eosio", "block_number" : 1200, "date_changed" : "2019-06-07T09:01", "new_jurisdictions" : [3] }, ] } <p dir="auto"><strong>Command <code>producer_jurisdiction_history <p dir="auto">This command will retrieve jurisdictions history for producer from the blockchain, for example: <p dir="auto"><code>./cleos get producer_jurisdiction_history "eosio" "2019-06-07T09:00" "2019-06-07T10:00" <p dir="auto">will return: <pre><code>{ "producer_jurisdiction_history" : [ { "producer_name" : "eosio", "block_number" : 700, "date_changed" : "2019-06-07T09:00", "new_jurisdictions" : [1,2] }, { "producer_name" : "eosio", "block_number" : 1200, "date_changed" : "2019-06-07T09:01", "new_jurisdictions" : [3] }, ] } <h1>Deployed now on BEOS blockchain <p dir="auto">All of the above functionalities are fully deployed on the latest version of the BEOS blockchain. Together, they enable both stationary and mobile block producers to publish the current jurisdictions in which they operate and for blockchain users to pick and choose among available jurisdictions to specify where they want their transactions to take place. <p dir="auto">The updated blockchain code is located at:<br /><span> <a href="https://github.com/terradacs/beos-core/tree/beos-jurisdiction-dev" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">https://github.com/terradacs/beos-core/tree/beos-jurisdiction-dev