Add boolean parameter to enable multisig output (#16)

* Add boolean parameter to enable multisig output

* Output instruction bytes rather than transaction

* Add proper payload output

* Dump all instructions as list of json objects

* Explicitly write to sys.stdout

Co-authored-by: Michael Anzuoni <[email protected]>

Author: xraymemory

program_admin/__init__.py

@@ -1,4 +1,7 @@
+import json
 import os
+import sys
+from dataclasses import asdict
 from pathlib import Path
 from typing import Dict, List, Literal, Tuple
 
@@ -151,6 +154,7 @@ async def send_transaction(
         self,
         instructions: List[TransactionInstruction],
         signers: List[Keypair],
+        dump_instructions: bool = False,
     ):
         if not instructions:
             return
@@ -166,6 +170,25 @@ async def send_transaction(
 
             ix_index = 1
 
+            if dump_instructions:
+                dump_output = []
+                for instruction in instructions:
+                    instruction_output = {
+                        "program_id": instruction.program_id,
+                        "data": instruction.data.decode(),
+                    }
+                    accounts = []
+                    for account in instruction.keys:
+                        account_data = {
+                            "pubkey": str(account.pubkey),
+                            "is_signer": account.is_signer,
+                            "is_writable": account.is_writable,
+                        }
+                        accounts.append(account_data)
+                    instruction_output["accounts"] = accounts
+                    dump_output.append(instruction_output)
+                sys.stdout.write(json.dumps(dump_output))
+
             # FIXME: Ideally, we would compute the exact additional size of each
             # instruction, add it to the current transaction size and compare
             # that with PACKET_DATA_SIZE. But there is currently no method that
@@ -187,21 +210,25 @@ async def send_transaction(
                 transaction.sign(*signers)
                 ix_index += 1
 
-            response = await client.send_raw_transaction(
-                transaction.serialize(),
-                opts=TxOpts(
-                    skip_confirmation=False, preflight_commitment=self.commitment
-                ),
-            )
+            if not dump_instructions:
+                response = await client.send_raw_transaction(
+                    transaction.serialize(),
+                    opts=TxOpts(
+                        skip_confirmation=False, preflight_commitment=self.commitment
+                    ),
+                )
+                logger.debug(f"Transaction: {response['result']}")
 
             logger.debug(f"Sent {ix_index} instructions")
-            logger.debug(f"Transaction: {response['result']}")
 
             remaining_instructions = instructions[ix_index:]
 
             if remaining_instructions:
                 logger.debug("Sending remaining instructions in separate transaction")
                 await self.send_transaction(remaining_instructions, signers)
+            else:
+                if dump_instructions:
+                    return dump_output
 
     async def sync(
         self,

program_admin/cli.py

@@ -35,7 +35,15 @@ def cli():
 )
 @click.option("--product", help="Public key of the product account")
 @click.option("--price", help="Public key of the price account")
-def delete_price(network, rpc_endpoint, program_key, keys, commitment, product, price):
+@click.option(
+    "--dump",
+    help="Output instructions rather than transact",
+    envvar="DUMP",
+    default=False,
+)
+def delete_price(
+    network, rpc_endpoint, program_key, keys, commitment, product, price, dump
+):
     program_admin = ProgramAdmin(
         network=network,
         rpc_endpoint=rpc_endpoint,
@@ -57,6 +65,7 @@ def delete_price(network, rpc_endpoint, program_key, keys, commitment, product,
         program_admin.send_transaction(
             [instruction],
             [funding_keypair, product_keypair, price_keypair],
+            dump_instructions=dump,
         )
     )
 
@@ -74,8 +83,14 @@ def delete_price(network, rpc_endpoint, program_key, keys, commitment, product,
 )
 @click.option("--price", help="Public key of the price account")
 @click.option("--min-pub", help="Minimum publishers value to set for this price")
+@click.option(
+    "--dump",
+    help="Output instructions rather than transact",
+    envvar="DUMP",
+    default=False,
+)
 def set_minimum_publishers_for_price(
-    network, rpc_endpoint, program_key, keys, commitment, price, min_pub
+    network, rpc_endpoint, program_key, keys, commitment, price, min_pub, dump
 ):
     program_admin = ProgramAdmin(
         network=network,
@@ -92,8 +107,7 @@ def set_minimum_publishers_for_price(
 
     asyncio.run(
         program_admin.send_transaction(
-            [instruction],
-            [funding_keypair, price_keypair],
+            [instruction], [funding_keypair, price_keypair], dump_instructions=dump
         )
     )
 
@@ -111,8 +125,14 @@ def set_minimum_publishers_for_price(
 )
 @click.option("--mapping", help="Public key of the mapping account")
 @click.option("--product", help="Public key of the product account")
+@click.option(
+    "--dump",
+    help="Output instructions rather than transact",
+    envvar="DUMP",
+    default=False,
+)
 def delete_product(
-    network, rpc_endpoint, program_key, keys, commitment, mapping, product
+    network, rpc_endpoint, program_key, keys, commitment, mapping, product, dump
 ):
     program_admin = ProgramAdmin(
         network=network,
@@ -135,6 +155,7 @@ def delete_product(
         program_admin.send_transaction(
             [instruction],
             [funding_keypair, mapping_keypair, product_keypair],
+            dump_instructions=dump,
         )
     )
 
@@ -338,6 +359,7 @@ def sync(
 cli.add_command(list_accounts)
 cli.add_command(restore_links)
 cli.add_command(sync)
+cli.add_command(set_minimum_publishers_for_price)
 
 
 logger.remove()

tests/test_sync.py

@@ -381,6 +381,13 @@ async def test_sync(
     min_pub_instruction = instructions.set_minimum_publishers(
         pyth_program, funding_key.public_key, price_keypair.public_key, 10
     )
+
+    # Test instruction print output
+    instruction_output = await program_admin.send_transaction(
+        [min_pub_instruction], [funding_key, price_keypair], dump_instructions=True
+    )
+    assert isinstance(instruction_output, list)
+
     await program_admin.send_transaction(
         [min_pub_instruction], [funding_key, price_keypair]
     )