[GraphQL]: Token-2022 Extension Instructions

[buffalojoec]

Motivation

Token-2022 extensions are live and gaining popularity on all clusters. The GraphQL library must offer support for these extension instructions within the schema.

• ConfidentialTransferFee
  • InitializeConfidentialTransferFeeConfig
  • WithdrawWithheldTokensFromMint
  • WithdrawWithheldTokensFromAccounts
  • HarvestWithheldTokensToMint
  • EnableHarvestToMint
  • DisableHarvestToMint
• ConfidentialTransfer
  • InitializeMint
  • UpdateMint
  • ConfigureAccount
  • ApproveAccount
  • EmptyAccount
  • Deposit
  • Withdraw
  • Transfer
  • ApplyPendingBalance
  • EnableConfidentialCredits
  • DisableConfidentialCredits
  • EnableNonConfidentialCredits
  • DisableNonConfidentialCredits
  • TransferWithSplitProofs
• CpiGuardInstruction
  • Enable
  • Disable
• DefaultAccountStateInstruction
  • Initialize
  • Update
• GroupMemberPointerInstruction
  • Initialize
  • Update
• GroupPointerInstruction
  • Initialize
  • Update
• InterestBearingMintInstruction
  • Initialize
  • Update
• RequiredMemoTransfersInstruction
  • Enable
  • Disable
• MetadataPointerInstruction
  • Initialize
  • Update
• InitializeMintCloseAuthority
• InitializePermanentDelegate
• Reallocate
• TokenGroupInstruction
  • InitializeGroup
  • UpdateGroupMaxSize
  • UpdateGroupAuthority
  • InitializeMember
• TokenMetadataInstruction
  • Initialize
  • UpdateField
  • RemoveKey
  • UpdateAuthority
  • Emit
• TransferFeeInstruction
  • InitializeTransferFeeConfig
  • TransferCheckedWithFee
  • WithdrawWithheldTokensFromMint
  • WithdrawWithheldTokensFromAccounts
  • HarvestWithheldTokensToMint
• TransferHookInstruction
  • Initialize
  • Update

[Hrushi20]

Hey! I'm interested in working on this issue. Can I get more context on getting started?

[buffalojoec]

Basically we need to add schema support for Token-2022 extensions. These will appear in a JSON-parsed instruction from an RPC-retrieved transaction or block.

I've marked a little placeholder in the instructions schema module where they can live:

solana-web3.js/packages/rpc-graphql/src/schema/instruction.ts

Lines 515 to 529 in acd929d

	# TODO: Extensions!
	# - TransferFeeExtension
	# - ConfidentialTransferFeeExtension
	# - DefaultAccountStateExtension
	# - Reallocate
	# - MemoTransferExtension
	# - CreateNativeMint
	# - InitializeNonTransferableMint
	# - InterestBearingMintExtension
	# - CpiGuardExtension
	# - InitializePermanentDelegate
	# - TransferHookExtension
	# - ConfidentialTransferFeeExtension
	# - WithdrawExcessLamports
	# - MetadataPointerExtension

I think the easiest way to roll each of these is to grab their layouts from the Solana Transaction Status crate:
https://github.com/anza-xyz/agave/blob/master/transaction-status/src/parse_token.rs

That file should have all the Token-2022 extensions that are parseable by the RPC's JSON-parsed, and we can just adapt them into GraphQL schema types!

The tricky bit is going to be querying the RPC manually (likely via CLI or something) and finding transaction payloads that have some of these instructions and using them in tests. You can just copy-paste them into the __setup__ module as we've done already:
https://github.com/solana-labs/solana-web3.js/blob/master/packages/rpc-graphql/src/__tests__/__setup__.ts

[Hrushi20]

Looking into it.

[Hrushi20]

Hey! I was going through transfer_fee.rs file. I see that mint field is stored as a String in json. In rpc-grpc module, in some places mint is used as Account type.. Not sure what is the right data type to use

Edit:
Or Should the type of mint be address?

[buffalojoec]

Hey! I was going through transfer_fee.rs file. I see that mint field is stored as a String in json. In rpc-grpc module, in some places mint is used as Account type.. Not sure what is the right data type to use

Edit: Or Should the type of mint be address?

So, with the way the GraphQL schema is configured, we can choose to use Account where the RPC would otherwise place an address. This allows queries to embed an account query on that address.

In other words, if initializeTransferFeeConfig comes back with:

mint: 'BrdbK35MgB3keCWx87eMpWf5v1QudW9vddxyH2Hb2m5r'

You could do something like:

query notARealQuery {
  transaction(signature: '5UJYEYLqHrdmnMU546Gs3Tj6PTnWPpwjarYAcG7Fp165PTnWPpwjarYAcG7Fp165') {
    instructions {
       ... on TransferFeeInitializeTransferFeeConfig {
         mint {
            lamports
            # More fields from `Account`...
            ... on MintAccount {
              supply
              # More fields from `MintAccount`...
            }
         }
       }
    }
  }
}

Note this only works if you add the field to the schema's resolver!

solana-web3.js/packages/rpc-graphql/src/resolvers/instruction.ts

Line 128 in f9ddff5

mint: resolveAccount('mint'),

[Hrushi20]

I'm unable to tick the checkbox in the PR.

[nasjuice]

I believe InitializeMint has been done for ConfidentialTransfer

solana-web3.js/packages/rpc-graphql/src/schema/instruction.ts

Line 745 in d275ba6

SplToken-2022: InitializeConfidentialTransferMint instruction

[nasjuice]

Also just noticed this

solana-web3.js/packages/rpc-graphql/src/schema/instruction.ts

Line 626 in 16bb0b8

maximumFee: Int

I believe that should be a BigInt since it is a u64
https://github.com/anza-xyz/agave/blob/a645d07e06a5b2da8076539d5799a5087c5cff52/transaction-status/src/parse_token/extension/transfer_fee.rs#L21

[buffalojoec]

Also just noticed this

solana-web3.js/packages/rpc-graphql/src/schema/instruction.ts

Line 626 in 16bb0b8

maximumFee: Int

I believe that should be a BigInt since it is a u64

https://github.com/anza-xyz/agave/blob/a645d07e06a5b2da8076539d5799a5087c5cff52/transaction-status/src/parse_token/extension/transfer_fee.rs#L21

Thanks I'll look into this. I think all Int fields in the instructions may need to become BigInt, but I can make that change.

[buffalojoec]

@Hrushi20 @nasjuice Hey guys, let's make sure to use the type aliases, such as Slot, Epoch and Lamports wherever appropriate.

I've added more of them in this PR: #2634.

[buffalojoec]

@Hrushi20 @nasjuice Thank you both for an awesome effort and hammering out all of these extensions!! I'll be sure to shout you guys out in the release.

If there's anything else you're interested in working on, feel free to tag me and ask any questions. As I continue to build the GraphQL demo application, I'll uncover more issues and things that need to be done in the GraphQL library.

The repository is public, and if you have ideas on stuff you want to add/showcase in the demo app, go ahead and dive in! Maybe we can work in the issues here, and over there as well!

https://github.com/buffalojoec/graphql-wallet

[github-actions]

Because there has been no activity on this issue for 7 days since it was closed, it has been automatically locked. Please open a new issue if it requires a follow up.