Add example of overrides for specific types

Author: macalinao

crates/anchor-idl/src/program.rs

@@ -16,6 +16,8 @@ use crate::{
 pub struct GeneratorOptions {
     /// Path to the IDL.
     pub idl_path: String,
+    /// List of types to skip from generation. These should be provided by the caller instead.
+    pub skip: Option<PathList>,
     /// List of zero copy structs.
     pub zero_copy: Option<PathList>,
     /// List of `repr(packed)` structs.
@@ -38,15 +40,23 @@ impl GeneratorOptions {
         let idl_contents = fs::read_to_string(&path).unwrap();
         let idl: anchor_lang_idl_spec::Idl = serde_json::from_str(&idl_contents).unwrap();
 
+        let skip = path_list_to_string(self.skip.as_ref());
         let zero_copy = path_list_to_string(self.zero_copy.as_ref());
         let packed = path_list_to_string(self.packed.as_ref());
 
+        let all_type_names = idl
+            .accounts
+            .iter()
+            .map(|a| a.name.clone())
+            .chain(idl.types.iter().map(|t| t.name.clone()))
+            .collect::<HashSet<_>>();
+
         let mut struct_opts: BTreeMap<String, StructOpts> = BTreeMap::new();
-        let all_structs: HashSet<&String> = zero_copy.union(&packed).collect::<HashSet<_>>();
-        all_structs.into_iter().for_each(|name| {
+        all_type_names.iter().for_each(|name| {
             struct_opts.insert(
                 name.to_string(),
                 StructOpts {
+                    skip: skip.contains(name),
                     zero_copy: zero_copy.contains(name),
                     packed: packed.contains(name),
                 },
@@ -57,8 +67,9 @@ impl GeneratorOptions {
     }
 }
 
-#[derive(Clone, Copy, Default)]
+#[derive(Clone, Copy, Debug, Default)]
 pub struct StructOpts {
+    pub skip: bool,
     pub packed: bool,
     pub zero_copy: bool,
 }

crates/anchor-idl/src/typedef.rs

@@ -307,16 +307,20 @@ pub fn generate_typedefs(
     struct_opts: &BTreeMap<String, StructOpts>,
 ) -> TokenStream {
     let defined = typedefs.iter().map(|def| {
-        let struct_name = format_ident!("{}", def.name);
-        match &def.ty {
-            anchor_lang_idl_spec::IdlTypeDefTy::Struct { fields } => {
-                let opts = struct_opts.get(&def.name).copied().unwrap_or_default();
-                generate_struct(typedefs, &struct_name, fields, opts)
-            }
-            anchor_lang_idl_spec::IdlTypeDefTy::Enum { variants } => {
-                generate_enum(typedefs, &struct_name, variants)
+        let opts = struct_opts.get(&def.name).copied().unwrap_or_default();
+        if opts.skip {
+            quote! {}
+        } else {
+            let struct_name = format_ident!("{}", def.name);
+            match &def.ty {
+                anchor_lang_idl_spec::IdlTypeDefTy::Struct { fields } => {
+                    generate_struct(typedefs, &struct_name, fields, opts)
+                }
+                anchor_lang_idl_spec::IdlTypeDefTy::Enum { variants } => {
+                    generate_enum(typedefs, &struct_name, variants)
+                }
+                anchor_lang_idl_spec::IdlTypeDefTy::Type { alias: _ } => todo!(),
             }
-            anchor_lang_idl_spec::IdlTypeDefTy::Type { alias: _ } => todo!(),
         }
     });
     quote! {

examples/kamino-lend/src/lib.rs

@@ -9,12 +9,13 @@
 
 #![allow(clippy::too_many_arguments)]
 
-use anchor_lang::zero_copy;
+mod overrides;
+pub use overrides::*;
 
 anchor_gen::generate_cpi_interface!(
     idl_path = "idl.json",
+    skip(UpdateConfigMode),
     zero_copy(
-        UpdateConfigMode,
         UpdateLendingMarketConfigValue,
         UpdateLendingMarketMode,
         LastUpdate,

examples/kamino-lend/src/overrides.rs

@@ -0,0 +1,55 @@
+use anchor_lang::prelude::*;
+
+#[derive(AnchorSerialize, AnchorDeserialize, PartialEq, Eq, Clone, Copy, Debug)]
+#[repr(u64)]
+pub enum UpdateConfigMode {
+    UpdateLoanToValuePct = 1,
+    UpdateMaxLiquidationBonusBps = 2,
+    UpdateLiquidationThresholdPct = 3,
+    UpdateProtocolLiquidationFee = 4,
+    UpdateProtocolTakeRate = 5,
+    UpdateFeesBorrowFee = 6,
+    UpdateFeesFlashLoanFee = 7,
+    UpdateFeesReferralFeeBps = 8,
+    UpdateDepositLimit = 9,
+    UpdateBorrowLimit = 10,
+    UpdateTokenInfoLowerHeuristic = 11,
+    UpdateTokenInfoUpperHeuristic = 12,
+    UpdateTokenInfoExpHeuristic = 13,
+    UpdateTokenInfoTwapDivergence = 14,
+    UpdateTokenInfoScopeTwap = 15,
+    UpdateTokenInfoScopeChain = 16,
+    UpdateTokenInfoName = 17,
+    UpdateTokenInfoPriceMaxAge = 18,
+    UpdateTokenInfoTwapMaxAge = 19,
+    UpdateScopePriceFeed = 20,
+    UpdatePythPrice = 21,
+    UpdateSwitchboardFeed = 22,
+    UpdateSwitchboardTwapFeed = 23,
+    UpdateBorrowRateCurve = 24,
+    UpdateEntireReserveConfig = 25,
+    UpdateDebtWithdrawalCap = 26,
+    UpdateDepositWithdrawalCap = 27,
+    UpdateDebtWithdrawalCapCurrentTotal = 28,
+    UpdateDepositWithdrawalCapCurrentTotal = 29,
+    UpdateBadDebtLiquidationBonusBps = 30,
+    UpdateMinLiquidationBonusBps = 31,
+    UpdateDeleveragingMarginCallPeriod = 32,
+    UpdateBorrowFactor = 33,
+    UpdateAssetTier = 34,
+    UpdateElevationGroup = 35,
+    UpdateDeleveragingThresholdDecreaseBpsPerDay = 36,
+    DeprecatedUpdateMultiplierSideBoost = 37,
+    DeprecatedUpdateMultiplierTagBoost = 38,
+    UpdateReserveStatus = 39,
+    UpdateFarmCollateral = 40,
+    UpdateFarmDebt = 41,
+    UpdateDisableUsageAsCollateralOutsideEmode = 42,
+    UpdateBlockBorrowingAboveUtilizationPct = 43,
+    UpdateBlockPriceUsage = 44,
+    UpdateBorrowLimitOutsideElevationGroup = 45,
+    UpdateBorrowLimitsInElevationGroupAgainstThisReserve = 46,
+    UpdateHostFixedInterestRateBps = 47,
+    UpdateAutodeleverageEnabled = 48,
+    UpdateDeleveragingBonusIncreaseBpsPerDay = 49,
+}