soroban_encoding.rs

// SPDX-License-Identifier: Apache-2.0

use crate::codegen::cfg::InternalCallTy;
use crate::codegen::cfg::{ControlFlowGraph, Instr};
use crate::codegen::encoding::create_encoder;
use crate::codegen::vartable::Vartable;
use crate::codegen::HostFunctions;
use crate::codegen::{Builtin, Expression};
use crate::sema::ast::{ArrayLength, Namespace, RetrieveType, StructType, Type, Type::Uint};
use num_bigint::BigInt;
use num_traits::Zero;
use solang_parser::helpers::CodeLocation;
use solang_parser::pt;
use solang_parser::pt::Loc;

/// Soroban encoder works a little differently than the other encoders.
/// For an external call, Soroban first needs to convert values into Soroban ScVals.
/// Each ScVal is 64 bits long, and encoded either via a host function or shifting bits.
/// For this reason, the soroban encoder is implemented as separate from the other encoders.
pub fn soroban_encode(
    loc: &Loc,
    args: Vec<Expression>,
    ns: &Namespace,
    vartab: &mut Vartable,
    cfg: &mut ControlFlowGraph,
    packed: bool,
) -> (Expression, Expression, Vec<Expression>) {
    let mut encoder = create_encoder(ns, packed);

    let size = 8 * args.len(); // 8 bytes per argument

    let size_expr = Expression::NumberLiteral {
        loc: *loc,
        ty: Uint(32),
        value: size.into(),
    };
    let encoded_bytes = vartab.temp_name("abi_encoded", &Type::Bytes(size as u8));

    let expr = Expression::AllocDynamicBytes {
        loc: *loc,
        ty: Type::Bytes(size as u8),
        size: size_expr.clone().into(),
        initializer: None,
    };

    cfg.add(
        vartab,
        Instr::Set {
            loc: *loc,
            res: encoded_bytes,
            expr,
        },
    );

    let mut offset = Expression::NumberLiteral {
        loc: *loc,
        ty: Uint(64),
        value: BigInt::zero(),
    };

    let buffer = Expression::Variable {
        loc: *loc,
        ty: Type::Bytes(size as u8),
        var_no: encoded_bytes,
    };

    let mut encoded_items = Vec::new();

    for (arg_no, item) in args.iter().enumerate() {
        let var = soroban_encode_arg(item.clone(), cfg, vartab, ns);

        encoded_items.push(var.clone());

        let advance = encoder.encode(&var, &buffer, &offset, arg_no, ns, vartab, cfg);
        offset = Expression::Add {
            loc: *loc,
            ty: Uint(64),
            overflowing: false,
            left: offset.into(),
            right: advance.into(),
        };
    }

    (buffer, size_expr, encoded_items)
}

pub fn soroban_decode(
    _loc: &Loc,
    buffer: &Expression,
    _types: &[Type],
    ns: &Namespace,
    vartab: &mut Vartable,
    cfg: &mut ControlFlowGraph,
    _buffer_size_expr: Option<Expression>,
) -> Vec<Expression> {
    let mut returns = Vec::new();

    let loaded_val = Expression::Load {
        loc: Loc::Codegen,
        ty: Type::Uint(64),
        expr: Box::new(buffer.clone()),
    };

    let decoded_val = soroban_decode_arg(loaded_val, cfg, vartab, ns, None);

    returns.push(decoded_val);

    returns
}

pub fn soroban_decode_arg(
    arg: Expression,
    wrapper_cfg: &mut ControlFlowGraph,
    vartab: &mut Vartable,
    ns: &Namespace,
    decode_as: Option<Type>,
) -> Expression {
    let ty = match decode_as {
        Some(ty) => ty,
        None => {
            if let Type::Ref(inner_ty) = arg.ty() {
                *inner_ty
            } else if let Type::StorageRef(_, inner) = arg.ty() {
                *inner
            } else if let Type::SorobanHandle(inner) = arg.ty() {
                *inner
            } else {
                arg.ty()
            }
        }
    };

    match ty {
        Type::Bool => Expression::NotEqual {
            loc: Loc::Codegen,
            left: arg.into(),
            right: Box::new(Expression::NumberLiteral {
                loc: Loc::Codegen,
                ty: Type::Uint(64),
                value: 0u64.into(),
            }),
        },
        Type::Uint(64) => Expression::ShiftRight {
            loc: Loc::Codegen,
            ty: Type::Uint(64),
            left: arg.into(),
            right: Box::new(Expression::NumberLiteral {
                loc: Loc::Codegen,
                ty: Type::Uint(64),
                value: BigInt::from(8_u64),
            }),
            signed: false,
        },

        Type::Address(_) | Type::String => arg.clone(),

        Type::Int(128) | Type::Uint(128) => decode_i128(wrapper_cfg, vartab, arg),

        Type::Int(256) | Type::Uint(256) => decode_i256(wrapper_cfg, vartab, arg),

        Type::Uint(32) => {
            // get payload out of major bits then truncate to 32‑bit
            Expression::Trunc {
                loc: Loc::Codegen,
                ty: Type::Uint(32),
                expr: Box::new(Expression::ShiftRight {
                    loc: Loc::Codegen,
                    ty: Type::Uint(64),
                    left: arg.into(),
                    right: Box::new(Expression::NumberLiteral {
                        loc: Loc::Codegen,
                        ty: Type::Uint(64),
                        value: 32u64.into(),
                    }),
                    signed: false,
                }),
            }
        }

        Type::Int(32) => Expression::Trunc {
            loc: Loc::Codegen,
            ty: Type::Int(32),
            expr: Box::new(Expression::ShiftRight {
                loc: Loc::Codegen,
                ty: Type::Int(64),
                left: arg.into(),
                right: Box::new(Expression::NumberLiteral {
                    loc: Loc::Codegen,
                    ty: Type::Uint(64),
                    value: 32u64.into(),
                }),
                signed: true,
            }),
        },
        Type::Int(64) => Expression::ShiftRight {
            loc: Loc::Codegen,
            ty: Type::Int(64),
            left: arg.into(),
            right: Box::new(Expression::NumberLiteral {
                loc: Loc::Codegen,
                ty: Type::Uint(64),
                value: BigInt::from(8u64),
            }),
            signed: true,
        },
        Type::Struct(StructType::UserDefined(n)) => {
            decode_struct(arg, wrapper_cfg, vartab, n, ns, ty)
        }
        Type::Array(elem_ty, _) => {
            if let Type::StorageRef(_, _) = arg.ty() {
                arg.clone()
            } else {
                decode_vector(arg, &elem_ty, ns, wrapper_cfg, vartab)
            }
        }

        _ => unimplemented!("unimplemented ty {:#?} in soroban decoder", ty),
    }
}

