chore: fixed-price upgrade spl-token dep to 0.2.0 (metaplex-foundation#304)

thlorenz · web-flow · commit 45a97b2edbfd · 2022-03-11T19:55:22.000-06:00
* token-vault: update to use new spl-token API

* token-metadata: move test consts to avoid circular ref

* token-metadata: update to new spl-token API

* deps: upgrade spl-token to latest except for fixed-price and core

- we had linked it so far to adapt API
- core is using this library only for `TokenAccount` wrapper
- TokenAccount wrapper is only used by fixed-price at this point and by
  token-metadata but only until the SDK is revamped (which is WIP)

* core: deprecated TokenAcccount and remove spl dep

* metaplex: replace type + const removed from token-vault

* fixed-price: add mpl-core dep

* fixed-price: fix type error in test helper

* fixed-price: remove extranous parameter for test transaction

* fixed-price: removed unneeded `await`s in test transactions

* fixed-price: adding test and test-utils updates (currently some failing)

* fixed-price: upgrade spl-token package and annotate invalid type errors

* nit: removing stray todo comment which was fixed
diff --git a/fixed-price-sale/js/package.json b/fixed-price-sale/js/package.json
@@ -41,7 +41,7 @@
     "@metaplex-foundation/beet": "^0.0.8",
     "@metaplex-foundation/beet-solana": "^0.0.6",
     "@metaplex-foundation/mpl-core": "^0.0.5",
-    "@solana/spl-token": "^0.1.8",
+    "@solana/spl-token": "^0.2.0",
     "@solana/web3.js": "^1.35.1"
   },
   "devDependencies": {
diff --git a/fixed-price-sale/js/test/actions/createMintAccount.ts b/fixed-price-sale/js/test/actions/createMintAccount.ts
@@ -1,5 +1,7 @@
 import { strict as assert } from 'assert';
-import { MintLayout, Token, TOKEN_PROGRAM_ID } from '@solana/spl-token';
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore createInitializeMintInstruction export actually exist but isn't setup correctly
+import { createInitializeMintInstruction, MintLayout, TOKEN_PROGRAM_ID } from '@solana/spl-token';
 import {
   Connection,
   Keypair,
@@ -40,8 +42,7 @@ export class CreateMint extends Transaction {
     );
 
     this.add(
-      Token.createInitMintInstruction(
-        TOKEN_PROGRAM_ID,
+      createInitializeMintInstruction(
         newAccountPubkey,
         decimals ?? 0,
         owner ?? feePayer,
diff --git a/fixed-price-sale/js/test/actions/initSellingResource.ts b/fixed-price-sale/js/test/actions/initSellingResource.ts
@@ -104,7 +104,6 @@ export const initSellingResource = async ({
 
   const { savePrimaryMetadataCreatorsInstruction, primaryMetadataCreators } =
     await createSavePrimaryMetadataCreators({
-      test,
       transactionHandler,
       payer,
       connection,
diff --git a/fixed-price-sale/js/test/actions/mintNft.ts b/fixed-price-sale/js/test/actions/mintNft.ts
@@ -12,7 +12,9 @@ import {
   CreateMasterEdition,
   Creator,
 } from '@metaplex-foundation/mpl-token-metadata';
-import { Token, TOKEN_PROGRAM_ID } from '@solana/spl-token';
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore createMintToInstruction export actually exist but isn't setup correctly
+import { createMintToInstruction } from '@solana/spl-token';
 import { strict as assert } from 'assert';
 
 import { createTokenAccount } from '../transactions/createTokenAccount';
@@ -47,14 +49,7 @@ export async function mintNFT({ transactionHandler, payer, connection, creators
   });
 
   createTokenTx.add(
-    Token.createMintToInstruction(
-      new PublicKey(TOKEN_PROGRAM_ID),
-      mint.publicKey,
-      tokenAccount.publicKey,
-      payer.publicKey,
-      [],
-      1,
-    ),
+    createMintToInstruction(mint.publicKey, tokenAccount.publicKey, payer.publicKey, 1),
   );
 
   const associatedTokenAccountRes = await transactionHandler.sendAndConfirmTransaction(
diff --git a/fixed-price-sale/js/test/actions/mintTokenToAccount.ts b/fixed-price-sale/js/test/actions/mintTokenToAccount.ts
@@ -1,5 +1,7 @@
 import { Connection, PublicKey, Transaction } from '@solana/web3.js';
-import { Token, TOKEN_PROGRAM_ID } from '@solana/spl-token';
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore createMintToInstruction export actually exist but isn't setup correctly
+import { createMintToInstruction } from '@solana/spl-token';
 import { defaultSendOptions, TransactionHandler } from '@metaplex-foundation/amman';
 
 import { CreateMint } from './createMintAccount';
@@ -30,16 +32,7 @@ export const mintTokenToAccount = async ({
 
   tx.add(createTokenTx);
 
-  tx.add(
-    Token.createMintToInstruction(
-      new PublicKey(TOKEN_PROGRAM_ID),
-      mint.publicKey,
-      associatedTokenAccount.publicKey,
-      payer,
-      [],
-      1,
-    ),
-  );
+  tx.add(createMintToInstruction(mint.publicKey, associatedTokenAccount.publicKey, payer, 1));
 
   await transactionHandler.sendAndConfirmTransaction(
     tx,
diff --git a/fixed-price-sale/js/test/claimResource.test.ts b/fixed-price-sale/js/test/claimResource.test.ts
@@ -1,6 +1,8 @@
 import BN from 'bn.js';
 import test from 'tape';
-import { ASSOCIATED_TOKEN_PROGRAM_ID, Token, TOKEN_PROGRAM_ID } from '@solana/spl-token';
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore these exports actually exist but aren't setup correctly
+import { getAccount, getAssociatedTokenAddress } from '@solana/spl-token';
 import {
   assertConfirmedTransaction,
   assertError,
@@ -163,12 +165,7 @@ test('claim resource: success', async (t) => {
     payer.publicKey,
   );
 
-  const destination = await Token.getAssociatedTokenAddress(
-    ASSOCIATED_TOKEN_PROGRAM_ID,
-    TOKEN_PROGRAM_ID,
-    treasuryMint.publicKey,
-    payer.publicKey,
-  );
+  const destination = await getAssociatedTokenAddress(treasuryMint.publicKey, payer.publicKey);
 
   const metadata = await Metadata.getPDA(resourceMint.publicKey);
 
@@ -231,8 +228,7 @@ test('claim resource: success', async (t) => {
 
   assertConfirmedTransaction(t, claimResourceRes.txConfirmed);
 
-  const token = new Token(connection, resourceMint.publicKey, TOKEN_PROGRAM_ID, payer);
-  const createdToken = await token.getAccountInfo(claimToken.publicKey);
+  const createdToken = await getAccount(connection, claimToken.publicKey);
 
   t.assert(createdToken.mint.toBase58() === resourceMint.publicKey.toBase58());
   t.assert(createdToken.owner.toBase58() === payer.publicKey.toBase58());
diff --git a/fixed-price-sale/js/test/transactions/buy.ts b/fixed-price-sale/js/test/transactions/buy.ts
@@ -44,7 +44,7 @@ export const createBuyTransaction = async ({
   newMintMetadata,
   newTokenAccount,
 }: BuyParams) => {
-  const instruction = await createBuyInstruction(
+  const instruction = createBuyInstruction(
     {
       // buyer wallet
       userWallet: buyer,
diff --git a/fixed-price-sale/js/test/transactions/claimResource.ts b/fixed-price-sale/js/test/transactions/claimResource.ts
@@ -28,7 +28,7 @@ export const createClaimResourceTransaction = async ({
   vaultOwnerBump,
   owner,
 }: ClaimResourceParams): Promise<Transaction> => {
-  const instruction = await createClaimResourceInstruction(
+  const instruction = createClaimResourceInstruction(
     {
       market,
       treasuryHolder,
diff --git a/fixed-price-sale/js/test/transactions/createSavePrimaryMetadataCreators.ts b/fixed-price-sale/js/test/transactions/createSavePrimaryMetadataCreators.ts
@@ -1,12 +1,10 @@
-import test from 'tape';
 import { PayerTransactionHandler } from '@metaplex-foundation/amman';
 import { Connection, Keypair, PublicKey, TransactionInstruction } from '@solana/web3.js';
 
 import { CreatorAccountData, findPrimaryMetadataCreatorsAddress } from '../../src';
 import { createSavePrimaryMetadataCreatorsInstruction } from '../../src/generated/instructions/savePrimaryMetadataCreators';
 
 type CreateSecondaryMetadataCreatorsParams = {
-  test: test.Test;
   transactionHandler: PayerTransactionHandler;
   payer: Keypair;
   connection: Connection;
diff --git a/fixed-price-sale/js/test/transactions/createTokenAccount.ts b/fixed-price-sale/js/test/transactions/createTokenAccount.ts
@@ -1,5 +1,11 @@
 import { Connection, Keypair, PublicKey, SystemProgram, Transaction } from '@solana/web3.js';
-import { AccountLayout, Token, TOKEN_PROGRAM_ID } from '@solana/spl-token';
+import {
+  AccountLayout,
+  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+  // @ts-ignore createInitializeAccountInstruction export actually exist but isn't setup correctly
+  createInitializeAccountInstruction,
+  TOKEN_PROGRAM_ID,
+} from '@solana/spl-token';
 
 export const createTokenAccount = async ({
   payer,
@@ -29,12 +35,7 @@ export const createTokenAccount = async ({
   );
 
   createTokenTx.add(
-    Token.createInitAccountInstruction(
-      new PublicKey(TOKEN_PROGRAM_ID),
-      mint,
-      tokenAccount.publicKey,
-      owner ?? payer,
-    ),
+    createInitializeAccountInstruction(tokenAccount.publicKey, mint, owner ?? payer),
   );
 
   createTokenTx.recentBlockhash = (await connection.getRecentBlockhash()).blockhash;
diff --git a/fixed-price-sale/js/test/withdraw.test.ts b/fixed-price-sale/js/test/withdraw.test.ts
@@ -1,6 +1,8 @@
 import BN from 'bn.js';
 import test from 'tape';
-import { ASSOCIATED_TOKEN_PROGRAM_ID, Token, TOKEN_PROGRAM_ID } from '@solana/spl-token';
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore getAssociatedTokenAddress export actually exist but isn't setup correctly
+import { getAssociatedTokenAddress } from '@solana/spl-token';
 import { assertConfirmedTransaction, defaultSendOptions } from '@metaplex-foundation/amman';
 import { Edition, EditionMarker, Metadata } from '@metaplex-foundation/mpl-token-metadata';
 import { findPayoutTicketAddress, findTradeHistoryAddress } from '../src/utils';
@@ -152,12 +154,7 @@ test('withdraw: success', async (t) => {
     payer.publicKey,
   );
 
-  const destination = await Token.getAssociatedTokenAddress(
-    ASSOCIATED_TOKEN_PROGRAM_ID,
-    TOKEN_PROGRAM_ID,
-    treasuryMint.publicKey,
-    payer.publicKey,
-  );
+  const destination = await getAssociatedTokenAddress(treasuryMint.publicKey, payer.publicKey);
 
   const metadata = await Metadata.getPDA(resourceMint.publicKey);
 
diff --git a/yarn.lock b/yarn.lock
@@ -41,20 +41,20 @@ __metadata:
   languageName: node
   linkType: hard
 
-"@eslint/eslintrc@npm:^1.2.0":
-  version: 1.2.0
-  resolution: "@eslint/eslintrc@npm:1.2.0"
+"@eslint/eslintrc@npm:^1.2.1":
+  version: 1.2.1
+  resolution: "@eslint/eslintrc@npm:1.2.1"
   dependencies:
     ajv: ^6.12.4
     debug: ^4.3.2
     espree: ^9.3.1
     globals: ^13.9.0
-    ignore: ^4.0.6
+    ignore: ^5.2.0
     import-fresh: ^3.2.1
     js-yaml: ^4.1.0
     minimatch: ^3.0.4
     strip-json-comments: ^3.1.1
-  checksum: a5e51dcf02627363567094456d7880b46b6a14a285d7a057f083ca903bdd862483bb6314cbc9fb6fa2d2c4537d50e0d28bd5e39650840241ae4796faaec65d2e
+  checksum: 1f797b9f94d71b965992cf6c44e3bcb574643014fd1e3d4862d25056bd5568f59c488461a7e9a1c1758ca7f0def5d3cb69c3d8b38581bcf4a53af74371243797
   languageName: node
   linkType: hard
 
@@ -1087,7 +1087,7 @@ __metadata:
     "@metaplex-foundation/mpl-core": ^0.0.5
     "@metaplex-foundation/mpl-token-metadata": 1.1.0
     "@metaplex-foundation/solita": ^0.1.0
-    "@solana/spl-token": ^0.1.8
+    "@solana/spl-token": ^0.2.0
     "@solana/web3.js": ^1.35.1
     "@types/debug": ^4.1.7
     "@types/tape": ^4.13.2
@@ -1573,11 +1573,11 @@ __metadata:
   linkType: hard
 
 "@solana/spl-token-registry@npm:^0.2.2405":
-  version: 0.2.2845
-  resolution: "@solana/spl-token-registry@npm:0.2.2845"
+  version: 0.2.2849
+  resolution: "@solana/spl-token-registry@npm:0.2.2849"
   dependencies:
     cross-fetch: 3.0.6
-  checksum: c8b5fb4bcaf549166656527193918cc585a58c988b918920cdf8eec9a45f9f8e6895e850562cc634b302e7a31400d3b6038e22cae7b84a33a5e5551122bd151c
+  checksum: d07114a5ca45f474084a1a6b0e03061264e09ee3c29b9d28969e345efeac38a5b2a386cf7b99840b4b6d06a009ca110627897dce9e6afc039d75cfbc0ee6f1ac
   languageName: node
   linkType: hard
 
@@ -3623,10 +3623,10 @@ __metadata:
   linkType: hard
 
 "eslint@npm:^8.3.0":
-  version: 8.10.0
-  resolution: "eslint@npm:8.10.0"
+  version: 8.11.0
+  resolution: "eslint@npm:8.11.0"
   dependencies:
-    "@eslint/eslintrc": ^1.2.0
+    "@eslint/eslintrc": ^1.2.1
     "@humanwhocodes/config-array": ^0.9.2
     ajv: ^6.10.0
     chalk: ^4.0.0
@@ -3663,7 +3663,7 @@ __metadata:
     v8-compile-cache: ^2.0.3
   bin:
     eslint: bin/eslint.js
-  checksum: 8b31ab3de5b48b6828bf13c09c9e62ee0045fa0afa017efaa73eedcf4dc33bc204ee4c467d4677e37967d1645f73816ddef4271422e691fded352040f8f83093
+  checksum: a06a2ea37002d6c0a4f462fe31b4411185dc3da7857fafb896eb392ba95a1289cc3538056474b2f44f08012f265bede01a39d46df4ac39ebc6d7be90e2c8f9fa
   languageName: node
   linkType: hard
 
@@ -4506,13 +4506,6 @@ __metadata:
   languageName: node
   linkType: hard
 
-"ignore@npm:^4.0.6":
-  version: 4.0.6
-  resolution: "ignore@npm:4.0.6"
-  checksum: 248f82e50a430906f9ee7f35e1158e3ec4c3971451dd9f99c9bc1548261b4db2b99709f60ac6c6cac9333494384176cc4cc9b07acbe42d52ac6a09cad734d800
-  languageName: node
-  linkType: hard
-
 "ignore@npm:^5.1.8, ignore@npm:^5.2.0":
   version: 5.2.0
   resolution: "ignore@npm:5.2.0"

Original file line number	Diff line number	Diff line change
`@@ -44,7 +44,7 @@ export const createBuyTransaction = async ({`
`44`	`44`	`newMintMetadata,`
`45`	`45`	`newTokenAccount,`
`46`	`46`	`}: BuyParams) => {`
`47`		`- const instruction = await createBuyInstruction(`
	`47`	`+ const instruction = createBuyInstruction(`
`48`	`48`	`{`
`49`	`49`	`// buyer wallet`
`50`	`50`	`userWallet: buyer,`
Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@ export const createClaimResourceTransaction = async ({`
`28`	`28`	`vaultOwnerBump,`
`29`	`29`	`owner,`
`30`	`30`	`}: ClaimResourceParams): Promise<Transaction> => {`
`31`		`- const instruction = await createClaimResourceInstruction(`
	`31`	`+ const instruction = createClaimResourceInstruction(`
`32`	`32`	`{`
`33`	`33`	`market,`
`34`	`34`	`treasuryHolder,`