Support associated token for JS (Also, make the program testable) #1364

ryoqun · 2021-03-02T13:23:53Z

Problem

There is no easy way of accessing associated tokens from JS land

Changes

Support them
Also, make testing more robust including ./program's NFC modifications.

token/js/client/token.js

jstarry · 2021-03-02T14:16:16Z

Unfortunately the type definitions in module.d.ts and module.flow.js have to be manually written for now. Hope to make this better soon after doing it for web3.js here: solana-labs/solana#15484

token/js/client/token.js

ryoqun · 2021-03-02T15:54:36Z

associated-token-account/program/src/processor.rs

@@ -41,7 +43,7 @@ pub fn process_instruction(

    let associated_token_account_signer_seeds: &[&[_]] = &[
        &wallet_account_info.key.to_bytes(),
-        &spl_token::id().to_bytes(),


So, spl-associated-program wrongly assumed spl_token isn't position-independent-code; but it actually IS. spent some time to debug... I suspected myself.. It turned out I needed these program changes... my js was correct. lol

ryoqun · 2021-03-03T02:54:59Z

ci/js-test-token.sh

@@ -10,5 +10,6 @@ npm install
 npm run lint
 npm run flow
 npm run defs
+npm run test


argh, so these aren't running properly?: https://github.com/solana-labs/solana-program-library/pull/1364/files#diff-4c840378b893bfac59f5aeba8c8933d67df2080e4254f22a9330b1808d15e00dR35

ryoqun · 2021-03-03T08:41:54Z

associated-token-account/program/src/lib.rs

-            &spl_token::id().to_bytes(),
-            &spl_token_mint_address.to_bytes(),
-        ],
+    get_associated_token_address_and_bump_seed_internal(


I believe these and following ./program diffs should absolutely have no-functional-changes. :)

Well, associated token program actually gets more flexible because it will not error for non-Tokenkeg program id's. But I think that's a nice change :) Do you mind adding the program change details to the PR title and description for posterity?

yeah, that's right. I meant in the context of real production environment (mainnet-beta). :)

Also, the subtlety is that deployed program and this helper get_associated_token_address are still hard-coded to the Tokenkeg program id...

Ah, I thought you planned to deploy an update to associated token program at some point. Are the program changes just for local testing then?

@jstarry According to this (https://explorer.solana.com/address/ATokenGPvbdGVxr1b2hvZbsiqW5xWH25efTNsLJA8knL), the associated token program isn't upgradable? ;) I wonder it's worth side-loading it... Also, I came up with some niceties: #1371

ryoqun · 2021-03-03T08:42:49Z

token/js/cli/token-test.js

    console.log(
-      '  Note: To reload program remove client/util/store/config.json',


no hard-coding, please. :)

ryoqun · 2021-03-03T08:43:31Z

token/js/cli/token-test.js

+    info = await connection.getAccountInfo(programId);
+    assert(info != null);
+    info = await connection.getAccountInfo(associatedProgramId);
+    assert(info != null);


some extra check for stale caches (where associated programs aren't loaded.)

ryoqun · 2021-03-03T08:44:52Z

token/js/client/token.js

+  /**
+   * The address of this account
+   */
+  address: PublicKey,


I needed this. Othwerwise, getOrCreateAssociatedAccountInfo is too cumbersome to use.

ryoqun · 2021-03-03T08:46:43Z

token/js/client/token.js

+   * @param owner User account that will own the new account
+   * @return Public key of the new associated account
+   */
+  async getOrCreateAssociatedAccountInfo(


Some must-to-have helper.. I realized doing right like this is too hard for most of partners, I think...

Yes, this is super useful!

ryoqun · 2021-03-03T08:48:58Z

token/js/cli/token-test.js

+  associatedAccount = await testToken.getOrCreateAssociatedAccountInfo(dest);
+  assert(associatedAccount.amount.toNumber() === 0);
+
+  await testToken.transferChecked(
+    testAccount,
+    associatedAccount.address,
+    testAccountOwner,
+    [],
+    123,
+    testTokenDecimals,
+  );
+
+  associatedAccount = await testToken.getOrCreateAssociatedAccountInfo(dest);
+  assert(associatedAccount.amount.toNumber() === 123);


thanks to https://github.com/solana-labs/solana-program-library/pull/1364/files#r586222243, this is so simple for api users. :)

jstarry · 2021-03-03T09:06:03Z

token/js/client/token.js

+    try {
+      return await this.getAccountInfo(associatedAddress);
+    } catch (err) {
+      if (err.message == FAILED_TO_FIND_ACCOUNT) {


I think it's worth handling the Invalid account owner error as well because otherwise, partners won't be able to create associated token accounts for addresses that receive small lamport transfers

yeah, another reason we need to publish this helper in this library. Too hard to write correct. ;)

jstarry

@ryoqun very useful work! looks great

token/js/module.flow.js

token/js/client/token.js

jstarry · 2021-03-03T09:22:23Z

token/js/client/token.js

+   * @param owner User account that will own the new account
+   * @return Public key of the new associated account
+   */
+  async getOrCreateAssociatedAccountInfo(


Yes, this is super useful!

token/js/client/token.js

jstarry · 2021-03-03T09:28:53Z

associated-token-account/program/src/lib.rs

-            &spl_token::id().to_bytes(),
-            &spl_token_mint_address.to_bytes(),
-        ],
+    get_associated_token_address_and_bump_seed_internal(


Well, associated token program actually gets more flexible because it will not error for non-Tokenkeg program id's. But I think that's a nice change :) Do you mind adding the program change details to the PR title and description for posterity?

jstarry · 2021-03-03T09:33:20Z

Can you also please bump the version in token/js/package.json?

ryoqun · 2021-03-03T09:39:22Z

token/js/client/token.js

+   * @return Public key of the new associated account
+   */
+  async getOrCreateAssociatedAccountInfo(
+    owner: PublicKey,


btw, I thought about checking the owner to avoid nested associated tokens like this: https://explorer.solana.com/address/7RyJpfyH38Vi5PcnNp4Nmiikc1dnXKv3WFXFY5GoC3Nm

But, the check would need extra rpc round-trip...

Yeah, it's gross. Anything can be the owner of a token account, including tokens haha. I think it's better to leave that out, some day tokens owning tokens will probably be a feature that someone wants 😉

Pull request has been modified.

ryoqun · 2021-03-03T10:58:48Z

Can you also please bump the version in token/js/package.json?

@jstarry Like this? 6e12b37

ryoqun · 2021-03-03T11:02:23Z

token/js/client/token.js

+      // Assuming program derived addressing is safe, this is the only case
+      // for the INVALID_ACCOUNT_OWNER in this code-path
+      if (
+        err.message === FAILED_TO_FIND_ACCOUNT ||


(small fyi: btw because we take no user-provided callbacks, this is safe; otherwise, we must guard against throw undefined, iirc; nasty JavaScript... lol)

Implement some js helpers for associated tokens

da3765f

ryoqun requested a review from jstarry March 2, 2021 13:23