refactor(experimental): support custom discriminator property for getDataEnumCodec

[lorisleiva]

This PR adds support for custom discriminator properties for getDataEnumCodecs.

// Before.
const codec = getDataEnumCodec([
  ['click', getStructCodec([[['x', u32], ['y', u32]]])],
  ['keyPress', getStructCodec([[['key', u32]]])]
]);

codec.encode({ __kind: 'click', x: 1, y: 2 });
codec.encode({ __kind: 'keyPress', key: 3 });

// After.
const codec = getDataEnumCodec([
  ['click', getStructCodec([[['x', u32], ['y', u32]]])],
  ['keyPress', getStructCodec([[['key', u32]]])]
], { discriminator: 'event' });

codec.encode({ event: 'click', x: 1, y: 2 });
codec.encode({ event: 'keyPress', key: 3 });

Note that, to make this work, this PR updates a few exported types such as GetDataEnumKind or GetDataEnumKindContent which is used by Kinobi. I'll make sure to have a PR ready on Kinobi's side when this is ready to be merged.

[changeset-bot]

🦋 Changeset detected

Latest commit: a8084d3

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 35 packages

Name	Type
@solana/codecs-data-structures	Patch
@solana/codecs	Patch
@solana/transactions	Patch
@solana/web3.js-experimental	Patch
@solana/sysvars	Patch
@solana/compat	Patch
@solana/web3.js-legacy-sham	Patch
@solana/programs	Patch
@solana/rpc-api	Patch
@solana/rpc-graphql	Patch
@solana/rpc-subscriptions-api	Patch
@solana/signers	Patch
@solana/transaction-confirmation	Patch
@solana/rpc	Patch
@solana/rpc-subscriptions	Patch
@solana/accounts	Patch
@solana/addresses	Patch
@solana/assertions	Patch
@solana/codecs-core	Patch
@solana/codecs-numbers	Patch
@solana/codecs-strings	Patch
@solana/errors	Patch
@solana/functional	Patch
@solana/instructions	Patch
@solana/keys	Patch
@solana/options	Patch
@solana/rpc-parsed-types	Patch
@solana/rpc-spec-types	Patch
@solana/rpc-spec	Patch
@solana/rpc-subscriptions-spec	Patch
@solana/rpc-subscriptions-transport-websocket	Patch
@solana/rpc-transformers	Patch
@solana/rpc-transport-http	Patch
@solana/rpc-types	Patch
@solana/webcrypto-ed25519-polyfill	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[lorisleiva]

• refactor(experimental): nit: rename define to describe #2384
• refactor(experimental): rename getScalarEnumCodec to getEnumCodec #2383
• refactor(experimental): rename getDataEnumCodec to getDiscriminatedUnionCodec #2382
• refactor(experimental): support number and symbol discriminator values for getDataEnumCodec #2381
• refactor(experimental): support custom discriminator property for getDataEnumCodec #2380 👈
• master

This stack of pull requests is managed by Graphite. Learn more about stacking.

Join @lorisleiva and the rest of your teammates on Graphite

[steveluscher]

[steveluscher]

[lorisleiva]

Kinobi PR ready to follow this up at: metaplex-foundation/kinobi#187

[lorisleiva]

Merge activity

• Mar 27, 9:34 AM EDT: @lorisleiva started a stack merge that includes this pull request via Graphite.
• Mar 27, 9:34 AM EDT: @lorisleiva merged this pull request with Graphite.

[github-actions]

🎉 This PR is included in version 1.91.3 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀

[github-actions]

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