@aztec/foundation 0.0.1-commit.96bb3f7 → 0.0.1-commit.993d240
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dest/array/sorted_array.d.ts +6 -1
- package/dest/array/sorted_array.d.ts.map +1 -1
- package/dest/array/sorted_array.js +18 -15
- package/dest/bigint-buffer/index.d.ts +1 -1
- package/dest/bigint-buffer/index.d.ts.map +1 -1
- package/dest/bigint-buffer/index.js +6 -1
- package/dest/branded-types/block_number.d.ts +6 -3
- package/dest/branded-types/block_number.d.ts.map +1 -1
- package/dest/branded-types/block_number.js +18 -4
- package/dest/branded-types/buffer32_hash.d.ts +27 -0
- package/dest/branded-types/buffer32_hash.d.ts.map +1 -0
- package/dest/branded-types/buffer32_hash.js +12 -0
- package/dest/branded-types/checkpoint_number.d.ts +9 -3
- package/dest/branded-types/checkpoint_number.d.ts.map +1 -1
- package/dest/branded-types/checkpoint_number.js +11 -0
- package/dest/branded-types/epoch.d.ts +2 -2
- package/dest/branded-types/epoch.d.ts.map +1 -1
- package/dest/branded-types/index.d.ts +3 -1
- package/dest/branded-types/index.d.ts.map +1 -1
- package/dest/branded-types/index.js +2 -0
- package/dest/branded-types/index_within_checkpoint.d.ts +42 -0
- package/dest/branded-types/index_within_checkpoint.d.ts.map +1 -0
- package/dest/branded-types/index_within_checkpoint.js +59 -0
- package/dest/branded-types/slot.d.ts +5 -2
- package/dest/branded-types/slot.d.ts.map +1 -1
- package/dest/branded-types/slot.js +3 -0
- package/dest/buffer/buffer16.d.ts +6 -1
- package/dest/buffer/buffer16.d.ts.map +1 -1
- package/dest/buffer/buffer32.d.ts +28 -58
- package/dest/buffer/buffer32.d.ts.map +1 -1
- package/dest/buffer/buffer32.js +29 -63
- package/dest/buffer/index.d.ts +2 -1
- package/dest/buffer/index.d.ts.map +1 -1
- package/dest/buffer/index.js +1 -0
- package/dest/buffer/utils.d.ts +3 -0
- package/dest/buffer/utils.d.ts.map +1 -0
- package/dest/buffer/utils.js +7 -0
- package/dest/collection/array.d.ts +22 -1
- package/dest/collection/array.d.ts.map +1 -1
- package/dest/collection/array.js +84 -0
- package/dest/collection/index.d.ts +3 -1
- package/dest/collection/index.d.ts.map +1 -1
- package/dest/collection/index.js +2 -0
- package/dest/collection/lru_map.d.ts +41 -0
- package/dest/collection/lru_map.d.ts.map +1 -0
- package/dest/collection/lru_map.js +119 -0
- package/dest/collection/lru_set.d.ts +35 -0
- package/dest/collection/lru_set.d.ts.map +1 -0
- package/dest/collection/lru_set.js +95 -0
- package/dest/committable/committable.js +1 -1
- package/dest/config/env_var.d.ts +2 -2
- package/dest/config/env_var.d.ts.map +1 -1
- package/dest/config/index.d.ts +50 -29
- package/dest/config/index.d.ts.map +1 -1
- package/dest/config/index.js +57 -43
- package/dest/config/network_config.d.ts +15 -41
- package/dest/config/network_config.d.ts.map +1 -1
- package/dest/config/network_config.js +4 -1
- package/dest/config/network_name.d.ts +2 -2
- package/dest/config/network_name.d.ts.map +1 -1
- package/dest/config/network_name.js +2 -2
- package/dest/config/secret_value.d.ts +2 -2
- package/dest/config/secret_value.d.ts.map +1 -1
- package/dest/crypto/aes128/index.d.ts +2 -1
- package/dest/crypto/aes128/index.d.ts.map +1 -1
- package/dest/crypto/aes128/index.js +11 -2
- package/dest/crypto/bls/bn254_keystore.d.ts +9 -176
- package/dest/crypto/bls/bn254_keystore.d.ts.map +1 -1
- package/dest/crypto/bls/bn254_keystore.js +0 -17
- package/dest/crypto/ecdsa/signature.d.ts +10 -1
- package/dest/crypto/ecdsa/signature.d.ts.map +1 -1
- package/dest/crypto/poseidon/index.d.ts +1 -2
- package/dest/crypto/poseidon/index.d.ts.map +1 -1
- package/dest/crypto/poseidon/index.js +40 -42
- package/dest/crypto/random/randomness_singleton.d.ts +4 -3
- package/dest/crypto/random/randomness_singleton.d.ts.map +1 -1
- package/dest/crypto/random/randomness_singleton.js +4 -4
- package/dest/crypto/schnorr/index.d.ts +8 -7
- package/dest/crypto/schnorr/index.d.ts.map +1 -1
- package/dest/crypto/schnorr/index.js +6 -6
- package/dest/crypto/schnorr/signature.d.ts +9 -29
- package/dest/crypto/schnorr/signature.d.ts.map +1 -1
- package/dest/crypto/schnorr/signature.js +20 -36
- package/dest/crypto/secp256k1-signer/utils.d.ts +12 -1
- package/dest/crypto/secp256k1-signer/utils.d.ts.map +1 -1
- package/dest/crypto/secp256k1-signer/utils.js +26 -0
- package/dest/crypto/sync/poseidon/index.d.ts +1 -2
- package/dest/crypto/sync/poseidon/index.d.ts.map +1 -1
- package/dest/crypto/sync/poseidon/index.js +0 -8
- package/dest/curves/bls12/field.d.ts +3 -3
- package/dest/curves/bls12/field.d.ts.map +1 -1
- package/dest/curves/bls12/field.js +0 -5
- package/dest/curves/bls12/point.d.ts +11 -2
- package/dest/curves/bls12/point.d.ts.map +1 -1
- package/dest/curves/bn254/field.d.ts +24 -19
- package/dest/curves/bn254/field.d.ts.map +1 -1
- package/dest/curves/bn254/field.js +28 -19
- package/dest/curves/grumpkin/point.d.ts +21 -26
- package/dest/curves/grumpkin/point.d.ts.map +1 -1
- package/dest/curves/grumpkin/point.js +29 -43
- package/dest/error/index.d.ts +4 -4
- package/dest/error/index.d.ts.map +1 -1
- package/dest/eth-address/index.d.ts +2 -2
- package/dest/eth-address/index.d.ts.map +1 -1
- package/dest/eth-address/index.js +0 -3
- package/dest/eth-signature/eth_signature.d.ts +6 -2
- package/dest/eth-signature/eth_signature.d.ts.map +1 -1
- package/dest/eth-signature/eth_signature.js +7 -2
- package/dest/fifo/fifo_frame_reader.d.ts +41 -0
- package/dest/fifo/fifo_frame_reader.d.ts.map +1 -0
- package/dest/fifo/fifo_frame_reader.js +74 -0
- package/dest/fifo/index.d.ts +2 -0
- package/dest/fifo/index.d.ts.map +1 -0
- package/dest/fifo/index.js +1 -0
- package/dest/fifo_set/fifo_set.d.ts +15 -0
- package/dest/fifo_set/fifo_set.d.ts.map +1 -0
- package/dest/fifo_set/fifo_set.js +39 -0
- package/dest/fifo_set/index.d.ts +2 -0
- package/dest/fifo_set/index.d.ts.map +1 -0
- package/dest/fifo_set/index.js +1 -0
- package/dest/jest/setup.js +28 -1
- package/dest/json-rpc/client/fetch.d.ts +1 -1
- package/dest/json-rpc/client/fetch.d.ts.map +1 -1
- package/dest/json-rpc/client/fetch.js +4 -3
- package/dest/json-rpc/client/safe_json_rpc_client.d.ts +2 -1
- package/dest/json-rpc/client/safe_json_rpc_client.d.ts.map +1 -1
- package/dest/json-rpc/client/safe_json_rpc_client.js +3 -3
- package/dest/json-rpc/client/undici.d.ts +1 -1
- package/dest/json-rpc/client/undici.d.ts.map +1 -1
- package/dest/json-rpc/client/undici.js +23 -4
- package/dest/json-rpc/fixtures/class_a.d.ts +3 -3
- package/dest/json-rpc/fixtures/class_a.d.ts.map +1 -1
- package/dest/json-rpc/fixtures/class_b.d.ts +3 -3
- package/dest/json-rpc/fixtures/class_b.d.ts.map +1 -1
- package/dest/json-rpc/fixtures/test_state.d.ts +4 -8
- package/dest/json-rpc/fixtures/test_state.d.ts.map +1 -1
- package/dest/json-rpc/fixtures/test_state.js +57 -17
- package/dest/json-rpc/server/api_key_auth.d.ts +19 -0
- package/dest/json-rpc/server/api_key_auth.d.ts.map +1 -0
- package/dest/json-rpc/server/api_key_auth.js +57 -0
- package/dest/json-rpc/server/index.d.ts +2 -1
- package/dest/json-rpc/server/index.d.ts.map +1 -1
- package/dest/json-rpc/server/index.js +1 -0
- package/dest/json-rpc/server/safe_json_rpc_server.d.ts +8 -3
- package/dest/json-rpc/server/safe_json_rpc_server.d.ts.map +1 -1
- package/dest/json-rpc/server/safe_json_rpc_server.js +28 -14
- package/dest/log/bigint-utils.d.ts +5 -0
- package/dest/log/bigint-utils.d.ts.map +1 -0
- package/dest/log/bigint-utils.js +21 -0
- package/dest/log/gcloud-logger-config.d.ts +1 -1
- package/dest/log/gcloud-logger-config.d.ts.map +1 -1
- package/dest/log/gcloud-logger-config.js +3 -0
- package/dest/log/libp2p_logger.d.ts +5 -2
- package/dest/log/libp2p_logger.d.ts.map +1 -1
- package/dest/log/libp2p_logger.js +14 -4
- package/dest/log/log-filters.d.ts +17 -4
- package/dest/log/log-filters.d.ts.map +1 -1
- package/dest/log/log-filters.js +26 -12
- package/dest/log/pino-logger-server.d.ts +9 -0
- package/dest/log/pino-logger-server.d.ts.map +1 -0
- package/dest/log/pino-logger-server.js +18 -0
- package/dest/log/pino-logger.d.ts +37 -8
- package/dest/log/pino-logger.d.ts.map +1 -1
- package/dest/log/pino-logger.js +137 -29
- package/dest/noir/noir_package_config.d.ts +19 -104
- package/dest/noir/noir_package_config.d.ts.map +1 -1
- package/dest/noir/noir_package_config.js +1 -1
- package/dest/queue/base_memory_queue.d.ts +2 -2
- package/dest/queue/base_memory_queue.d.ts.map +1 -1
- package/dest/queue/batch_queue.d.ts +1 -1
- package/dest/queue/batch_queue.d.ts.map +1 -1
- package/dest/queue/batch_queue.js +1 -0
- package/dest/queue/semaphore.d.ts +5 -1
- package/dest/queue/semaphore.d.ts.map +1 -1
- package/dest/retry/index.d.ts +22 -1
- package/dest/retry/index.d.ts.map +1 -1
- package/dest/retry/index.js +32 -0
- package/dest/schemas/api.d.ts +12 -10
- package/dest/schemas/api.d.ts.map +1 -1
- package/dest/schemas/api.js +7 -1
- package/dest/schemas/parse.d.ts +4 -4
- package/dest/schemas/parse.d.ts.map +1 -1
- package/dest/schemas/parse.js +6 -5
- package/dest/schemas/schemas.d.ts +15 -15
- package/dest/schemas/types.d.ts +3 -3
- package/dest/schemas/types.d.ts.map +1 -1
- package/dest/schemas/utils.d.ts +7 -11
- package/dest/schemas/utils.d.ts.map +1 -1
- package/dest/schemas/utils.js +2 -18
- package/dest/serialize/buffer_reader.d.ts +14 -4
- package/dest/serialize/buffer_reader.d.ts.map +1 -1
- package/dest/serialize/buffer_reader.js +26 -4
- package/dest/serialize/buffer_sink.d.ts +134 -0
- package/dest/serialize/buffer_sink.d.ts.map +1 -0
- package/dest/serialize/buffer_sink.js +297 -0
- package/dest/serialize/index.d.ts +2 -1
- package/dest/serialize/index.d.ts.map +1 -1
- package/dest/serialize/index.js +1 -0
- package/dest/serialize/serialize.d.ts +19 -1
- package/dest/serialize/serialize.d.ts.map +1 -1
- package/dest/serialize/serialize.js +31 -0
- package/dest/sleep/index.d.ts +2 -1
- package/dest/sleep/index.d.ts.map +1 -1
- package/dest/sleep/index.js +10 -1
- package/dest/string/index.js +1 -1
- package/dest/timer/date.d.ts +25 -1
- package/dest/timer/date.d.ts.map +1 -1
- package/dest/timer/date.js +33 -0
- package/dest/timer/index.d.ts +2 -2
- package/dest/timer/index.d.ts.map +1 -1
- package/dest/timer/index.js +1 -1
- package/dest/timer/timeout.d.ts +3 -1
- package/dest/timer/timeout.d.ts.map +1 -1
- package/dest/timer/timeout.js +26 -0
- package/dest/transport/dispatch/create_dispatch_proxy.d.ts +11 -2
- package/dest/transport/dispatch/create_dispatch_proxy.d.ts.map +1 -1
- package/dest/transport/index.d.ts +1 -2
- package/dest/transport/index.d.ts.map +1 -1
- package/dest/transport/index.js +0 -1
- package/dest/transport/transport_client.js +2 -2
- package/dest/trees/balanced_merkle_tree_root.d.ts +16 -0
- package/dest/trees/balanced_merkle_tree_root.d.ts.map +1 -0
- package/dest/trees/{balanced_merkle_tree.js → balanced_merkle_tree_root.js} +3 -19
- package/dest/trees/hasher.d.ts +4 -1
- package/dest/trees/hasher.d.ts.map +1 -1
- package/dest/trees/hasher.js +10 -5
- package/dest/trees/index.d.ts +4 -4
- package/dest/trees/index.d.ts.map +1 -1
- package/dest/trees/index.js +3 -3
- package/dest/trees/indexed_merkle_tree_calculator.d.ts +1 -1
- package/dest/trees/indexed_merkle_tree_calculator.d.ts.map +1 -1
- package/dest/trees/indexed_merkle_tree_calculator.js +5 -1
- package/dest/trees/membership_witness.d.ts +12 -2
- package/dest/trees/membership_witness.d.ts.map +1 -1
- package/dest/trees/membership_witness.js +9 -0
- package/dest/trees/merkle_tree_calculator.d.ts +4 -2
- package/dest/trees/merkle_tree_calculator.d.ts.map +1 -1
- package/dest/trees/merkle_tree_calculator.js +1 -5
- package/dest/trees/sibling_path.d.ts +6 -4
- package/dest/trees/sibling_path.d.ts.map +1 -1
- package/dest/trees/sibling_path.js +10 -8
- package/dest/trees/unbalanced_merkle_tree_calculator.d.ts +2 -2
- package/dest/trees/unbalanced_merkle_tree_calculator.d.ts.map +1 -1
- package/dest/trees/unbalanced_merkle_tree_calculator.js +1 -1
- package/dest/trees/{unbalanced_merkle_tree.d.ts → unbalanced_merkle_tree_root.d.ts} +4 -9
- package/dest/trees/unbalanced_merkle_tree_root.d.ts.map +1 -0
- package/dest/trees/{unbalanced_merkle_tree.js → unbalanced_merkle_tree_root.js} +9 -54
- package/dest/trees/unbalanced_tree_store.d.ts +5 -1
- package/dest/trees/unbalanced_tree_store.d.ts.map +1 -1
- package/dest/trees/unbalanced_tree_store.js +49 -1
- package/dest/types/index.d.ts +12 -2
- package/dest/types/index.d.ts.map +1 -1
- package/dest/types/index.js +3 -0
- package/package.json +29 -6
- package/src/array/sorted_array.ts +22 -17
- package/src/bigint-buffer/index.ts +6 -1
- package/src/branded-types/block_number.ts +25 -2
- package/src/branded-types/buffer32_hash.ts +38 -0
- package/src/branded-types/checkpoint_number.ts +16 -1
- package/src/branded-types/epoch.ts +1 -1
- package/src/branded-types/index.ts +2 -0
- package/src/branded-types/index_within_checkpoint.ts +88 -0
- package/src/branded-types/slot.ts +6 -1
- package/src/buffer/buffer16.ts +3 -0
- package/src/buffer/buffer32.ts +39 -68
- package/src/buffer/index.ts +1 -0
- package/src/buffer/utils.ts +8 -0
- package/src/collection/array.ts +86 -0
- package/src/collection/index.ts +2 -0
- package/src/collection/lru_map.ts +143 -0
- package/src/collection/lru_set.ts +115 -0
- package/src/committable/committable.ts +1 -1
- package/src/config/env_var.ts +84 -28
- package/src/config/index.ts +132 -95
- package/src/config/network_config.ts +3 -0
- package/src/config/network_name.ts +4 -4
- package/src/config/secret_value.ts +1 -1
- package/src/crypto/aes128/index.ts +11 -2
- package/src/crypto/bls/bn254_keystore.ts +0 -23
- package/src/crypto/poseidon/index.ts +42 -44
- package/src/crypto/random/randomness_singleton.ts +9 -5
- package/src/crypto/schnorr/index.ts +9 -8
- package/src/crypto/schnorr/signature.ts +17 -46
- package/src/crypto/secp256k1-signer/utils.ts +32 -0
- package/src/crypto/sync/poseidon/index.ts +0 -9
- package/src/curves/bls12/field.ts +0 -7
- package/src/curves/bn254/field.ts +41 -36
- package/src/curves/grumpkin/point.ts +23 -40
- package/src/eth-address/index.ts +0 -4
- package/src/eth-signature/eth_signature.ts +7 -1
- package/src/fifo/fifo_frame_reader.ts +98 -0
- package/src/fifo/index.ts +1 -0
- package/src/fifo_set/fifo_set.ts +52 -0
- package/src/fifo_set/index.ts +1 -0
- package/src/jest/setup.mjs +31 -1
- package/src/json-rpc/client/fetch.ts +4 -3
- package/src/json-rpc/client/safe_json_rpc_client.ts +4 -2
- package/src/json-rpc/client/undici.ts +23 -3
- package/src/json-rpc/fixtures/test_state.ts +10 -10
- package/src/json-rpc/server/api_key_auth.ts +63 -0
- package/src/json-rpc/server/index.ts +1 -0
- package/src/json-rpc/server/safe_json_rpc_server.ts +32 -14
- package/src/log/bigint-utils.ts +25 -0
- package/src/log/gcloud-logger-config.ts +5 -0
- package/src/log/libp2p_logger.ts +12 -5
- package/src/log/log-filters.ts +29 -11
- package/src/log/pino-logger-server.ts +25 -0
- package/src/log/pino-logger.ts +160 -39
- package/src/noir/noir_package_config.ts +32 -20
- package/src/queue/base_memory_queue.ts +1 -1
- package/src/queue/batch_queue.ts +1 -0
- package/src/queue/semaphore.ts +5 -0
- package/src/retry/index.ts +48 -0
- package/src/schemas/api.ts +25 -25
- package/src/schemas/parse.ts +9 -6
- package/src/schemas/schemas.ts +4 -4
- package/src/schemas/types.ts +2 -2
- package/src/schemas/utils.ts +4 -38
- package/src/serialize/buffer_reader.ts +36 -9
- package/src/serialize/buffer_sink.ts +350 -0
- package/src/serialize/index.ts +1 -0
- package/src/serialize/serialize.ts +32 -0
- package/src/sleep/index.ts +10 -1
- package/src/string/index.ts +1 -1
- package/src/timer/date.ts +48 -0
- package/src/timer/index.ts +1 -1
- package/src/timer/timeout.ts +31 -0
- package/src/transport/dispatch/create_dispatch_proxy.ts +11 -1
- package/src/transport/index.ts +0 -1
- package/src/transport/transport_client.ts +2 -2
- package/src/trees/{balanced_merkle_tree.ts → balanced_merkle_tree_root.ts} +3 -22
- package/src/trees/hasher.ts +12 -0
- package/src/trees/index.ts +3 -3
- package/src/trees/indexed_merkle_tree_calculator.ts +5 -1
- package/src/trees/membership_witness.ts +8 -0
- package/src/trees/merkle_tree_calculator.ts +4 -10
- package/src/trees/sibling_path.ts +11 -6
- package/src/trees/unbalanced_merkle_tree_calculator.ts +1 -2
- package/src/trees/{unbalanced_merkle_tree.ts → unbalanced_merkle_tree_root.ts} +9 -70
- package/src/trees/unbalanced_tree_store.ts +57 -2
- package/src/types/index.ts +20 -1
- package/dest/crypto/serialize.d.ts +0 -51
- package/dest/crypto/serialize.d.ts.map +0 -1
- package/dest/crypto/serialize.js +0 -68
- package/dest/transport/dispatch/create_dispatch_fn.d.ts +0 -25
- package/dest/transport/dispatch/create_dispatch_fn.d.ts.map +0 -1
- package/dest/transport/dispatch/create_dispatch_fn.js +0 -17
- package/dest/trees/balanced_merkle_tree.d.ts +0 -22
- package/dest/trees/balanced_merkle_tree.d.ts.map +0 -1
- package/dest/trees/unbalanced_merkle_tree.d.ts.map +0 -1
- package/src/crypto/serialize.ts +0 -85
- package/src/transport/dispatch/create_dispatch_fn.ts +0 -35
package/src/retry/index.ts
CHANGED
|
@@ -103,3 +103,51 @@ export async function retryUntil<T>(
|
|
|
103
103
|
}
|
|
104
104
|
}
|
|
105
105
|
}
|
|
106
|
+
|
|
107
|
+
/**
|
|
108
|
+
* Retry an asynchronous function until it returns a truthy value or the maximum number of retries is exceeded.
|
|
109
|
+
* The function is retried periodically with a fixed interval between attempts.
|
|
110
|
+
*
|
|
111
|
+
* @param fn - The asynchronous function to be retried, which should return a truthy value upon success or undefined otherwise.
|
|
112
|
+
* @param name - The optional name of the operation, used for generating error messages.
|
|
113
|
+
* @param maxRetries - The maximum number of retry attempts before throwing an error.
|
|
114
|
+
* @param retryInterval - The optional interval, in seconds, between retry attempts. Defaults to 1 second.
|
|
115
|
+
* @returns A Promise that resolves with the successful (truthy) result of the provided function, or rejects if retries are exhausted.
|
|
116
|
+
*/
|
|
117
|
+
export async function retryTimes<T>(
|
|
118
|
+
fn: () => (T | undefined) | Promise<T | undefined>,
|
|
119
|
+
name = '',
|
|
120
|
+
maxRetries: number,
|
|
121
|
+
retryInterval = 1,
|
|
122
|
+
) {
|
|
123
|
+
for (let attempt = 0; attempt <= maxRetries; attempt++) {
|
|
124
|
+
const result = await fn();
|
|
125
|
+
if (result) {
|
|
126
|
+
return result;
|
|
127
|
+
}
|
|
128
|
+
|
|
129
|
+
if (attempt < maxRetries) {
|
|
130
|
+
await sleep(retryInterval * 1000);
|
|
131
|
+
}
|
|
132
|
+
}
|
|
133
|
+
|
|
134
|
+
throw new Error(name ? `Retries exhausted awaiting ${name}` : 'Retries exhausted');
|
|
135
|
+
}
|
|
136
|
+
|
|
137
|
+
/**
|
|
138
|
+
* Convenience wrapper around retryUntil with fast polling for tests.
|
|
139
|
+
* Uses 10s timeout and 100ms polling interval by default.
|
|
140
|
+
*
|
|
141
|
+
* @param fn - The function to retry until it returns a truthy value.
|
|
142
|
+
* @param name - Description of what we're waiting for (for error messages).
|
|
143
|
+
* @param timeout - Optional timeout in seconds. Defaults to 10s.
|
|
144
|
+
* @param interval - Optional interval in seconds. Defaults to 0.1s (100ms).
|
|
145
|
+
*/
|
|
146
|
+
export function retryFastUntil<T>(
|
|
147
|
+
fn: () => (T | undefined) | Promise<T | undefined>,
|
|
148
|
+
name = '',
|
|
149
|
+
timeout = 10,
|
|
150
|
+
interval = 0.1,
|
|
151
|
+
) {
|
|
152
|
+
return retryUntil(fn, name, timeout, interval);
|
|
153
|
+
}
|
package/src/schemas/api.ts
CHANGED
|
@@ -2,32 +2,19 @@ import type { z } from 'zod';
|
|
|
2
2
|
|
|
3
3
|
import type { ZodNullableOptional } from './utils.js';
|
|
4
4
|
|
|
5
|
-
// Forces usage of
|
|
6
|
-
type ZodParameterTypeFor<T> = undefined extends T
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
type
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
// The complexity is required to satisfy ZodTuple which requires a fixed length tuple and
|
|
14
|
-
// has a very annoying type of [] | [ZodTypeAny, ...ZodTypeAny], and most types fail to match
|
|
15
|
-
// the second option. While a purely recursive approach works, it fails when trying to deal
|
|
16
|
-
// with optional arguments (ie optional items in the tuple), and ts does not really like them
|
|
17
|
-
// during a recursion and fails with infinite stack depth.
|
|
18
|
-
// This type appears to satisfy everyone. Everyone but me.
|
|
19
|
-
type ZodMapParameterTypes<T> = T extends []
|
|
20
|
-
? []
|
|
21
|
-
: T extends [item: infer Head, ...infer Rest]
|
|
22
|
-
? [ZodParameterTypeFor<Head>, ...{ [K in keyof Rest]: ZodParameterTypeFor<Rest[K]> }]
|
|
23
|
-
: T extends [item?: infer Head, ...infer Rest]
|
|
24
|
-
? [ZodNullableOptional<ZodParameterTypeFor<Head>>, ...{ [K in keyof Rest]: ZodParameterTypeFor<Rest[K]> }]
|
|
25
|
-
: never;
|
|
5
|
+
// Forces usage of schemas that accept nulls for optional parameters.
|
|
6
|
+
type ZodParameterTypeFor<T> = undefined extends T ? ZodNullableOptional<z.ZodType<T, any>> : z.ZodType<T, any>;
|
|
7
|
+
|
|
8
|
+
type ZodReturnTypeFor<T> = z.ZodType<T, any>;
|
|
9
|
+
|
|
10
|
+
type ZodMapParameterTypes<T extends readonly unknown[]> = {
|
|
11
|
+
[K in keyof T]-?: ZodParameterTypeFor<T[K]>;
|
|
12
|
+
};
|
|
26
13
|
|
|
27
14
|
/** Maps all functions in an interface to their schema representation. */
|
|
28
15
|
export type ApiSchemaFor<T> = {
|
|
29
16
|
[K in keyof T]: T[K] extends (...args: infer Args) => Promise<infer Ret>
|
|
30
|
-
? z.ZodFunction<z.ZodTuple<ZodMapParameterTypes<Args>,
|
|
17
|
+
? z.ZodFunction<z.ZodTuple<ZodMapParameterTypes<Args>, null>, ZodReturnTypeFor<Ret>>
|
|
31
18
|
: never;
|
|
32
19
|
};
|
|
33
20
|
|
|
@@ -37,11 +24,24 @@ export type ApiSchema = {
|
|
|
37
24
|
};
|
|
38
25
|
|
|
39
26
|
/** Return whether an API schema defines a valid function schema for a given method name. */
|
|
40
|
-
export function schemaHasMethod
|
|
27
|
+
export function schemaHasMethod<T extends ApiSchema>(
|
|
28
|
+
schema: T,
|
|
29
|
+
methodName: string,
|
|
30
|
+
): methodName is Extract<keyof T, string> {
|
|
41
31
|
return (
|
|
42
32
|
typeof methodName === 'string' &&
|
|
43
33
|
Object.hasOwn(schema, methodName) &&
|
|
44
|
-
|
|
45
|
-
|
|
34
|
+
schema[methodName].def.input !== undefined &&
|
|
35
|
+
schema[methodName].def.output !== undefined
|
|
46
36
|
);
|
|
47
37
|
}
|
|
38
|
+
|
|
39
|
+
/** Returns the parameter tuple schema for an API method schema. */
|
|
40
|
+
export function getSchemaParameters<T extends z.ZodFunction<z.ZodTuple<any, any>, z.ZodTypeAny>>(schema: T) {
|
|
41
|
+
return schema.def.input;
|
|
42
|
+
}
|
|
43
|
+
|
|
44
|
+
/** Returns the return value schema for an API method schema. */
|
|
45
|
+
export function getSchemaReturnType<T extends z.ZodFunction<z.ZodTuple<any, any>, z.ZodTypeAny>>(schema: T) {
|
|
46
|
+
return schema.def.output;
|
|
47
|
+
}
|
package/src/schemas/parse.ts
CHANGED
|
@@ -4,16 +4,19 @@ import { times } from '../collection/array.js';
|
|
|
4
4
|
|
|
5
5
|
/** Parses the given arguments using a tuple from the provided schemas. */
|
|
6
6
|
export function parse<T extends [] | [z.ZodTypeAny, ...z.ZodTypeAny[]]>(args: IArguments, ...schemas: T) {
|
|
7
|
-
return
|
|
7
|
+
return schemas.length === 0
|
|
8
|
+
? z.tuple([]).parse(args)
|
|
9
|
+
: z.tuple(schemas as [z.ZodTypeAny, ...z.ZodTypeAny[]]).parse(args);
|
|
8
10
|
}
|
|
9
11
|
|
|
10
12
|
/**
|
|
11
13
|
* Parses the given arguments against a tuple, allowing empty for optional items.
|
|
12
|
-
* @dev Zod doesn't like
|
|
14
|
+
* @dev Zod doesn't like tuples with optional items. See https://github.com/colinhacks/zod/discussions/949.
|
|
13
15
|
*/
|
|
14
|
-
export function parseWithOptionals<T extends z.
|
|
15
|
-
const
|
|
16
|
-
const
|
|
16
|
+
export function parseWithOptionals<T extends z.ZodTuple<any, any>>(args: any[], schema: T): Promise<z.output<T>> {
|
|
17
|
+
const items = schema.def.items;
|
|
18
|
+
const missingCount = items.length - args.length;
|
|
19
|
+
const optionalCount = items.filter(isOptional).length;
|
|
17
20
|
const toParse =
|
|
18
21
|
missingCount > 0 && missingCount <= optionalCount ? args.concat(times(missingCount, () => undefined)) : args;
|
|
19
22
|
return schema.parseAsync(toParse);
|
|
@@ -24,6 +27,6 @@ function isOptional(schema: z.ZodTypeAny) {
|
|
|
24
27
|
return schema.isOptional();
|
|
25
28
|
} catch {
|
|
26
29
|
// See https://github.com/colinhacks/zod/issues/1911
|
|
27
|
-
return schema.
|
|
30
|
+
return schema.def.type === 'optional';
|
|
28
31
|
}
|
|
29
32
|
}
|
package/src/schemas/schemas.ts
CHANGED
|
@@ -44,15 +44,15 @@ export const schemas = {
|
|
|
44
44
|
]),
|
|
45
45
|
|
|
46
46
|
/** Coerces any input to bigint. */
|
|
47
|
-
BigInt: z.union([z.bigint(), z.number(), z.string()]).pipe(z.coerce.bigint()),
|
|
47
|
+
BigInt: z.union([z.bigint(), z.number(), z.string()]).pipe(z.coerce.bigint<string | number | bigint>()),
|
|
48
48
|
|
|
49
49
|
/** Coerces any input to integer number. */
|
|
50
|
-
Integer: z.union([z.bigint(), z.number(), z.string()]).pipe(z.coerce.number().int()),
|
|
50
|
+
Integer: z.union([z.bigint(), z.number(), z.string()]).pipe(z.coerce.number<string | number | bigint>().int()),
|
|
51
51
|
|
|
52
52
|
/** Coerces input to UInt32. */
|
|
53
53
|
UInt32: z.union([z.bigint(), z.number(), z.string()]).pipe(
|
|
54
54
|
z.coerce
|
|
55
|
-
.number()
|
|
55
|
+
.number<string | number | bigint>()
|
|
56
56
|
.int()
|
|
57
57
|
.min(0)
|
|
58
58
|
.max(2 ** 32 - 1),
|
|
@@ -61,7 +61,7 @@ export const schemas = {
|
|
|
61
61
|
/** Coerces input to UInt64. */
|
|
62
62
|
UInt64: z.union([z.bigint(), z.number(), z.string()]).pipe(
|
|
63
63
|
z.coerce
|
|
64
|
-
.bigint()
|
|
64
|
+
.bigint<string | number | bigint>()
|
|
65
65
|
.min(0n)
|
|
66
66
|
.max(2n ** 64n - 1n),
|
|
67
67
|
),
|
package/src/schemas/types.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import type { ZodType } from 'zod';
|
|
2
2
|
|
|
3
|
-
export type ZodFor<T> = ZodType<T, any
|
|
3
|
+
export type ZodFor<T> = ZodType<T, any>;
|
|
4
4
|
|
|
5
5
|
/**
|
|
6
6
|
* Creates a schema validator that enforces all properties of type T are present in the schema.
|
|
@@ -26,7 +26,7 @@ export type ZodFor<T> = ZodType<T, any, any>;
|
|
|
26
26
|
* ```
|
|
27
27
|
*/
|
|
28
28
|
export function zodFor<T>() {
|
|
29
|
-
return (schema => schema) as <S extends ZodType<any, any
|
|
29
|
+
return (schema => schema) as <S extends ZodType<any, any>>(
|
|
30
30
|
schema: keyof T extends keyof S['_output']
|
|
31
31
|
? keyof S['_output'] extends keyof T
|
|
32
32
|
? S
|
package/src/schemas/utils.ts
CHANGED
|
@@ -1,16 +1,4 @@
|
|
|
1
|
-
import {
|
|
2
|
-
OK,
|
|
3
|
-
type ParseInput,
|
|
4
|
-
type ParseReturnType,
|
|
5
|
-
ZodFirstPartyTypeKind,
|
|
6
|
-
type ZodObject,
|
|
7
|
-
ZodOptional,
|
|
8
|
-
ZodParsedType,
|
|
9
|
-
type ZodRawShape,
|
|
10
|
-
type ZodType,
|
|
11
|
-
type ZodTypeAny,
|
|
12
|
-
z,
|
|
13
|
-
} from 'zod';
|
|
1
|
+
import { type ZodObject, type ZodRawShape, type ZodType, type ZodTypeAny, z } from 'zod';
|
|
14
2
|
|
|
15
3
|
import { pick } from '../collection/object.js';
|
|
16
4
|
import { isHex, withoutHexPrefix } from '../string/index.js';
|
|
@@ -41,24 +29,7 @@ export const bufferSchema: ZodFor<Buffer> = z.union([
|
|
|
41
29
|
z.instanceof(Buffer),
|
|
42
30
|
]);
|
|
43
31
|
|
|
44
|
-
export
|
|
45
|
-
_isNullableOptional = true;
|
|
46
|
-
|
|
47
|
-
override _parse(input: ParseInput): ParseReturnType<this['_output']> {
|
|
48
|
-
const parsedType = this._getType(input);
|
|
49
|
-
if (parsedType === ZodParsedType.undefined || parsedType === ZodParsedType.null) {
|
|
50
|
-
return OK(undefined);
|
|
51
|
-
}
|
|
52
|
-
return this._def.innerType._parse(input);
|
|
53
|
-
}
|
|
54
|
-
|
|
55
|
-
static override create<T extends ZodTypeAny>(type: T): ZodNullableOptional<T> {
|
|
56
|
-
return new ZodNullableOptional({
|
|
57
|
-
innerType: type,
|
|
58
|
-
typeName: ZodFirstPartyTypeKind.ZodOptional,
|
|
59
|
-
}) as any;
|
|
60
|
-
}
|
|
61
|
-
}
|
|
32
|
+
export type ZodNullableOptional<T extends ZodTypeAny> = ZodType<z.output<T> | undefined, z.input<T> | null | undefined>;
|
|
62
33
|
|
|
63
34
|
/**
|
|
64
35
|
* Declares a parameter as optional. Use this over z.optional in order to accept nulls as undefineds.
|
|
@@ -66,7 +37,7 @@ export class ZodNullableOptional<T extends ZodTypeAny> extends ZodOptional<T> {
|
|
|
66
37
|
* need to convert nulls to undefineds as we parse.
|
|
67
38
|
*/
|
|
68
39
|
export function optional<T extends ZodTypeAny>(schema: T) {
|
|
69
|
-
return
|
|
40
|
+
return schema.nullish().transform(value => value ?? undefined);
|
|
70
41
|
}
|
|
71
42
|
|
|
72
43
|
type ToJsonIs<T, TRet> = T extends { toJSON(): TRet } ? T : never;
|
|
@@ -83,7 +54,6 @@ export function hexSchemaFor<TClass extends { fromString(str: string): any } | {
|
|
|
83
54
|
TClass extends { fromString(str: string): infer TInstance } | { fromBuffer(buf: Buffer): infer TInstance }
|
|
84
55
|
? ToJsonIs<TInstance, string>
|
|
85
56
|
: never,
|
|
86
|
-
any,
|
|
87
57
|
string
|
|
88
58
|
> {
|
|
89
59
|
const stringSchema = refinement ? z.string().refine(refinement, `Not a valid instance`) : z.string();
|
|
@@ -101,11 +71,7 @@ export function hexSchemaFor<TClass extends { fromString(str: string): any } | {
|
|
|
101
71
|
export function bufferSchemaFor<TClass extends { fromBuffer(buf: Buffer): any }>(
|
|
102
72
|
klazz: TClass,
|
|
103
73
|
refinement?: (buf: Buffer) => boolean,
|
|
104
|
-
): ZodType<
|
|
105
|
-
TClass extends { fromBuffer(buf: Buffer): infer TInstance } ? ToJsonIs<TInstance, Buffer> : never,
|
|
106
|
-
any,
|
|
107
|
-
string
|
|
108
|
-
> {
|
|
74
|
+
): ZodType<TClass extends { fromBuffer(buf: Buffer): infer TInstance } ? ToJsonIs<TInstance, Buffer> : never, string> {
|
|
109
75
|
return bufferSchema.refine(refinement ?? (() => true), 'Not a valid buffer').transform(klazz.fromBuffer.bind(klazz));
|
|
110
76
|
}
|
|
111
77
|
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { toBigIntBE } from '../bigint-buffer/index.js';
|
|
1
2
|
import type { Tuple } from './types.js';
|
|
2
3
|
|
|
3
4
|
/**
|
|
@@ -130,6 +131,20 @@ export class BufferReader {
|
|
|
130
131
|
return result;
|
|
131
132
|
}
|
|
132
133
|
|
|
134
|
+
/**
|
|
135
|
+
* Reads a 256-bit signed integer (two's complement) from the buffer at the current index position.
|
|
136
|
+
* Updates the index position by 32 bytes after reading the number.
|
|
137
|
+
*
|
|
138
|
+
* @returns The read 256 bit signed value as a bigint.
|
|
139
|
+
*/
|
|
140
|
+
public readInt256(): bigint {
|
|
141
|
+
this.#rangeCheck(32);
|
|
142
|
+
const unsigned = toBigIntBE(this.buffer.subarray(this.index, this.index + 32));
|
|
143
|
+
this.index += 32;
|
|
144
|
+
const signBit = 1n << 255n;
|
|
145
|
+
return unsigned >= signBit ? unsigned - (1n << 256n) : unsigned;
|
|
146
|
+
}
|
|
147
|
+
|
|
133
148
|
/** Alias for readUInt256 */
|
|
134
149
|
public readBigInt(): bigint {
|
|
135
150
|
return this.readUInt256();
|
|
@@ -224,15 +239,22 @@ export class BufferReader {
|
|
|
224
239
|
* deserializing each one using the 'fromBuffer' method of 'itemDeserializer'.
|
|
225
240
|
*
|
|
226
241
|
* @param itemDeserializer - Object with 'fromBuffer' method to deserialize vector elements.
|
|
242
|
+
* @param maxSize - Optional maximum allowed size for the vector. If the size exceeds this, an error is thrown.
|
|
227
243
|
* @returns An array of deserialized elements of type T.
|
|
228
244
|
*/
|
|
229
|
-
public readVector<T>(
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
245
|
+
public readVector<T>(
|
|
246
|
+
itemDeserializer: {
|
|
247
|
+
/**
|
|
248
|
+
* A method to deserialize data from a buffer.
|
|
249
|
+
*/
|
|
250
|
+
fromBuffer: (reader: BufferReader) => T;
|
|
251
|
+
},
|
|
252
|
+
maxSize?: number,
|
|
253
|
+
): T[] {
|
|
235
254
|
const size = this.readNumber();
|
|
255
|
+
if (maxSize !== undefined && size > maxSize) {
|
|
256
|
+
throw new Error(`Vector size ${size} exceeds maximum allowed ${maxSize}`);
|
|
257
|
+
}
|
|
236
258
|
const result = new Array<T>(size);
|
|
237
259
|
for (let i = 0; i < size; i++) {
|
|
238
260
|
result[i] = itemDeserializer.fromBuffer(this);
|
|
@@ -344,10 +366,11 @@ export class BufferReader {
|
|
|
344
366
|
* The method first reads the size of the string, then reads the corresponding
|
|
345
367
|
* number of bytes from the buffer and converts them to a string.
|
|
346
368
|
*
|
|
369
|
+
* @param maxSize - Optional maximum allowed size for the string buffer. If the size exceeds this, an error is thrown.
|
|
347
370
|
* @returns The read string from the buffer.
|
|
348
371
|
*/
|
|
349
|
-
public readString(): string {
|
|
350
|
-
return this.readBuffer().toString();
|
|
372
|
+
public readString(maxSize?: number): string {
|
|
373
|
+
return this.readBuffer(maxSize).toString();
|
|
351
374
|
}
|
|
352
375
|
|
|
353
376
|
/**
|
|
@@ -356,10 +379,14 @@ export class BufferReader {
|
|
|
356
379
|
* a Buffer with that size containing the bytes. Useful for reading variable-length
|
|
357
380
|
* binary data encoded as (size, data) format.
|
|
358
381
|
*
|
|
382
|
+
* @param maxSize - Optional maximum allowed size for the buffer. If the size exceeds this, an error is thrown.
|
|
359
383
|
* @returns A Buffer containing the read bytes.
|
|
360
384
|
*/
|
|
361
|
-
public readBuffer(): Buffer {
|
|
385
|
+
public readBuffer(maxSize?: number): Buffer {
|
|
362
386
|
const size = this.readNumber();
|
|
387
|
+
if (maxSize !== undefined && size > maxSize) {
|
|
388
|
+
throw new Error(`Buffer size ${size} exceeds maximum allowed ${maxSize}`);
|
|
389
|
+
}
|
|
363
390
|
this.#rangeCheck(size);
|
|
364
391
|
return this.readBytes(size);
|
|
365
392
|
}
|