[token/ts] TypeError: fields must be array of Layout instances #2683

Admdebian · 2021-12-30T09:30:41Z

If I import the library I get:

TypeError: fields must be array of Layout instances

NPM package:

@solana/spl-token: ^0.2.0-alpha.0

solana-program-library/token/ts/src/instructions/initializeMint.ts

Lines 22 to 29 in c5d7381

    
           /** TODO: docs */ 
        
           export const initializeMintInstructionData = struct<InitializeMintInstructionData>([ 
        
               u8('instruction'), 
        
               u8('decimals'), 
        
               publicKey('mintAuthority'), 
        
               u8('freezeAuthorityOption'), 
        
               publicKey('freezeAuthority'), 
        
           ]);

Update

The problem disappear if I install:

npm install -S @solana/buffer-layout

NPM package:

@solana/buffer-layout: ^4.0.0

Maybe it's an npm dependencies resolution problem.

The text was updated successfully, but these errors were encountered:

jordaaash · 2021-12-30T15:18:36Z

Hmm

solana-program-library/token/ts/package.json

Line 42 in c5d7381

"@solana/buffer-layout": "^4.0.0",

The package declares that dependency. Can you post your package.json?

Admdebian · 2021-12-30T16:00:25Z

{
  "name": "MyProject",
  "version": "1.0.0",
  "private": true,
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "jest",
    "lint": "eslint . --ext .js,.jsx,.ts,.tsx"
  },
  "keywords": [
    "blockchain"
  ],
  "author": "Admdebian",
  "license": "ISC",
  "devDependencies": {
    "@babel/core": "^7.16.0",
    "@babel/preset-env": "^7.16.4",
    "@babel/preset-flow": "^7.16.0",
    "@babel/runtime": "^7.16.3",
    "@types/bs58": "^4.0.1",
    "@types/jest": "^27.0.2",
    "babel-jest": "^27.3.1",
    "babel-plugin-transform-async-to-generator": "^6.24.1",
    "eslint": "^8.2.0",
    "jest": "^27.3.1",
    "metro-react-native-babel-preset": "^0.66.2",
    "tslint": "^6.1.3",
    "typescript": "^4.4.4"
  },
  "jest": {
    "transform": {
      "^.+\\.[t|j]sx?$": "babel-jest"
    },
    "moduleFileExtensions": [
      "ts",
      "tsx",
      "js",
      "jsx",
      "json",
      "node"
    ]
  },
  "files": [
    "/src"
  ],
  "dependencies": {
    "@bonfida/spl-name-service": "^0.1.22",
    "@project-serum/serum": "^0.13.60",
    "@pythnetwork/client": "^2.5.1",
    "@solana/buffer-layout": "^4.0.0",
    "@solana/spl-token": "^0.2.0-alpha.0",
    "@solana/web3.js": "^1.30.2",
    "bip39": "^3.0.4",
    "bs58": "^4.0.1",
    "ed25519-hd-key": "^1.2.0"
  }
}

Admdebian · 2021-12-30T16:02:40Z

Hmm

solana-program-library/token/ts/package.json

Line 42 in c5d7381

"@solana/buffer-layout": "^4.0.0",

The package declares that dependency. Can you post your package.json?

Yes, the dependency is correct. My project requires that I save the dependency in the main package.json

jordaaash · 2021-12-30T19:08:43Z

It would help to see your entire project. The error here (TypeError: fields must be array of Layout instances) doesn't give enough context, as I can't tell where it's coming from.

Admdebian · 2021-12-30T20:14:26Z

It would help to see your entire project. The error here (TypeError: fields must be array of Layout instances) doesn't give enough context, as I can't tell where it's coming from.

I made a new project with only a sample code and the problem disappeared. I think is not related with this library.

Sorry. Thanks for your time!

KunalBagaria · 2022-02-02T09:08:16Z

Having this issue myself now with the latest @solana/pay library.

rez-cpu · 2022-02-13T02:44:25Z

Its the package version, this is what current combo that works:
"@solana/pay": "^0.1.3",
"@solana/spl-token": "^0.2.0-alpha.1",
"@solana/buffer-layout": "^4.0.0",
"@solana/web3.js": "^1.34.0",

cqfd · 2022-03-04T15:32:28Z

I'm having this same issue while attempting to use the 0.2.0 createMint function in an anchor test (anchor test ends up running yarn run ts-mocha -p ./tsconfig.json -t 1000000 tests/**/*.ts).

The fix for me was to add an explicit package.json dependency on "@solana/buffer-layout": "^4.0.0",, and then delete my node_modules directory and re-install from scratch (🤦‍♂️).

