chore: use spl-* crates (#212)

(XC-297) This is a follow-up to #197. Now that the `solana-sdk`
dependencies are upgraded to v3, use the
`spl_associated_token_account_interface` crate to compute associated
token addresses (ATAs) and `spl-token-interface` crate to create an SPL
transfer instruction in the `basic_solana` example and integration
tests.

Author: lpahlavi

.github/workflows/ci.yml

@@ -34,7 +34,7 @@ jobs:
       - name: 'Check Cargo.toml'
         run: cargo sort --workspace --check
 
-# TODO XC-XXX: Re-enable once `sol_rpc_client` v3.0.0 is released and ICP Ninja deployment of `basic_solana` is reverted
+# TODO XC-456: Re-enable once `sol_rpc_client` v3.0.0 is released and ICP Ninja deployment of `basic_solana` is reverted
 #  check-ninja-cargo-toml:
 #    runs-on: ubuntu-latest
 #    steps:

Cargo.lock

@@ -82,6 +82,7 @@ solana-system-interface = "2.0.0"
 solana-transaction = "3.0.0"
 solana-transaction-error = "3.0.0"
 solana-transaction-status-client-types = "3.0.0"
+spl-associated-token-account-interface = "2.0.0"
 strum = { version = "0.27.2", features = ["derive"] }
 thiserror = "2.0.12"
 tokio = "1.47.0"

Cargo.toml

@@ -26,6 +26,7 @@ solana-pubkey = { workspace = true, features = ["curve25519"] }
 solana-signature = { workspace = true }
 solana-system-interface = { workspace = true, features = ["bincode"] }
 solana-transaction = { workspace = true, features = ["bincode"] }
+spl-associated-token-account-interface = { workspace = true }
 
 [dev-dependencies]
 candid = { workspace = true }

examples/basic_solana/Cargo.toml

@@ -1,6 +1,6 @@
 use basic_solana::{
-    client, solana_wallet::SolanaWallet, spl, state::init_state, validate_caller_not_anonymous,
-    InitArg,
+    client, solana_wallet::SolanaWallet, spl::transfer_instruction_with_program_id,
+    state::init_state, validate_caller_not_anonymous, InitArg,
 };
 use candid::{Nat, Principal};
 use ic_cdk::{init, post_upgrade, update};
@@ -12,6 +12,10 @@ use solana_message::Message;
 use solana_pubkey::Pubkey;
 use solana_system_interface::instruction;
 use solana_transaction::Transaction;
+use spl_associated_token_account_interface::{
+    address::get_associated_token_address_with_program_id,
+    instruction::create_associated_token_account_idempotent,
+};
 use std::str::FromStr;
 
 #[init]
@@ -45,7 +49,7 @@ pub async fn associated_token_account(owner: Option<Principal>, mint_account: St
     let owner = owner.unwrap_or_else(validate_caller_not_anonymous);
     let wallet = SolanaWallet::new(owner).await;
     let mint = Pubkey::from_str(&mint_account).unwrap();
-    spl::get_associated_token_address(
+    get_associated_token_address_with_program_id(
         wallet.solana_account().as_ref(),
         &mint,
         &get_account_owner(&mint).await,
@@ -175,30 +179,15 @@ pub async fn create_associated_token_account(
     let payer = wallet.solana_account();
     let mint = Pubkey::from_str(&mint_account).unwrap();
 
-    let (associated_token_account, instruction) = spl::create_associated_token_account_instruction(
+    let account_owner = get_account_owner(&mint).await;
+
+    let instruction = create_associated_token_account_idempotent(
         payer.as_ref(),
         payer.as_ref(),
         &mint,
-        &get_account_owner(&mint).await,
+        &account_owner,
     );
 
-    if let Some(_account) = client
-        .get_account_info(associated_token_account)
-        .with_encoding(GetAccountInfoEncoding::Base64)
-        .send()
-        .await
-        .expect_consistent()
-        .unwrap_or_else(|e| {
-            panic!("Call to `getAccountInfo` for {associated_token_account} failed: {e}")
-        })
-    {
-        ic_cdk::println!(
-            "[create_associated_token_account]: Account {} already exists. Skipping creation of associated token account",
-            associated_token_account
-        );
-        return associated_token_account.to_string();
-    }
-
     let message = Message::new_with_blockhash(
         &[instruction],
         Some(payer.as_ref()),
@@ -219,7 +208,7 @@ pub async fn create_associated_token_account(
         .expect("Call to `sendTransaction` failed")
         .to_string();
 
-    associated_token_account.to_string()
+    get_associated_token_address_with_program_id(payer.as_ref(), &mint, &account_owner).to_string()
 }
 
 #[update]
@@ -317,16 +306,11 @@ pub async fn send_spl_token(
 
     let token_program = get_account_owner(&mint).await;
 
-    let from = spl::get_associated_token_address(payer.as_ref(), &mint, &token_program);
-    let to = spl::get_associated_token_address(&recipient, &mint, &token_program);
+    let from = get_associated_token_address_with_program_id(payer.as_ref(), &mint, &token_program);
+    let to = get_associated_token_address_with_program_id(&recipient, &mint, &token_program);
 
-    let instruction = spl::transfer_instruction_with_program_id(
-        &from,
-        &to,
-        payer.as_ref(),
-        amount,
-        &token_program,
-    );
+    let instruction =
+        transfer_instruction_with_program_id(&from, &to, payer.as_ref(), amount, &token_program);
 
     let message = Message::new_with_blockhash(
         &[instruction],

examples/basic_solana/src/main.rs

@@ -0,0 +1,22 @@
+use solana_instruction::{AccountMeta, Instruction};
+use solana_pubkey::Pubkey;
+
+/// Creates an instruction to run the [`Transfer` instruction](https://github.com/solana-program/token/blob/main/interface/src/instruction.rs)
+/// in the SPL Token program.
+pub fn transfer_instruction_with_program_id(
+    source_address: &Pubkey,
+    destination_address: &Pubkey,
+    authority_address: &Pubkey,
+    amount: u64,
+    token_program_id: &Pubkey,
+) -> Instruction {
+    Instruction {
+        program_id: *token_program_id,
+        accounts: vec![
+            AccountMeta::new(*source_address, false),
+            AccountMeta::new(*destination_address, false),
+            AccountMeta::new_readonly(*authority_address, true),
+        ],
+        data: [vec![3], amount.to_le_bytes().to_vec()].concat(), // SPL token program "transfer" instruction
+    }
+}

examples/basic_solana/src/spl.rs

@@ -40,6 +40,7 @@ solana-signature = { workspace = true }
 solana-signer = { workspace = true }
 solana-transaction = { workspace = true }
 solana-transaction-status-client-types = { workspace = true }
+spl-associated-token-account-interface = { workspace = true }
 tokio = { workspace = true }
 url = { workspace = true }
 

examples/basic_solana/src/spl/mod.rs

@@ -25,7 +25,6 @@ use std::{
 };
 
 pub mod mock;
-pub mod spl;
 pub mod wallet;
 
 use mock::{MockOutcall, MockOutcallBuilder};