solana: Add no registered transceivers check (#514)

nvsriram · johnsaigle · web-flow · commit 6cc8beee57e8 · 2024-09-10T17:02:17.000-04:00
* Add check for no registered transceivers
* Update IDL

---------

Co-authored-by: John Saigle &lt;john@asymmetric.re&gt;
diff --git a/solana/programs/example-native-token-transfers/src/bitmap.rs b/solana/programs/example-native-token-transfers/src/bitmap.rs
@@ -47,6 +47,14 @@ impl Bitmap {
             .try_into()
             .expect("Bitmap length must not exceed the bounds of u8")
     }
+
+    pub fn len(self) -> usize {
+        BM::<128>::from_value(self.map).len()
+    }
+
+    pub fn is_empty(self) -> bool {
+        BM::<128>::from_value(self.map).is_empty()
+    }
 }
 
 #[cfg(test)]
diff --git a/solana/programs/example-native-token-transfers/src/error.rs b/solana/programs/example-native-token-transfers/src/error.rs
@@ -51,6 +51,8 @@ pub enum NTTError {
     OverflowScaledAmount,
     #[msg("BitmapIndexOutOfBounds")]
     BitmapIndexOutOfBounds,
+    #[msg("NoRegisteredTransceivers")]
+    NoRegisteredTransceivers,
 }
 
 impl From<ScalingError> for NTTError {
diff --git a/solana/programs/example-native-token-transfers/src/instructions/transfer.rs b/solana/programs/example-native-token-transfers/src/instructions/transfer.rs
@@ -37,6 +37,10 @@ pub struct Transfer<'info> {
     #[account(mut)]
     pub payer: Signer<'info>,
 
+    // Ensure that there exists at least one enabled transceiver
+    #[account(
+        constraint = !config.enabled_transceivers.is_empty() @ NTTError::NoRegisteredTransceivers,
+    )]
     pub config: NotPausedConfig<'info>,
 
     #[account(
