docs

Author: rajranjan0608

interchain/src/chains/index.ts

@@ -1,2 +1,3 @@
+export type { ChainConfig } from "./types/chainConfig";
 export { avalancheFuji } from "./avalancheFuji";
 export { dispatch } from "./dispatch";

interchain/src/warp/addressedCallMessages/conversionData.ts

@@ -4,6 +4,12 @@ import { sha256 } from "@noble/hashes/sha2";
 
 const warpManager = pvmSerial.warp.getWarpManager();
 
+/**
+ * Parses a ConversionData (SubnetToL1Conversion) from a hex string.
+ *
+ * @param conversionDataHex - The hex string representing the ConversionData.
+ * @returns The parsed ConversionData instance. {@link ConversionData}
+ */
 export function parseConversionData(
     conversionDataHex: string,
 ): ConversionData {
@@ -19,6 +25,18 @@ export function parseConversionData(
     );
 }
 
+/**
+ * Creates a new ConversionData from values.
+ *
+ * @param subnetId - The subnet ID (base58check encoded).
+ * @param managerChainId - The manager chain ID (base58check encoded).
+ * @param managerAddress - The manager address in Bech32 format.
+ * @param validators - An array of validator data.
+ * @param validators.nodeId - The node ID (base58check encoded).
+ * @param validators.blsPublicKey - The BLS public key in hex format.
+ * @param validators.weight - The weight of the validator as a bigint.
+ * @returns A new ConversionData instance. {@link ConversionData}
+ */
 export function newConversionData(
     subnetId: string,
     managerChainId: string,
@@ -40,6 +58,11 @@ export function newConversionData(
     );
 }
 
