mango-explorer/mango/combinableinstructions.py

# # ⚠ Warning
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
# LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
# NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
#
# [🥭 Mango Markets](https://mango.markets/) support is available at:
#   [Docs](https://docs.mango.markets/)
#   [Discord](https://discord.gg/67jySBhxrg)
#   [Twitter](https://twitter.com/mangomarkets)
#   [Github](https://github.com/blockworks-foundation)
#   [Email](mailto:hello@blockworks.foundation)

import logging
import typing

from pyserum._layouts.instructions import InstructionType as SerumInstructionType
from solana.account import Account as SolanaAccount
from solana.blockhash import Blockhash
from solana.publickey import PublicKey
from solana.transaction import Transaction, TransactionInstruction

from .context import Context
from .layouts import layouts
from .transactionscout import MangoInstruction, InstructionType
from .wallet import Wallet

_MAXIMUM_TRANSACTION_LENGTH = 1280 - 40 - 8
_SIGNATURE_LENGTH = 64


def _mango_instruction_to_str(instruction: TransactionInstruction) -> str:
    initial = layouts.MANGO_INSTRUCTION_VARIANT_FINDER.parse(instruction.data)
    parser = layouts.InstructionParsersByVariant[initial.variant]
    if parser is None:
        raise Exception(
            f"Could not find instruction parser for variant {initial.variant} / {InstructionType(initial.variant)}.")

    accounts: typing.List[PublicKey] = list(map(lambda meta: meta.pubkey, instruction.keys))
    parsed = parser.parse(instruction.data)
    instruction_type = InstructionType(int(parsed.variant))

    return str(MangoInstruction(instruction_type, parsed, accounts))


def _serum_instruction_to_str(instruction: TransactionInstruction) -> str:
    initial = layouts.SERUM_INSTRUCTION_VARIANT_FINDER.parse(instruction.data)
    instruction_type = SerumInstructionType(initial.variant)
    return f"« Serum Instruction: {instruction_type.name}: " + "".join("{:02x}".format(x) for x in instruction.data) + "»"


def _raw_instruction_to_str(instruction: TransactionInstruction) -> str:
    report: typing.List[str] = []
    for index, key in enumerate(instruction.keys):
        report += [f"Key[{index}]: {key.pubkey} {key.is_signer: <5} {key.is_writable: <5}"]
    report += [f"Program ID: {instruction.program_id}"]
    report += ["Data: " + "".join("{:02x}".format(x) for x in instruction.data)]
    return "\n".join(report)


def _instruction_to_str(context: Context, instruction: TransactionInstruction) -> str:
    if instruction.program_id == context.program_id:
        return _mango_instruction_to_str(instruction)
    elif instruction.program_id == context.dex_program_id:
        return _serum_instruction_to_str(instruction)
    return _raw_instruction_to_str(instruction)


def _split_instructions_into_chunks(signers: typing.Sequence[SolanaAccount], instructions: typing.Sequence[TransactionInstruction]) -> typing.Sequence[typing.Sequence[TransactionInstruction]]:
    vetted_chunks: typing.List[typing.List[TransactionInstruction]] = []
    current_chunk: typing.List[TransactionInstruction] = []
    for instruction in instructions:
        instruction_size_on_its_own = CombinableInstructions.transaction_size(signers, [instruction])
        if instruction_size_on_its_own >= _MAXIMUM_TRANSACTION_LENGTH:
            raise Exception(
                f"Instruction exceeds maximum size - creates a transaction {instruction_size_on_its_own} bytes long. {instruction}")

        in_progress_chunk = current_chunk + [instruction]
        transaction_size = CombinableInstructions.transaction_size(signers, in_progress_chunk)
        if transaction_size < _MAXIMUM_TRANSACTION_LENGTH:
            current_chunk = in_progress_chunk
        else:
            vetted_chunks += [current_chunk]
            current_chunk = [instruction]

    all_chunks = vetted_chunks + [current_chunk]

    total_in_chunks = sum(map(lambda chunk: len(chunk), all_chunks))
    if total_in_chunks != len(instructions):
        raise Exception(
            f"Failed to chunk instructions. Have {total_in_chunks} instuctions in chunks. Should have {len(instructions)}.")

    return all_chunks


# 🥭 CombinableInstructions class
#
# This class wraps up zero or more Solana instructions and signers, and allows instances to be combined
# easily into a single instance. This instance can then be executed.
#
# This allows simple uses like, for example:
# ```
# (signers + place_orders + settle + crank).execute(context)
# ```
#