pub fn soroban_encode_arg(
    item: Expression,
    cfg: &mut ControlFlowGraph,
    vartab: &mut Vartable,
    ns: &Namespace,
) -> Expression {
    let obj = vartab.temp_name("obj_".to_string().as_str(), &Type::Uint(64));

    let ret = match item.ty() {
        Type::Bool => {
            let encoded = match item {
                Expression::BoolLiteral { value, .. } => Expression::NumberLiteral {
                    loc: item.loc(),
                    ty: Type::Uint(64),
                    value: if value { 1u64.into() } else { 0u64.into() },
                },
                _ => item.cast(&Type::Uint(64), ns),
            };

            Instr::Set {
                loc: item.loc(),
                res: obj,
                expr: encoded,
            }
        }
        Type::String => {
            if let Expression::Variable {
                loc: _,
                ty: _,
                var_no: _,
            } = item.clone()
            {
                Instr::Set {
                    loc: Loc::Codegen,
                    res: obj,
                    expr: item.clone(),
                }
            } else {
                let inp = Expression::VectorData {
                    pointer: Box::new(item.clone()),
                };

                let inp_extend = Expression::ZeroExt {
                    loc: Loc::Codegen,
                    ty: Type::Uint(64),
                    expr: Box::new(inp),
                };

                let encoded = Expression::ShiftLeft {
                    loc: Loc::Codegen,
                    ty: Uint(64),
                    left: Box::new(inp_extend),
                    right: Box::new(Expression::NumberLiteral {
                        loc: Loc::Codegen,
                        ty: Type::Uint(64),
                        value: BigInt::from(32),
                    }),
                };

                let encoded = Expression::Add {
                    loc: Loc::Codegen,
                    ty: Type::Uint(64),
                    overflowing: true,
                    left: Box::new(encoded),
                    right: Box::new(Expression::NumberLiteral {
                        loc: Loc::Codegen,
                        ty: Type::Uint(64),
                        value: BigInt::from(4),
                    }),
                };

                let len = match item.clone() {
                    Expression::AllocDynamicBytes { size, .. } => {
                        let sesa = Expression::ShiftLeft {
                            loc: Loc::Codegen,
                            ty: Uint(64),
                            left: Box::new(size.clone().cast(&Type::Uint(64), ns)),
                            right: Box::new(Expression::NumberLiteral {
                                loc: Loc::Codegen,
                                ty: Type::Uint(64),
                                value: BigInt::from(32),
                            }),
                        };

                        Expression::Add {
                            loc: Loc::Codegen,
                            ty: Type::Uint(64),
                            overflowing: true,
                            left: Box::new(sesa),
                            right: Box::new(Expression::NumberLiteral {
                                loc: Loc::Codegen,
                                ty: Type::Uint(64),
                                value: BigInt::from(4),
                            }),
                        }
                    }
                    Expression::BytesLiteral { loc, ty: _, value } => {
                        let len = Expression::NumberLiteral {
                            loc,
                            ty: Type::Uint(64),
                            value: BigInt::from(value.len() as u64),
                        };

                        let len = Expression::ShiftLeft {
                            loc,
                            ty: Type::Uint(64),
                            left: Box::new(len),
                            right: Box::new(Expression::NumberLiteral {
                                loc,
                                ty: Type::Uint(64),
                                value: BigInt::from(32),
                            }),
                        };

                        Expression::Add {
                            loc,
                            ty: Type::Uint(64),
                            left: Box::new(len),
                            right: Box::new(Expression::NumberLiteral {
                                loc,
                                ty: Type::Uint(64),
                                value: BigInt::from(4),
                            }),
                            overflowing: false,
                        }
                    }
                    _ => unreachable!(),
                };

                Instr::Call {
                    res: vec![obj],
                    return_tys: vec![Type::Uint(64)],
                    call: crate::codegen::cfg::InternalCallTy::HostFunction {
                        name: HostFunctions::SymbolNewFromLinearMemory.name().to_string(),
                    },
                    args: vec![encoded, len],
                }
            }
        }
        Type::Uint(32) | Type::Int(32) => {
            // widen to 64 bits so we can shift
            let widened = match item.ty() {
                Type::Uint(32) => Expression::ZeroExt {
                    loc: item.loc(),
                    ty: Type::Uint(64),
                    expr: Box::new(item.clone()),
                },
                Type::Int(32) => Expression::SignExt {
                    loc: item.loc(),
                    ty: Type::Int(64),
                    expr: Box::new(item.clone()),
                },
                _ => unreachable!(),
            };

            // the value goes into the major bits of the 64 bit value
            let shifted = Expression::ShiftLeft {
                loc: item.loc(),
                ty: Type::Uint(64),
                left: Box::new(widened.cast(&Type::Uint(64), ns)),
                right: Box::new(Expression::NumberLiteral {
                    loc: item.loc(),
                    ty: Type::Uint(64),
                    value: 32u64.into(), // 24 (minor) + 8 (tag)
                }),
            };

            let tag = if matches!(item.ty(), Type::Uint(32)) {
                4
            } else {
                5
            };
            Instr::Set {
                loc: item.loc(),
                res: obj,
                expr: Expression::Add {
                    loc: item.loc(),
                    ty: Type::Uint(64),
                    left: Box::new(shifted),
                    right: Box::new(Expression::NumberLiteral {
                        loc: item.loc(),
                        ty: Type::Uint(64),
                        value: tag.into(),
                    }),
                    overflowing: false,
                },
            }
        }
        Type::Uint(64) | Type::Int(64) => {
            let shift_left = Expression::ShiftLeft {
                loc: item.loc(),
                ty: Type::Uint(64),
                left: Box::new(item.clone()),
                right: Box::new(Expression::NumberLiteral {
                    loc: item.loc(),
                    ty: Type::Uint(64),
                    value: BigInt::from(8),
                }),
            };

            let tag = match item.ty() {
                Type::Uint(64) => 6,
                Type::Int(64) => 7,
                _ => unreachable!(),
            };

            let added = Expression::Add {
                loc: item.loc(),
                ty: Type::Uint(64),
                left: Box::new(shift_left),
                right: Box::new(Expression::NumberLiteral {
                    loc: item.loc(),
                    ty: Type::Uint(64),
                    value: BigInt::from(tag),
                }),
                overflowing: false,
            };

            Instr::Set {
                loc: item.loc(),
                res: obj,
                expr: added,
            }
        }
        Type::Address(_) => {
            let instr = if let Expression::Cast { loc, ty: _, expr } = item {
                let address_literal = expr;

                let pointer = Expression::VectorData {
                    pointer: address_literal.clone(),
                };

                let pointer_extend = Expression::ZeroExt {
                    loc,
                    ty: Type::Uint(64),
                    expr: Box::new(pointer),
                };

                let encoded = Expression::ShiftLeft {
                    loc,
                    ty: Uint(64),
                    left: Box::new(pointer_extend),
                    right: Box::new(Expression::NumberLiteral {
                        loc,
                        ty: Type::Uint(64),
                        value: BigInt::from(32),
                    }),
                };

                let encoded = Expression::Add {
                    loc,
                    ty: Type::Uint(64),
                    overflowing: true,
                    left: Box::new(encoded),
                    right: Box::new(Expression::NumberLiteral {
                        loc,
                        ty: Type::Uint(64),
                        value: BigInt::from(4),
                    }),
                };

                let len = if let Expression::BytesLiteral { loc, ty: _, value } =
                    *address_literal.clone()
                {
                    let len = Expression::NumberLiteral {
                        loc,
                        ty: Type::Uint(64),
                        value: BigInt::from(value.len() as u64),
                    };

                    let len = Expression::ShiftLeft {
                        loc,
                        ty: Type::Uint(64),
                        left: Box::new(len),
                        right: Box::new(Expression::NumberLiteral {
                            loc,
                            ty: Type::Uint(64),
                            value: BigInt::from(32),
                        }),
                    };

                    Expression::Add {
                        loc,
                        ty: Type::Uint(64),
                        left: Box::new(len),
                        right: Box::new(Expression::NumberLiteral {
                            loc,
                            ty: Type::Uint(64),
                            value: BigInt::from(4),
                        }),
                        overflowing: false,
                    }
                } else {
                    todo!()
                };

                let str_key_temp = vartab.temp_name("str_key", &Type::Uint(64));
                let str_key_var = Expression::Variable {
                    loc,
                    ty: Type::Uint(64),
                    var_no: str_key_temp,
                };

                let soroban_str_key = Instr::Call {
                    res: vec![str_key_temp],
                    return_tys: vec![Type::Uint(64)],
                    call: crate::codegen::cfg::InternalCallTy::HostFunction {
                        name: HostFunctions::StringNewFromLinearMemory.name().to_string(),
                    },
                    args: vec![encoded.clone(), len.clone()],
                };

                cfg.add(vartab, soroban_str_key);

                let address_object = Instr::Call {
                    res: vec![obj],
                    return_tys: vec![Type::Uint(64)],
                    call: crate::codegen::cfg::InternalCallTy::HostFunction {
                        name: HostFunctions::StrKeyToAddr.name().to_string(),
                    },
                    args: vec![str_key_var],
                };

                address_object
            } else {
                Instr::Set {
                    loc: Loc::Codegen,
                    res: obj,
                    expr: item.clone(),
                }
            };

            instr
        }
        Type::Int(128) | Type::Uint(128) => {
            let low = Expression::Trunc {
                loc: Loc::Codegen,
                ty: Type::Int(64),
                expr: Box::new(item.clone()),
            };

            let high = Expression::ShiftRight {
                loc: Loc::Codegen,
                ty: Type::Int(128),
                left: Box::new(item.clone()),
                right: Box::new(Expression::NumberLiteral {
                    loc: Loc::Codegen,
                    ty: Type::Int(128),
                    value: BigInt::from(64),
                }),
                signed: false,
            };

            let high = Expression::Trunc {
                loc: Loc::Codegen,
                ty: Type::Int(64),
                expr: Box::new(high),
            };

            let encoded = encode_i128(cfg, vartab, low, high, item.ty());
            Instr::Set {
                loc: item.loc(),
                res: obj,
                expr: encoded,
            }
        }
        Type::Int(256) | Type::Uint(256) => {
            // For 256-bit integers, we need to split into four 64-bit pieces
            // lo_lo: bits 0-63
            // lo_hi: bits 64-127
            // hi_lo: bits 128-191
            // hi_hi: bits 192-255

            let is_signed = matches!(item.ty(), Type::Int(256));

            // Extract lo_lo (bits 0-63)
            let lo_lo = Expression::Trunc {
                loc: Loc::Codegen,
                ty: Type::Int(64),
                expr: Box::new(item.clone()),
            };

            // Extract lo_hi (bits 64-127)
            let lo_hi_shift = Expression::ShiftRight {
                loc: Loc::Codegen,
                ty: Type::Int(256),
                left: Box::new(item.clone()),
                right: Box::new(Expression::NumberLiteral {
                    loc: Loc::Codegen,
                    ty: Type::Int(256),
                    value: BigInt::from(64),
                }),
                signed: is_signed,
            };

            let lo_hi = Expression::Trunc {
                loc: Loc::Codegen,
                ty: Type::Int(64),
                expr: Box::new(lo_hi_shift),
            };

            // Extract hi_lo (bits 128-191)
            let hi_lo_shift = Expression::ShiftRight {
                loc: Loc::Codegen,
                ty: Type::Int(256),
                left: Box::new(item.clone()),
                right: Box::new(Expression::NumberLiteral {
                    loc: Loc::Codegen,
                    ty: Type::Int(256),
                    value: BigInt::from(128),
                }),
                signed: is_signed,
            };

            let hi_lo = Expression::Trunc {
                loc: Loc::Codegen,
                ty: Type::Int(64),
                expr: Box::new(hi_lo_shift),
            };

            // Extract hi_hi (bits 192-255)
            let hi_hi_shift = Expression::ShiftRight {
                loc: Loc::Codegen,
                ty: Type::Int(256),
                left: Box::new(item.clone()),
                right: Box::new(Expression::NumberLiteral {
                    loc: Loc::Codegen,
                    ty: Type::Int(256),
                    value: BigInt::from(192),
                }),
                signed: is_signed,
            };

            let hi_hi = Expression::Trunc {
                loc: Loc::Codegen,
                ty: Type::Int(64),
                expr: Box::new(hi_hi_shift),
            };

            let encoded = encode_i256(cfg, vartab, lo_lo, lo_hi, hi_lo, hi_hi, item.ty());
            Instr::Set {
                loc: item.loc(),
                res: obj,
                expr: encoded,
            }
        }
        Type::Struct(StructType::UserDefined(n)) => {
            let buf = encode_struct(item.clone(), cfg, vartab, ns, n);

            Instr::Set {
                loc: Loc::Codegen,
                res: obj,
                expr: buf,
            }
        }
        Type::SorobanHandle(_) => Instr::Set {
            loc: Loc::Codegen,
            res: obj,
            expr: item.clone(),
        },
        Type::Array(_, _) => Instr::Set {
            loc: Loc::Codegen,
            res: obj,
            expr: encode_vector(item.clone(), cfg, vartab),
        },

        _ => todo!("Type not yet supported in soroban encoder: {:?}", item.ty()),
    };

    cfg.add(vartab, ret);

    Expression::Variable {
        loc: pt::Loc::Codegen,
        ty: Type::Uint(64),
        var_no: obj,
    }
}

