feat: add support for getTransaction RPC method

Cargo.toml

@@ -73,10 +73,13 @@ solana-message = "2.2.0"
 solana-nonce = "2.2.0"
 solana-program = "2.2.0"
 solana-pubkey = "2.2.0"
+solana-reward-info = "2.2.0"
 solana-rpc-client-api = "2.2.0"
 solana-signature = "2.2.0"
 solana-signer = "2.2.0"
 solana-transaction = "2.2.0"
+solana-transaction-context = "2.2.0"
+solana-transaction-error = "2.2.0"
 solana-transaction-status-client-types = "2.2.0"
 strum = { version = "0.27.0", features = ["derive"] }
 thiserror = "2.0.12"
@@ -103,9 +106,12 @@ solana-message = { git = "https://github.com/dfinity/agave", tag = "323039e-js-f
 solana-nonce = { git = "https://github.com/dfinity/agave", tag = "323039e-js-feature-flag" }
 solana-program = { git = "https://github.com/dfinity/agave", tag = "323039e-js-feature-flag" }
 solana-pubkey = { git = "https://github.com/dfinity/agave", tag = "323039e-js-feature-flag" }
+solana-reward-info = { git = "https://github.com/dfinity/agave", tag = "323039e-js-feature-flag" }
 solana-rpc-client-api = { git = "https://github.com/dfinity/agave", tag = "323039e-js-feature-flag" }
 solana-signer = { git = "https://github.com/dfinity/agave", tag = "323039e-js-feature-flag" }
 solana-signature = { git = "https://github.com/dfinity/agave", tag = "323039e-js-feature-flag" }
 solana-transaction = { git = "https://github.com/dfinity/agave", tag = "323039e-js-feature-flag" }
+solana-transaction-context = { git = "https://github.com/dfinity/agave", tag = "323039e-js-feature-flag" }
+solana-transaction-error = { git = "https://github.com/dfinity/agave", tag = "323039e-js-feature-flag" }
 solana-transaction-status-client-types = { git = "https://github.com/dfinity/agave", tag = "323039e-js-feature-flag" }
 solana-system-interface = { git = "https://github.com/lpahlavi/solana-program-system.git" }

canister/Cargo.toml

@@ -48,7 +48,7 @@ serde_with = { workspace = true }
 candid_parser = { workspace = true }
 proptest = { workspace = true }
 solana-pubkey = { workspace = true }
-solana-rpc-client-api = { workspace = true }
+solana-signature = { workspace = true }
 
 [features]
 # WARNING: Disabling this feature will lead to some functionality not working anymore

canister/scripts/examples.sh

@@ -22,7 +22,8 @@ GET_SLOT_PARAMS="(
   opt record { minContextSlot = null; commitment = opt variant { finalized } },
 )"
 CYCLES=$(dfx canister call sol_rpc getSlotCyclesCost "$GET_SLOT_PARAMS" $FLAGS --output json | jq '.Ok' --raw-output || exit 1)
-SLOT=$(dfx canister call sol_rpc getSlot "$GET_SLOT_PARAMS" $FLAGS --with-cycles "$CYCLES" --output json | jq '.Consistent.Ok' --raw-output || exit 1)
+GET_SLOT_OUTPUT=$(dfx canister call sol_rpc getSlot "$GET_SLOT_PARAMS" $FLAGS --output json --with-cycles "$CYCLES" || exit 1)
+SLOT=$(jq --raw-output '.Consistent.Ok' <<< "$GET_SLOT_OUTPUT")
 
 # Fetch the latest finalized block
 GET_BLOCK_PARAMS="(
@@ -36,11 +37,32 @@ GET_BLOCK_PARAMS="(
   record {
     slot = ${SLOT};
     commitment = opt variant { finalized };
+    transactionDetails = opt variant { signatures };
     maxSupportedTransactionVersion = null;
   },
 )"
 CYCLES=$(dfx canister call sol_rpc getBlockCyclesCost "$GET_BLOCK_PARAMS" $FLAGS --output json | jq '.Ok' --raw-output || exit 1)
