@api3/commons 0.7.1 → 0.9.0

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

@@ -1,78 +1,24 @@
 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;
+export declare const deriveHdNodeFromXpub: (xpub: string) => ethers.utils.HDNode;
+export declare const verifyAirnodeXpub: (airnodeXpub: string, airnodeAddress: Address) => ethers.utils.HDNode;
+export declare function deriveSponsorWalletAddress(airnodeXpub: string, sponsorAddress: Address, protocolId: ProtocolId, airnodeAddress?: Address): 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;AAE1F,eAAO,MAAM,oBAAoB,SAAU,MAAM,wBAA8C,CAAC;AAEhG,eAAO,MAAM,iBAAiB,gBAAiB,MAAM,kBAAkB,OAAO,KAAG,OAAO,KAAK,CAAC,MAQ7F,CAAC;AAEF,wBAAgB,0BAA0B,CACxC,WAAW,EAAE,MAAM,EACnB,cAAc,EAAE,OAAO,EACvB,UAAU,EAAE,UAAU,EACtB,cAAc,CAAC,EAAE,OAAO,UAKzB"}

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.deriveSponsorWalletAddress = exports.verifyAirnodeXpub = exports.deriveHdNodeFromXpub = 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,39 @@ 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;
+const deriveHdNodeFromXpub = (xpub) => ethers_1.ethers.utils.HDNode.fromExtendedKey(xpub);
+exports.deriveHdNodeFromXpub = deriveHdNodeFromXpub;
+const verifyAirnodeXpub = (airnodeXpub, airnodeAddress) => {
+    // The xpub is expected to belong to the hardened path m/44'/60'/0' so we must derive the child default derivation
+    // path m/44'/60'/0'/0/0 to compare it and check if xpub belongs to the Airnode wallet.
+    const hdNode = (0, exports.deriveHdNodeFromXpub)(airnodeXpub);
+    if (airnodeAddress !== hdNode.derivePath('0/0').address) {
+        throw new Error(`xpub does not belong to Airnode: ${airnodeAddress}`);
+    }
+    return hdNode;
+};
+exports.verifyAirnodeXpub = verifyAirnodeXpub;
+function deriveSponsorWalletAddress(airnodeXpub, sponsorAddress, protocolId, airnodeAddress) {
+    const hdNode = airnodeAddress ? (0, exports.verifyAirnodeXpub)(airnodeXpub, airnodeAddress) : (0, exports.deriveHdNodeFromXpub)(airnodeXpub);
+    const derivationPath = deriveWalletPathFromSponsorAddress(sponsorAddress, protocolId);
+    return hdNode.derivePath(derivationPath).address;
+}
+exports.deriveSponsorWalletAddress = deriveSponsorWalletAddress;
 //# 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;AAEnF,MAAM,oBAAoB,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,eAAM,CAAC,KAAK,CAAC,MAAM,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;AAAnF,QAAA,oBAAoB,wBAA+D;AAEzF,MAAM,iBAAiB,GAAG,CAAC,WAAmB,EAAE,cAAuB,EAAuB,EAAE;IACrG,kHAAkH;IAClH,uFAAuF;IACvF,MAAM,MAAM,GAAG,IAAA,4BAAoB,EAAC,WAAW,CAAC,CAAC;IACjD,IAAI,cAAc,KAAK,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,OAAO,EAAE;QACvD,MAAM,IAAI,KAAK,CAAC,oCAAoC,cAAc,EAAE,CAAC,CAAC;KACvE;IACD,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AARW,QAAA,iBAAiB,qBAQ5B;AAEF,SAAgB,0BAA0B,CACxC,WAAmB,EACnB,cAAuB,EACvB,UAAsB,EACtB,cAAwB;IAExB,MAAM,MAAM,GAAG,cAAc,CAAC,CAAC,CAAC,IAAA,yBAAiB,EAAC,WAAW,EAAE,cAAc,CAAC,CAAC,CAAC,CAAC,IAAA,4BAAoB,EAAC,WAAW,CAAC,CAAC;IACnH,MAAM,cAAc,GAAG,kCAAkC,CAAC,cAAc,EAAE,UAAU,CAAC,CAAC;IACtF,OAAO,MAAM,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC,OAAO,CAAC;AACnD,CAAC;AATD,gEASC"}

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/http/index.d.ts