scottwilson312 · 2022-03-04T19:10:49Z

    "@solana/buffer-layout": "^4.0.0",
    "@solana/wallet-adapter-base": "^0.9.3",
    "@solana/wallet-adapter-react": "^0.15.3",
    "@solana/wallet-adapter-react-ui": "^0.9.5",
    "@solana/wallet-adapter-wallets": "^0.15.2",
    "@solana/web3.js": "^1.35.1"

I have this build and after rebuilding from scratch today, I got this error. The fix above worked for me, putting buffer-layout in package.json 👍

wedvjin · 2022-03-05T19:08:14Z

i used yarn instead of npm to install dependencies on a clean project and it worked

"dependencies": {
        "@project-serum/anchor": "^0.22.1",
        "@solana/buffer-layout": "^4.0.0",
        "@solana/spl-token": "^0.2.0",
        "@solana/web3.js": "^1.34.0"
    },

thedonmon · 2022-03-07T04:14:06Z

I'm running into this same issue when calling any of the spl functions.

    const walletAta = await spl.getAssociatedTokenAddress(new PublicKey(mint), walletKeyPair.publicKey, false, spl.TOKEN_PROGRAM_ID, spl.ASSOCIATED_TOKEN_PROGRAM_ID);
    const escrowAta = await spl.getAssociatedTokenAddress(new PublicKey(mint), escrowPaymentAccount, false, spl.TOKEN_PROGRAM_ID, spl.ASSOCIATED_TOKEN_PROGRAM_ID);


"dependencies": {
        "@project-serum/anchor": "^0.22.1",
        "@solana/buffer-layout": "^4.0.0",
        "@solana/spl-token": "^0.2.0",
        "@solana/web3.js": "^1.34.0"
    },

straversi · 2022-03-22T19:02:52Z

I'm also running into this issue, even with the provided suggestion of explicitly listing buffer-layout as a dep. Maybe it should be re-opened?

jordaaash · 2022-03-22T19:49:34Z

@straversi I've reopened. Please provide a complete, clear reproduction of the issue. So far all we've got to go on is 8 different code snippets, which is kind of impossible to debug.

FWIW, we use @solana/spl-token in Solana Pay and we don't need to import @solana/buffer-layout, so I'm skeptical that's the actual issue. Dependency issues like this sometimes come from how the dependencies are installed or what the build tooling and config is (Create React App, Webpack, Babel, esbuild, etc)

straversi · 2022-03-22T21:05:10Z

Of course, thank you!

echo '{
  "name": "spl-repro",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "keywords": [],
  "author": "",
  "license": "ISC",
  "dependencies": {
    "@metaplex-foundation/mpl-token-metadata": "1.2.4",
    "@solana/spl-token": "0.2.0",
    "@solana/web3.js": "1.30.2"
  }
}
' > package.json

npm i

# I'm running node v14.18.2
node

> require('@solana/spl-token');

That's all it takes for me.

jordaaash · 2022-03-22T21:11:55Z

Thanks! Do you get the same issue when installing with yarn?

charlie-amihan · 2022-03-22T22:13:17Z

I am getting the same issue with npm install, yarn install solves the issue for me.

steveluscher · 2022-03-23T02:18:34Z

Yeah, this is unfortunate. Sorry folks.

Basically when npm lays out the dependency tree, it ends up looking like this.

spl-token and the root package each end up with their own copy of buffer-layout.

Next, initializeMint tries to make use of buffer-layout-utils which again has its own copy of buffer-layout in it.

By the time these instances of Layout – all constructed from different packages of JavaScript – make their way to node_modules/@solana/spl-token/node_modules/@solana/buffer-layout/lib/Layout.js, this instanceof check fails.

You know, and I know, that those values are instances of Layout, but since they didn't come from literally the same class, they will never pass an instanceof check.

I'll have a think on this.

steveluscher · 2022-03-23T02:31:12Z

If someone gets there before I do tomorrow, the answer is going to have something to do with carefully setting peerDependencies in various package.json files.

steveluscher · 2022-03-23T02:31:16Z

Another thing we might consider, one day, is reimplementing this not to depend on classes, but rather tagged data structures.

// Instead of...
new Float(...)

// Do...
float(...)

// Which produces not an instance of a class, but rather a tagged object…
{__type: 'float', ...}

No classes, no instances, no problems.

steveluscher · 2022-03-23T21:40:10Z

After a few hundred npm link backflips, I figured out a short-term fix for this. We're going to have to upgrade buffer-layout in unison (solana-labs/solana#23899) and republish Every Package™. Stay tuned.

steveluscher · 2022-03-30T16:03:09Z

