refactor(experimental): add padLeftCodec and padRightCodec helpers to @solana/codecs-core

[lorisleiva]

This PR adds new padLeftCodec and padRightCodec helper functions. See copy/pasted documentation below:

---

Padding codecs

The padLeftCodec and padRightCodec helpers can be used to add padding to the left or right of a given codec. They accept an offset number that tells us how big the padding should be.

const getLeftPaddedCodec = () => padLeftCodec(getU16Codec(), 4);
getLeftPaddedCodec().encode(0xffff);
// 0x00000000ffff
//   |       └-- Our encoded u16 number.
//   └-- Our 4-byte padding.

const getRightPaddedCodec = () => padRightCodec(getU16Codec(), 4);
getRightPaddedCodec().encode(0xffff);
// 0xffff00000000
//   |   └-- Our 4-byte padding.
//   └-- Our encoded u16 number.

Note that both the padLeftCodec and padRightCodec functions are simple wrappers around the offsetCodec and resizeCodec functions. For more complex padding strategies, you may want to use the offsetCodec and resizeCodec functions directly instead.

As usual, encoder-only and decoder-only helpers are available for these padding functions. Namely, padLeftEncoder, padRightEncoder, padLeftDecoder and padRightDecoder.

const getMyPaddedEncoder = () => padLeftEncoder(getU16Encoder());
const getMyPaddedDecoder = () => padLeftDecoder(getU16Decoder());
const getMyPaddedCodec = () => combineCodec(getMyPaddedEncoder(), getMyPaddedDecoder());

[changeset-bot]

⚠️ No Changeset found

Latest commit: f783650

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

[lorisleiva]

• refactor(experimental): add padLeftCodec and padRightCodec helpers to @solana/codecs-core #2314 👈
• refactor(experimental): add offsetCodec helper to @solana/codecs-core #2294
• refactor(experimental): add resizeCodec helper to @solana/codecs-core #2293
• master

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

Join @lorisleiva and the rest of your teammates on Graphite

[buffalojoec]

Nice! Good API sugar here.

[lorisleiva]

Merge activity

• Mar 14, 6:08 AM EDT: @lorisleiva started a stack merge that includes this pull request via Graphite.
• Mar 14, 6:11 AM EDT: Graphite rebased this pull request as part of a merge.
• Mar 14, 6:12 AM EDT: @lorisleiva merged this pull request with Graphite.

[github-actions]

🎉 This PR is included in version 1.91.2 🎉

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.