@@ -1,4 +1,4 @@
-import { type Method, type AxiosError, type AxiosResponse } from 'axios';
+import { type Method, type AxiosError } from 'axios';
 export interface Request {
     readonly method: Method;
     readonly url: string;
@@ -8,7 +8,7 @@ export interface Request {
     readonly body?: unknown;
 }
 export interface ErrorResponse {
-    readonly axiosResponse: Pick<AxiosResponse, 'data' | 'headers' | 'status'> | undefined;
+    readonly response: unknown;
     readonly message: string;
     readonly code: string | undefined;
 }
@@ -17,11 +17,13 @@ interface ExecuteRequestSuccess<T> {
     success: true;
     errorData: undefined;
     data: T;
+    statusCode: number;
 }
 interface ExecuteRequestError {
     success: false;
     errorData: ErrorResponse;
     data: undefined;
+    statusCode: number | undefined;
 }
 export type ExecuteRequestResult<T> = ExecuteRequestError | ExecuteRequestSuccess<T>;
 export declare function executeRequest<T>(request: Request): Promise<ExecuteRequestResult<T>>;

package/dist/http/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/http/index.ts"],"names":[],"mappings":"AACA,OAAc,EAAE,KAAK,MAAM,EAAE,KAAK,UAAU,EAAE,KAAK,aAAa,EAAE,MAAM,OAAO,CAAC;AAKhF,MAAM,WAAW,OAAO;IACtB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC1C,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC3C,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC;CACzB;AAED,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,aAAa,EAAE,IAAI,CAAC,aAAa,EAAE,MAAM,GAAG,SAAS,GAAG,QAAQ,CAAC,GAAG,SAAS,CAAC;IACvF,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,CAAC;CACnC;AAED,eAAO,MAAM,qBAAqB,UAAW,UAAU,KAAG,aAOzD,CAAC;AAEF,UAAU,qBAAqB,CAAC,CAAC;IAC/B,OAAO,EAAE,IAAI,CAAC;IACd,SAAS,EAAE,SAAS,CAAC;IACrB,IAAI,EAAE,CAAC,CAAC;CACT;AACD,UAAU,mBAAmB;IAC3B,OAAO,EAAE,KAAK,CAAC;IACf,SAAS,EAAE,aAAa,CAAC;IACzB,IAAI,EAAE,SAAS,CAAC;CACjB;AAED,MAAM,MAAM,oBAAoB,CAAC,CAAC,IAAI,mBAAmB,GAAG,qBAAqB,CAAC,CAAC,CAAC,CAAC;AAErF,wBAAsB,cAAc,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC,CAiB1F"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/http/index.ts"],"names":[],"mappings":"AACA,OAAc,EAAE,KAAK,MAAM,EAAE,KAAK,UAAU,EAAsB,MAAM,OAAO,CAAC;AAIhF,MAAM,WAAW,OAAO;IACtB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC1C,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC3C,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC;CACzB;AAED,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;IAC3B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,CAAC;CACnC;AAED,eAAO,MAAM,qBAAqB,UAAW,UAAU,KAAG,aAOzD,CAAC;AAEF,UAAU,qBAAqB,CAAC,CAAC;IAC/B,OAAO,EAAE,IAAI,CAAC;IACd,SAAS,EAAE,SAAS,CAAC;IACrB,IAAI,EAAE,CAAC,CAAC;IACR,UAAU,EAAE,MAAM,CAAC;CACpB;AACD,UAAU,mBAAmB;IAC3B,OAAO,EAAE,KAAK,CAAC;IACf,SAAS,EAAE,aAAa,CAAC;IACzB,IAAI,EAAE,SAAS,CAAC;IAChB,UAAU,EAAE,MAAM,GAAG,SAAS,CAAC;CAChC;AAED,MAAM,MAAM,oBAAoB,CAAC,CAAC,IAAI,mBAAmB,GAAG,qBAAqB,CAAC,CAAC,CAAC,CAAC;AAErF,wBAAsB,cAAc,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC,CAwB1F"}