@@ -153,6 +157,7 @@ pub fn transfer_burn<'info>(
     args: TransferArgs,
 ) -> Result<()> {
     let accs = ctx.accounts;
+
     let TransferArgs {
         mut amount,
         recipient_chain,
@@ -293,6 +298,7 @@ pub fn transfer_lock<'info>(
     args: TransferArgs,
 ) -> Result<()> {
     let accs = ctx.accounts;
+
     let TransferArgs {
         mut amount,
         recipient_chain,
diff --git a/solana/ts/idl/2_0_0/json/example_native_token_transfers.json b/solana/ts/idl/2_0_0/json/example_native_token_transfers.json
@@ -38,7 +38,14 @@
         {
           "name": "tokenAuthority",
           "isMut": false,
-          "isSigner": false
+          "isSigner": false,
+          "docs": [
+            "In any case, this function is used to set the Config and initialize the program so we",
+            "assume the caller of this function will have total control over the program.",
+            "",
+            "TODO: Using `UncheckedAccount` here leads to \"Access violation in stack frame ...\".",
+            "Could refactor code to use `Box<_>` to reduce stack size."
+          ]
         },
         {
           "name": "custody",
@@ -508,7 +515,10 @@
             {
               "name": "tokenAuthority",
               "isMut": false,
-              "isSigner": false
+              "isSigner": false,
+              "docs": [
+                "CHECK The seeds constraint ensures that this is the correct address"
+              ]
             },
             {
               "name": "mint",
@@ -571,7 +581,10 @@
             {
               "name": "tokenAuthority",
               "isMut": false,
-              "isSigner": false
+              "isSigner": false,
+              "docs": [
+                "CHECK The seeds constraint ensures that this is the correct address"
+              ]
             },
             {
               "name": "mint",
@@ -752,7 +765,10 @@
         {
           "name": "transceiver",
           "isMut": false,
-          "isSigner": false
+          "isSigner": false,
+          "docs": [
+            "used here that wraps the Transceiver account type."
+          ]
         },
         {
           "name": "registeredTransceiver",
@@ -1927,6 +1943,11 @@
       "code": 6022,
       "name": "BitmapIndexOutOfBounds",
       "msg": "BitmapIndexOutOfBounds"
+    },
+    {
+      "code": 6023,
+      "name": "NoRegisteredTransceivers",
+      "msg": "NoRegisteredTransceivers"
     }
   ]
 }
diff --git a/solana/ts/idl/2_0_0/json/wormhole_governance.json b/solana/ts/idl/2_0_0/json/wormhole_governance.json
@@ -15,7 +15,7 @@
           "isMut": true,
           "isSigner": false,
           "docs": [
-            "governed program."
+            "governed program. This account is validated by Wormhole, not this program."
           ]
         },
         {
diff --git a/solana/ts/idl/2_0_0/ts/example_native_token_transfers.ts b/solana/ts/idl/2_0_0/ts/example_native_token_transfers.ts
@@ -38,7 +38,14 @@ export type ExampleNativeTokenTransfers = {
         {
           "name": "tokenAuthority",
           "isMut": false,
-          "isSigner": false
+          "isSigner": false,
+          "docs": [
+            "In any case, this function is used to set the Config and initialize the program so we",
+            "assume the caller of this function will have total control over the program.",
+            "",
+            "TODO: Using `UncheckedAccount` here leads to \"Access violation in stack frame ...\".",
+            "Could refactor code to use `Box<_>` to reduce stack size."
+          ]
         },
         {
           "name": "custody",
@@ -508,7 +515,10 @@ export type ExampleNativeTokenTransfers = {
             {
               "name": "tokenAuthority",
               "isMut": false,
-              "isSigner": false
+              "isSigner": false,
+              "docs": [
+                "CHECK The seeds constraint ensures that this is the correct address"
+              ]
             },
             {
               "name": "mint",
@@ -571,7 +581,10 @@ export type ExampleNativeTokenTransfers = {
             {
               "name": "tokenAuthority",
               "isMut": false,
-              "isSigner": false
+              "isSigner": false,
+              "docs": [
+                "CHECK The seeds constraint ensures that this is the correct address"
+              ]
             },
             {
               "name": "mint",
@@ -752,7 +765,10 @@ export type ExampleNativeTokenTransfers = {
         {
           "name": "transceiver",
           "isMut": false,
-          "isSigner": false
+          "isSigner": false,
+          "docs": [
+            "used here that wraps the Transceiver account type."
+          ]
         },
         {
           "name": "registeredTransceiver",
@@ -1927,6 +1943,11 @@ export type ExampleNativeTokenTransfers = {
       "code": 6022,
       "name": "BitmapIndexOutOfBounds",
       "msg": "BitmapIndexOutOfBounds"
+    },
+    {
+      "code": 6023,
+      "name": "NoRegisteredTransceivers",
+      "msg": "NoRegisteredTransceivers"
     }
   ]
 }
@@ -1970,7 +1991,14 @@ export const IDL: ExampleNativeTokenTransfers = {
         {
           "name": "tokenAuthority",
           "isMut": false,
-          "isSigner": false
+          "isSigner": false,
+          "docs": [
+            "In any case, this function is used to set the Config and initialize the program so we",
+            "assume the caller of this function will have total control over the program.",
+            "",
+            "TODO: Using `UncheckedAccount` here leads to \"Access violation in stack frame ...\".",
+            "Could refactor code to use `Box<_>` to reduce stack size."
+          ]
         },
         {
           "name": "custody",
@@ -2440,7 +2468,10 @@ export const IDL: ExampleNativeTokenTransfers = {
             {
               "name": "tokenAuthority",
               "isMut": false,
-              "isSigner": false
+              "isSigner": false,
+              "docs": [
+                "CHECK The seeds constraint ensures that this is the correct address"
+              ]
             },
             {
               "name": "mint",
@@ -2503,7 +2534,10 @@ export const IDL: ExampleNativeTokenTransfers = {
             {
               "name": "tokenAuthority",
               "isMut": false,
-              "isSigner": false
+              "isSigner": false,
+              "docs": [
+                "CHECK The seeds constraint ensures that this is the correct address"
+              ]
             },
             {
               "name": "mint",
@@ -2684,7 +2718,10 @@ export const IDL: ExampleNativeTokenTransfers = {
         {
           "name": "transceiver",
           "isMut": false,
-          "isSigner": false
+          "isSigner": false,
+          "docs": [
+            "used here that wraps the Transceiver account type."
+          ]
         },
         {
           "name": "registeredTransceiver",
@@ -3859,6 +3896,11 @@ export const IDL: ExampleNativeTokenTransfers = {
       "code": 6022,
       "name": "BitmapIndexOutOfBounds",
       "msg": "BitmapIndexOutOfBounds"
+    },
+    {
+      "code": 6023,
+      "name": "NoRegisteredTransceivers",
+      "msg": "NoRegisteredTransceivers"
     }
   ]
 }
diff --git a/solana/ts/idl/2_0_0/ts/wormhole_governance.ts b/solana/ts/idl/2_0_0/ts/wormhole_governance.ts
@@ -15,7 +15,7 @@ export type WormholeGovernance = {
           "isMut": true,
           "isSigner": false,
           "docs": [
-            "governed program."
+            "governed program. This account is validated by Wormhole, not this program."
           ]
         },
         {
@@ -91,7 +91,7 @@ export const IDL: WormholeGovernance = {
           "isMut": true,
           "isSigner": false,
           "docs": [
-            "governed program."
+            "governed program. This account is validated by Wormhole, not this program."
           ]
         },
         {

Original file line number	Diff line number	Diff line change
`@@ -47,6 +47,14 @@ impl Bitmap {`
`47`	`47`	`.try_into()`
`48`	`48`	`.expect("Bitmap length must not exceed the bounds of u8")`
`49`	`49`	`}`
	`50`	`+`
	`51`	`+ pub fn len(self) -> usize {`
	`52`	`+ BM::<128>::from_value(self.map).len()`
	`53`	`+ }`
	`54`	`+`
	`55`	`+ pub fn is_empty(self) -> bool {`
	`56`	`+ BM::<128>::from_value(self.map).is_empty()`
	`57`	`+ }`
`50`	`58`	`}`
`51`	`59`
`52`	`60`	`#[cfg(test)]`
Original file line number	Diff line number	Diff line change
`@@ -51,6 +51,8 @@ pub enum NTTError {`
`51`	`51`	`OverflowScaledAmount,`
`52`	`52`	`#[msg("BitmapIndexOutOfBounds")]`
`53`	`53`	`BitmapIndexOutOfBounds,`
	`54`	`+ #[msg("NoRegisteredTransceivers")]`
	`55`	`+ NoRegisteredTransceivers,`
`54`	`56`	`}`
`55`	`57`
`56`	`58`	`impl From<ScalingError> for NTTError {`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@`
`15`	`15`	`"isMut": true,`
`16`	`16`	`"isSigner": false,`
`17`	`17`	`"docs": [`
`18`		`- "governed program."`
	`18`	`+ "governed program. This account is validated by Wormhole, not this program."`
`19`	`19`	`]`
`20`	`20`	`},`
`21`	`21`	`{`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@ export type WormholeGovernance = {`
`15`	`15`	`"isMut": true,`
`16`	`16`	`"isSigner": false,`
`17`	`17`	`"docs": [`
`18`		`- "governed program."`
	`18`	`+ "governed program. This account is validated by Wormhole, not this program."`
`19`	`19`	`]`
`20`	`20`	`},`
`21`	`21`	`{`
`@@ -91,7 +91,7 @@ export const IDL: WormholeGovernance = {`
`91`	`91`	`"isMut": true,`
`92`	`92`	`"isSigner": false,`
`93`	`93`	`"docs": [`
`94`		`- "governed program."`
	`94`	`+ "governed program. This account is validated by Wormhole, not this program."`
`95`	`95`	`]`
`96`	`96`	`},`
`97`	`97`	`{`