Skip to content

Commit 1d971c9

Browse files
committed
add comment
1 parent ef9a56f commit 1d971c9

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

crates/wallets/src/multi_wallet.rs

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -402,7 +402,16 @@ impl MultiWalletOpts {
402402
Ok(None)
403403
}
404404

405-
// TODO: Support multiple keys
405+
/// Returns a list of GCP signers if the GCP flag is set.
406+
///
407+
/// The GCP signers are created from the following environment variables:
408+
/// - GCP_PROJECT_ID: The GCP project ID. e.g. `my-project-123456`.
409+
/// - GCP_LOCATION: The GCP location. e.g. `us-central1`.
410+
/// - GCP_KEY_RING: The GCP key ring name. e.g. `my-key-ring`.
411+
/// - GCP_KEY_NAME: The GCP key name. e.g. `my-key`.
412+
/// - GCP_KEY_VERSION: The GCP key version. e.g. `1`.
413+
///
414+
/// For more information on GCP KMS, see the [official documentation](https://cloud.google.com/kms/docs).
406415
pub async fn gcp_signers(&self) -> Result<Option<Vec<WalletSigner>>> {
407416
#[cfg(feature = "gcp-kms")]
408417
if self.gcp {

0 commit comments

Comments
 (0)