package/dist/http/index.js

@@ -6,12 +6,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.executeRequest = exports.extractAxiosErrorData = void 0;
 const promise_utils_1 = require("@api3/promise-utils");
 const axios_1 = __importDefault(require("axios"));
-const pick_1 = __importDefault(require("lodash/pick"));
 const DEFAULT_TIMEOUT_MS = 10_000;
 const extractAxiosErrorData = (error) => {
     // Inspired by: https://axios-http.com/docs/handling_errors
     return {
-        axiosResponse: error.response ? (0, pick_1.default)(error.response, ['data', 'status']) : undefined,
+        response: error.response?.data,
         message: error.message,
         code: error.code,
     };
@@ -27,10 +26,16 @@ async function executeRequest(request) {
         params: queryParams,
         timeout,
     }));
-    if (!goAxios.success)
-        return { success: false, errorData: (0, exports.extractAxiosErrorData)(goAxios.error), data: undefined };
+    if (!goAxios.success) {
+        return {
+            success: false,
+            errorData: (0, exports.extractAxiosErrorData)(goAxios.error),
+            data: undefined,
+            statusCode: goAxios.error.status,
+        };
+    }
     const response = goAxios.data;
-    return { success: true, errorData: undefined, data: response.data };
+    return { success: true, errorData: undefined, data: response.data, statusCode: response.status };
 }
 exports.executeRequest = executeRequest;
 //# sourceMappingURL=index.js.map

package/dist/http/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/http/index.ts"],"names":[],"mappings":";;;;;;AAAA,uDAAyC;AACzC,kDAAgF;AAChF,uDAA+B;AAE/B,MAAM,kBAAkB,GAAG,MAAM,CAAC;AAiB3B,MAAM,qBAAqB,GAAG,CAAC,KAAiB,EAAiB,EAAE;IACxE,2DAA2D;IAC3D,OAAO;QACL,aAAa,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAA,cAAI,EAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS;QACpF,OAAO,EAAE,KAAK,CAAC,OAAO;QACtB,IAAI,EAAE,KAAK,CAAC,IAAI;KACA,CAAC;AACrB,CAAC,CAAC;AAPW,QAAA,qBAAqB,yBAOhC;AAeK,KAAK,UAAU,cAAc,CAAI,OAAgB;IACtD,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,GAAG,EAAE,EAAE,WAAW,GAAG,EAAE,EAAE,OAAO,GAAG,kBAAkB,EAAE,GAAG,OAAO,CAAC;IAEpG,MAAM,OAAO,GAAG,MAAM,IAAA,kBAAE,EAAwC,KAAK,IAAI,EAAE,CACzE,IAAA,eAAK,EAAC;QACJ,GAAG;QACH,MAAM;QACN,OAAO;QACP,IAAI,EAAE,IAAI;QACV,MAAM,EAAE,WAAW;QACnB,OAAO;KACR,CAAC,CACH,CAAC;IACF,IAAI,CAAC,OAAO,CAAC,OAAO;QAAE,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,IAAA,6BAAqB,EAAC,OAAO,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;IAClH,MAAM,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;IAE9B,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,SAAS,EAAE,IAAI,EAAE,QAAQ,CAAC,IAAI,EAAE,CAAC;AACtE,CAAC;AAjBD,wCAiBC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/http/index.ts"],"names":[],"mappings":";;;;;;AAAA,uDAAyC;AACzC,kDAAgF;AAEhF,MAAM,kBAAkB,GAAG,MAAM,CAAC;AAiB3B,MAAM,qBAAqB,GAAG,CAAC,KAAiB,EAAiB,EAAE;IACxE,2DAA2D;IAC3D,OAAO;QACL,QAAQ,EAAE,KAAK,CAAC,QAAQ,EAAE,IAAI;QAC9B,OAAO,EAAE,KAAK,CAAC,OAAO;QACtB,IAAI,EAAE,KAAK,CAAC,IAAI;KACjB,CAAC;AACJ,CAAC,CAAC;AAPW,QAAA,qBAAqB,yBAOhC;AAiBK,KAAK,UAAU,cAAc,CAAI,OAAgB;IACtD,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,GAAG,EAAE,EAAE,WAAW,GAAG,EAAE,EAAE,OAAO,GAAG,kBAAkB,EAAE,GAAG,OAAO,CAAC;IAEpG,MAAM,OAAO,GAAG,MAAM,IAAA,kBAAE,EAAwC,KAAK,IAAI,EAAE,CACzE,IAAA,eAAK,EAAC;QACJ,GAAG;QACH,MAAM;QACN,OAAO;QACP,IAAI,EAAE,IAAI;QACV,MAAM,EAAE,WAAW;QACnB,OAAO;KACR,CAAC,CACH,CAAC;IACF,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE;QACpB,OAAO;YACL,OAAO,EAAE,KAAK;YACd,SAAS,EAAE,IAAA,6BAAqB,EAAC,OAAO,CAAC,KAAK,CAAC;YAC/C,IAAI,EAAE,SAAS;YACf,UAAU,EAAE,OAAO,CAAC,KAAK,CAAC,MAAM;SACjC,CAAC;KACH;IACD,MAAM,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;IAE9B,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,SAAS,EAAE,IAAI,EAAE,QAAQ,CAAC,IAAI,EAAE,UAAU,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC;AACnG,CAAC;AAxBD,wCAwBC"}

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.1",
+  "version": "0.9.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,20 +6,24 @@ import {
   deriveBeaconSetId,
   deriveEndpointId,
   deriveSponsorWallet,
