@api3/commons 0.7.0 → 0.8.0

package/dist/blockchain-utilities/derivation.d.ts

@@ -1,78 +1,21 @@
 import { ethers } from 'ethers';
+import type { Address, Hex, Mnemonic } from './schema';
 export declare const PROTOCOL_IDS: {
-    RRP: string;
-    PSP: string;
-    RELAYED_RRP: string;
-    RELAYED_PSP: string;
-    AIRSEEKER: string;
+    readonly RRP: "1";
+    readonly PSP: "2";
+    readonly RELAYED_RRP: "3";
+    readonly RELAYED_PSP: "4";
+    readonly AIRSEEKER: "5";
 };
-/**
- * An interface that reflects the structure of a Template
- */
-export interface Template {
-    airnode: string;
-    encodedParameters: string;
-    endpointId: string;
-}
-/**
- * Derives a template ID from the input parameters
- *
- * @param airnode an Airnode address
- * @param encodedParameters encoded parameters, see the airnode/abi package's encode function
- * @param endpointId An endpointID (see deriveEndpointId)
- */
-export declare const deriveTemplateId: ({ airnode, encodedParameters, endpointId }: Template) => string;
-/**
- * Derives an endpoint ID
- *
- * @param oisTitle the OIS title
- * @param endpointName the endpoint name
- */
+export type ProtocolId = (typeof PROTOCOL_IDS)[keyof typeof PROTOCOL_IDS];
+export declare const deriveTemplateIdV0: (airnode: Address, endpointId: Hex, encodedParameters: Hex) => string;
+export declare const deriveTemplateIdV1: (endpointId: Hex, encodedParameters: Hex) => string;
 export declare const deriveEndpointId: (oisTitle: string, endpointName: string) => string;
-/**
- * Derives an airnode address's xpub, required for allowing signed data consumers to verify authenticity
- *
- * @param airnodeMnemonic the airnode's mnemonic
- */
-export declare const deriveAirnodeXpub: (airnodeMnemonic: string) => string;
-/**
- * Derives a wallet path from a sponsor address, used for calculating a sponsor wallet.
- *
- * @param sponsorAddress an EVM-compatible address
- * @param protocolId an API application protocol ID
- */
-export declare function deriveWalletPathFromSponsorAddress(sponsorAddress: string, protocolId: string): string;
-/**
- * Encodes/formats a string as a hex-encoded bytes32 string.
- *
- * @param input the input string
- */
+export declare const deriveAirnodeXpub: (airnodeMnemonic: Mnemonic) => string;
+export declare function deriveWalletPathFromSponsorAddress(sponsorAddress: Address, protocolId: ProtocolId): string;
 export declare const toBytes32String: (input: string) => string;
-/**
- * Decodes a hex-encoded bytes32 string to a normal string.
- *
- * @param input the input hex string
- */
-export declare const fromBytes32String: (input: string) => string;
-/**
- * Derives a sponsor wallet, given a mnemonic and dapiName.
- *
- * @param sponsorWalletMnemonic the sponsor wallet mnemonic
- * @param dapiName the dapi name
- */
-export declare const deriveSponsorWallet: (sponsorWalletMnemonic: string, dapiName: string) => ethers.Wallet;
-/**
- * Derives the ID of a single beacon
- *
- * @param airnodeAddress the airnode address of the provider that supplies the data used to update this beacon
- * @param templateId the templateId of the template used to generate the data used to update this beacon
- */
-export declare const deriveBeaconId: (airnodeAddress: string, templateId: string) => string;
-/**
- * Derives the ID of a set of beacons.
- * By convention beacon IDs are sorted alphabetically - the ordering impacts the resulting hash.
- *
- * @param beaconIds an ordered array of beacon ids
- */
-export declare const deriveBeaconSetId: (beaconIds: string[]) => string;
+export declare const fromBytes32String: (input: Hex) => string;
+export declare const deriveSponsorWallet: (airnodeMnemonic: Mnemonic, dapiName: string, protocolId: ProtocolId) => ethers.Wallet;
+export declare const deriveBeaconId: (airnodeAddress: Address, templateId: Hex) => string;
+export declare const deriveBeaconSetId: (beaconIds: Hex[]) => string;
 //# sourceMappingURL=derivation.d.ts.map