fn encode_i128(
    cfg: &mut ControlFlowGraph,
    vartab: &mut Vartable,
    lo: Expression,
    high: Expression,
    int128_ty: Type,
) -> Expression {
    let ret_var = vartab.temp_anonymous(&lo.ty());

    let ret = Expression::Variable {
        loc: pt::Loc::Codegen,
        ty: lo.ty().clone(),
        var_no: ret_var,
    };

    vartab.new_dirty_tracker();
    let fits_in_56_bits = cfg.new_basic_block("fits_in_56_bits".to_string());
    let should_be_in_host = cfg.new_basic_block("should_be_in_host".to_string());
    let return_block = cfg.new_basic_block("finish".to_string());

    let high_8_bits = Expression::ShiftRight {
        loc: pt::Loc::Codegen,
        ty: Type::Uint(64),
        left: lo.clone().into(),
        right: Expression::NumberLiteral {
            loc: pt::Loc::Codegen,
            ty: Type::Uint(64),
            value: BigInt::from(56_u64),
        }
        .into(),
        signed: false,
    };

    let cond = Expression::Equal {
        loc: pt::Loc::Codegen,
        left: high_8_bits.clone().into(),
        right: Expression::NumberLiteral {
            loc: pt::Loc::Codegen,
            ty: Type::Uint(64),
            value: BigInt::from(0_u64),
        }
        .into(),
    };

    cfg.add(
        vartab,
        Instr::BranchCond {
            cond,
            true_block: fits_in_56_bits,
            false_block: should_be_in_host,
        },
    );

    cfg.set_basic_block(fits_in_56_bits);

    let to_return = Expression::ShiftLeft {
        loc: Loc::Codegen,
        ty: Type::Uint(64),
        left: Box::new(lo.clone()),
        right: Box::new(Expression::NumberLiteral {
            loc: Loc::Codegen,
            ty: Type::Uint(64),
            value: BigInt::from(8_u64),
        }),
    };
    let tag = match int128_ty {
        Type::Int(128) => 11,
        Type::Uint(128) => 10,
        _ => unreachable!(),
    };

    let to_return = Expression::Add {
        loc: Loc::Codegen,
        ty: Type::Uint(64),
        left: to_return.into(),
        right: Expression::NumberLiteral {
            loc: Loc::Codegen,
            ty: Type::Uint(64),
            value: BigInt::from(tag),
        }
        .into(),
        overflowing: false,
    };

    let set_instr = Instr::Set {
        loc: pt::Loc::Codegen,
        res: ret_var,
        expr: to_return,
    };
    cfg.add(vartab, set_instr);

    cfg.add(
        vartab,
        Instr::Branch {
            block: return_block,
        },
    );

    cfg.set_basic_block(should_be_in_host);

    let instr = match int128_ty {
        Type::Int(128) => Instr::Call {
            res: vec![ret_var],
            return_tys: vec![Type::Uint(64)],
            call: InternalCallTy::HostFunction {
                name: HostFunctions::ObjFromI128Pieces.name().to_string(),
            },
            args: vec![high, lo],
        },
        Type::Uint(128) => Instr::Call {
            res: vec![ret_var],
            return_tys: vec![Type::Uint(64)],
            call: InternalCallTy::HostFunction {
                name: HostFunctions::ObjFromU128Pieces.name().to_string(),
            },
            args: vec![high, lo],
        },
        _ => unreachable!(),
    };

    cfg.add(vartab, instr);

    cfg.add(
        vartab,
        Instr::Branch {
            block: return_block,
        },
    );

    cfg.set_basic_block(return_block);
    cfg.set_phis(return_block, vartab.pop_dirty_tracker());

    ret
}

