portalpayments/simple-transactions

Convert @solana/web3.js into human-readable transactions

Portal Simple Transactions

Portal's Simple Transactions convert @solana/web3.js transactions - the ParsedTransactionWithMeta objects you get from getTransactionsForAddress() into human-readable transactions suitable for consumption by front end apps.

The library is in TypeScript with minimal dependencies.

This is our production transaction parsing code used in Portal Wallet, we're releasing it for the first time here, so bear with us as we get it established as a standalone library!

Example

Before

A Solana ParsedTransactionWithMeta (you know what this looks like).

After

{
  id: "5e9xViaBigEX6G17PvHt9AizyJwRBHPdxCEkz2eLRYsanr53567SHzULhYT6zk63vbsZ4puN3WY7i5774HS7CneZ",
  date: 1669052844000,
  status: true,
  networkFee: 5000,
  direction: 0,
  amount: 5000000,
  currency: CURRENCY_MINT_ADDRESS,
  from: MIKES_WALLET,
  to: GREGS_WALLET,
  counterParty: GREGS_WALLET,
  memo: "Hey Greg! 🙋🏻‍♂️",
  receipt: null,
  swapAmount: null,
  swapCurrency: null,
}

Features

Portal's wallet is aimed principally at payments and spending, rather than exotic options trading, digital art, or other popular activities.

If you want to inspect transactions from on-chain programs that don't have their IDLs published or that aren't open-source, you should investigate Helius' Enhanced Transactions API

Portal Simple Transactions features include:

Summarizes a wide array of common payment transactions

Portal Simple Transactions handles and includes test transactions for Solana and SPL tokens, transactions that create wallets and transfer, transactions that just create wallets, transactions that just transfer, swaps, transfers with memos and notes, cyclical transfers that end up where they started, and more. You're welcome to add more! See the test-data directory.

direction - whether the user sent or recieved funds

'wallet A sent money to wallet B' isn't useful to end users. Users want to know whether they're getting or receiving money (or swapping their own tokens). When producing simple transactions, we take both a transaction and a user's wallet address to provide a direction from that wallet's point of view.

• 0 Send
• 1 Recieved
• 2 Swapped

counterParty - who you're dealing with.

So wallet A sent money to wallet B. Or wallet B sent money to wallet A. Either way, if you're wallet A, the person you're dealing with is wallet B. There's a counterParty field for this.

Details for swaps swapCurrency and swapAmount

Swap transactions include the source amount and currency.

memo - decoded note and memos

Solana transactions can have notes and note or memos - attached - little messages like 'thanks for the beer'. These are public, and you can use them like Venmo (as a public statement of what the transaction was for) or as a pointer to something private (like a receipt sent via wallet-to-wallet messaging).

Proper handling of money in amount, networkFee, swapAmount etc.

Our background is making trading apps. Because humans work in decimal, and computers work in binary, and because it's really hard to represent 0.1 in binary, money should always handled in minor units (like cents for USD, pence for GBP, wei for Ethereum, lamports for Solana). Portal Simple Transactions always uses whole numbers. We looked at other transaction summary tools and they send figures using decimal point numbers - these won't because other tools inevitably try and do maths with them and fail due to decimal / binary issues! Simple Transactions always uses whole numbers.

Experimental: itemised receipts for physical items

Portal Simple Transactions can show users what they purchased at retail, using Decaf point of sale:

This uses the Dialect SDK for wallet-to-wallet messaging. As walled-to-wallet messages are encrypted, you'll need user's the private key. This is considered experimental as:

• The message recieved in the users account doesn't actually have the Solana transaction included in it - so we have to use some fuzzy timestamp logic.
• You'll also need a CORS proxy to request the receipt from Decaf.

Tools to display crypto consistently with fiat

USDC has 9 decimal places. USD has two. In many cases, particularly when dealing with amounts more than 1 cent, it's useful to be able to display USDC in a manner consistent with USD.

Using getMajorAndMinor(), 2000000000 USDC is properly displayed as "2.00". 200000000 USDC is properly displayed as "0.20". You may even want to format it as something like 0.20

Usage

Get a simple transaction for a ParsedTransactionWithMeta

const portalSimpleTransaction = await summarizeTransaction(
  rawTransaction,
  new PublicKey('aWalletAddress')
);

Get simple transactions for multiple ParsedTransactionWithMetas

secretkey is only needed to read the users purchased items.

let transactionSummaries = await asyncMap(
  rawTransactions,
  (rawTransaction) => {
    return summarizeTransaction(
      rawTransaction,
      walletAddress,
      null,
      true,
      secretKey
    );
  }
);