package/dist/blockchain-utilities/derivation.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"derivation.d.ts","sourceRoot":"","sources":["../../src/blockchain-utilities/derivation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAIhC,eAAO,MAAM,YAAY;;;;;;CAMxB,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,OAAO,EAAE,MAAM,CAAC;IAChB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;;;;;GAMG;AACH,eAAO,MAAM,gBAAgB,+CAAgD,QAAQ,WACsB,CAAC;AAE5G;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,aAAc,MAAM,gBAAgB,MAAM,WACsC,CAAC;AAE9G;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,oBAAqB,MAAM,WAC0C,CAAC;AAEpG;;;;;GAKG;AACH,wBAAgB,kCAAkC,CAAC,cAAc,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,UAU5F;AAED;;;;GAIG;AACH,eAAO,MAAM,eAAe,UAAW,MAAM,WAA4C,CAAC;AAE1F;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,UAAW,MAAM,WAA2C,CAAC;AAE3F;;;;;GAKG;AACH,eAAO,MAAM,mBAAmB,0BAA2B,MAAM,YAAY,MAAM,kBAWlF,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,cAAc,mBAAoB,MAAM,cAAc,MAAM,WACa,CAAC;AAEvF;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB,cAAe,MAAM,EAAE,WACoC,CAAC"}
+{"version":3,"file":"derivation.d.ts","sourceRoot":"","sources":["../../src/blockchain-utilities/derivation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhC,OAAO,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAEvD,eAAO,MAAM,YAAY;;;;;;CAMf,CAAC;AAEX,MAAM,MAAM,UAAU,GAAG,CAAC,OAAO,YAAY,CAAC,CAAC,MAAM,OAAO,YAAY,CAAC,CAAC;AAE1E,eAAO,MAAM,kBAAkB,YAAa,OAAO,cAAc,GAAG,qBAAqB,GAAG,WACe,CAAC;AAE5G,eAAO,MAAM,kBAAkB,eAAgB,GAAG,qBAAqB,GAAG,WACa,CAAC;AAExF,eAAO,MAAM,gBAAgB,aAAc,MAAM,gBAAgB,MAAM,WACsC,CAAC;AAE9G,eAAO,MAAM,iBAAiB,oBAAqB,QAAQ,WACwC,CAAC;AAEpG,wBAAgB,kCAAkC,CAAC,cAAc,EAAE,OAAO,EAAE,UAAU,EAAE,UAAU,UAQjG;AAED,eAAO,MAAM,eAAe,UAAW,MAAM,WAA4C,CAAC;AAE1F,eAAO,MAAM,iBAAiB,UAAW,GAAG,WAA2C,CAAC;AAExF,eAAO,MAAM,mBAAmB,oBAAqB,QAAQ,YAAY,MAAM,cAAc,UAAU,kBAStG,CAAC;AAEF,eAAO,MAAM,cAAc,mBAAoB,OAAO,cAAc,GAAG,WACe,CAAC;AAEvF,eAAO,MAAM,iBAAiB,cAAe,GAAG,EAAE,WAEuC,CAAC"}

package/dist/blockchain-utilities/derivation.js

@@ -1,8 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.deriveBeaconSetId = exports.deriveBeaconId = exports.deriveSponsorWallet = exports.fromBytes32String = exports.toBytes32String = exports.deriveWalletPathFromSponsorAddress = exports.deriveAirnodeXpub = exports.deriveEndpointId = exports.deriveTemplateId = exports.PROTOCOL_IDS = void 0;
+exports.deriveBeaconSetId = exports.deriveBeaconId = exports.deriveSponsorWallet = exports.fromBytes32String = exports.toBytes32String = exports.deriveWalletPathFromSponsorAddress = exports.deriveAirnodeXpub = exports.deriveEndpointId = exports.deriveTemplateIdV1 = exports.deriveTemplateIdV0 = exports.PROTOCOL_IDS = void 0;
 const ethers_1 = require("ethers");
-const schema_1 = require("./schema");
 exports.PROTOCOL_IDS = {
     RRP: '1',
     PSP: '2',
@@ -10,38 +9,15 @@ exports.PROTOCOL_IDS = {
     RELAYED_PSP: '4',
     AIRSEEKER: '5',
 };
-/**
- * Derives a template ID from the input parameters
- *
- * @param airnode an Airnode address
- * @param encodedParameters encoded parameters, see the airnode/abi package's encode function
- * @param endpointId An endpointID (see deriveEndpointId)
- */
-const deriveTemplateId = ({ airnode, encodedParameters, endpointId }) => ethers_1.ethers.utils.solidityKeccak256(['address', 'bytes32', 'bytes'], [airnode, endpointId, encodedParameters]);
-exports.deriveTemplateId = deriveTemplateId;
-/**
- * Derives an endpoint ID
- *
- * @param oisTitle the OIS title
- * @param endpointName the endpoint name
- */
+const deriveTemplateIdV0 = (airnode, endpointId, encodedParameters) => ethers_1.ethers.utils.solidityKeccak256(['address', 'bytes32', 'bytes'], [airnode, endpointId, encodedParameters]);
+exports.deriveTemplateIdV0 = deriveTemplateIdV0;
+const deriveTemplateIdV1 = (endpointId, encodedParameters) => ethers_1.ethers.utils.solidityKeccak256(['bytes32', 'bytes'], [endpointId, encodedParameters]);
+exports.deriveTemplateIdV1 = deriveTemplateIdV1;
 const deriveEndpointId = (oisTitle, endpointName) => ethers_1.ethers.utils.keccak256(ethers_1.ethers.utils.defaultAbiCoder.encode(['string', 'string'], [oisTitle, endpointName]));
 exports.deriveEndpointId = deriveEndpointId;
-/**
- * Derives an airnode address's xpub, required for allowing signed data consumers to verify authenticity
- *
- * @param airnodeMnemonic the airnode's mnemonic
- */
 const deriveAirnodeXpub = (airnodeMnemonic) => ethers_1.ethers.utils.HDNode.fromMnemonic(airnodeMnemonic).derivePath("m/44'/60'/0'").neuter().extendedKey;
 exports.deriveAirnodeXpub = deriveAirnodeXpub;
-/**
- * Derives a wallet path from a sponsor address, used for calculating a sponsor wallet.
- *
- * @param sponsorAddress an EVM-compatible address
- * @param protocolId an API application protocol ID
- */
 function deriveWalletPathFromSponsorAddress(sponsorAddress, protocolId) {
-    schema_1.addressSchema.parse(sponsorAddress);
     const sponsorAddressBN = ethers_1.ethers.BigNumber.from(sponsorAddress);
     const paths = [];
     for (let i = 0; i < 6; i++) {
@@ -51,47 +27,21 @@ function deriveWalletPathFromSponsorAddress(sponsorAddress, protocolId) {
     return `${protocolId}/${paths.join('/')}`;
 }
 exports.deriveWalletPathFromSponsorAddress = deriveWalletPathFromSponsorAddress;
-/**
- * Encodes/formats a string as a hex-encoded bytes32 string.
- *
- * @param input the input string
- */
 const toBytes32String = (input) => ethers_1.ethers.utils.formatBytes32String(input);
 exports.toBytes32String = toBytes32String;
-/**
- * Decodes a hex-encoded bytes32 string to a normal string.
- *
- * @param input the input hex string
- */
 const fromBytes32String = (input) => ethers_1.ethers.utils.parseBytes32String(input);
 exports.fromBytes32String = fromBytes32String;
-/**
- * Derives a sponsor wallet, given a mnemonic and dapiName.
- *
- * @param sponsorWalletMnemonic the sponsor wallet mnemonic
- * @param dapiName the dapi name
- */
-const deriveSponsorWallet = (sponsorWalletMnemonic, dapiName) => {
+const deriveSponsorWallet = (airnodeMnemonic, dapiName, protocolId) => {
     // Take first 20 bytes of dapiName as sponsor address together with the "0x" prefix.
     const sponsorAddress = ethers_1.ethers.utils.getAddress(dapiName.slice(0, 42));
-    const sponsorWallet = ethers_1.ethers.Wallet.fromMnemonic(sponsorWalletMnemonic, `m/44'/60'/0'/${(deriveWalletPathFromSponsorAddress(sponsorAddress, exports.PROTOCOL_IDS.AIRSEEKER), exports.PROTOCOL_IDS.AIRSEEKER)}`);
+    const sponsorWallet = ethers_1.ethers.Wallet.fromMnemonic(airnodeMnemonic, `m/44'/60'/0'/${deriveWalletPathFromSponsorAddress(sponsorAddress, protocolId)}`);
     return sponsorWallet;
 };
 exports.deriveSponsorWallet = deriveSponsorWallet;
-/**
- * Derives the ID of a single beacon
- *
- * @param airnodeAddress the airnode address of the provider that supplies the data used to update this beacon
- * @param templateId the templateId of the template used to generate the data used to update this beacon
- */
 const deriveBeaconId = (airnodeAddress, templateId) => ethers_1.ethers.utils.solidityKeccak256(['address', 'bytes32'], [airnodeAddress, templateId]);
 exports.deriveBeaconId = deriveBeaconId;
-/**
- * Derives the ID of a set of beacons.
- * By convention beacon IDs are sorted alphabetically - the ordering impacts the resulting hash.
- *
- * @param beaconIds an ordered array of beacon ids
- */
-const deriveBeaconSetId = (beaconIds) => ethers_1.ethers.utils.keccak256(ethers_1.ethers.utils.defaultAbiCoder.encode(['bytes32[]'], [beaconIds]));
+const deriveBeaconSetId = (beaconIds) => 
+// By convention beacon IDs are sorted alphabetically - the ordering impacts the resulting hash.
+ethers_1.ethers.utils.keccak256(ethers_1.ethers.utils.defaultAbiCoder.encode(['bytes32[]'], [beaconIds]));
 exports.deriveBeaconSetId = deriveBeaconSetId;
 //# sourceMappingURL=derivation.js.map

package/dist/blockchain-utilities/derivation.js.map

@@ -1 +1 @@
-{"version":3,"file":"derivation.js","sourceRoot":"","sources":["../../src/blockchain-utilities/derivation.ts"],"names":[],"mappings":";;;AAAA,mCAAgC;AAEhC,qCAAyC;AAE5B,QAAA,YAAY,GAAG;IAC1B,GAAG,EAAE,GAAG;IACR,GAAG,EAAE,GAAG;IACR,WAAW,EAAE,GAAG;IAChB,WAAW,EAAE,GAAG;IAChB,SAAS,EAAE,GAAG;CACf,CAAC;AAWF;;;;;;GAMG;AACI,MAAM,gBAAgB,GAAG,CAAC,EAAE,OAAO,EAAE,iBAAiB,EAAE,UAAU,EAAY,EAAE,EAAE,CACvF,eAAM,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,UAAU,EAAE,iBAAiB,CAAC,CAAC,CAAC;AAD/F,QAAA,gBAAgB,oBAC+E;AAE5G;;;;;GAKG;AACI,MAAM,gBAAgB,GAAG,CAAC,QAAgB,EAAE,YAAoB,EAAE,EAAE,CACzE,eAAM,CAAC,KAAK,CAAC,SAAS,CAAC,eAAM,CAAC,KAAK,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,QAAQ,CAAC,EAAE,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC;AADjG,QAAA,gBAAgB,oBACiF;AAE9G;;;;GAIG;AACI,MAAM,iBAAiB,GAAG,CAAC,eAAuB,EAAE,EAAE,CAC3D,eAAM,CAAC,KAAK,CAAC,MAAM,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC,MAAM,EAAE,CAAC,WAAW,CAAC;AADvF,QAAA,iBAAiB,qBACsE;AAEpG;;;;;GAKG;AACH,SAAgB,kCAAkC,CAAC,cAAsB,EAAE,UAAkB;IAC3F,sBAAa,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;IAEpC,MAAM,gBAAgB,GAAG,eAAM,CAAC,SAAS,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IAC/D,MAAM,KAAK,GAAG,EAAE,CAAC;IACjB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE;QAC1B,MAAM,uBAAuB,GAAG,gBAAgB,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;QAC7D,KAAK,CAAC,IAAI,CAAC,uBAAuB,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC;KACzD;IACD,OAAO,GAAG,UAAU,IAAI,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;AAC5C,CAAC;AAVD,gFAUC;AAED;;;;GAIG;AACI,MAAM,eAAe,GAAG,CAAC,KAAa,EAAE,EAAE,CAAC,eAAM,CAAC,KAAK,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC;AAA7E,QAAA,eAAe,mBAA8D;AAE1F;;;;GAIG;AACI,MAAM,iBAAiB,GAAG,CAAC,KAAa,EAAE,EAAE,CAAC,eAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;AAA9E,QAAA,iBAAiB,qBAA6D;AAE3F;;;;;GAKG;AACI,MAAM,mBAAmB,GAAG,CAAC,qBAA6B,EAAE,QAAgB,EAAE,EAAE;IACrF,oFAAoF;IACpF,MAAM,cAAc,GAAG,eAAM,CAAC,KAAK,CAAC,UAAU,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;IACtE,MAAM,aAAa,GAAG,eAAM,CAAC,MAAM,CAAC,YAAY,CAC9C,qBAAqB,EACrB,gBACE,CAAC,kCAAkC,CAAC,cAAc,EAAE,oBAAY,CAAC,SAAS,CAAC,EAAE,oBAAY,CAAC,SAAS,CACrG,EAAE,CACH,CAAC;IAEF,OAAO,aAAa,CAAC;AACvB,CAAC,CAAC;AAXW,QAAA,mBAAmB,uBAW9B;AAEF;;;;;GAKG;AACI,MAAM,cAAc,GAAG,CAAC,cAAsB,EAAE,UAAkB,EAAE,EAAE,CAC3E,eAAM,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,SAAS,EAAE,SAAS,CAAC,EAAE,CAAC,cAAc,EAAE,UAAU,CAAC,CAAC,CAAC;AAD1E,QAAA,cAAc,kBAC4D;AAEvF;;;;;GAKG;AACI,MAAM,iBAAiB,GAAG,CAAC,SAAmB,EAAE,EAAE,CACvD,eAAM,CAAC,KAAK,CAAC,SAAS,CAAC,eAAM,CAAC,KAAK,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC,WAAW,CAAC,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;AAD7E,QAAA,iBAAiB,qBAC4D"}
+{"version":3,"file":"derivation.js","sourceRoot":"","sources":["../../src/blockchain-utilities/derivation.ts"],"names":[],"mappings":";;;AAAA,mCAAgC;AAInB,QAAA,YAAY,GAAG;IAC1B,GAAG,EAAE,GAAG;IACR,GAAG,EAAE,GAAG;IACR,WAAW,EAAE,GAAG;IAChB,WAAW,EAAE,GAAG;IAChB,SAAS,EAAE,GAAG;CACN,CAAC;AAIJ,MAAM,kBAAkB,GAAG,CAAC,OAAgB,EAAE,UAAe,EAAE,iBAAsB,EAAE,EAAE,CAC9F,eAAM,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,UAAU,EAAE,iBAAiB,CAAC,CAAC,CAAC;AAD/F,QAAA,kBAAkB,sBAC6E;AAErG,MAAM,kBAAkB,GAAG,CAAC,UAAe,EAAE,iBAAsB,EAAE,EAAE,CAC5E,eAAM,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,SAAS,EAAE,OAAO,CAAC,EAAE,CAAC,UAAU,EAAE,iBAAiB,CAAC,CAAC,CAAC;AAD3E,QAAA,kBAAkB,sBACyD;AAEjF,MAAM,gBAAgB,GAAG,CAAC,QAAgB,EAAE,YAAoB,EAAE,EAAE,CACzE,eAAM,CAAC,KAAK,CAAC,SAAS,CAAC,eAAM,CAAC,KAAK,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,QAAQ,CAAC,EAAE,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC;AADjG,QAAA,gBAAgB,oBACiF;AAEvG,MAAM,iBAAiB,GAAG,CAAC,eAAyB,EAAE,EAAE,CAC7D,eAAM,CAAC,KAAK,CAAC,MAAM,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC,MAAM,EAAE,CAAC,WAAW,CAAC;AADvF,QAAA,iBAAiB,qBACsE;AAEpG,SAAgB,kCAAkC,CAAC,cAAuB,EAAE,UAAsB;IAChG,MAAM,gBAAgB,GAAG,eAAM,CAAC,SAAS,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IAC/D,MAAM,KAAK,GAAG,EAAE,CAAC;IACjB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE;QAC1B,MAAM,uBAAuB,GAAG,gBAAgB,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;QAC7D,KAAK,CAAC,IAAI,CAAC,uBAAuB,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC;KACzD;IACD,OAAO,GAAG,UAAU,IAAI,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;AAC5C,CAAC;AARD,gFAQC;AAEM,MAAM,eAAe,GAAG,CAAC,KAAa,EAAE,EAAE,CAAC,eAAM,CAAC,KAAK,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC;AAA7E,QAAA,eAAe,mBAA8D;AAEnF,MAAM,iBAAiB,GAAG,CAAC,KAAU,EAAE,EAAE,CAAC,eAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;AAA3E,QAAA,iBAAiB,qBAA0D;AAEjF,MAAM,mBAAmB,GAAG,CAAC,eAAyB,EAAE,QAAgB,EAAE,UAAsB,EAAE,EAAE;IACzG,oFAAoF;IACpF,MAAM,cAAc,GAAG,eAAM,CAAC,KAAK,CAAC,UAAU,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAY,CAAC;IACjF,MAAM,aAAa,GAAG,eAAM,CAAC,MAAM,CAAC,YAAY,CAC9C,eAAe,EACf,gBAAgB,kCAAkC,CAAC,cAAc,EAAE,UAAU,CAAC,EAAE,CACjF,CAAC;IAEF,OAAO,aAAa,CAAC;AACvB,CAAC,CAAC;AATW,QAAA,mBAAmB,uBAS9B;AAEK,MAAM,cAAc,GAAG,CAAC,cAAuB,EAAE,UAAe,EAAE,EAAE,CACzE,eAAM,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,SAAS,EAAE,SAAS,CAAC,EAAE,CAAC,cAAc,EAAE,UAAU,CAAC,CAAC,CAAC;AAD1E,QAAA,cAAc,kBAC4D;AAEhF,MAAM,iBAAiB,GAAG,CAAC,SAAgB,EAAE,EAAE;AACpD,gGAAgG;AAChG,eAAM,CAAC,KAAK,CAAC,SAAS,CAAC,eAAM,CAAC,KAAK,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC,WAAW,CAAC,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;AAF7E,QAAA,iBAAiB,qBAE4D"}

package/dist/blockchain-utilities/schema.d.ts

@@ -1,12 +1,14 @@
 import { z } from 'zod';
-/**
- * A Zod validation schema that represents an EVM-compatible address.
- */
-export declare const addressSchema: z.ZodString;
-/**
- * A Zod validation schema that represents an EVM-compatible hash, which includes beacon IDs and template IDs.
- */
-export declare const idSchema: z.ZodString;
+export declare const hexSchema: z.ZodString;
+export type Hex = `0x${string}`;
+export declare const addressSchema: z.ZodEffects<z.ZodString, `0x${string}`, string>;
 export type Address = z.infer<typeof addressSchema>;
-export type Id = z.infer<typeof idSchema>;
+export declare const keccak256HashSchema: z.ZodEffects<z.ZodString, `0x${string}`, string>;
+export type Keccak256Hash = z.infer<typeof keccak256HashSchema>;
+export declare const chainIdSchema: z.ZodEffects<z.ZodString, string, string>;
+export type ChainId = z.infer<typeof chainIdSchema>;
+export declare const ethUnitsSchema: z.ZodUnion<[z.ZodLiteral<"wei">, z.ZodLiteral<"kwei">, z.ZodLiteral<"mwei">, z.ZodLiteral<"gwei">, z.ZodLiteral<"szabo">, z.ZodLiteral<"finney">, z.ZodLiteral<"ether">]>;
+export type EthUnits = z.infer<typeof ethUnitsSchema>;
+export declare const mnemonicSchema: z.ZodEffects<z.ZodString, string, string>;
+export type Mnemonic = z.infer<typeof mnemonicSchema>;
 //# sourceMappingURL=schema.d.ts.map

package/dist/blockchain-utilities/schema.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../../src/blockchain-utilities/schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;GAEG;AACH,eAAO,MAAM,aAAa,aAAwE,CAAC;AAEnG;;GAEG;AACH,eAAO,MAAM,QAAQ,aAAqE,CAAC;AAE3F,MAAM,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAC;AACpD,MAAM,MAAM,EAAE,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,QAAQ,CAAC,CAAC"}
+{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../../src/blockchain-utilities/schema.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,eAAO,MAAM,SAAS,aAAoE,CAAC;AAE3F,MAAM,MAAM,GAAG,GAAG,KAAK,MAAM,EAAE,CAAC;AAEhC,eAAO,MAAM,aAAa,kDAQxB,CAAC;AAEH,MAAM,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAC;AAEpD,eAAO,MAAM,mBAAmB,kDAGC,CAAC;AAElC,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAEhE,eAAO,MAAM,aAAa,2CAGoD,CAAC;AAE/E,MAAM,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAC;AAEpD,eAAO,MAAM,cAAc,2KAQzB,CAAC;AAEH,MAAM,MAAM,QAAQ,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,cAAc,CAAC,CAAC;AAEtD,eAAO,MAAM,cAAc,2CAEwD,CAAC;AAEpF,MAAM,MAAM,QAAQ,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,cAAc,CAAC,CAAC"}

package/dist/blockchain-utilities/schema.js

@@ -1,13 +1,36 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.idSchema = exports.addressSchema = void 0;
+exports.mnemonicSchema = exports.ethUnitsSchema = exports.chainIdSchema = exports.keccak256HashSchema = exports.addressSchema = exports.hexSchema = void 0;
+const promise_utils_1 = require("@api3/promise-utils");
+const ethers_1 = require("ethers");
 const zod_1 = require("zod");
-/**
- * A Zod validation schema that represents an EVM-compatible address.
- */
-exports.addressSchema = zod_1.z.string().regex(/^0x[\dA-Fa-f]{40}$/, 'Must be a valid EVM address');
-/**
- * A Zod validation schema that represents an EVM-compatible hash, which includes beacon IDs and template IDs.
- */
-exports.idSchema = zod_1.z.string().regex(/^0x[\dA-Fa-f]{64}$/, 'Must be a valid EVM hash');
+exports.hexSchema = zod_1.z.string().regex(/^0x[\dA-Fa-f]+$/, 'Must be a valid hex string');
+exports.addressSchema = zod_1.z.string().transform((value, ctx) => {
+    const goParseAddress = (0, promise_utils_1.goSync)(() => ethers_1.ethers.utils.getAddress(value));
+    if (!goParseAddress.success) {
+        ctx.addIssue({ code: zod_1.z.ZodIssueCode.custom, message: 'Invalid EVM address' });
+        return zod_1.z.NEVER;
+    }
+    return goParseAddress.data;
+});
+exports.keccak256HashSchema = zod_1.z
+    .string()
+    .regex(/^0x[\dA-Fa-f]{64}$/, 'Must be a valid EVM keccak256 hash')
+    .transform((val) => val);
+exports.chainIdSchema = zod_1.z
+    .string()
+    .regex(/^\d+$/, 'Must be a valid chain ID')
+    .refine((chainId) => Number(chainId) > 0, 'Chain ID must be greater than 0');
+exports.ethUnitsSchema = zod_1.z.union([
+    zod_1.z.literal('wei'),
+    zod_1.z.literal('kwei'),
+    zod_1.z.literal('mwei'),
+    zod_1.z.literal('gwei'),
+    zod_1.z.literal('szabo'),
+    zod_1.z.literal('finney'),
+    zod_1.z.literal('ether'),
+]);
+exports.mnemonicSchema = zod_1.z
+    .string()
+    .refine((mnemonic) => ethers_1.ethers.utils.isValidMnemonic(mnemonic), 'Invalid mnemonic');
 //# sourceMappingURL=schema.js.map

package/dist/blockchain-utilities/schema.js.map

@@ -1 +1 @@
-{"version":3,"file":"schema.js","sourceRoot":"","sources":["../../src/blockchain-utilities/schema.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AAExB;;GAEG;AACU,QAAA,aAAa,GAAG,OAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,oBAAoB,EAAE,6BAA6B,CAAC,CAAC;AAEnG;;GAEG;AACU,QAAA,QAAQ,GAAG,OAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,oBAAoB,EAAE,0BAA0B,CAAC,CAAC"}
+{"version":3,"file":"schema.js","sourceRoot":"","sources":["../../src/blockchain-utilities/schema.ts"],"names":[],"mappings":";;;AAAA,uDAA6C;AAC7C,mCAAgC;AAChC,6BAAwB;AAEX,QAAA,SAAS,GAAG,OAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,iBAAiB,EAAE,4BAA4B,CAAC,CAAC;AAI9E,QAAA,aAAa,GAAG,OAAC,CAAC,MAAM,EAAE,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;IAC/D,MAAM,cAAc,GAAG,IAAA,sBAAM,EAAC,GAAG,EAAE,CAAC,eAAM,CAAC,KAAK,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;IACpE,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE;QAC3B,GAAG,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,OAAC,CAAC,YAAY,CAAC,MAAM,EAAE,OAAO,EAAE,qBAAqB,EAAE,CAAC,CAAC;QAC9E,OAAO,OAAC,CAAC,KAAK,CAAC;KAChB;IAED,OAAO,cAAc,CAAC,IAAW,CAAC;AACpC,CAAC,CAAC,CAAC;AAIU,QAAA,mBAAmB,GAAG,OAAC;KACjC,MAAM,EAAE;KACR,KAAK,CAAC,oBAAoB,EAAE,oCAAoC,CAAC;KACjE,SAAS,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAU,CAAC,CAAC;AAIrB,QAAA,aAAa,GAAG,OAAC;KAC3B,MAAM,EAAE;KACR,KAAK,CAAC,OAAO,EAAE,0BAA0B,CAAC;KAC1C,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,iCAAiC,CAAC,CAAC;AAIlE,QAAA,cAAc,GAAG,OAAC,CAAC,KAAK,CAAC;IACpC,OAAC,CAAC,OAAO,CAAC,KAAK,CAAC;IAChB,OAAC,CAAC,OAAO,CAAC,MAAM,CAAC;IACjB,OAAC,CAAC,OAAO,CAAC,MAAM,CAAC;IACjB,OAAC,CAAC,OAAO,CAAC,MAAM,CAAC;IACjB,OAAC,CAAC,OAAO,CAAC,OAAO,CAAC;IAClB,OAAC,CAAC,OAAO,CAAC,QAAQ,CAAC;IACnB,OAAC,CAAC,OAAO,CAAC,OAAO,CAAC;CACnB,CAAC,CAAC;AAIU,QAAA,cAAc,GAAG,OAAC;KAC5B,MAAM,EAAE;KACR,MAAM,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,eAAM,CAAC,KAAK,CAAC,eAAe,CAAC,QAAQ,CAAC,EAAE,kBAAkB,CAAC,CAAC"}

package/dist/config-parsing/index.d.ts

@@ -1,12 +1,12 @@
 import dotenv from 'dotenv';
 import { z } from 'zod';
-export declare const secretNamePattern: RegExp;
-export declare const secretNameSchema: z.ZodString;
-export declare const secretsSchema: z.ZodRecord<z.ZodString, z.ZodString>;
-export declare const nonBlankSecretsSchema: z.ZodRecord<z.ZodString, z.ZodString>;
+export declare const strictSecretNamePattern: RegExp;
+export declare const strictSecretNameSchema: z.ZodString;
+export declare const nonBlankSecretValueSchema: z.ZodString;
 export type Secrets = Record<string, string>;
 export interface InterpolationOptions {
-    allowBlankSecretValue: boolean;
+    allowBlankSecretValue?: boolean;
+    validateSecretName?: boolean;
 }
 export type AnyObject = Record<string, unknown>;
 export declare function interpolateSecretsIntoConfig<T = AnyObject>(config: T, secrets: unknown, options?: InterpolationOptions): T;

package/dist/config-parsing/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/config-parsing/index.ts"],"names":[],"mappings":"AAEA,OAAO,MAAM,MAAM,QAAQ,CAAC;AAG5B,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,eAAO,MAAM,iBAAiB,QAAqB,CAAC;AAEpD,eAAO,MAAM,gBAAgB,aAEoF,CAAC;AAElH,eAAO,MAAM,aAAa,uCAAyC,CAAC;AAEpE,eAAO,MAAM,qBAAqB,uCAGjC,CAAC;AAEF,MAAM,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAe7C,MAAM,WAAW,oBAAoB;IACnC,qBAAqB,EAAE,OAAO,CAAC;CAChC;AAED,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAEhD,wBAAgB,4BAA4B,CAAC,CAAC,GAAG,SAAS,EACxD,MAAM,EAAE,CAAC,EACT,OAAO,EAAE,OAAO,EAChB,OAAO,GAAE,oBAAsD,KA0BhE;AAED,eAAO,MAAM,WAAW,SAAU,MAAM,6BAA6C,CAAC;AAEtF,eAAO,MAAM,UAAU,SAAU,MAAM,QAA2C,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/config-parsing/index.ts"],"names":[],"mappings":"AAEA,OAAO,MAAM,MAAM,QAAQ,CAAC;AAG5B,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,eAAO,MAAM,uBAAuB,QAAqB,CAAC;AAE1D,eAAO,MAAM,sBAAsB,aAKhC,CAAC;AAEJ,eAAO,MAAM,yBAAyB,aAA2D,CAAC;AAElG,MAAM,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAe7C,MAAM,WAAW,oBAAoB;IACnC,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAC9B;AAED,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAEhD,wBAAgB,4BAA4B,CAAC,CAAC,GAAG,SAAS,EACxD,MAAM,EAAE,CAAC,EACT,OAAO,EAAE,OAAO,EAChB,OAAO,CAAC,EAAE,oBAAoB,KA4B/B;AAED,eAAO,MAAM,WAAW,SAAU,MAAM,6BAA6C,CAAC;AAEtF,eAAO,MAAM,UAAU,SAAU,MAAM,QAA2C,CAAC"}

package/dist/config-parsing/index.js

@@ -3,18 +3,17 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.loadConfig = exports.loadSecrets = exports.interpolateSecretsIntoConfig = exports.nonBlankSecretsSchema = exports.secretsSchema = exports.secretNameSchema = exports.secretNamePattern = void 0;
+exports.loadConfig = exports.loadSecrets = exports.interpolateSecretsIntoConfig = exports.nonBlankSecretValueSchema = exports.strictSecretNameSchema = exports.strictSecretNamePattern = void 0;
 const node_fs_1 = require("node:fs");
 const dotenv_1 = __importDefault(require("dotenv"));
 const reduce_1 = __importDefault(require("lodash/reduce"));
 const template_1 = __importDefault(require("lodash/template"));
 const zod_1 = require("zod");
-exports.secretNamePattern = /^[A-Z][\dA-Z_]*$/;
-exports.secretNameSchema = zod_1.z
+exports.strictSecretNamePattern = /^[A-Z][\dA-Z_]*$/;
+exports.strictSecretNameSchema = zod_1.z
     .string()
-    .regex(exports.secretNamePattern, `Secret name is not a valid. Secret name must match ${exports.secretNamePattern.toString()}`);
-exports.secretsSchema = zod_1.z.record(exports.secretNameSchema, zod_1.z.string());
-exports.nonBlankSecretsSchema = zod_1.z.record(exports.secretNameSchema, zod_1.z.string().min(1, { message: 'Secret cannot be blank' }));
+    .regex(exports.strictSecretNamePattern, `Secret name is not a valid. Secret name must match ${exports.strictSecretNamePattern.toString()}`);
+exports.nonBlankSecretValueSchema = zod_1.z.string().min(1, { message: 'Secret cannot be blank' });
 // Regular expression that does not match anything, ensuring no escaping or interpolation happens
 // https://github.com/lodash/lodash/blob/4.17.15/lodash.js#L199
 // eslint-disable-next-line prefer-named-capture-group
@@ -27,9 +26,11 @@ const ES_MATCH_REGEXP = /(?<!\\)\${([^\\}]*(?:\\.[^\\}]*)*)}/g;
 // because "\\" becomes "\\\\" when converted to string
 // eslint-disable-next-line prefer-named-capture-group
 const ESCAPED_ES_MATCH_REGEXP = /\\\\(\${([^\\}]*(?:\\.[^\\}]*)*)})/g;
-function interpolateSecretsIntoConfig(config, secrets, options = { allowBlankSecretValue: true }) {
-    const { allowBlankSecretValue } = options;
-    const validatedSecrets = (allowBlankSecretValue ? exports.secretsSchema : exports.nonBlankSecretsSchema).parse(secrets);
+function interpolateSecretsIntoConfig(config, secrets, options) {
+    const { allowBlankSecretValue = true, validateSecretName = true } = options ?? {};
+    const secretNameSchema = validateSecretName ? exports.strictSecretNameSchema : zod_1.z.string();
+    const secretValueSchema = allowBlankSecretValue ? zod_1.z.string() : exports.nonBlankSecretValueSchema;
+    const validatedSecrets = zod_1.z.record(secretNameSchema, secretValueSchema).parse(secrets);
     const stringifiedSecrets = (0, reduce_1.default)(validatedSecrets, (acc, value, key) => {
         return {
             ...acc,

package/dist/config-parsing/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/config-parsing/index.ts"],"names":[],"mappings":";;;;;;AAAA,qCAAuC;AAEvC,oDAA4B;AAC5B,2DAAmC;AACnC,+DAAuC;AACvC,6BAAwB;AAEX,QAAA,iBAAiB,GAAG,kBAAkB,CAAC;AAEvC,QAAA,gBAAgB,GAAG,OAAC;KAC9B,MAAM,EAAE;KACR,KAAK,CAAC,yBAAiB,EAAE,sDAAsD,yBAAiB,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;AAErG,QAAA,aAAa,GAAG,OAAC,CAAC,MAAM,CAAC,wBAAgB,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,CAAC;AAEvD,QAAA,qBAAqB,GAAG,OAAC,CAAC,MAAM,CAC3C,wBAAgB,EAChB,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,OAAO,EAAE,wBAAwB,EAAE,CAAC,CACzD,CAAC;AAIF,iGAAiG;AACjG,+DAA+D;AAC/D,sDAAsD;AACtD,MAAM,eAAe,GAAG,MAAM,CAAC;AAC/B,gFAAgF;AAChF,+DAA+D;AAC/D,sDAAsD;AACtD,MAAM,eAAe,GAAG,sCAAsC,CAAC;AAC/D,wHAAwH;AACxH,uDAAuD;AACvD,sDAAsD;AACtD,MAAM,uBAAuB,GAAG,qCAAqC,CAAC;AAQtE,SAAgB,4BAA4B,CAC1C,MAAS,EACT,OAAgB,EAChB,UAAgC,EAAE,qBAAqB,EAAE,IAAI,EAAE;IAE/D,MAAM,EAAE,qBAAqB,EAAE,GAAG,OAAO,CAAC;IAC1C,MAAM,gBAAgB,GAAG,CAAC,qBAAqB,CAAC,CAAC,CAAC,qBAAa,CAAC,CAAC,CAAC,6BAAqB,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAExG,MAAM,kBAAkB,GAAG,IAAA,gBAAM,EAC/B,gBAAgB,EAChB,CAAC,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE;QAClB,OAAO;YACL,GAAG,GAAG;YACN,8GAA8G;YAC9G,wBAAwB;YACxB,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;SAC1C,CAAC;IACJ,CAAC,EACD,EAAa,CACd,CAAC;IAEF,MAAM,kBAAkB,GAAG,IAAA,kBAAQ,EAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE;QAC1D,MAAM,EAAE,eAAe;QACvB,QAAQ,EAAE,eAAe;QACzB,WAAW,EAAE,eAAe;KAC7B,CAAC,CAAC,kBAAkB,CAAC,CAAC;IACvB,oHAAoH;IACpH,2CAA2C;IAC3C,OAAO,IAAI,CAAC,KAAK,CAAC,kBAAkB,CAAC,UAAU,CAAC,uBAAuB,EAAE,IAAI,CAAC,CAAM,CAAC;AACvF,CAAC;AA7BD,oEA6BC;AAEM,MAAM,WAAW,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,gBAAM,CAAC,KAAK,CAAC,IAAA,sBAAY,EAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC;AAAzE,QAAA,WAAW,eAA8D;AAE/E,MAAM,UAAU,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,IAAA,sBAAY,EAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC;AAAtE,QAAA,UAAU,cAA4D"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/config-parsing/index.ts"],"names":[],"mappings":";;;;;;AAAA,qCAAuC;AAEvC,oDAA4B;AAC5B,2DAAmC;AACnC,+DAAuC;AACvC,6BAAwB;AAEX,QAAA,uBAAuB,GAAG,kBAAkB,CAAC;AAE7C,QAAA,sBAAsB,GAAG,OAAC;KACpC,MAAM,EAAE;KACR,KAAK,CACJ,+BAAuB,EACvB,sDAAsD,+BAAuB,CAAC,QAAQ,EAAE,EAAE,CAC3F,CAAC;AAES,QAAA,yBAAyB,GAAG,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,OAAO,EAAE,wBAAwB,EAAE,CAAC,CAAC;AAIlG,iGAAiG;AACjG,+DAA+D;AAC/D,sDAAsD;AACtD,MAAM,eAAe,GAAG,MAAM,CAAC;AAC/B,gFAAgF;AAChF,+DAA+D;AAC/D,sDAAsD;AACtD,MAAM,eAAe,GAAG,sCAAsC,CAAC;AAC/D,wHAAwH;AACxH,uDAAuD;AACvD,sDAAsD;AACtD,MAAM,uBAAuB,GAAG,qCAAqC,CAAC;AAStE,SAAgB,4BAA4B,CAC1C,MAAS,EACT,OAAgB,EAChB,OAA8B;IAE9B,MAAM,EAAE,qBAAqB,GAAG,IAAI,EAAE,kBAAkB,GAAG,IAAI,EAAE,GAAG,OAAO,IAAI,EAAE,CAAC;IAClF,MAAM,gBAAgB,GAAG,kBAAkB,CAAC,CAAC,CAAC,8BAAsB,CAAC,CAAC,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC;IAClF,MAAM,iBAAiB,GAAG,qBAAqB,CAAC,CAAC,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,iCAAyB,CAAC;IACzF,MAAM,gBAAgB,GAAG,OAAC,CAAC,MAAM,CAAC,gBAAgB,EAAE,iBAAiB,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAEtF,MAAM,kBAAkB,GAAG,IAAA,gBAAM,EAC/B,gBAAgB,EAChB,CAAC,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE;QAClB,OAAO;YACL,GAAG,GAAG;YACN,8GAA8G;YAC9G,wBAAwB;YACxB,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;SAC1C,CAAC;IACJ,CAAC,EACD,EAAa,CACd,CAAC;IAEF,MAAM,kBAAkB,GAAG,IAAA,kBAAQ,EAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE;QAC1D,MAAM,EAAE,eAAe;QACvB,QAAQ,EAAE,eAAe;QACzB,WAAW,EAAE,eAAe;KAC7B,CAAC,CAAC,kBAAkB,CAAC,CAAC;IACvB,oHAAoH;IACpH,2CAA2C;IAC3C,OAAO,IAAI,CAAC,KAAK,CAAC,kBAAkB,CAAC,UAAU,CAAC,uBAAuB,EAAE,IAAI,CAAC,CAAM,CAAC;AACvF,CAAC;AA/BD,oEA+BC;AAEM,MAAM,WAAW,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,gBAAM,CAAC,KAAK,CAAC,IAAA,sBAAY,EAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC;AAAzE,QAAA,WAAW,eAA8D;AAE/E,MAAM,UAAU,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,IAAA,sBAAY,EAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC;AAAtE,QAAA,UAAU,cAA4D"}

package/dist/universal-index.d.ts

@@ -1,2 +1,3 @@
 export * from './blockchain-utilities';
+export * from './http';
 //# sourceMappingURL=universal-index.d.ts.map

package/dist/universal-index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"universal-index.d.ts","sourceRoot":"","sources":["../src/universal-index.ts"],"names":[],"mappings":"AACA,cAAc,wBAAwB,CAAC"}
+{"version":3,"file":"universal-index.d.ts","sourceRoot":"","sources":["../src/universal-index.ts"],"names":[],"mappings":"AACA,cAAc,wBAAwB,CAAC;AACvC,cAAc,QAAQ,CAAC"}

package/dist/universal-index.js

@@ -16,4 +16,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 // NOTE: Only export modules which work in both Node.js and browser environments.
 __exportStar(require("./blockchain-utilities"), exports);
+__exportStar(require("./http"), exports);
 //# sourceMappingURL=universal-index.js.map

package/dist/universal-index.js.map

@@ -1 +1 @@
-{"version":3,"file":"universal-index.js","sourceRoot":"","sources":["../src/universal-index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,iFAAiF;AACjF,yDAAuC"}
+{"version":3,"file":"universal-index.js","sourceRoot":"","sources":["../src/universal-index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,iFAAiF;AACjF,yDAAuC;AACvC,yCAAuB"}

package/package.json

@@ -1,11 +1,10 @@
 {
   "name": "@api3/commons",
-  "version": "0.7.0",
+  "version": "0.8.0",
   "keywords": [],
   "license": "MIT",
   "engines": {
-    "node": "^18.14.0 || ^20.10.0",
-    "pnpm": "^8.8.0"
+    "node": ">=18.14.0"
   },
   "files": [
     "dist",

package/src/blockchain-utilities/derivation.test.ts

@@ -6,12 +6,14 @@ import {
   deriveBeaconSetId,
   deriveEndpointId,
   deriveSponsorWallet,
-  deriveTemplateId,
+  deriveTemplateIdV0,
+  deriveTemplateIdV1,
   deriveWalletPathFromSponsorAddress,
   fromBytes32String,
   PROTOCOL_IDS,
   toBytes32String,
 } from './derivation';
+import type { Address } from './schema';
 
 describe('deriveWalletPathFromSponsorAddress', () => {
   it('converts address to derivation path', () => {
@@ -19,7 +21,7 @@ describe('deriveWalletPathFromSponsorAddress', () => {
     const res = deriveWalletPathFromSponsorAddress(sponsorAddress, PROTOCOL_IDS.AIRSEEKER);
     expect(res).toBe('5/973563544/2109481170/2137349576/871269377/610184194/17');
 
-    const randomAddress = ethers.utils.getAddress(ethers.utils.hexlify(ethers.utils.randomBytes(20)));
+    const randomAddress = ethers.utils.getAddress(ethers.utils.hexlify(ethers.utils.randomBytes(20))) as Address;
     const randomPath = deriveWalletPathFromSponsorAddress(randomAddress, PROTOCOL_IDS.AIRSEEKER);
     expect(res).not.toStrictEqual(randomPath);
   });
@@ -45,24 +47,7 @@ describe('deriveWalletPathFromSponsorAddress', () => {
   });
 
   it('throws if address is an empty string', () => {
-    const sponsorAddress = '';
-    expect(() => deriveWalletPathFromSponsorAddress(sponsorAddress, PROTOCOL_IDS.AIRSEEKER)).toThrow(
-      expect.objectContaining({ name: expect.stringContaining('Error') })
-    );
-  });
-
-  it('throws if address is invalid', () => {
-    let sponsorAddress = '7dD0803Fd957723EdE10693A076698';
-    expect(() => deriveWalletPathFromSponsorAddress(sponsorAddress, PROTOCOL_IDS.AIRSEEKER)).toThrow(
-      expect.objectContaining({ name: expect.stringContaining('Error') })
-    );
-
-    sponsorAddress = ethers.utils.hexlify(ethers.utils.randomBytes(4));
-    expect(() => deriveWalletPathFromSponsorAddress(sponsorAddress, PROTOCOL_IDS.AIRSEEKER)).toThrow(
-      expect.objectContaining({ name: expect.stringContaining('Error') })
-    );
-
-    sponsorAddress = ethers.utils.hexlify(ethers.utils.randomBytes(32));
+    const sponsorAddress = '' as Address;
     expect(() => deriveWalletPathFromSponsorAddress(sponsorAddress, PROTOCOL_IDS.AIRSEEKER)).toThrow(
       expect.objectContaining({ name: expect.stringContaining('Error') })
     );
@@ -73,20 +58,39 @@ describe('deriveWalletPathFromSponsorAddress', () => {
       const dapiName = ethers.utils.formatBytes32String('BTC/ETH');
       const sponsorWallet = deriveSponsorWallet(
         'test test test test test test test test test test test junk',
-        dapiName
+        dapiName,
+        '1'
       );
 
-      expect(sponsorWallet.address).toBe('0x1e6f0dfb1775f5032f12f56a01526351eD3F07aF');
+      expect(sponsorWallet.address).toBe('0x4f86228e0Bc58829Cd77547224291bb8d212174D');
     });
 
     it('throws deriving a sponsor wallet due to an invalid DApi name', () => {
       const dapiName = 'invalid dapi name';
       const throwingFn = () =>
-        deriveSponsorWallet('test test test test test test test test test test test junk', dapiName);
+        deriveSponsorWallet('test test test test test test test test test test test junk', dapiName, '5');
 
       expect(throwingFn).toThrow(expect.objectContaining({ name: expect.stringContaining('Error') }));
     });
 
+    it('derives the same sponsor wallet as Airnode', () => {
+      function deriveSponsorWalletAirnode(masterHDNode: ethers.utils.HDNode, sponsorAddress: Address): ethers.Wallet {
+        const sponsorWalletHdNode = masterHDNode.derivePath(
+          `m/44'/60'/0'/${deriveWalletPathFromSponsorAddress(sponsorAddress, '1')}`
+        );
+        return new ethers.Wallet(sponsorWalletHdNode.privateKey);
+      }
+      const mnemonic = 'achieve climb couple wait accident symbol spy blouse reduce foil echo label';
+      const hdNode = ethers.utils.HDNode.fromMnemonic(mnemonic);
+
+      // https://github.com/api3dao/airnode/blob/a4c17c28c8b31c9fb13d2828764b89f1063b702f/packages/airnode-node/src/evm/wallet.test.ts#L25
+      const expectedSponsorWallet = deriveSponsorWalletAirnode(hdNode, '0x06f509f73eefba36352bc8228f9112c3786100da');
+      const actualSponsorWallet = deriveSponsorWallet(mnemonic, '0x06f509f73eefba36352bc8228f9112c3786100da', '1');
+
+      expect(actualSponsorWallet.address).toBe(expectedSponsorWallet.address);
+      expect(actualSponsorWallet.address).toBe('0x228A54F33E46fbb32a62ca650Fcc9eD3C730511d');
+    });
+
     it(`derives an airnode's xpub from a mnemonic`, () => {
       const xpub = deriveAirnodeXpub('test test test test test test test test test test test junk');
 
@@ -101,14 +105,23 @@ describe('deriveWalletPathFromSponsorAddress', () => {
       expect(endpointId).toBe('0x5a82d40e44ecd3ef0906e9e82c1a20f2f4ffe4f613ac70f999047496a9cd4635');
     });
 
-    it(`it derives a template ID`, () => {
-      const templateId = deriveTemplateId({
-        airnode: '0x4E95C31894a89CdC4288669A6F294836948c862b',
-        endpointId: '0x5a82d40e44ecd3ef0906e9e82c1a20f2f4ffe4f613ac70f999047496a9cd4635',
-        encodedParameters: '0x1234',
-      });
+    it(`it derives a template ID V0`, () => {
+      const templateId = deriveTemplateIdV0(
+        '0x4E95C31894a89CdC4288669A6F294836948c862b',
+        '0x5a82d40e44ecd3ef0906e9e82c1a20f2f4ffe4f613ac70f999047496a9cd4635',
+        '0x6466726f6d63455448'
+      );
+
+      expect(templateId).toBe('0x25ea8b12135e4b8d49960ef9e0f967b7c0ccad136b955fbb7fbeb76da27d60b0');
+    });
+
+    it('derives templateId for V1', () => {
+      const expectedTemplateIdV1 = deriveTemplateIdV1(
+        '0x2f3a3adf6daf5a3bb00ab83aa82262a6a84b59b0a89222386135330a1819ab48',
+        '0x6466726f6d63455448'
+      );
 
-      expect(templateId).toBe('0x7655363f294273f84bcc7c47d79858cf46f21951deee92746d9f17a69ac0b0c0');
+      expect(expectedTemplateIdV1).toBe('0xe5d99287b5a870c3453bc0b42769c6f37cf4a3143890e9c34753181171fac842');
     });
 
     it('derives a beacon ID', () => {

package/src/blockchain-utilities/derivation.ts

@@ -1,6 +1,6 @@
 import { ethers } from 'ethers';
 
-import { addressSchema } from './schema';
+import type { Address, Hex, Mnemonic } from './schema';
 
 export const PROTOCOL_IDS = {
   RRP: '1',
@@ -8,53 +8,23 @@ export const PROTOCOL_IDS = {
   RELAYED_RRP: '3',
   RELAYED_PSP: '4',
   AIRSEEKER: '5',
-};
+} as const;
 
-/**
- * An interface that reflects the structure of a Template
- */
-export interface Template {
-  airnode: string;
-  encodedParameters: string;
-  endpointId: string;
-}
+export type ProtocolId = (typeof PROTOCOL_IDS)[keyof typeof PROTOCOL_IDS];
 
-/**
- * Derives a template ID from the input parameters
- *
- * @param airnode an Airnode address
- * @param encodedParameters encoded parameters, see the airnode/abi package's encode function
- * @param endpointId An endpointID (see deriveEndpointId)
- */
-export const deriveTemplateId = ({ airnode, encodedParameters, endpointId }: Template) =>
+export const deriveTemplateIdV0 = (airnode: Address, endpointId: Hex, encodedParameters: Hex) =>
   ethers.utils.solidityKeccak256(['address', 'bytes32', 'bytes'], [airnode, endpointId, encodedParameters]);
 
-/**
- * Derives an endpoint ID
- *
- * @param oisTitle the OIS title
- * @param endpointName the endpoint name
- */
+export const deriveTemplateIdV1 = (endpointId: Hex, encodedParameters: Hex) =>
+  ethers.utils.solidityKeccak256(['bytes32', 'bytes'], [endpointId, encodedParameters]);
+
 export const deriveEndpointId = (oisTitle: string, endpointName: string) =>
   ethers.utils.keccak256(ethers.utils.defaultAbiCoder.encode(['string', 'string'], [oisTitle, endpointName]));
 
-/**
- * Derives an airnode address's xpub, required for allowing signed data consumers to verify authenticity
- *
- * @param airnodeMnemonic the airnode's mnemonic
- */
-export const deriveAirnodeXpub = (airnodeMnemonic: string) =>
+export const deriveAirnodeXpub = (airnodeMnemonic: Mnemonic) =>
   ethers.utils.HDNode.fromMnemonic(airnodeMnemonic).derivePath("m/44'/60'/0'").neuter().extendedKey;
 
-/**
- * Derives a wallet path from a sponsor address, used for calculating a sponsor wallet.
- *
- * @param sponsorAddress an EVM-compatible address
- * @param protocolId an API application protocol ID
- */
-export function deriveWalletPathFromSponsorAddress(sponsorAddress: string, protocolId: string) {
-  addressSchema.parse(sponsorAddress);
-
+export function deriveWalletPathFromSponsorAddress(sponsorAddress: Address, protocolId: ProtocolId) {
   const sponsorAddressBN = ethers.BigNumber.from(sponsorAddress);
   const paths = [];
   for (let i = 0; i < 6; i++) {
@@ -64,53 +34,24 @@ export function deriveWalletPathFromSponsorAddress(sponsorAddress: string, proto
   return `${protocolId}/${paths.join('/')}`;
 }
 
-/**
- * Encodes/formats a string as a hex-encoded bytes32 string.
- *
- * @param input the input string
- */
 export const toBytes32String = (input: string) => ethers.utils.formatBytes32String(input);
 
-/**
- * Decodes a hex-encoded bytes32 string to a normal string.
- *
- * @param input the input hex string
- */
-export const fromBytes32String = (input: string) => ethers.utils.parseBytes32String(input);
+export const fromBytes32String = (input: Hex) => ethers.utils.parseBytes32String(input);
 
-/**
- * Derives a sponsor wallet, given a mnemonic and dapiName.
- *
- * @param sponsorWalletMnemonic the sponsor wallet mnemonic
- * @param dapiName the dapi name
- */
-export const deriveSponsorWallet = (sponsorWalletMnemonic: string, dapiName: string) => {
+export const deriveSponsorWallet = (airnodeMnemonic: Mnemonic, dapiName: string, protocolId: ProtocolId) => {
   // Take first 20 bytes of dapiName as sponsor address together with the "0x" prefix.
-  const sponsorAddress = ethers.utils.getAddress(dapiName.slice(0, 42));
+  const sponsorAddress = ethers.utils.getAddress(dapiName.slice(0, 42)) as Address;
   const sponsorWallet = ethers.Wallet.fromMnemonic(
-    sponsorWalletMnemonic,
-    `m/44'/60'/0'/${
-      (deriveWalletPathFromSponsorAddress(sponsorAddress, PROTOCOL_IDS.AIRSEEKER), PROTOCOL_IDS.AIRSEEKER)
-    }`
+    airnodeMnemonic,
+    `m/44'/60'/0'/${deriveWalletPathFromSponsorAddress(sponsorAddress, protocolId)}`
   );
 
   return sponsorWallet;
 };
 
-/**
- * Derives the ID of a single beacon
- *
- * @param airnodeAddress the airnode address of the provider that supplies the data used to update this beacon
- * @param templateId the templateId of the template used to generate the data used to update this beacon
- */
-export const deriveBeaconId = (airnodeAddress: string, templateId: string) =>
+export const deriveBeaconId = (airnodeAddress: Address, templateId: Hex) =>
   ethers.utils.solidityKeccak256(['address', 'bytes32'], [airnodeAddress, templateId]);
 
-/**
- * Derives the ID of a set of beacons.
- * By convention beacon IDs are sorted alphabetically - the ordering impacts the resulting hash.
- *
- * @param beaconIds an ordered array of beacon ids
- */
-export const deriveBeaconSetId = (beaconIds: string[]) =>
+export const deriveBeaconSetId = (beaconIds: Hex[]) =>
+  // By convention beacon IDs are sorted alphabetically - the ordering impacts the resulting hash.
   ethers.utils.keccak256(ethers.utils.defaultAbiCoder.encode(['bytes32[]'], [beaconIds]));

package/src/blockchain-utilities/schema.test.ts

@@ -1,8 +1,10 @@
-import { addressSchema, idSchema } from './schema';
+import { addressSchema, hexSchema, keccak256HashSchema, chainIdSchema, ethUnitsSchema, mnemonicSchema } from './schema';
 
-describe('schema', () => {
-  it('validates a valid address', () => {
-    expect(() => addressSchema.parse('0x8A45eac0267dD0803Fd957723EdE10693A076698')).not.toThrow();
+describe('addressSchema', () => {
+  it('validates a valid address and returns its checksum', () => {
+    expect(addressSchema.parse('0x8a45eac0267dd0803fd957723ede10693a076698')).toBe(
+      '0x8A45eac0267dD0803Fd957723EdE10693A076698'
+    );
   });
 
   it('throws for an invalid address', () => {
@@ -10,14 +12,70 @@ describe('schema', () => {
       expect.objectContaining({ name: 'ZodError' })
     );
   });
+});
 
+describe('keccak256HashSchema', () => {
   it('validates a valid ID', () => {
-    expect(() => idSchema.parse('0x3528e42b017a5fbf9d2993a2df04efc3ed474357575065a111b054ddf9de2acc')).not.toThrow();
+    expect(() =>
+      keccak256HashSchema.parse('0x3528e42b017a5fbf9d2993a2df04efc3ed474357575065a111b054ddf9de2acc')
+    ).not.toThrow();
   });
 
   it('throws for an invalid ID', () => {
-    expect(() => idSchema.parse('0xA3528e42b017a5fbf9d2993a2df04efc3ed474357575065a111b054ddf9de2acc')).toThrow(
+    expect(() =>
+      keccak256HashSchema.parse('0xA3528e42b017a5fbf9d2993a2df04efc3ed474357575065a111b054ddf9de2acc')
+    ).toThrow(expect.objectContaining({ name: 'ZodError' }));
+  });
+});
+
+describe('hexSchema', () => {
+  it('validates a valid hex string', () => {
+    expect(() => hexSchema.parse('0x3528e42b017a5fbf9d2993a2df04efc3ed474357575065a111b054ddf9de2acc')).not.toThrow();
+  });
+
+  it('throws for an invalid hex string', () => {
+    expect(() => hexSchema.parse('3528e42b017a5fbf9d2993a2df04efc3ed474357575065a111b054ddf9de2acc')).toThrow(
       expect.objectContaining({ name: 'ZodError' })
     );
   });
 });
+
+describe('chainIdSchema', () => {
+  it('validates a valid chain ID', () => {
+    expect(() => chainIdSchema.parse('1')).not.toThrow();
+  });
+
+  it('throws for an invalid chain ID', () => {
+    expect(() => chainIdSchema.parse('0')).toThrow(expect.objectContaining({ name: 'ZodError' }));
+  });
+});
+
+describe('ethUnitsSchema', () => {
+  it('validates a valid unit', () => {
+    expect(() => ethUnitsSchema.parse('wei')).not.toThrow();
+    expect(() => ethUnitsSchema.parse('kwei')).not.toThrow();
+    expect(() => ethUnitsSchema.parse('mwei')).not.toThrow();
+    expect(() => ethUnitsSchema.parse('gwei')).not.toThrow();
+    expect(() => ethUnitsSchema.parse('szabo')).not.toThrow();
+    expect(() => ethUnitsSchema.parse('finney')).not.toThrow();
+    expect(() => ethUnitsSchema.parse('ether')).not.toThrow();
+  });
+
+  it('throws for an invalid unit', () => {
+    expect(() => ethUnitsSchema.parse('wei2')).toThrow(expect.objectContaining({ name: 'ZodError' }));
+  });
+});
+
+describe('mnemonicSchema', () => {
+  it('validates a valid mnemonic', () => {
+    expect(() =>
+      mnemonicSchema.parse('destroy manual orange pole pioneer enemy detail lady cake bus shed visa')
+    ).not.toThrow();
+  });
+
+  it('throws for an invalid mnemonic', () => {
+    expect(() =>
+      mnemonicSchema.parse('destroy manual orange pole pioneer enemy detail lady cake bus shed WTF')
+    ).toThrow(expect.objectContaining({ name: 'ZodError' }));
+  });
+});

package/src/blockchain-utilities/schema.ts

@@ -1,14 +1,51 @@
+import { goSync } from '@api3/promise-utils';
+import { ethers } from 'ethers';
 import { z } from 'zod';
 
-/**
- * A Zod validation schema that represents an EVM-compatible address.
- */
-export const addressSchema = z.string().regex(/^0x[\dA-Fa-f]{40}$/, 'Must be a valid EVM address');
+export const hexSchema = z.string().regex(/^0x[\dA-Fa-f]+$/, 'Must be a valid hex string');
 
-/**
- * A Zod validation schema that represents an EVM-compatible hash, which includes beacon IDs and template IDs.
- */
-export const idSchema = z.string().regex(/^0x[\dA-Fa-f]{64}$/, 'Must be a valid EVM hash');
+export type Hex = `0x${string}`; // Not using z.infer<typeof hexSchema> because the inferred type is just `string`.
+
+export const addressSchema = z.string().transform((value, ctx) => {
+  const goParseAddress = goSync(() => ethers.utils.getAddress(value));
+  if (!goParseAddress.success) {
+    ctx.addIssue({ code: z.ZodIssueCode.custom, message: 'Invalid EVM address' });
+    return z.NEVER;
+  }
+
+  return goParseAddress.data as Hex;
+});
 
 export type Address = z.infer<typeof addressSchema>;
-export type Id = z.infer<typeof idSchema>;
+
+export const keccak256HashSchema = z
+  .string()
+  .regex(/^0x[\dA-Fa-f]{64}$/, 'Must be a valid EVM keccak256 hash')
+  .transform((val) => val as Hex);
+
+export type Keccak256Hash = z.infer<typeof keccak256HashSchema>;
+
+export const chainIdSchema = z
+  .string()
+  .regex(/^\d+$/, 'Must be a valid chain ID')
+  .refine((chainId) => Number(chainId) > 0, 'Chain ID must be greater than 0');
+
+export type ChainId = z.infer<typeof chainIdSchema>;
+
+export const ethUnitsSchema = z.union([
+  z.literal('wei'),
+  z.literal('kwei'),
+  z.literal('mwei'),
+  z.literal('gwei'),
+  z.literal('szabo'),
+  z.literal('finney'),
+  z.literal('ether'),
+]);
+
+export type EthUnits = z.infer<typeof ethUnitsSchema>;
+
+export const mnemonicSchema = z
+  .string()
+  .refine((mnemonic) => ethers.utils.isValidMnemonic(mnemonic), 'Invalid mnemonic');
+
+export type Mnemonic = z.infer<typeof mnemonicSchema>;

package/src/config-parsing/index.test.ts

@@ -127,6 +127,38 @@ describe(interpolateSecretsIntoConfig.name, () => {
     );
   });
 
+  it('allows parsing secrets without validating secret names', () => {
+    const rawSecrets = {
+      SECRET_A: 'secretValueA',
+      SECRET_B: 'secretValueB',
+      'CANNOT-CONTAIN-HYPHEN': 'invalid',
+      lowercasedSecret: 'valid',
+    };
+
+    expect(() => interpolateSecretsIntoConfig(rawConfig, rawSecrets)).toThrow(
+      new ZodError([
+        {
+          validation: 'regex',
+          code: 'invalid_string',
+          message: 'Secret name is not a valid. Secret name must match /^[A-Z][\\dA-Z_]*$/',
+          path: ['CANNOT-CONTAIN-HYPHEN'],
+        },
+        {
+          validation: 'regex',
+          code: 'invalid_string',
+          message: 'Secret name is not a valid. Secret name must match /^[A-Z][\\dA-Z_]*$/',
+          path: ['lowercasedSecret'],
+        },
+      ])
+    );
+
+    expect(interpolateSecretsIntoConfig(rawConfig, rawSecrets, { validateSecretName: false })).toStrictEqual({
+      property: 'value',
+      secretA: 'secretValueA',
+      secretB: 'secretValueB',
+    });
+  });
+
   it('provides up to date README examples', () => {
     // Basic interpolation
     const basicInterpolationConfig = {

package/src/config-parsing/index.ts

@@ -5,18 +5,16 @@ import reduce from 'lodash/reduce';
 import template from 'lodash/template';
 import { z } from 'zod';
 
-export const secretNamePattern = /^[A-Z][\dA-Z_]*$/;
+export const strictSecretNamePattern = /^[A-Z][\dA-Z_]*$/;
 
-export const secretNameSchema = z
+export const strictSecretNameSchema = z
   .string()
-  .regex(secretNamePattern, `Secret name is not a valid. Secret name must match ${secretNamePattern.toString()}`);
-
-export const secretsSchema = z.record(secretNameSchema, z.string());
+  .regex(
+    strictSecretNamePattern,
+    `Secret name is not a valid. Secret name must match ${strictSecretNamePattern.toString()}`
+  );
 
-export const nonBlankSecretsSchema = z.record(
-  secretNameSchema,
-  z.string().min(1, { message: 'Secret cannot be blank' })
-);
+export const nonBlankSecretValueSchema = z.string().min(1, { message: 'Secret cannot be blank' });
 
 export type Secrets = Record<string, string>;
 
@@ -34,7 +32,8 @@ const ES_MATCH_REGEXP = /(?<!\\)\${([^\\}]*(?:\\.[^\\}]*)*)}/g;
 const ESCAPED_ES_MATCH_REGEXP = /\\\\(\${([^\\}]*(?:\\.[^\\}]*)*)})/g;
 
 export interface InterpolationOptions {
-  allowBlankSecretValue: boolean;
+  allowBlankSecretValue?: boolean;
+  validateSecretName?: boolean;
 }
 
 export type AnyObject = Record<string, unknown>;
@@ -42,10 +41,12 @@ export type AnyObject = Record<string, unknown>;
 export function interpolateSecretsIntoConfig<T = AnyObject>(
   config: T,
   secrets: unknown,
-  options: InterpolationOptions = { allowBlankSecretValue: true }
+  options?: InterpolationOptions
 ) {
-  const { allowBlankSecretValue } = options;
-  const validatedSecrets = (allowBlankSecretValue ? secretsSchema : nonBlankSecretsSchema).parse(secrets);
+  const { allowBlankSecretValue = true, validateSecretName = true } = options ?? {};
+  const secretNameSchema = validateSecretName ? strictSecretNameSchema : z.string();
+  const secretValueSchema = allowBlankSecretValue ? z.string() : nonBlankSecretValueSchema;
+  const validatedSecrets = z.record(secretNameSchema, secretValueSchema).parse(secrets);
 
   const stringifiedSecrets = reduce(
     validatedSecrets,

package/src/universal-index.ts

@@ -1,2 +1,3 @@
 // NOTE: Only export modules which work in both Node.js and browser environments.
 export * from './blockchain-utilities';
+export * from './http';