/// Encodes a 256-bit integer (signed or unsigned) into a Soroban ScVal.
/// This function handles both Int256 and Uint256 types by splitting them into
/// four 64-bit pieces and using the appropriate host functions.
fn encode_i256(
    cfg: &mut ControlFlowGraph,
    vartab: &mut Vartable,
    lo_lo: Expression,
    lo_hi: Expression,
    hi_lo: Expression,
    hi_hi: Expression,
    int256_ty: Type,
) -> Expression {
    let ret_var = vartab.temp_anonymous(&lo_lo.ty());

    let ret = Expression::Variable {
        loc: pt::Loc::Codegen,
        ty: lo_lo.ty().clone(),
        var_no: ret_var,
    };

    // For 256-bit integers, we always use the host functions since they can't fit in a 64-bit ScVal
    let instr = match int256_ty {
        Type::Int(256) => Instr::Call {
            res: vec![ret_var],
            return_tys: vec![Type::Uint(64)],
            call: InternalCallTy::HostFunction {
                name: HostFunctions::ObjFromI256Pieces.name().to_string(),
            },
            args: vec![hi_hi, hi_lo, lo_hi, lo_lo],
        },
        Type::Uint(256) => Instr::Call {
            res: vec![ret_var],
            return_tys: vec![Type::Uint(64)],
            call: InternalCallTy::HostFunction {
                name: HostFunctions::ObjFromU256Pieces.name().to_string(),
            },
            args: vec![hi_hi, hi_lo, lo_hi, lo_lo],
        },
        _ => unreachable!(),
    };

    cfg.add(vartab, instr);

    ret
}