Upgrade @solana/web3.js in your package.json to 1.37.0 and the fields must be array of Layout instances error should go away.

Namely, @straversi's example above works for me when I do that. #2683 (comment)

steveluscher · 2022-03-30T16:27:27Z

Feel free to reopen this if your problems still persist. Closing for now.

Henry-E · 2022-04-27T11:38:14Z

I'm having this same issue while attempting to use the 0.2.0 createMint function in an anchor test (anchor test ends up running yarn run ts-mocha -p ./tsconfig.json -t 1000000 tests/**/*.ts).

This worked for me but I had to also delete package-lock.json

mschneider · 2022-05-03T09:04:31Z

After a few hundred npm link backflips, I figured out a short-term fix for this. We're going to have to upgrade buffer-layout in unison (solana-labs/solana#23899) and republish Every Package™. Stay tuned.

@steveluscher I saw similar issues with BN js previously. Did you consider to re-export the whole buffer-layout package in web3? This way there's a sure fire way to access the "correct" version in downstream code. Not sure of the drawbacks and longterm issues related to this approach, but it is what anchor does fyi:

https://github.com/project-serum/anchor/blob/master/ts/src/index.ts#L5

steveluscher · 2022-05-03T17:06:38Z

Oof. The fact that Anchor re-exports all of web3.js is actually pretty troublesome until I finish solana-labs/solana-web3.js#1122.

WrRaThY · 2022-05-03T23:39:20Z

started happening to me after I updated anchor js to 0.24.2

keitaj · 2022-05-14T10:24:21Z

started happening to me after I updated anchor js to 0.24.2

I happened too but I updated @solana/web3.js and @solana/spl-token and the error did not happen.

 "dependencies": {
    "@project-serum/anchor": "^0.24.2",
    "@project-serum/serum": "0.13.61",
    "@solana/buffer-layout": "^4.0.0",
    "@solana/spl-token": "^0.2.0",
    "@solana/web3.js": "^1.41.10",
    "@types/chai": "^4.3.1"
  },

aaronovz1 · 2022-06-01T13:26:37Z

This is still an extremely annoying problem. How does one work around it if it's a dependency out of our control and can't be updated, or updated in a reasonable timeframe?

steveluscher · 2022-06-01T19:39:01Z