-dfx canister call sol_rpc getBlock "$GET_BLOCK_PARAMS" $FLAGS --with-cycles "$CYCLES" || exit 1
+GET_BLOCK_OUTPUT=$(dfx canister call sol_rpc getBlock "$GET_BLOCK_PARAMS" $FLAGS --output json --with-cycles "$CYCLES" || exit 1)
+SIGNATURE=$(jq --raw-output '.Consistent.Ok[0].signatures[0][0]' <<< "$GET_BLOCK_OUTPUT")
+
+# Fetch the first transaction in the retrieved block
+GET_TRANSACTION_PARAMS="(
+  variant { Default = variant { Mainnet } },
+  opt record {
+    responseConsensus = opt variant {
+      Threshold = record { min = 2 : nat8; total = opt (3 : nat8) }
+    };
+    responseSizeEstimate = null;
+  },
+  record {
+    signature = \"${SIGNATURE}\";
+    commitment = opt variant { finalized };
+    encoding = opt variant{ base64 };
+    maxSupportedTransactionVersion = null;
+  },
+)"
+CYCLES=$(dfx canister call sol_rpc getTransactionCyclesCost "$GET_TRANSACTION_PARAMS" $FLAGS --output json | jq '.Ok' --raw-output || exit 1)
+dfx canister call sol_rpc getTransaction "$GET_TRANSACTION_PARAMS" $FLAGS --with-cycles "$CYCLES" || exit 1
 
 # TODO XC-339: Add end-to-end test for `sendTransaction` using `getSlot` and `getBlock`
 

canister/sol_rpc_canister.did