fn decode_i128(cfg: &mut ControlFlowGraph, vartab: &mut Vartable, arg: Expression) -> Expression {
    let ty = match arg.ty() {
        Type::Ref(inner_ty) => *inner_ty.clone(),
        Type::SorobanHandle(inner_ty) => *inner_ty.clone(),
        _ => arg.ty(),
    };

    let ret_var = vartab.temp_anonymous(&ty);

    let ret = Expression::Variable {
        loc: pt::Loc::Codegen,
        ty: ty.clone(),
        var_no: ret_var,
    };

    vartab.new_dirty_tracker();

    let tag = extract_tag(arg.clone());

    let val_in_host = cfg.new_basic_block("val_is_host".to_string());
    let val_in_obj = cfg.new_basic_block("val_is_obj".to_string());
    let return_block = cfg.new_basic_block("finish".to_string());

    let predicate = match ty {
        Type::Int(128) => 11,
        Type::Uint(128) => 10,
        _ => unreachable!(),
    };
    let is_in_obj = Expression::Equal {
        loc: pt::Loc::Codegen,
        left: tag.clone().into(),
        right: Expression::NumberLiteral {
            loc: pt::Loc::Codegen,
            ty: Type::Uint(64),
            value: BigInt::from(predicate),
        }
        .into(),
    };

    cfg.add(
        vartab,
        Instr::BranchCond {
            cond: is_in_obj,
            true_block: val_in_obj,
            false_block: val_in_host,
        },
    );

    cfg.set_basic_block(val_in_obj);

    let value = Expression::ShiftRight {
        loc: pt::Loc::Codegen,
        ty: Type::Int(64),
        left: arg.clone().into(),
        right: Expression::NumberLiteral {
            loc: pt::Loc::Codegen,
            ty: Type::Int(64),
            value: BigInt::from(8_u64),
        }
        .into(),
        signed: false,
    };

    let extend = Expression::ZeroExt {
        loc: Loc::Codegen,
        ty: ty.clone(),
        expr: Box::new(value.clone()),
    };

    let set_instr = Instr::Set {
        loc: pt::Loc::Codegen,
        res: ret_var,
        expr: extend,
    };

    cfg.add(vartab, set_instr);

    cfg.add(
        vartab,
        Instr::Branch {
            block: return_block,
        },
    );

    cfg.set_basic_block(val_in_host);

    let low_var_no = vartab.temp_anonymous(&Type::Uint(64));
    let low_var = Expression::Variable {
        loc: pt::Loc::Codegen,
        ty: Type::Uint(64),
        var_no: low_var_no,
    };

    let get_lo_instr = match ty {
        Type::Int(128) => Instr::Call {
            res: vec![low_var_no],
            return_tys: vec![Type::Uint(64)],
            call: InternalCallTy::HostFunction {
                name: HostFunctions::ObjToI128Lo64.name().to_string(),
            },
            args: vec![arg.clone()],
        },
        Type::Uint(128) => Instr::Call {
            res: vec![low_var_no],
            return_tys: vec![Type::Uint(64)],
            call: InternalCallTy::HostFunction {
                name: HostFunctions::ObjToU128Lo64.name().to_string(),
            },
            args: vec![arg.clone()],
        },
        _ => unreachable!(),
    };

    cfg.add(vartab, get_lo_instr);

    let low_var = Expression::ZeroExt {
        loc: Loc::Codegen,
        ty: ty.clone(),
        expr: Box::new(low_var),
    };

    let high_var_no = vartab.temp_anonymous(&Type::Uint(64));
    let high_var = Expression::Variable {
        loc: pt::Loc::Codegen,
        ty: Type::Uint(64),
        var_no: high_var_no,
    };

    let get_hi_instr = match ty {
        Type::Int(128) => Instr::Call {
            res: vec![high_var_no],
            return_tys: vec![Type::Uint(64)],
            call: InternalCallTy::HostFunction {
                name: HostFunctions::ObjToI128Hi64.name().to_string(),
            },
            args: vec![arg.clone()],
        },
        Type::Uint(128) => Instr::Call {
            res: vec![high_var_no],
            return_tys: vec![Type::Uint(64)],
            call: InternalCallTy::HostFunction {
                name: HostFunctions::ObjToU128Hi64.name().to_string(),
            },
            args: vec![arg.clone()],
        },
        _ => unreachable!(),
    };

    cfg.add(vartab, get_hi_instr);

    let total = Expression::ZeroExt {
        loc: Loc::Codegen,
        ty: ty.clone(),
        expr: Box::new(high_var),
    };

    let total = Expression::ShiftLeft {
        loc: Loc::Codegen,
        ty: ty.clone(),
        left: Box::new(total),
        right: Box::new(Expression::NumberLiteral {
            loc: Loc::Codegen,
            ty: ty.clone(),
            value: BigInt::from(64),
        }),
    };

    let total = Expression::Add {
        loc: Loc::Codegen,
        ty: ty.clone(),
        overflowing: false,
        left: total.into(),
        right: low_var.into(),
    };

    let set_instr = Instr::Set {
        loc: pt::Loc::Codegen,
        res: ret_var,
        expr: total,
    };

    cfg.add(vartab, set_instr);

    cfg.add(
        vartab,
        Instr::Branch {
            block: return_block,
        },
    );

    cfg.set_basic_block(return_block);
    cfg.set_phis(return_block, vartab.pop_dirty_tracker());

    ret
}

