|
| 1 | +import { encodeAbiParameters, encodeFunctionData, type Hex, size, toHex, zeroAddress } from 'viem' |
| 2 | +import { pdpVerifierAbi } from '../abis/generated.ts' |
| 3 | +import { AddPiecesBatchTooLargeError, InvalidUploadSizeError } from '../errors/pdp.ts' |
| 4 | +import { AtLeastOnePieceRequiredError } from '../errors/warm-storage.ts' |
| 5 | +import type { PieceCID } from '../piece/piece-cid.ts' |
| 6 | +import { signAddPiecesAbiParameters } from '../typed-data/sign-add-pieces.ts' |
| 7 | +import { signCreateDataSetAbiParameters } from '../typed-data/sign-create-dataset.ts' |
| 8 | +import { signcreateDataSetAndAddPiecesAbiParameters } from '../typed-data/sign-create-dataset-add-pieces.ts' |
| 9 | +import { SIZE_CONSTANTS } from '../utils/constants.ts' |
| 10 | +import { datasetMetadataObjectToEntry, type MetadataObject, pieceMetadataObjectToEntry } from '../utils/metadata.ts' |
| 11 | +import type { PdpDataSet } from '../warm-storage/types.ts' |
| 12 | + |
| 13 | +/** Dummy secp256k1 signature used only to size extraData. */ |
| 14 | +const DUMMY_SIGNATURE = `0x${'00'.repeat(65)}` as Hex |
| 15 | + |
| 16 | +export type LimiterPiece = { |
| 17 | + pieceCid: PieceCID |
| 18 | + metadata?: MetadataObject |
| 19 | +} |
| 20 | + |
| 21 | +export type LimiterOptions = |
| 22 | + | { |
| 23 | + kind: 'addPieces' |
| 24 | + dataSet?: PdpDataSet |
| 25 | + pieces: LimiterPiece[] |
| 26 | + } |
| 27 | + | { |
| 28 | + kind: 'createDataSetAndAddPieces' |
| 29 | + metadata?: MetadataObject |
| 30 | + cdn?: boolean |
| 31 | + pieces: LimiterPiece[] |
| 32 | + } |
| 33 | + |
| 34 | +/** `true` if `pieces` still fit in one addPieces / createAndAdd operation. */ |
| 35 | +export type Limiter = (options: LimiterOptions) => boolean |
| 36 | + |
| 37 | +export namespace addPiecesFits { |
| 38 | + export type OptionsType = LimiterOptions |
| 39 | + export type OutputType = boolean |
| 40 | +} |
| 41 | + |
| 42 | +/** |
| 43 | + * Whether a candidate piece list fits in one addPieces / createAndAdd message. |
| 44 | + * |
| 45 | + * Uses estimated encoded-params size (PieceCID bytes + dummy extraData) against |
| 46 | + * {@link SIZE_CONSTANTS.MAX_ADD_PIECES_MESSAGE_SIZE} (64 KiB message cap minus |
| 47 | + * overhead). Empty `pieces` does not fit. |
| 48 | + * |
| 49 | + * @param options - {@link addPiecesFits.OptionsType} |
| 50 | + * @returns Whether the pieces fit {@link addPiecesFits.OutputType} |
| 51 | + * |
| 52 | + * @example |
| 53 | + * ```ts |
| 54 | + * import { addPiecesFits } from '@filoz/synapse-core/sp' |
| 55 | + * |
| 56 | + * const fits = addPiecesFits({ |
| 57 | + * kind: 'addPieces', |
| 58 | + * dataSet, |
| 59 | + * pieces: [{ pieceCid }], |
| 60 | + * }) |
| 61 | + * ``` |
| 62 | + */ |
| 63 | +export function addPiecesFits(options: addPiecesFits.OptionsType): addPiecesFits.OutputType { |
| 64 | + if (options.pieces.length < 1) { |
| 65 | + return false |
| 66 | + } |
| 67 | + return estimateAddPiecesCalldataSize(options) <= SIZE_CONSTANTS.MAX_ADD_PIECES_MESSAGE_SIZE |
| 68 | +} |
| 69 | + |
| 70 | +/** |
| 71 | + * Throw if a PieceCID's encoded raw size is outside Curio's upload bounds |
| 72 | + * ({@link SIZE_CONSTANTS.MIN_UPLOAD_SIZE}–{@link SIZE_CONSTANTS.MAX_UPLOAD_SIZE}). |
| 73 | + * |
| 74 | + * @throws {@link InvalidUploadSizeError} |
| 75 | + */ |
| 76 | +export function assertPieceCidSize(pieceCid: PieceCID): void { |
| 77 | + const pieceSize = pieceCid.size |
| 78 | + if (pieceSize < SIZE_CONSTANTS.MIN_UPLOAD_SIZE || pieceSize > SIZE_CONSTANTS.MAX_UPLOAD_SIZE) { |
| 79 | + throw new InvalidUploadSizeError(pieceSize) |
| 80 | + } |
| 81 | +} |
| 82 | + |
| 83 | +/** |
| 84 | + * Throw if `pieces` is empty, a PieceCID is outside Curio's size bounds, or the |
| 85 | + * list does not fit in one addPieces / createAndAdd message. |
| 86 | + * |
| 87 | + * @param options - {@link LimiterOptions} |
| 88 | + * @throws {@link AtLeastOnePieceRequiredError} when `pieces` is empty |
| 89 | + * @throws {@link InvalidUploadSizeError} when a PieceCID size is below {@link SIZE_CONSTANTS.MIN_UPLOAD_SIZE} or above {@link SIZE_CONSTANTS.MAX_UPLOAD_SIZE} |
| 90 | + * @throws {@link AddPiecesBatchTooLargeError} when the estimated message exceeds {@link SIZE_CONSTANTS.MAX_ADD_PIECES_MESSAGE_SIZE} |
| 91 | + */ |
| 92 | +export function assertAddPiecesFit(options: LimiterOptions): void { |
| 93 | + if (options.pieces.length < 1) { |
| 94 | + throw new AtLeastOnePieceRequiredError() |
| 95 | + } |
| 96 | + for (const piece of options.pieces) { |
| 97 | + assertPieceCidSize(piece.pieceCid) |
| 98 | + } |
| 99 | + if (!addPiecesFits(options)) { |
| 100 | + throw new AddPiecesBatchTooLargeError(options.pieces.length) |
| 101 | + } |
| 102 | +} |
| 103 | + |
| 104 | +/** |
| 105 | + * Estimated on-chain calldata size in bytes for the given piece list. |
| 106 | + */ |
| 107 | +export function estimateAddPiecesCalldataSize(options: LimiterOptions): number { |
| 108 | + const extraData = dummyExtraData(options) |
| 109 | + const pieceData = options.pieces.map((piece) => ({ data: toHex(piece.pieceCid.bytes) })) |
| 110 | + const calldata = encodeFunctionData({ |
| 111 | + abi: pdpVerifierAbi, |
| 112 | + functionName: 'addPieces', |
| 113 | + args: [0n, zeroAddress, pieceData, extraData], |
| 114 | + }) |
| 115 | + return size(calldata) |
| 116 | +} |
| 117 | + |
| 118 | +function dummyExtraData(options: LimiterOptions): Hex { |
| 119 | + const addPiecesExtraData = dummyAddPiecesExtraData(options.pieces) |
| 120 | + if (options.kind === 'addPieces') { |
| 121 | + return addPiecesExtraData |
| 122 | + } |
| 123 | + const createEntries = datasetMetadataObjectToEntry(options.metadata, { cdn: options.cdn ?? false }) |
| 124 | + const createExtraData = encodeAbiParameters(signCreateDataSetAbiParameters, [ |
| 125 | + zeroAddress, |
| 126 | + 0n, |
| 127 | + createEntries.map((entry) => entry.key), |
| 128 | + createEntries.map((entry) => entry.value), |
| 129 | + DUMMY_SIGNATURE, |
| 130 | + ]) |
| 131 | + return encodeAbiParameters(signcreateDataSetAndAddPiecesAbiParameters, [createExtraData, addPiecesExtraData]) |
| 132 | +} |
| 133 | + |
| 134 | +function dummyAddPiecesExtraData(pieces: LimiterPiece[]): Hex { |
| 135 | + const metadataKV = pieces.map((piece) => pieceMetadataObjectToEntry(piece.metadata)) |
| 136 | + const keys = metadataKV.map((entries) => entries.map((entry) => entry.key)) |
| 137 | + const values = metadataKV.map((entries) => entries.map((entry) => entry.value)) |
| 138 | + return encodeAbiParameters(signAddPiecesAbiParameters, [0n, keys, values, DUMMY_SIGNATURE]) |
| 139 | +} |
0 commit comments