+/**
+ * ConversionData class provides utility methods to build
+ * and parse ConversionData from hex strings or values, and
+ * access its properties.
+ */
 export class ConversionData extends pvmSerial.warp.AddressedCallPayloads.ConversionData {
     static fromHex(conversionDataHex: string) {
         return parseConversionData(conversionDataHex);

interchain/src/warp/addressedCallMessages/l1ValidatorRegistrationMessage.ts

@@ -3,6 +3,12 @@ import { parseAddressedCallPayload } from "../addressedCallPayload";
 
 const warpManager = pvmSerial.warp.getWarpManager();
 
+/**
+ * Parses a L1ValidatorRegistrationMessage (AddressedCall payload) from a hex string.
+ *
+ * @param l1ValidatorRegistrationMessageHex - The hex string representing the L1ValidatorRegistrationMessage.
+ * @returns The parsed L1ValidatorRegistrationMessage instance. {@link L1ValidatorRegistrationMessage}
+ */
 export function parseL1ValidatorRegistrationMessage(
     l1ValidatorRegistrationMessageHex: string,
 ): L1ValidatorRegistrationMessage {
@@ -24,6 +30,13 @@ export function parseL1ValidatorRegistrationMessage(
     }
 }
 
+/**
+ * Creates a new L1ValidatorRegistrationMessage from values.
+ *
+ * @param validationId - The validation ID (base58check encoded).
+ * @param registered - The registration status as a boolean.
+ * @returns A new L1ValidatorRegistrationMessage instance. {@link L1ValidatorRegistrationMessage}
+ */
 export function newL1ValidatorRegistrationMessage(
     validationId: string,
     registered: boolean,
@@ -35,6 +48,11 @@ export function newL1ValidatorRegistrationMessage(
     );
 }
 
+/**
+ * L1ValidatorRegistrationMessage class provides utility methods to build
+ * and parse L1ValidatorRegistrationMessage from hex strings or values, and
+ * access its properties.
+ */
 export class L1ValidatorRegistrationMessage extends pvmSerial.warp.AddressedCallPayloads.L1ValidatorRegistrationMessage {
     static fromHex(l1ValidatorRegistrationMessageHex: string) {
         return parseL1ValidatorRegistrationMessage(l1ValidatorRegistrationMessageHex);

interchain/src/warp/addressedCallMessages/l1ValidatorWeightMessage.ts

@@ -3,6 +3,12 @@ import { parseAddressedCallPayload } from "../addressedCallPayload";
 
 const warpManager = pvmSerial.warp.getWarpManager();
 
+/**
+ * Parses a L1ValidatorWeightMessage (AddressedCall payload) from a hex string.
+ *
+ * @param l1ValidatorWeightMessageHex - The hex string representing the L1ValidatorWeightMessage.
+ * @returns The parsed L1ValidatorWeightMessage instance. {@link L1ValidatorWeightMessage}
+ */
 export function parseL1ValidatorWeightMessage(
     l1ValidatorWeightMessageHex: string,
 ): L1ValidatorWeightMessage {
@@ -25,6 +31,14 @@ export function parseL1ValidatorWeightMessage(
     }
 }
 
+/**
+ * Creates a new L1ValidatorWeightMessage from values.
+ *
+ * @param validationId - The validation ID (base58check encoded).
+ * @param nonce - The nonce as a bigint.
+ * @param weight - The weight of the validator as a bigint.
+ * @returns A new L1ValidatorWeightMessage instance. {@link L1ValidatorWeightMessage}
+ */
 export function newL1ValidatorWeightMessage(validationId: string, nonce: bigint, weight: bigint) {
     const validationIdBytes = utils.base58check.decode(validationId);
     return new L1ValidatorWeightMessage(
@@ -34,6 +48,11 @@ export function newL1ValidatorWeightMessage(validationId: string, nonce: bigint,
     );
 }
 
+/**
+ * L1ValidatorWeightMessage class provides utility methods to build
+ * and parse L1ValidatorWeightMessage from hex strings or values, and
+ * access its properties.
+ */
 export class L1ValidatorWeightMessage extends pvmSerial.warp.AddressedCallPayloads.L1ValidatorWeightMessage {
     static fromHex(l1ValidatorWeightMessageHex: string) {
         return parseL1ValidatorWeightMessage(l1ValidatorWeightMessageHex);

interchain/src/warp/addressedCallMessages/registerL1ValidatorMessage.ts

@@ -14,6 +14,12 @@ import type { PChainOwner as PChainOwnerRaw } from "../types";
 
 const warpManager = pvmSerial.warp.getWarpManager();
 
+/**
+ * Parses a RegisterL1ValidatorMessage (AddressedCall payload) from a hex string.
+ *
+ * @param registerL1ValidatorMessageHex - The hex string representing the RegisterL1ValidatorMessage.
+ * @returns The parsed RegisterL1ValidatorMessage instance. {@link RegisterL1ValidatorMessage}
+ */
 export function parseRegisterL1ValidatorMessage(
     registerL1ValidatorMessageHex: string,
 ): RegisterL1ValidatorMessage {
@@ -40,6 +46,18 @@ export function parseRegisterL1ValidatorMessage(
     }
 }
 
+/**
+ * Creates a new RegisterL1ValidatorMessage from values.
+ *
+ * @param subnetId - The subnet ID (base58check encoded).
+ * @param nodeId - The node ID (base58check encoded).
+ * @param blsPublicKey - The BLS public key in hex format.
+ * @param expiry - The expiry time as a bigint.
+ * @param remainingBalanceOwner - The remaining balance owner details.
+ * @param disableOwner - The disable owner details.
+ * @param weight - The weight of the validator as a bigint.
+ * @returns A new RegisterL1ValidatorMessage instance. {@link RegisterL1ValidatorMessage}
+ */
 export function newRegisterL1ValidatorMessage(
     subnetId: string,
     nodeId: string,
@@ -70,6 +88,11 @@ export function newRegisterL1ValidatorMessage(
     )
 }
 
+/**
+ * RegisterL1ValidatorMessage class provides utility methods to build
+ * and parse RegisterL1ValidatorMessage from hex strings or values, and
+ * access its properties.
+ */
 export class RegisterL1ValidatorMessage extends pvmSerial.warp.AddressedCallPayloads.RegisterL1ValidatorMessage {
     static fromHex(registerL1ValidatorMessageHex: string) {
         return parseRegisterL1ValidatorMessage(registerL1ValidatorMessageHex);

interchain/src/warp/addressedCallMessages/subnetToL1ConversionMessage.ts

@@ -3,6 +3,12 @@ import { parseAddressedCallPayload } from "../addressedCallPayload";
 
 const warpManager = pvmSerial.warp.getWarpManager();
 
+/**
+ * Parses a SubnetToL1ConversionMessage (AddressedCall payload) from a hex string.
+ *
+ * @param subnetToL1ConversionMessageHex - The hex string representing the SubnetToL1ConversionMessage.
+ * @returns The parsed SubnetToL1ConversionMessage instance. {@link SubnetToL1ConversionMessage}
+ */
 export function parseSubnetToL1ConversionMessage(
     subnetToL1ConversionMessageHex: string,
 ): SubnetToL1ConversionMessage {
@@ -23,6 +29,12 @@ export function parseSubnetToL1ConversionMessage(
     }
 }
 
+/**
+ * Creates a new SubnetToL1ConversionMessage from a conversion ID.
+ *
+ * @param conversionId - The conversion ID (base58check encoded).
+ * @returns A new SubnetToL1ConversionMessage instance. {@link SubnetToL1ConversionMessage}
+ */
 export function newSubnetToL1ConversionMessage(
     conversionId: string,
 ) {
@@ -32,6 +44,11 @@ export function newSubnetToL1ConversionMessage(
     )
 }
 
+/**
+ * SubnetToL1ConversionMessage class provides utility methods to build
+ * and parse SubnetToL1ConversionMessage from hex strings or values, and
+ * access its properties.
+ */
 export class SubnetToL1ConversionMessage extends pvmSerial.warp.AddressedCallPayloads.SubnetToL1ConversionMessage {
     static fromHex(subnetToL1ConversionMessageHex: string) {
         return parseSubnetToL1ConversionMessage(subnetToL1ConversionMessageHex);

interchain/src/warp/addressedCallPayload.ts

@@ -4,6 +4,12 @@ import { evmOrBech32AddressToBytes } from "./utils";
 
 const warpManager = pvmSerial.warp.getWarpManager();
 
+/**
+ * Parses a Warp AddressedCall payload from a hex string.
+ *
+ * @param addressedCallPayloadHex - The hex string representing the AddressedCall payload.
+ * @returns The parsed AddressedCall instance. {@link AddressedCall}
+ */
 export function parseAddressedCallPayload(
     addressedCallPayloadHex: string,
 ): AddressedCall {
@@ -25,12 +31,24 @@ export function parseAddressedCallPayload(
     }
 }
 
+/**
+ * Creates a new AddressedCall from values.
+ *
+ * @param sourceAddress - The source address (EVM or Bech32 format).
+ * @param payloadHex - The payload as a hex string.
+ * @returns A new AddressedCall instance. {@link AddressedCall}
+ */
 export function newAddressedCallPayload(sourceAddress: string, payloadHex: string) {
     const sourceAddressBytes = evmOrBech32AddressToBytes(sourceAddress);
     const payloadBytes = utils.hexToBuffer(payloadHex);
     return new AddressedCall(new Address(sourceAddressBytes), new Bytes(payloadBytes));
 }
 
+/**
+ * AddressedCall class provides utility methods to build
+ * and parse AddressedCall payloads from hex strings or values, and
+ * access its properties.
+ */
 export class AddressedCall extends pvmSerial.warp.AddressedCallPayloads.AddressedCall {
     static fromHex(addressedCallPayloadHex: string): AddressedCall {
         return parseAddressedCallPayload(addressedCallPayloadHex);

interchain/src/warp/warpMessage.ts

@@ -2,6 +2,12 @@ import { pvmSerial, Short, utils } from "@avalabs/avalanchejs";
 
 const warpManager = pvmSerial.warp.getWarpManager();
 
+/**
+ * Parses a Warp signed message from a hex string.
+ *
+ * @param warpMsgHex - The hex string representing the signed message.
+ * @returns The parsed WarpSignedMessage instance. {@link WarpMessage}
+*/
 export function parseWarpMessage(warpMsgHex: string): WarpMessage {
     const parsedWarpMsg = warpManager.unpack(
         utils.hexToBuffer(warpMsgHex),
@@ -14,6 +20,11 @@ export function parseWarpMessage(warpMsgHex: string): WarpMessage {
     );
 }
 
+/**
+ * WarpSignedMessage class provides utility methods to build
+ * and parse signed warp message from hex strings or values, and
+ * access its properties.
+ */
 export class WarpMessage extends pvmSerial.warp.WarpMessage {
     static fromHex(warpMsgHex: string) {
         return parseWarpMessage(warpMsgHex);

interchain/src/warp/warpUnsignedMessage.ts

@@ -3,6 +3,12 @@ import { parseWarpMessage } from "./warpMessage";
 
 const warpManager = pvmSerial.warp.getWarpManager();
 
+/**
+ * Parses a Warp unsigned or signed message from a hex string.
+ *
+ * @param unsignedMsgHex - The hex string representing the unsigned or signed message.
+ * @returns The parsed WarpUnsignedMessage instance. {@link WarpUnsignedMessage}
+ */
 export function parseWarpUnsignedMessage(unsignedMsgHex: string): WarpUnsignedMessage {
     try {
         const parsedWarpUnsignedMsg = warpManager.unpack(
@@ -24,6 +30,14 @@ export function parseWarpUnsignedMessage(unsignedMsgHex: string): WarpUnsignedMe
     }
 }
 
+/**
+ * Creates a new WarpUnsignedMessage from values.
+ *
+ * @param networkId - The Avalanche network ID.
+ * @param sourceChainId - The source blockchain ID.
+ * @param payloadHex - The warp message payload as a hex string.
+ * @returns A new WarpUnsignedMessage instance. {@link WarpUnsignedMessage}
+ */
 export function newWarpUnsignedMessage(
     networkId: number,
     sourceChainId: string,
@@ -36,11 +50,28 @@ export function newWarpUnsignedMessage(
     );
 }
 
+/**
+ * WarpUnsignedMessage class provides utility methods to build
+ * and parse unsigned warp message from hex strings or values, and
+ * access its properties.
+ */
 export class WarpUnsignedMessage extends pvmSerial.warp.WarpUnsignedMessage {
+    /**
+     * Creates a WarpUnsignedMessage instance from a hex string.
+     * @param unsignedMsgHex - The hex string representing the unsigned message.
+     * @returns The parsed WarpUnsignedMessage instance. {@link WarpUnsignedMessage}
+     */
     static fromHex(unsignedMsgHex: string) {
         return parseWarpUnsignedMessage(unsignedMsgHex);
     }
 
+    /**
+     * Creates a WarpUnsignedMessage instance from values.
+     * @param networkId - The Avalanche network ID.
+     * @param sourceChainId - The source chain ID (base58check encoded).
+     * @param payloadHex - The payload as a hex string.
+     * @returns A new WarpUnsignedMessage instance. {@link WarpUnsignedMessage}
+     */
     static fromValues(
         networkId: number,
         sourceChainId: string,
@@ -49,6 +80,10 @@ export class WarpUnsignedMessage extends pvmSerial.warp.WarpUnsignedMessage {
         return newWarpUnsignedMessage(networkId, sourceChainId, payloadHex);
     }
 
+    /**
+     * Serializes the WarpUnsignedMessage to a hex string.
+     * @returns The hex string representation of the message.
+     */
     toHex() {
         const bytesWithoutCodec = this.toBytes(pvmSerial.warp.codec)
         const codecBytes = new Short(0)
@@ -57,6 +92,8 @@ export class WarpUnsignedMessage extends pvmSerial.warp.WarpUnsignedMessage {
 
     /**
      * Do not use this method directly.
+     * Throws an error if called.
+     * @throws Error
      */
     static override fromBytes(
         _bytes: never,