/// Decodes a 256-bit integer (signed or unsigned) from a Soroban ScVal.
/// This function handles both Int256 and Uint256 types by retrieving
/// the four 64-bit pieces from the host object.
fn decode_i256(cfg: &mut ControlFlowGraph, vartab: &mut Vartable, arg: Expression) -> Expression {
    let ty = match arg.ty() {
        Type::Ref(inner_ty) => *inner_ty.clone(),
        Type::SorobanHandle(inner_ty) => *inner_ty.clone(),
        _ => arg.ty(),
    };

    let ret_var = vartab.temp_anonymous(&ty);

    let ret = Expression::Variable {
        loc: pt::Loc::Codegen,
        ty: ty.clone(),
        var_no: ret_var,
    };

    // For 256-bit integers, we need to extract all four 64-bit pieces
    // lo_lo: bits 0-63
    // lo_hi: bits 64-127
    // hi_lo: bits 128-191
    // hi_hi: bits 192-255

    // Extract lo_lo (bits 0-63)
    let lo_lo_var_no = vartab.temp_anonymous(&Type::Uint(64));
    let lo_lo_var = Expression::Variable {
        loc: pt::Loc::Codegen,
        ty: Type::Uint(64),
        var_no: lo_lo_var_no,
    };

    let get_lo_lo_instr = match ty {
        Type::Int(256) => Instr::Call {
            res: vec![lo_lo_var_no],
            return_tys: vec![Type::Uint(64)],
            call: InternalCallTy::HostFunction {
                name: HostFunctions::ObjToI256LoLo.name().to_string(),
            },
            args: vec![arg.clone()],
        },
        Type::Uint(256) => Instr::Call {
            res: vec![lo_lo_var_no],
            return_tys: vec![Type::Uint(64)],
            call: InternalCallTy::HostFunction {
                name: HostFunctions::ObjToU256LoLo.name().to_string(),
            },
            args: vec![arg.clone()],
        },
        _ => unreachable!(),
    };

    cfg.add(vartab, get_lo_lo_instr);

    // Extract lo_hi (bits 64-127)
    let lo_hi_var_no = vartab.temp_anonymous(&Type::Uint(64));
    let lo_hi_var = Expression::Variable {
        loc: pt::Loc::Codegen,
        ty: Type::Uint(64),
        var_no: lo_hi_var_no,
    };

    let get_lo_hi_instr = match ty {
        Type::Int(256) => Instr::Call {
            res: vec![lo_hi_var_no],
            return_tys: vec![Type::Uint(64)],
            call: InternalCallTy::HostFunction {
                name: HostFunctions::ObjToI256LoHi.name().to_string(),
            },
            args: vec![arg.clone()],
        },
        Type::Uint(256) => Instr::Call {
            res: vec![lo_hi_var_no],
            return_tys: vec![Type::Uint(64)],
            call: InternalCallTy::HostFunction {
                name: HostFunctions::ObjToU256LoHi.name().to_string(),
            },
            args: vec![arg.clone()],
        },
        _ => unreachable!(),
    };

    cfg.add(vartab, get_lo_hi_instr);

    // Extract hi_lo (bits 128-191)
    let hi_lo_var_no = vartab.temp_anonymous(&Type::Uint(64));
    let hi_lo_var = Expression::Variable {
        loc: pt::Loc::Codegen,
        ty: Type::Uint(64),
        var_no: hi_lo_var_no,
    };

    let get_hi_lo_instr = match ty {
        Type::Int(256) => Instr::Call {
            res: vec![hi_lo_var_no],
            return_tys: vec![Type::Uint(64)],
            call: InternalCallTy::HostFunction {
                name: HostFunctions::ObjToI256HiLo.name().to_string(),
            },
            args: vec![arg.clone()],
        },
        Type::Uint(256) => Instr::Call {
            res: vec![hi_lo_var_no],
            return_tys: vec![Type::Uint(64)],
            call: InternalCallTy::HostFunction {
                name: HostFunctions::ObjToU256HiLo.name().to_string(),
            },
            args: vec![arg.clone()],
        },
        _ => unreachable!(),
    };

    cfg.add(vartab, get_hi_lo_instr);

    // Extract hi_hi (bits 192-255)
    let hi_hi_var_no = vartab.temp_anonymous(&Type::Uint(64));
    let hi_hi_var = Expression::Variable {
        loc: pt::Loc::Codegen,
        ty: Type::Uint(64),
        var_no: hi_hi_var_no,
    };

    let get_hi_hi_instr = match ty {
        Type::Int(256) => Instr::Call {
            res: vec![hi_hi_var_no],
            return_tys: vec![Type::Uint(64)],
            call: InternalCallTy::HostFunction {
                name: HostFunctions::ObjToI256HiHi.name().to_string(),
            },
            args: vec![arg.clone()],
        },
        Type::Uint(256) => Instr::Call {
            res: vec![hi_hi_var_no],
            return_tys: vec![Type::Uint(64)],
            call: InternalCallTy::HostFunction {
                name: HostFunctions::ObjToU256HiHi.name().to_string(),
            },
            args: vec![arg.clone()],
        },
        _ => unreachable!(),
    };

    cfg.add(vartab, get_hi_hi_instr);

    // Now combine all pieces to form the 256-bit value
    // Start with hi_hi (bits 192-255)
    let mut combined = Expression::ZeroExt {
        loc: Loc::Codegen,
        ty: ty.clone(),
        expr: Box::new(hi_hi_var),
    };

    // Shift left by 64 and add hi_lo (bits 128-191)
    combined = Expression::ShiftLeft {
        loc: Loc::Codegen,
        ty: ty.clone(),
        left: Box::new(combined),
        right: Box::new(Expression::NumberLiteral {
            loc: Loc::Codegen,
            ty: ty.clone(),
            value: BigInt::from(64),
        }),
    };

    let hi_lo_extended = Expression::ZeroExt {
        loc: Loc::Codegen,
        ty: ty.clone(),
        expr: Box::new(hi_lo_var),
    };

    combined = Expression::Add {
        loc: Loc::Codegen,
        ty: ty.clone(),
        overflowing: false,
        left: Box::new(combined),
        right: Box::new(hi_lo_extended),
    };

    // Shift left by 64 and add lo_hi (bits 64-127)
    combined = Expression::ShiftLeft {
        loc: Loc::Codegen,
        ty: ty.clone(),
        left: Box::new(combined),
        right: Box::new(Expression::NumberLiteral {
            loc: Loc::Codegen,
            ty: ty.clone(),
            value: BigInt::from(64),
        }),
    };

    let lo_hi_extended = Expression::ZeroExt {
        loc: Loc::Codegen,
        ty: ty.clone(),
        expr: Box::new(lo_hi_var),
    };

    combined = Expression::Add {
        loc: Loc::Codegen,
        ty: ty.clone(),
        overflowing: false,
        left: Box::new(combined),
        right: Box::new(lo_hi_extended),
    };

    // Shift left by 64 and add lo_lo (bits 0-63)
    combined = Expression::ShiftLeft {
        loc: Loc::Codegen,
        ty: ty.clone(),
        left: Box::new(combined),
        right: Box::new(Expression::NumberLiteral {
            loc: Loc::Codegen,
            ty: ty.clone(),
            value: BigInt::from(64),
        }),
    };

    let lo_lo_extended = Expression::ZeroExt {
        loc: Loc::Codegen,
        ty: ty.clone(),
        expr: Box::new(lo_lo_var),
    };

    combined = Expression::Add {
        loc: Loc::Codegen,
        ty: ty.clone(),
        overflowing: false,
        left: Box::new(combined),
        right: Box::new(lo_lo_extended),
    };

    // Set the final combined value
    let set_instr = Instr::Set {
        loc: pt::Loc::Codegen,
        res: ret_var,
        expr: combined,
    };

    cfg.add(vartab, set_instr);

    ret
}

