refactor(experimental): add getConstantCodec to @solana/codecs-data-structures

[lorisleiva]

This PR adds two new helpers: containsBytes and getConstantCodec.

The containsBytes helper checks if a Uint8Array contains another Uint8Array at a given offset.

containsBytes(new Uint8Array([1, 2, 3, 4]), new Uint8Array([2, 3]), 1); // true
containsBytes(new Uint8Array([1, 2, 3, 4]), new Uint8Array([2, 3]), 2); // false

The getConstantCodec function accepts any Uint8Array and returns a Codec<void>. When encoding, it will set the provided Uint8Array as-is. When decoding, it will assert that the next bytes contain the provided Uint8Array and move the offset forward.

const codec = getConstantCodec(new Uint8Array([1, 2, 3]));

codec.encode(undefined); // 0x010203
codec.decode(new Uint8Array([1, 2, 3])); // undefined
codec.decode(new Uint8Array([1, 2, 4])); // Throws an error.

[changeset-bot]

🦋 Changeset detected

Latest commit: 2e26dc2

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-core	Patch
@solana/errors	Patch
@solana/codecs	Patch
@solana/transactions	Patch
@solana/accounts	Patch
@solana/addresses	Patch
@solana/codecs-numbers	Patch
@solana/codecs-strings	Patch
@solana/keys	Patch
@solana/options	Patch
@solana/rpc-api	Patch
@solana/rpc-types	Patch
@solana/assertions	Patch
@solana/compat	Patch
@solana/instructions	Patch
@solana/web3.js-experimental	Patch
@solana/rpc-spec	Patch
@solana/rpc-subscriptions-spec	Patch
@solana/rpc-subscriptions-transport-websocket	Patch
@solana/rpc-subscriptions	Patch
@solana/rpc-transport-http	Patch
@solana/rpc	Patch
@solana/signers	Patch
@solana/sysvars	Patch
@solana/transaction-confirmation	Patch
@solana/web3.js-legacy-sham	Patch
@solana/programs	Patch
@solana/rpc-graphql	Patch
@solana/rpc-subscriptions-api	Patch
@solana/rpc-parsed-types	Patch
@solana/rpc-transformers	Patch
@solana/functional	Patch
@solana/rpc-spec-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): rename prefixCodecSize to addCodecSizePrefix #2417
• refactor(experimental): nit: rename Endian enum variants #2414
• refactor(experimental): remove getStringCodec in favour of fixCodecSize and prefixCodecSize #2413
• refactor(experimental): remove the size option of getBytesCodec #2412
• refactor(experimental): rename fixCodec and prefixCodec to fixCodecSize and prefixCodecSize #2411
• refactor(experimental): add getZeroableNullableCodec and getZeroableOptionCodec #2410
• refactor(experimental): refactor getNullableCodec and getOptionCodec to use getUnionCodec #2409
• refactor(experimental): add getHiddenPrefixCodec and getHiddenSuffixCodec to @solana/codecs-data-structures #2401
• refactor(experimental): add getConstantCodec to @solana/codecs-data-structures #2400 👈
• refactor(experimental): refactor getDiscriminatedUnionCodec by using new getUnionCodec primitive #2399
• refactor(experimental): add getUnionCodec to @solana/codecs-data-structures #2398
• refactor(experimental): add prefixCodec to @solana/codecs-core #2397
• refactor(experimental): nit: extract any types to local codec types #2396
• refactor(experimental): support more scalar values in getDiscriminatedUnionCodec #2395
• refactor(experimental): add getLiteralUnionCodec to @solana/codecs-data-structures #2394
• 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]

This will return true if both data and bytes are of zero length. I don't know how you feel about that.

[lorisleiva]

Does nothing not contain nothing? 😅

[steveluscher]

[steveluscher]

[lorisleiva]

Merge activity

• Apr 2, 6:48 PM EDT: @lorisleiva started a stack merge that includes this pull request via Graphite.
• Apr 2, 6:58 PM EDT: The Graphite merge of this pull request was cancelled.
• Apr 2, 6:58 PM EDT: @lorisleiva started a stack merge that includes this pull request via Graphite.
• Apr 2, 6:59 PM EDT: Graphite rebased this pull request as part of a merge.
• Apr 2, 7:01 PM EDT: @lorisleiva merged this pull request with Graphite.

[github-actions]

🎉 This PR is included in version 1.91.4 🎉

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.