Any time you run into this and can produce a minimal repro (eg. a GitHub repro that I can check out that's broken) or straight up give me access to your project, I'm happy to debug and make the fixes necessary, or a recommendation of what to do.

…a workaround for solana-labs/solana-program-library#2683

karan-ksrk · 2022-07-30T07:20:05Z

These Two Combination works for me

  "dependencies": {
    "@solana/buffer-layout": "^3.0.0",
    "@solana/web3.js": "^1.41.10",
}

h4rkl · 2022-08-18T05:50:01Z

If you're using yarn you can specify child dependancy resolutions in your package.json file using:

  "resolutions": {
    "@solana/buffer-layout": "^4.0.0"
  },

This will force all packages to use the specified dependancy version rather than the "3.x.x" version which looks like its causing the conflict.

NPMs equivalent is overrides - https://docs.npmjs.com/cli/v8/configuring-npm/package-json#overrides

ExoticCoder16 · 2022-09-26T07:55:40Z

Upgrade @solana/web3.js in your package.json to 1.37.0 and the fields must be array of Layout instances error should go away.

Namely, @straversi's example above works for me when I do that. #2683 (comment)

Yes ! Just by typing is not enough, I just re-install solana web3.js package ( npm install --save @solana/web3.js ), it works instantly ! Thank you !

…a workaround for solana-labs/solana-program-library#2683

georgiod9 · 2022-11-25T11:31:40Z

spl-token and the root package each end up with their own copy of buffer-layout.

I have stumbled upon the same issue, and have also deduced that the problem stems from the duplicity of that same package in 3 places.

zsyborg · 2023-06-02T06:09:27Z

rekt, this issue troubling in 2023 too, same old thing, tried yarn, npm, pnpm. Tried reordering the packages in package.json
this issuede my existing running project. Critical Issue

reza2870 · 2024-02-12T18:29:10Z

"@metaplex-foundation/mpl-token-metadata": "1.2.4",

Yes
I did all ways
Didn't work for me

Admdebian changed the title ~~TypeError: fields must be array of Layout instances~~ [token][ts] TypeError: fields must be array of Layout instances Dec 30, 2021

Admdebian changed the title ~~[token][ts] TypeError: fields must be array of Layout instances~~ [token/ts] TypeError: fields must be array of Layout instances Dec 30, 2021

Admdebian closed this as completed Dec 30, 2021

drinksbydrew mentioned this issue Feb 16, 2022

TypeError: fields must be array of Layout instances saber-hq/saber-common#486

Closed

UjjwalGupta49 mentioned this issue Feb 18, 2022

error with Layout.ts anza-xyz/solana-pay#79

Closed

jordaaash reopened this Mar 22, 2022

steveluscher mentioned this issue Mar 23, 2022

chore: Upgrade buffer-layout package in web3.js solana-labs/solana#23897

Merged

AronYeager mentioned this issue Mar 29, 2022

Comet liquidations and claiming Clone-Protocol/clone-protocol#12

Merged

steveluscher closed this as completed Mar 30, 2022

zaxozhu mentioned this issue Apr 6, 2022

fix: fixed-price-sale broken packages metaplex-foundation/metaplex-program-library#358

Merged

dankelleher added a commit to identity-com/on-chain-identity-gateway that referenced this issue Jun 26, 2022

Fix for the cluster URL being picked up wrong from the env vars, and …

081ed02

…a workaround for solana-labs/solana-program-library#2683

dankelleher mentioned this issue Jun 26, 2022

Bugfix/url identity-com/on-chain-identity-gateway#233

Merged

dankelleher added a commit to identity-com/on-chain-identity-gateway that referenced this issue Jun 26, 2022

Fix for the cluster URL being picked up wrong from the env vars, and …

da1c3de

…a workaround for solana-labs/solana-program-library#2683

dankelleher added a commit to identity-com/on-chain-identity-gateway that referenced this issue Jun 27, 2022

Fix for the cluster URL being picked up wrong from the env vars, and …

8e2c0bd

…a workaround for solana-labs/solana-program-library#2683

jnwng mentioned this issue Jul 12, 2022

error only in findAllByOwner 'Assertion failed' metaplex-foundation/js#158

Closed

This was referenced Sep 1, 2022

chore: use the same version of @solana/web3 that spl-token depends on BitGo/BitGoJS#2717

Closed

chore: bump solana/web3 library BitGo/BitGoJS#2718

Merged

alvinphilips mentioned this issue Oct 3, 2022

feat: Add Lido Finance as a Vault DappioLab/navigator#98

Merged

rado0x54 pushed a commit to identity-com/on-chain-identity-gateway that referenced this issue Oct 7, 2022

Fix for the cluster URL being picked up wrong from the env vars, and …

b8eb4b8

…a workaround for solana-labs/solana-program-library#2683

solana-labs locked as resolved and limited conversation to collaborators Feb 13, 2024

[token/ts] TypeError: fields must be array of Layout instances #2683

[token/ts] TypeError: fields must be array of Layout instances #2683

Comments

Admdebian commented Dec 30, 2021 • edited Loading

Update

jordaaash commented Dec 30, 2021

Admdebian commented Dec 30, 2021

Admdebian commented Dec 30, 2021

jordaaash commented Dec 30, 2021

Admdebian commented Dec 30, 2021

KunalBagaria commented Feb 2, 2022

rez-cpu commented Feb 13, 2022

cqfd commented Mar 4, 2022

scottwilson312 commented Mar 4, 2022 • edited Loading

wedvjin commented Mar 5, 2022

thedonmon commented Mar 7, 2022

straversi commented Mar 22, 2022

jordaaash commented Mar 22, 2022

straversi commented Mar 22, 2022 • edited Loading

jordaaash commented Mar 22, 2022

charlie-amihan commented Mar 22, 2022

steveluscher commented Mar 23, 2022

steveluscher commented Mar 23, 2022

steveluscher commented Mar 23, 2022

steveluscher commented Mar 23, 2022 • edited Loading

steveluscher commented Mar 30, 2022

steveluscher commented Mar 30, 2022

Henry-E commented Apr 27, 2022

mschneider commented May 3, 2022

steveluscher commented May 3, 2022

WrRaThY commented May 3, 2022

keitaj commented May 14, 2022

aaronovz1 commented Jun 1, 2022

steveluscher commented Jun 1, 2022

karan-ksrk commented Jul 30, 2022 • edited Loading

h4rkl commented Aug 18, 2022 • edited Loading

ExoticCoder16 commented Sep 26, 2022

georgiod9 commented Nov 25, 2022

zsyborg commented Jun 2, 2023

reza2870 commented Feb 12, 2024

Admdebian commented Dec 30, 2021 •

edited

Loading

scottwilson312 commented Mar 4, 2022 •

edited

Loading

straversi commented Mar 22, 2022 •

edited

Loading

steveluscher commented Mar 23, 2022 •

edited

Loading

karan-ksrk commented Jul 30, 2022 •

edited

Loading

h4rkl commented Aug 18, 2022 •

edited

Loading