fn extract_tag(arg: Expression) -> Expression {
    let bit_mask = Expression::NumberLiteral {
        loc: pt::Loc::Codegen,
        ty: Type::Uint(64),
        value: BigInt::from(0xFF),
    };

    Expression::BitwiseAnd {
        loc: pt::Loc::Codegen,
        ty: Type::Uint(64),
        left: arg.clone().into(),
        right: bit_mask.into(),
    }
}

/// encode a struct into a buffer where each field is 64 bits long soroban Val.
fn encode_struct(
    item: Expression,
    cfg: &mut ControlFlowGraph,
    vartab: &mut Vartable,
    ns: &Namespace,
    struct_no: usize,
) -> Expression {
    let fields = &ns.structs[struct_no].fields;
    let mut fields_vars = Vec::new();

    for (index, field) in fields.iter().enumerate() {
        let field = Expression::StructMember {
            loc: item.loc(),
            ty: field.ty.clone(),
            expr: Box::new(item.clone()),
            member: index,
        };

        let actual_loaded_field = Expression::Load {
            loc: Loc::Codegen,
            ty: field.ty(),
            expr: field.into(),
        };

        fields_vars.push(actual_loaded_field);
    }

    // now call soroban_encode for all fields
    let ret = soroban_encode(&item.loc(), fields_vars, ns, vartab, cfg, false);

    ret.0
}