-  deriveTemplateId,
+  deriveSponsorWalletAddress,
+  deriveTemplateIdV0,
+  deriveTemplateIdV1,
   deriveWalletPathFromSponsorAddress,
   fromBytes32String,
   PROTOCOL_IDS,
   toBytes32String,
+  verifyAirnodeXpub,
 } from './derivation';
+import type { Address } from './schema';
 
-describe('deriveWalletPathFromSponsorAddress', () => {
+describe(deriveWalletPathFromSponsorAddress.name, () => {
   it('converts address to derivation path', () => {
     const sponsorAddress = '0x8A45eac0267dD0803Fd957723EdE10693A076698';
     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,103 +49,184 @@ describe('deriveWalletPathFromSponsorAddress', () => {
   });
 
   it('throws if address is an empty string', () => {
-    const sponsorAddress = '';
+    const sponsorAddress = '' as Address;
     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') })
+describe(deriveSponsorWallet.name, () => {
+  it('derives a sponsor wallet', () => {
+    const dapiName = ethers.utils.formatBytes32String('BTC/ETH');
+    const sponsorWallet = deriveSponsorWallet(
+      'test test test test test test test test test test test junk',
+      dapiName,
+      '1'
     );
 
-    sponsorAddress = ethers.utils.hexlify(ethers.utils.randomBytes(4));
-    expect(() => deriveWalletPathFromSponsorAddress(sponsorAddress, PROTOCOL_IDS.AIRSEEKER)).toThrow(
-      expect.objectContaining({ name: expect.stringContaining('Error') })
-    );
+    expect(sponsorWallet.address).toBe('0x4f86228e0Bc58829Cd77547224291bb8d212174D');
+  });
 
-    sponsorAddress = ethers.utils.hexlify(ethers.utils.randomBytes(32));
-    expect(() => deriveWalletPathFromSponsorAddress(sponsorAddress, PROTOCOL_IDS.AIRSEEKER)).toThrow(
-      expect.objectContaining({ name: expect.stringContaining('Error') })
-    );
+  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, '5');
+
+    expect(throwingFn).toThrow(expect.objectContaining({ name: expect.stringContaining('Error') }));
   });
 
-  describe('blockchain utilities', () => {
-    it('derives a sponsor wallet', () => {
-      const dapiName = ethers.utils.formatBytes32String('BTC/ETH');
-      const sponsorWallet = deriveSponsorWallet(
-        'test test test test test test test test test test test junk',
-        dapiName
+  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);
 
-      expect(sponsorWallet.address).toBe('0x1e6f0dfb1775f5032f12f56a01526351eD3F07aF');
-    });
+    // 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');
 
-    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);
+    expect(actualSponsorWallet.address).toBe(expectedSponsorWallet.address);
+    expect(actualSponsorWallet.address).toBe('0x228A54F33E46fbb32a62ca650Fcc9eD3C730511d');
+  });
+});
 
-      expect(throwingFn).toThrow(expect.objectContaining({ name: expect.stringContaining('Error') }));
-    });
+describe(deriveAirnodeXpub.name, () => {
+  it(`derives an airnode's xpub from a mnemonic`, () => {
+    const xpub = deriveAirnodeXpub('test test test test test test test test test test test junk');
 
-    it(`derives an airnode's xpub from a mnemonic`, () => {
-      const xpub = deriveAirnodeXpub('test test test test test test test test test test test junk');
+    expect(xpub).toBe(
+      'xpub6Ce9NcJvTk36xtLSrJLZqE7wtgA5deCeYs7rSQtreh4cj6ByPtrg9sD7V2FNFLPnf8heNP3FGkeV9qwfzvZNSd54JoNXVsXFYSYwHsnJxqP'
+    );
+  });
+});
 
-      expect(xpub).toBe(
-        'xpub6Ce9NcJvTk36xtLSrJLZqE7wtgA5deCeYs7rSQtreh4cj6ByPtrg9sD7V2FNFLPnf8heNP3FGkeV9qwfzvZNSd54JoNXVsXFYSYwHsnJxqP'
-      );
-    });
+describe(deriveEndpointId.name, () => {
+  it(`derives an endpoint ID`, () => {
+    const endpointId = deriveEndpointId('weather', 'temperature');
 
-    it(`derives an endpoint ID`, () => {
-      const endpointId = deriveEndpointId('weather', 'temperature');
+    expect(endpointId).toBe('0x5a82d40e44ecd3ef0906e9e82c1a20f2f4ffe4f613ac70f999047496a9cd4635');
+  });
+});
 
-      expect(endpointId).toBe('0x5a82d40e44ecd3ef0906e9e82c1a20f2f4ffe4f613ac70f999047496a9cd4635');
-    });
+describe(deriveTemplateIdV0.name, () => {
+  it(`it derives a template ID V0`, () => {
+    const templateId = deriveTemplateIdV0(
+      '0x4E95C31894a89CdC4288669A6F294836948c862b',
+      '0x5a82d40e44ecd3ef0906e9e82c1a20f2f4ffe4f613ac70f999047496a9cd4635',
+      '0x6466726f6d63455448'
+    );
 
-    it(`it derives a template ID`, () => {
-      const templateId = deriveTemplateId({
-        airnode: '0x4E95C31894a89CdC4288669A6F294836948c862b',
-        endpointId: '0x5a82d40e44ecd3ef0906e9e82c1a20f2f4ffe4f613ac70f999047496a9cd4635',
-        encodedParameters: '0x1234',
-      });
+    expect(templateId).toBe('0x25ea8b12135e4b8d49960ef9e0f967b7c0ccad136b955fbb7fbeb76da27d60b0');
+  });
+});
 
-      expect(templateId).toBe('0x7655363f294273f84bcc7c47d79858cf46f21951deee92746d9f17a69ac0b0c0');
-    });
+describe(deriveTemplateIdV1.name, () => {
+  it('derives templateId for V1', () => {
+    const expectedTemplateIdV1 = deriveTemplateIdV1(
+      '0x2f3a3adf6daf5a3bb00ab83aa82262a6a84b59b0a89222386135330a1819ab48',
+      '0x6466726f6d63455448'
+    );
 
-    it('derives a beacon ID', () => {
-      const beaconId = deriveBeaconId(
-        '0xc52EeA00154B4fF1EbbF8Ba39FDe37F1AC3B9Fd4',
-        '0x457a3b3da67e394a895ea49e534a4d91b2d009477bef15eab8cbed313925b010'
-      );
+    expect(expectedTemplateIdV1).toBe('0xe5d99287b5a870c3453bc0b42769c6f37cf4a3143890e9c34753181171fac842');
+  });
+});
+
+describe(deriveBeaconId.name, () => {
+  it('derives a beacon ID', () => {
+    const beaconId = deriveBeaconId(
+      '0xc52EeA00154B4fF1EbbF8Ba39FDe37F1AC3B9Fd4',
+      '0x457a3b3da67e394a895ea49e534a4d91b2d009477bef15eab8cbed313925b010'
+    );
+
+    expect(beaconId).toBe('0xf5c140bcb4814dfec311d38f6293e86c02d32ba1b7da027fe5b5202cae35dbc6');
+  });
+});
+
+describe(deriveBeaconSetId.name, () => {
+  it(`derives a beacon set ID`, () => {
+    const beaconSetId = deriveBeaconSetId([
+      '0x0e30ed302a3c8eeaa0053caf5fbd0825c86ce1767584d12c69c310f0068b1176',
+      '0x496092597aef79595df1567412c6ddefd037f63a5a1572702dd469f62f31f469',
+      '0x84c1da28b2f29f0a2b0ff360d537d405d1cd69249fcf5f32ae9c2298cee6da12',
+      '0xe8655dc68f2b765c5e6d4a042ba7ba8606cf37e1c8c96676f85364ec5bfe9163',
+      '0xf5c140bcb4814dfec311d38f6293e86c02d32ba1b7da027fe5b5202cae35dbc6',
+    ]);
+
+    expect(beaconSetId).toBe('0x33bf380fd5b06a317a905b23eaf5c61ef0a9b4a20589a1bf1d13133daca34b0e');
+  });
+});
+
+describe(toBytes32String.name, () => {
+  it('encodes a string as a bytes32 string', () => {
+    const formattedString = toBytes32String('test string');
+
+    expect(formattedString).toBe('0x7465737420737472696e67000000000000000000000000000000000000000000');
+  });
+});
+
+describe(fromBytes32String.name, () => {
+  it('decodes a bytes32 string to a normal string', () => {
+    const formattedString = fromBytes32String('0x7465737420737472696e67000000000000000000000000000000000000000000');
+
+    expect(formattedString).toBe('test string');
+  });
+});
 
-      expect(beaconId).toBe('0xf5c140bcb4814dfec311d38f6293e86c02d32ba1b7da027fe5b5202cae35dbc6');
-    });
+describe(verifyAirnodeXpub.name, () => {
+  it('does not throw for valid xpub/airnode combination', () => {
+    expect(() =>
+      verifyAirnodeXpub(
+        'xpub6CvZvZuFtPUtNirE36eMqYu8pRa1CEQuDon9tT4G8fisU3jj38Sn53TxdHb1SUvWiwVjJ68ytPZf45gnPM7Kg4g4CNTdyjJMevDQ1wk4tYD',
+        '0x02F5BD238B866c36f7d7b144D2889fB5e594474e'
+      )
+    ).not.toThrow();
+  });
 
-    it(`derives a beacon set ID`, () => {
-      const beaconSetId = deriveBeaconSetId([
-        '0x0e30ed302a3c8eeaa0053caf5fbd0825c86ce1767584d12c69c310f0068b1176',
-        '0x496092597aef79595df1567412c6ddefd037f63a5a1572702dd469f62f31f469',
-        '0x84c1da28b2f29f0a2b0ff360d537d405d1cd69249fcf5f32ae9c2298cee6da12',
-        '0xe8655dc68f2b765c5e6d4a042ba7ba8606cf37e1c8c96676f85364ec5bfe9163',
-        '0xf5c140bcb4814dfec311d38f6293e86c02d32ba1b7da027fe5b5202cae35dbc6',
-      ]);
+  it('throws when the xpub is invalid', () => {
+    expect(() =>
+      verifyAirnodeXpub(
+        'xpub6CvZvZuFtPUtNirE36eMqYu8pRa1CEQuDon9tT4G8fisU3jj38Sn53TxdHb1SUvWiwVjJ68ytPZf45gnPM7Kg4g4CNTdyjJMevDQ1wk4tYD',
+        '0xDdfd47366cA427e75C26c9F3364EE37b33e1DD38'
+      )
+    ).toThrow('xpub does not belong to Airnode: 0xDdfd47366cA427e75C26c9F3364EE37b33e1DD38');
+  });
+});
 
-      expect(beaconSetId).toBe('0x33bf380fd5b06a317a905b23eaf5c61ef0a9b4a20589a1bf1d13133daca34b0e');
-    });
+describe(deriveSponsorWalletAddress, () => {
+  it('derives the sponsor wallet address and verifies airnode address', () => {
+    const sponsorWalletAddress = deriveSponsorWalletAddress(
+      'xpub6CvZvZuFtPUtNirE36eMqYu8pRa1CEQuDon9tT4G8fisU3jj38Sn53TxdHb1SUvWiwVjJ68ytPZf45gnPM7Kg4g4CNTdyjJMevDQ1wk4tYD',
+      '0xE9232cde1f37B029dfbB403f79429f912D7405F3',
+      '1',
+      '0x02F5BD238B866c36f7d7b144D2889fB5e594474e'
+    );
 
-    it('encodes a string as a bytes32 string', () => {
-      const formattedString = toBytes32String('test string');
+    expect(sponsorWalletAddress).toBe('0xDdfd47366cA427e75C26c9F3364EE37b33e1DD38');
+  });
 
-      expect(formattedString).toBe('0x7465737420737472696e67000000000000000000000000000000000000000000');
-    });
+  it('derives the sponsor wallet without xpub verifification', () => {
+    const sponsorWalletAddress = deriveSponsorWalletAddress(
+      'xpub6CvZvZuFtPUtNirE36eMqYu8pRa1CEQuDon9tT4G8fisU3jj38Sn53TxdHb1SUvWiwVjJ68ytPZf45gnPM7Kg4g4CNTdyjJMevDQ1wk4tYD',
+      '0xE9232cde1f37B029dfbB403f79429f912D7405F3',
+      '1'
+    );
 
-    it('decodes a bytes32 string to a normal string', () => {
-      const formattedString = fromBytes32String('0x7465737420737472696e67000000000000000000000000000000000000000000');
+    expect(sponsorWalletAddress).toBe('0xDdfd47366cA427e75C26c9F3364EE37b33e1DD38');
+  });
 
-      expect(formattedString).toBe('test string');
-    });
+  it('verifies that xpub is valid when airnode address is provided', () => {
+    expect(() =>
+      deriveSponsorWalletAddress(
+        'xpub6CvZvZuFtPUtNirE36eMqYu8pRa1CEQuDon9tT4G8fisU3jj38Sn53TxdHb1SUvWiwVjJ68ytPZf45gnPM7Kg4g4CNTdyjJMevDQ1wk4tYD',
+        '0xE9232cde1f37B029dfbB403f79429f912D7405F3',
+        '1',
+        '0xA143283e75c8e0a3174d51e6ccA38B334E1D6b12'
+      )
+    ).toThrow('xpub does not belong to Airnode: 0xA143283e75c8e0a3174d51e6ccA38B334E1D6b12');
   });
 });

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,47 @@ 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);
-
-/**
- * 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 fromBytes32String = (input: Hex) => ethers.utils.parseBytes32String(input);
+
+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]));
+
+export const deriveHdNodeFromXpub = (xpub: string) => ethers.utils.HDNode.fromExtendedKey(xpub);
+
+export const verifyAirnodeXpub = (airnodeXpub: string, airnodeAddress: Address): ethers.utils.HDNode => {
+  // The xpub is expected to belong to the hardened path m/44'/60'/0' so we must derive the child default derivation
+  // path m/44'/60'/0'/0/0 to compare it and check if xpub belongs to the Airnode wallet.
+  const hdNode = deriveHdNodeFromXpub(airnodeXpub);
+  if (airnodeAddress !== hdNode.derivePath('0/0').address) {
+    throw new Error(`xpub does not belong to Airnode: ${airnodeAddress}`);
+  }
+  return hdNode;
+};
+
+export function deriveSponsorWalletAddress(
+  airnodeXpub: string,
+  sponsorAddress: Address,
+  protocolId: ProtocolId,
+  airnodeAddress?: Address
+) {
+  const hdNode = airnodeAddress ? verifyAirnodeXpub(airnodeXpub, airnodeAddress) : deriveHdNodeFromXpub(airnodeXpub);
+  const derivationPath = deriveWalletPathFromSponsorAddress(sponsorAddress, protocolId);
+  return hdNode.derivePath(derivationPath).address;
+}

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/http/index.test.ts

@@ -11,12 +11,9 @@ describe(extractAxiosErrorData.name, () => {
     } as any as AxiosResponse);
 
     expect(extractAxiosErrorData(axiosError)).toStrictEqual({
-      axiosResponse: {
-        data: 'error data',
-        status: 500,
-      },
-      code: '500',
+      response: 'error data',
       message: 'error message',
+      code: '500',
     });
   });
 });
@@ -33,10 +30,11 @@ describe(executeRequest.name, () => {
     expect(response).toStrictEqual({
       data: undefined,
       errorData: {
-        axiosResponse: undefined,
+        response: undefined,
         code: 'ECONNREFUSED',
         message: expect.any(String), // The message is empty in node@20, but "connect ECONNREFUSED ::1:9999" on node@18
       },
+      statusCode: undefined,
       success: false,
     });
   });

package/src/http/index.ts

@@ -1,6 +1,5 @@
 import { go } from '@api3/promise-utils';
 import axios, { type Method, type AxiosError, type AxiosResponse } from 'axios';
-import pick from 'lodash/pick';
 
 const DEFAULT_TIMEOUT_MS = 10_000;
 
@@ -14,7 +13,7 @@ export interface Request {
 }
 
 export interface ErrorResponse {
-  readonly axiosResponse: Pick<AxiosResponse, 'data' | 'headers' | 'status'> | undefined;
+  readonly response: unknown;
   readonly message: string;
   readonly code: string | undefined;
 }
@@ -22,21 +21,23 @@ export interface ErrorResponse {
 export const extractAxiosErrorData = (error: AxiosError): ErrorResponse => {
   // Inspired by: https://axios-http.com/docs/handling_errors
   return {
-    axiosResponse: error.response ? pick(error.response, ['data', 'status']) : undefined,
+    response: error.response?.data,
     message: error.message,
     code: error.code,
-  } as ErrorResponse;
+  };
 };
 
 interface ExecuteRequestSuccess<T> {
   success: true;
   errorData: undefined;
   data: T;
+  statusCode: number;
 }
 interface ExecuteRequestError {
   success: false;
   errorData: ErrorResponse;
   data: undefined;
+  statusCode: number | undefined;
 }
 
 export type ExecuteRequestResult<T> = ExecuteRequestError | ExecuteRequestSuccess<T>;
@@ -54,8 +55,15 @@ export async function executeRequest<T>(request: Request): Promise<ExecuteReques
       timeout,
     })
   );
-  if (!goAxios.success) return { success: false, errorData: extractAxiosErrorData(goAxios.error), data: undefined };
+  if (!goAxios.success) {
+    return {
+      success: false,
+      errorData: extractAxiosErrorData(goAxios.error),
+      data: undefined,
+      statusCode: goAxios.error.status,
+    };
+  }
   const response = goAxios.data;
 
-  return { success: true, errorData: undefined, data: response.data };
+  return { success: true, errorData: undefined, data: response.data, statusCode: response.status };
 }

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';