class CombinableInstructions():
    def __init__(self, signers: typing.Sequence[SolanaAccount], instructions: typing.Sequence[TransactionInstruction]):
        self.logger: logging.Logger = logging.getLogger(self.__class__.__name__)
        self.signers: typing.Sequence[SolanaAccount] = signers
        self.instructions: typing.Sequence[TransactionInstruction] = instructions

    @staticmethod
    def empty() -> "CombinableInstructions":
        return CombinableInstructions(signers=[], instructions=[])

    @staticmethod
    def from_signers(signers: typing.Sequence[SolanaAccount]) -> "CombinableInstructions":
        return CombinableInstructions(signers=signers, instructions=[])

    @staticmethod
    def from_wallet(wallet: Wallet) -> "CombinableInstructions":
        return CombinableInstructions(signers=[wallet.account], instructions=[])

    @staticmethod
    def from_instruction(instruction: TransactionInstruction) -> "CombinableInstructions":
        return CombinableInstructions(signers=[], instructions=[instruction])

    # This is a quick-and-dirty way to find out the size the transaction will be. There's an upper limit
    # on transaction size of 1232 so we need to keep all transactions below this size.
    @staticmethod
    def transaction_size(signers: typing.Sequence[SolanaAccount], instructions: typing.Sequence[TransactionInstruction]) -> int:
        inspector = Transaction()
        inspector.recent_blockhash = Blockhash(str(PublicKey(3)))
        inspector.instructions.extend(instructions)
        inspector.sign(*signers)
        signed_data = inspector.serialize_message()

        length: int = len(signed_data)

        # Signature count length
        length += 1

        # Signatures
        length += (len(inspector.signatures) * _SIGNATURE_LENGTH)

        return length

    def __add__(self, new_instruction_data: "CombinableInstructions") -> "CombinableInstructions":
        all_signers = [*self.signers, *new_instruction_data.signers]
        all_instructions = [*self.instructions, *new_instruction_data.instructions]
        return CombinableInstructions(signers=all_signers, instructions=all_instructions)

    def execute(self, context: Context) -> typing.Any:
        chunks: typing.Sequence[typing.Sequence[TransactionInstruction]
                                ] = _split_instructions_into_chunks(self.signers, self.instructions)

        if len(chunks) == 1 and len(chunks[0]) == 0:
            self.logger.info("No instructions to run.")
            return []

        if len(chunks) > 1:
            self.logger.info(f"Running instructions in {len(chunks)} transactions.")

        results = []
        for chunk in chunks:
            transaction = Transaction()
            transaction.instructions.extend(chunk)
            response = context.client.send_transaction(transaction, *self.signers, opts=context.transaction_options)
            results += [context.unwrap_or_raise_exception(response)]

        return results

    def execute_individually_and_continue_on_failures(self, context: Context) -> typing.Any:
        results = []
        for instruction in self.instructions:
            transaction = Transaction()
            transaction.instructions = [instruction]
            try:
                response = context.client.send_transaction(transaction, *self.signers, opts=context.transaction_options)
                results += [context.unwrap_or_raise_exception(response)]
            except Exception as exception:
                instruction_str: str = _instruction_to_str(context, instruction)
                self.logger.error(f"""Error executing individual instruction: {exception}
{instruction_str}""")

        return results

    def execute_and_continue_on_failures(self, context: Context) -> typing.Any:
        chunks: typing.Sequence[typing.Sequence[TransactionInstruction]
                                ] = _split_instructions_into_chunks(self.signers, self.instructions)

        if len(chunks) == 1 and len(chunks[0]) == 0:
            self.logger.info("No instructions to run.")
            return []

        if len(chunks) > 1:
            self.logger.info(f"Running instructions in {len(chunks)} transactions.")

        results = []
        for index, chunk in enumerate(chunks):
            transaction = Transaction()
            transaction.instructions.extend(chunk)
            try:
                response = context.client.send_transaction(transaction, *self.signers, opts=context.transaction_options)
                results += [context.unwrap_or_raise_exception(response)]
            except Exception as exception:
                starts_at = sum(len(ch) for ch in chunks[0:index])
                instruction_text = "\n".join(list(map(lambda ins: _instruction_to_str(context, ins), chunk)))
                self.logger.error(f"""Error executing chunk {index} (instructions {starts_at} to {starts_at + len(chunk)}) of CombinableInstruction.
Exception: {exception}
Failing instruction(s):
{instruction_text}""")

        return results

    def execute_and_unwrap_transaction_ids(self, context: Context) -> typing.Sequence[str]:
        return typing.cast(typing.Sequence[str], self.execute(context))

    def __str__(self) -> str:
        report: typing.List[str] = []
        for index, signer in enumerate(self.signers):
            report += [f"Signer[{index}]: {signer.public_key()}"]

        for instruction in self.instructions:
            report += _raw_instruction_to_str(instruction)

        return "\n".join(report)

    def __repr__(self) -> str:
        return f"{self}"