/// Encode a linear-memory array into a Soroban VecObject using `VectorNewFromLinearMemory`.
fn encode_vector(
    item: Expression,
    cfg: &mut ControlFlowGraph,
    vartab: &mut Vartable,
) -> Expression {
    let len = Expression::Builtin {
        loc: item.loc(),
        tys: vec![Type::Uint(32)],
        kind: Builtin::ArrayLength,
        args: vec![item.clone()],
    };

    let data_ptr = Expression::VectorData {
        pointer: Box::new(item.clone()),
    };

    // VectorNewFromLinearMemory expects (ptr_u32val, len_u32val).
    let encoded_ptr = zext_shift_add(item.loc(), data_ptr, 32, 4);
    let encoded_len = zext_shift_add(item.loc(), len, 32, 4);

    let obj = vartab.temp_name("vec_obj", &Type::Uint(64));
    cfg.add(
        vartab,
        Instr::Call {
            res: vec![obj],
            return_tys: vec![Type::Uint(64)],
            call: InternalCallTy::HostFunction {
                name: HostFunctions::VectorNewFromLinearMemory.name().to_string(),
            },
            args: vec![encoded_ptr, encoded_len],
        },
    );

    Expression::Variable {
        loc: item.loc(),
        ty: Type::Uint(64),
        var_no: obj,
    }
}

/// Decode a struct from soroban encoding. Struct fields are laid out sequentially in a buffer, where each field is 64 bits long.
fn decode_struct(
    mut item: Expression,
    cfg: &mut ControlFlowGraph,
    vartab: &mut Vartable,
    struct_no: usize,
    ns: &Namespace,
    struct_ty: Type,
) -> Expression {
    let tys = &ns.structs[struct_no]
        .fields
        .iter()
        .map(|f| f.ty.clone())
        .collect::<Vec<_>>();

    let mut members = Vec::new();

    for ty in tys {
        let loaded_val = Expression::Load {
            loc: Loc::Codegen,
            ty: Uint(64),
            expr: Box::new(item.clone()),
        };

        let decode_val = soroban_decode_arg(loaded_val, cfg, vartab, ns, Some(ty.clone()));

        members.push(decode_val);

        item = Expression::AdvancePointer {
            pointer: Box::new(item),
            bytes_offset: Box::new(Expression::NumberLiteral {
                loc: Loc::Codegen,
                ty: Uint(32),
                value: BigInt::from(8),
            }),
        };
    }

    Expression::StructLiteral {
        loc: Loc::Codegen,
        ty: struct_ty,
        values: members,
    }
}

fn zext_shift_add(loc: pt::Loc, value: Expression, shift: u64, tag: u64) -> Expression {
    let shifted = Expression::ShiftLeft {
        loc,
        ty: Type::Uint(64),
        left: Box::new(Expression::ZeroExt {
            loc,
            ty: Type::Uint(64),
            expr: Box::new(value),
        }),
        right: Box::new(Expression::NumberLiteral {
            loc,
            ty: Type::Uint(64),
            value: BigInt::from(shift),
        }),
    };

    Expression::Add {
        loc,
        ty: Type::Uint(64),
        left: Box::new(shifted),
        right: Box::new(Expression::NumberLiteral {
            loc,
            ty: Type::Uint(64),
            value: BigInt::from(tag),
        }),
        overflowing: false,
    }
}
fn decode_vector(
    vec_object: Expression,
    elem_ty: &Type,
    _ns: &Namespace,
    cfg: &mut ControlFlowGraph,
    vartab: &mut Vartable,
) -> Expression {
    let vec_len = vartab.temp_name("vec_len", &Type::Uint(64));

    // Get the length of the vector by VecLen (returns U32Val in a 64-bit host object).
    let get_len_instr = Instr::Call {
        res: vec![vec_len],
        return_tys: vec![Type::Uint(64)],
        call: crate::codegen::cfg::InternalCallTy::HostFunction {
            name: HostFunctions::VecLen.name().to_string(),
        },
        args: vec![vec_object.clone()],
    };

    cfg.add(vartab, get_len_instr);

    let len_var = Expression::Variable {
        loc: pt::Loc::Codegen,
        ty: Type::Uint(64),
        var_no: vec_len,
    };

    // Decode vector length from U32Val payload.
    let decoded_len_u64 = Expression::ShiftRight {
        loc: pt::Loc::Codegen,
        ty: Type::Uint(64),
        left: Box::new(len_var.clone()),
        right: Box::new(Expression::NumberLiteral {
            loc: pt::Loc::Codegen,
            ty: Type::Uint(64),
            value: BigInt::from(32),
        }),
        signed: false,
    };

    let decoded_len_u32 = Expression::Trunc {
        loc: Loc::Codegen,
        ty: Type::Uint(32),
        expr: Box::new(decoded_len_u64.clone()),
    };

    let decoded_array_ty = Type::Array(
        Box::new(Type::SorobanHandle(Box::new(elem_ty.clone()))),
        vec![ArrayLength::Dynamic],
    );
    let decoded_buffer_var = vartab.temp_name("vector_data_decoded", &decoded_array_ty);
    cfg.add(
        vartab,
        Instr::Set {
            loc: Loc::Codegen,
            res: decoded_buffer_var,
            expr: Expression::AllocDynamicBytes {
                loc: Loc::Codegen,
                ty: decoded_array_ty.clone(),
                size: Box::new(decoded_len_u32.clone()),
                initializer: None,
            },
        },
    );

    let decoded_buffer = Expression::Variable {
        loc: Loc::Codegen,
        ty: decoded_array_ty,
        var_no: decoded_buffer_var,
    };

    let data_location = Expression::VectorData {
        pointer: decoded_buffer.clone().into(),
    };

    let data_location = zext_shift_add(Loc::Codegen, data_location, 32, 4);
    let unused = vartab.temp_name("unused_void_return", &Type::Uint(64));
    // VecUnpack expects vector object, output pointer (U32Val), and element count (U32Val).
    let unpack_instr = Instr::Call {
        res: vec![unused],
        return_tys: vec![Type::Uint(64)],
        call: crate::codegen::cfg::InternalCallTy::HostFunction {
            name: HostFunctions::VecUnpackToLinearMemory.name().to_string(),
        },
        args: vec![vec_object.clone(), data_location, len_var],
    };

    cfg.add(vartab, unpack_instr);

    decoded_buffer
}