Ricardian contracts script

scripts/ricardeos/README.md

@@ -0,0 +1,20 @@
+# Purpose
+The `ricardeos.py` imports or exports recardian contracts to and from a contracts abi
+
+## Import Example
+`$ python3 ricardeos.py import /path/to/sorce-contract.abi /path/to/new-smart-contract-abi.abi`
+
+Running this will scan the directory of the abi for all rc.md files and add them to their respective actions.  All files with a path format of *clause*-rc.md will be added to the ricardian_clauses section.  You can provide the same name for the source and new smart contract abi, the script will prompt you before overwriting.
+
+The script will also notify the user of any actions that the script cannot find rc.md files for.
+
+## Export Example
+`$ python3 ricardeos.py export /path/to/sorce-contract.abi`
+
+Running this will dump the contents of all ricardian contracts:
+
+Actions will be exported in the following format: `<contract-name>-<action-name>-rc.md`
+
+Clauses will be exported in the following format: `<contract-name>-clause-<clause-id>-rc.md`
+
+If a file already exists the user will be asked if they wish to overwrite the file

scripts/ricardeos/ricardeos.py

@@ -0,0 +1,164 @@
+#!/usr/bin/env python3
+
+import json
+import sys
+import os.path
+import fnmatch
+
+def add_ricardian_contracts_to_actions(source_abi_directory, contract_name, abi_actions):
+    abi_actions_with_ricardian_contracts = []
+
+    for abi_action in abi_actions:
+        action_name = abi_action["name"]
+        contract_action_filename = '{contract_name}-{action_name}-rc.md'.format(contract_name = contract_name, action_name = action_name)
+
+        # check for rc file
+        rc_contract_path = os.path.join(source_abi_directory, contract_action_filename)
+        if os.path.exists(rc_contract_path):
+            print('Importing Contract {contract_action_filename} for {contract_name}:{action_name}'.format(
+                contract_action_filename = contract_action_filename, 
+                contract_name = contract_name, 
+                action_name = action_name
+            ))
+
+            with open(rc_contract_path) as contract_file_handle:
+                contract_contents = contract_file_handle.read()
+
+            abi_action['ricardian_contract'] = contract_contents
+        else:
+            print('Did not find recardian contract file {contract_action_filename} for {contract_name}:{action_name}, skipping inclusion'.format(
+                contract_action_filename = contract_action_filename,
+                contract_name = contract_name,
+                action_name = action_name
+            ))
+
+        abi_actions_with_ricardian_contracts.append(abi_action)
+
+    return abi_actions_with_ricardian_contracts
+
+def create_ricardian_clauses_list(source_abi_directory, contract_name):
+    clause_file_pattern = '*-clause*-rc.md'
+    clause_files = fnmatch.filter(os.listdir(source_abi_directory), clause_file_pattern)
+
+    clause_prefix = 'clause-'
+    clause_postfix = '-rc.md'
+
+    abi_ricardian_clauses = []
+
+    for clause_file_name in clause_files:
+        rc_contract_path = os.path.join(source_abi_directory, clause_file_name)
+        with open(rc_contract_path) as contract_file_handle:
+            contract_contents = contract_file_handle.read()
+
+        start_of_clause_id = clause_file_name.index( clause_prefix ) + len( clause_prefix )
+        end_of_clause_id = clause_file_name.rindex(clause_postfix, start_of_clause_id)
+
+        clause_id = clause_file_name[start_of_clause_id:end_of_clause_id]
+
+        abi_ricardian_clauses.append({
+            'id': clause_id, 
+            'body': contract_contents
+        })
+
+    return abi_ricardian_clauses
+
+def add_ricardian_contracts_to_abi(source_abi, output_abi):
+    source_abi_directory = os.path.dirname(source_abi)
+    contract_name = os.path.split(source_abi)[1].rpartition(".")[0]
+
+    print('Creating {output_abi} with ricardian contracts included'.format(output_abi = output_abi))
+
+    with open(source_abi, 'r') as source_abi_file:
+        source_abi_json = json.load(source_abi_file)
+
+    source_abi_json['actions'] = add_ricardian_contracts_to_actions(source_abi_directory, contract_name, source_abi_json['actions'])
+    source_abi_json['ricardian_clauses'] = create_ricardian_clauses_list(source_abi_directory, contract_name)
+
+    with open(output_abi, 'w') as output_abi_file:
+        json.dump(source_abi_json, output_abi_file, indent=2)
+
+def import_ricardian_to_abi(source_abi, output_abi):
+    if not os.path.exists(source_abi):
+        print('Source ABI not found in {source_abi}'.format(source_abi = source_abi))
+        sys.exit(0)
+
+    if os.path.exists(output_abi):
+        overwrite_prompt_response = input('Output ABI {output_abi} already exists, do you want to proceed? (y|n): '.format(output_abi = output_abi))
+        if  overwrite_prompt_response == 'y':
+            print('Overwriting existing output abi')
+            add_ricardian_contracts_to_abi(source_abi, output_abi)
+            sys.exit(0)
+        else:
+            print('User aborted, not overwriting existing abi')
+            sys.exit(0)
+    else:
+        add_ricardian_contracts_to_abi(source_abi, output_abi)
+
+def write_rc_file(path, filename, content):
+    output_filename = os.path.join(path, filename)
+    write_file = True
+
+    if os.path.exists(output_filename):
+        overwrite_prompt_response = input('Output rc {output_filename} already exists, do you want to proceed? (y|n): '.format(output_filename = output_filename))
+        if  overwrite_prompt_response == 'y':
+            print('Overwriting existing output rc')
+        elif overwrite_prompt_response == 'n':
+            print('Skipping overwrite of {output_filename}'.format(output_filename = output_filename))
+            write_file = False
+
+    if write_file:
+        with open(output_filename, 'w') as text_file:
+            print(content, file=text_file)
+
+        print('Wrote {output_filename}'.format(output_filename = output_filename))
+
+def export_ricardian_from_abi(source_abi):
+    source_abi_directory = os.path.dirname(source_abi)
+    contract_name = os.path.split(source_abi)[1].rpartition(".")[0]
+
+    if not os.path.exists(source_abi):
+        print('Source ABI not found in {source_abi}'.format(source_abi = source_abi))
+        sys.exit(0)
+
+    with open(source_abi, 'r') as source_abi_file:
+        source_abi_json = json.load(source_abi_file)
+
+    for abi_action in source_abi_json['actions']:
+        output_action_rc_file_name = '{contract_name}-{action_name}-rc.md'.format(contract_name = contract_name, action_name = abi_action['name'])
+        write_rc_file(source_abi_directory, output_action_rc_file_name, abi_action['ricardian_contract'])
+
+    for abi_clause in source_abi_json['ricardian_clauses']:
+        output_clause_rc_file_name = '{contract_name}-clause-{clause_id}-rc.md'.format(contract_name = contract_name, clause_id = abi_clause['id'])
+        write_rc_file(source_abi_directory, output_clause_rc_file_name, abi_clause['body'])
+
+def main():
+    if len(sys.argv) == 1:
+        print('Please specify an operation of export or import: ./ricardeos.py <import|export>')
+        sys.exit(1)
+
+    if sys.argv[1] == 'import':
+        if len(sys.argv) != 4:
+            print('Please specify a source and destination abi:')
+            print('Usage: ./ricardeos.py import /eos/contracts/contract/mycontract.abi /eos/contracts/contract/withricardian-mycontract.abi')
+
+            sys.exit(0)
+        else:
+            import_ricardian_to_abi(sys.argv[2], sys.argv[3])
+
+            sys.exit(0)
+    elif sys.argv[1] == 'export':
+        if len(sys.argv) != 3:
+            print('Please specify a source abi:')
+            print('Usage: ./ricardeos.py export /eos/contracts/contract/mycontract.abi')
+
+            sys.exit(0)
+        else:
+            export_ricardian_from_abi(sys.argv[2])
+
+            sys.exit(0)
+
+    else:
+        print('Operation not recognized only import and export operations are supported')
+
+if __name__ == '__main__':
+        main()