@@ -189,6 +189,14 @@ type GetAccountInfoParams = record {
 // Example: "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v"
 type Pubkey = text;
 
+// Ed25519 signature as a base-58 encoded string.
+// Example: "5LrcE2f6uvydKRquEJ8xp19heGxSvqsVbcqUeFoiWbXe8JNip7ftPQNTAVPyTK7ijVdpkzmKKaAQR7MWMmujAhXD"
+type Signature = text;
+
+// A Solana blockhash as a bse58-encoded string.
+// Example: "DzfXchZJoLMG3cNftcf2sw7qatkkuwQf4xH15N5wkKAb"
+type Blockhash = text;
+
 // Solana account info.
 type AccountInfo = record {
     // Number of lamports assigned to this account.
@@ -241,6 +249,15 @@ type AccountEncoding = variant {
     jsonParsed;
 };
 
+// The parameters for a Solana `getTransaction` RPC method call.
+// TODO XC-293: documentation
+type GetTransactionParams = record {
+    signature: Signature;
+    commitment: opt CommitmentLevel;
+    maxSupportedTransactionVersion: opt nat8;
+    encoding: opt variant { base58; base64 };
+};
+
 // The parameters for a Solana `sendTransaction` RPC method call.
 type SendTransactionParams = record {
     // Fully-signed transaction, as encoded string.
@@ -283,6 +300,9 @@ type MultiGetAccountInfoResult = variant {
 type GetBlockParams = record {
     // Slot number of the block to fetch.
     slot: Slot;
+    // Specifies what transaction details to include in the response.
+    // If this field is not specified, the default value of "none" will be used.
+    transactionDetails: opt TransactionDetails;
     // The commitment describes how finalized a block is at that point in time.
     commitment: opt variant { confirmed; finalized };
     // The max transaction version to return in responses.
@@ -303,15 +323,18 @@ type Timestamp = int64;
 type ConfirmedBlock = record {
     // The blockhash of this block's parent, as base-58 encoded string; if the parent block is not
     // available due to ledger cleanup, this field will return "11111111111111111111111111111111".
-    previousBlockhash: text;
+    previousBlockhash: Blockhash;
     // The blockhash of this block, as base-58 encoded string.
-    blockhash: text;
+    blockhash: Blockhash;
     // The slot index of this block's parent.
     parentSlot: nat64;
     // Estimated production time.
     blockTime: opt Timestamp;
     // The number of blocks beneath this block.
     blockHeight: opt nat64;
+    // The signatures of the transactions in this block. Included if the request parameter `transactionDetails` is not
+    // `none`.
+    signatures: opt vec Signature;
 };
 
 // Represents the result of a call to the `getBlock` Solana RPC method.
@@ -324,6 +347,172 @@ type MultiGetBlockResult = variant {
     Inconsistent : vec record { RpcSource; GetBlockResult };
 };
 
+// TODO XC-293: Format and add documentation
+type CompiledInstruction = record {
+  data : text;
+  accounts : blob;
+  programIdIndex : nat8;
+  stackHeight : opt nat32;
+};
+type EncodedTransaction = variant {
+  Binary : record { text; variant { base58; base64 } };
+  LegacyBinary : text;
+};
+type Instruction = variant { Compiled : CompiledInstruction };
+type InnerInstructions = record {
+  instructions : vec Instruction;
+  index : nat8;
+};
+type InstructionError = variant {
+  ModifiedProgramId;
+  CallDepth;
+  Immutable;
+  GenericError;
+  ExecutableAccountNotRentExempt;
+  IncorrectAuthority;
+  PrivilegeEscalation;
+  ReentrancyNotAllowed;
+  InvalidInstructionData;
+  RentEpochModified;
+  IllegalOwner;
+  ComputationalBudgetExceeded;
+  ExecutableDataModified;
+  ExecutableLamportChange;
+  UnbalancedInstruction;
+  ProgramEnvironmentSetupFailure;
+  IncorrectProgramId;
+  UnsupportedSysvar;
+  UnsupportedProgramId;
+  AccountDataTooSmall;
+  NotEnoughAccountKeys;
+  AccountBorrowFailed;
+  InvalidRealloc;
+  AccountNotExecutable;
+  AccountNotRentExempt;
+  Custom : nat32;
+  AccountDataSizeChanged;
+  MaxAccountsDataAllocationsExceeded;
+  ExternalAccountLamportSpend;
+  ExternalAccountDataModified;
+  MissingAccount;
+  ProgramFailedToComplete;
+  MaxInstructionTraceLengthExceeded;
+  InvalidAccountData;
+  ProgramFailedToCompile;
+  ExecutableModified;
+  InvalidAccountOwner;
+  MaxSeedLengthExceeded;
+  AccountAlreadyInitialized;
+  AccountBorrowOutstanding;
+  ReadonlyDataModified;
+  UninitializedAccount;
+  InvalidArgument;
+  BorshIoError : text;
+  BuiltinProgramsMustConsumeComputeUnits;
+  MissingRequiredSignature;
+  DuplicateAccountOutOfSync;
+  MaxAccountsExceeded;
+  ArithmeticOverflow;
+  InvalidError;
+  InvalidSeeds;
+  DuplicateAccountIndex;
+  ReadonlyLamportChange;
+  InsufficientFunds;
+};
+type LoadedAddresses = record { writable : vec Pubkey; readonly : vec Pubkey };
+type Reward = record {
+  lamports : int64;
+  commission : opt nat8;
+  pubkey : Pubkey;
+  rewardType : opt variant { Fee; Rent; Voting; Staking };
+  postBalance : nat64;
+};
+type TokenAmount = record {
+  decimals : nat8;
+  uiAmount : opt float64;
+  uiAmountString : text;
+  amount : text;
+};
+type TransactionDetails = variant { none; signatures };
+type TransactionError = variant {
+  ProgramCacheHitMaxLimit;
+  InvalidAccountForFee;
+  AddressLookupTableNotFound;
+  MissingSignatureForFee;
+  WouldExceedAccountDataBlockLimit;
+  AccountInUse;
+  DuplicateInstruction : nat8;
+  AccountNotFound;
+  TooManyAccountLocks;
+  InvalidAccountIndex;
+  AlreadyProcessed;
+  WouldExceedAccountDataTotalLimit;
+  InvalidAddressLookupTableIndex;
+  SanitizeFailure;
+  ResanitizationNeeded;
+  InvalidRentPayingAccount;
+  MaxLoadedAccountsDataSizeExceeded;
+  InvalidAddressLookupTableData;
+  InvalidWritableAccount;
+  WouldExceedMaxAccountCostLimit;
+  InvalidLoadedAccountsDataSizeLimit;
+  InvalidProgramForExecution;
+  InstructionError : record { nat8; InstructionError };
+  InsufficientFundsForRent : record { account_index : nat8 };
+  UnsupportedVersion;
+  ClusterMaintenance;
+  WouldExceedMaxVoteCostLimit;
+  SignatureFailure;
+  ProgramAccountNotFound;
+  AccountLoadedTwice;
+  ProgramExecutionTemporarilyRestricted : record { account_index : nat8 };
+  AccountBorrowOutstanding;
+  WouldExceedMaxBlockCostLimit;
+  InvalidAddressLookupTableOwner;
+  InsufficientFundsForFee;
+  CallChainTooDeep;
+  UnbalancedTransaction;
+  CommitCancelled;
+  BlockhashNotFound;
+};
+type TransactionInfo = record {
+  blockTime : opt Timestamp;
+  meta : opt TransactionStatusMeta;
+  transaction : EncodedTransaction;
+  slot : nat64;
+  version : opt variant { Legacy; Number : nat8 };
+};
+type TransactionStatusMeta = record {
+  fee : nat64;
+  status : variant { Ok; Err: TransactionError };
+  innerInstructions : opt vec InnerInstructions;
+  postTokenBalances : opt vec TransactionTokenBalance;
+  preBalances : vec nat64;
+  postBalances : vec nat64;
+  returnData : opt record { data : text; programId : Pubkey };
+  logMessages : opt vec text;
+  rewards : opt vec Reward;
+  loadedAddresses : opt LoadedAddresses;
+  preTokenBalances : opt vec TransactionTokenBalance;
+  computeUnitsConsumed : opt nat64;
+};
+type TransactionTokenBalance = record {
+  owner : opt Pubkey;
+  mint : text;
+  programId : opt Pubkey;
+  accountIndex : nat8;
+  uiTokenAmount : TokenAmount;
+};
+
+// Represents the result of a call to the `getTransaction` Solana RPC method.
+type GetTransactionResult = variant { Ok : opt TransactionInfo; Err : RpcError };
+
+// Represents an aggregated result from multiple RPC calls to the `getTransaction` Solana RPC method.
+type MultiGetTransactionResult = variant {
+    Consistent : GetTransactionResult;
+    Inconsistent : vec record { RpcSource; GetTransactionResult };
+};
+
 // Represents a Solana slot
 type Slot = nat64;
 
@@ -336,11 +525,8 @@ type MultiGetSlotResult = variant {
     Inconsistent : vec record { RpcSource; GetSlotResult };
 };
 
-// First transaction signature embedded in the transaction, as base-58 encoded string.
-type TransactionId = text;
-
 // Represents the result of a call to the `sendTransaction` Solana RPC method.
-type SendTransactionResult = variant { Ok : TransactionId; Err : RpcError };
+type SendTransactionResult = variant { Ok : Signature; Err : RpcError };
 
 // Represents an aggregated result from multiple RPC calls to the `sendTransaction` Solana RPC method.
 type MultiSendTransactionResult = variant {
@@ -435,6 +621,10 @@ service : (InstallArgs,) -> {
   getSlot : (RpcSources, opt GetSlotRpcConfig, opt GetSlotParams) -> (MultiGetSlotResult);
   getSlotCyclesCost : (RpcSources, opt GetSlotRpcConfig, opt GetSlotParams) -> (RequestCostResult) query;
 
+  // Call the Solana `getTransaction` RPC method and return the resulting slot.
+  getTransaction : (RpcSources, opt RpcConfig, GetTransactionParams) -> (MultiGetTransactionResult);
+  getTransactionCyclesCost : (RpcSources, opt RpcConfig, GetTransactionParams) -> (RequestCostResult) query;
+
   // Call the Solana `sendTransaction` RPC method and return the resulting transaction ID.
   sendTransaction : (RpcSources, opt RpcConfig, SendTransactionParams) -> (MultiSendTransactionResult);
   sendTransactionCyclesCost : (RpcSources, opt RpcConfig, SendTransactionParams) -> (RequestCostResult) query;