viem
Version:
57 lines • 2.88 kB
TypeScript
import type { ErrorType } from '../../errors/utils.js';
import type { BlobSidecars } from '../../types/eip4844.js';
import type { Kzg } from '../../types/kzg.js';
import type { ByteArray, Hex } from '../../types/misc.js';
import type { OneOf } from '../../types/utils.js';
import { type BlobsToCommitmentsErrorType } from './blobsToCommitments.js';
import { type blobsToProofsErrorType } from './blobsToProofs.js';
import { type ToBlobsErrorType } from './toBlobs.js';
type To = 'hex' | 'bytes';
export type ToBlobSidecarsParameters<data extends Hex | ByteArray | undefined = undefined, blobs extends readonly Hex[] | readonly ByteArray[] | undefined = undefined, to extends To = (blobs extends readonly Hex[] ? 'hex' : never) | (blobs extends readonly ByteArray[] ? 'bytes' : never), _blobsType = (blobs extends readonly Hex[] ? readonly Hex[] : never) | (blobs extends readonly ByteArray[] ? readonly ByteArray[] : never)> = {
/** Return type. */
to?: to | To | undefined;
} & OneOf<{
/** Data to transform into blobs. */
data: data | Hex | ByteArray;
/** KZG implementation. */
kzg: Kzg;
} | {
/** Blobs. */
blobs: blobs | readonly Hex[] | readonly ByteArray[];
/** Commitment for each blob. */
commitments: _blobsType | readonly Hex[] | readonly ByteArray[];
/** Proof for each blob. */
proofs: _blobsType | readonly Hex[] | readonly ByteArray[];
}>;
export type ToBlobSidecarsReturnType<to extends To> = (to extends 'bytes' ? BlobSidecars<ByteArray> : never) | (to extends 'hex' ? BlobSidecars<Hex> : never);
export type ToBlobSidecarsErrorType = BlobsToCommitmentsErrorType | ToBlobsErrorType | blobsToProofsErrorType | ErrorType;
/**
* Transforms arbitrary data (or blobs, commitments, & proofs) into a sidecar array.
*
* @example
* ```ts
* import { toBlobSidecars, stringToHex } from 'viem'
*
* const sidecars = toBlobSidecars({ data: stringToHex('hello world') })
* ```
*
* @example
* ```ts
* import {
* blobsToCommitments,
* toBlobs,
* blobsToProofs,
* toBlobSidecars,
* stringToHex
* } from 'viem'
*
* const blobs = toBlobs({ data: stringToHex('hello world') })
* const commitments = blobsToCommitments({ blobs, kzg })
* const proofs = blobsToProofs({ blobs, commitments, kzg })
*
* const sidecars = toBlobSidecars({ blobs, commitments, proofs })
* ```
*/
export declare function toBlobSidecars<const data extends Hex | ByteArray | undefined = undefined, const blobs extends readonly Hex[] | readonly ByteArray[] | undefined = undefined, to extends To = (data extends Hex ? 'hex' : never) | (data extends ByteArray ? 'bytes' : never) | (blobs extends readonly Hex[] ? 'hex' : never) | (blobs extends readonly ByteArray[] ? 'bytes' : never)>(parameters: ToBlobSidecarsParameters<data, blobs, to>): ToBlobSidecarsReturnType<to>;
export {};
//# sourceMappingURL=toBlobSidecars.d.ts.map