@wormhole-foundation/sdk-definitions 0.4.0-beta.1 → 0.4.0-beta.11

package/dist/cjs/address.d.ts

@@ -1,9 +1,24 @@
 import { Chain, ChainToPlatform, Platform } from "@wormhole-foundation/sdk-base";
 import { UniversalAddress } from "./universalAddress";
+/**
+ * Address is the base interface all address types must implement.
+ *
+ * Represents a parsed address
+ */
 export interface Address {
+    /**
+     * unwrap returns the underlying native address type, e.g.:
+     * a Uint8Array for UniversalAddress
+     * a checksum hex string string for EVM(ethers)
+     * a PublicKey for Solana
+     * etc.
+     */
     unwrap(): unknown;
+    /** Return the address in its canonical string format */
     toString(): string;
+    /** Return the bytes for the address */
     toUint8Array(): Uint8Array;
+    /** Return an Address that has been converted to its Universal representation */
     toUniversalAddress(): UniversalAddress;
 }
 declare global {
@@ -13,10 +28,18 @@ declare global {
     }
 }
 export type MappedPlatforms = keyof WormholeNamespace.PlatformToNativeAddressMapping;
+/** Utility type to map platform to its native address implementation */
 type GetNativeAddress<P extends Platform> = P extends MappedPlatforms ? WormholeNamespace.PlatformToNativeAddressMapping[P] : never;
+/** An address that has been parsed into its Nativfe Address type */
 export type NativeAddress<C extends Chain> = GetNativeAddress<ChainToPlatform<C>>;
+/** A union type representing a parsed address */
 export type UniversalOrNative<C extends Chain> = UniversalAddress | NativeAddress<C>;
+/** An address that represents an account  */
 export type AccountAddress<C extends Chain> = UniversalOrNative<C>;
+/**
+ * ChainAddress represents the parsed address for a given chain
+ * and comes with the context of which chain its relevant for
+ */
 export type ChainAddress<C extends Chain = Chain> = {
     readonly chain: C;
     readonly address: UniversalOrNative<C>;
@@ -24,6 +47,7 @@ export type ChainAddress<C extends Chain = Chain> = {
 type NativeAddressCtr = new (ua: UniversalAddress | string | Uint8Array) => Address;
 export declare function registerNative<P extends Platform>(platform: P, ctr: NativeAddressCtr): void;
 export declare function nativeIsRegistered<C extends Chain>(chain: C): boolean;
+/** Parse an address into its NativeAddress representation */
 export declare function toNative<C extends Chain>(chain: C, ua: UniversalAddress | string | Uint8Array): NativeAddress<C>;
 export declare function toUniversal<C extends Chain>(chain: C, address: string | Uint8Array): UniversalAddress;
 export {};

package/dist/cjs/address.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"address.d.ts","sourceRoot":"","sources":["../../src/address.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,EACL,eAAe,EACf,QAAQ,EAGT,MAAM,+BAA+B,CAAC;AAUvC,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAEtD,MAAM,WAAW,OAAO;IAMtB,MAAM,IAAI,OAAO,CAAC;IAClB,QAAQ,IAAI,MAAM,CAAC;IACnB,YAAY,IAAI,UAAU,CAAC;IAC3B,kBAAkB,IAAI,gBAAgB,CAAC;CAOxC;AAED,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,iBAAiB,CAAC;QAC1B,UAAiB,8BAA8B;SAAG;KACnD;CACF;AAED,MAAM,MAAM,eAAe,GAAG,MAAM,iBAAiB,CAAC,8BAA8B,CAAC;AAErF,KAAK,gBAAgB,CAAC,CAAC,SAAS,QAAQ,IAAI,CAAC,SAAS,eAAe,GACjE,iBAAiB,CAAC,8BAA8B,CAAC,CAAC,CAAC,GACnD,KAAK,CAAC;AAEV,MAAM,MAAM,aAAa,CAAC,CAAC,SAAS,KAAK,IAAI,gBAAgB,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC;AAElF,MAAM,MAAM,iBAAiB,CAAC,CAAC,SAAS,KAAK,IAAI,gBAAgB,GAAG,aAAa,CAAC,CAAC,CAAC,CAAC;AAErF,MAAM,MAAM,cAAc,CAAC,CAAC,SAAS,KAAK,IAAI,iBAAiB,CAAC,CAAC,CAAC,CAAC;AAEnE,MAAM,MAAM,YAAY,CAAC,CAAC,SAAS,KAAK,GAAG,KAAK,IAAI;IAClD,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC;IAClB,QAAQ,CAAC,OAAO,EAAE,iBAAiB,CAAC,CAAC,CAAC,CAAC;CACxC,CAAC;AAEF,KAAK,gBAAgB,GAAG,KAAK,EAAE,EAAE,gBAAgB,GAAG,MAAM,GAAG,UAAU,KAAK,OAAO,CAAC;AAIpF,wBAAgB,cAAc,CAAC,CAAC,SAAS,QAAQ,EAAE,QAAQ,EAAE,CAAC,EAAE,GAAG,EAAE,gBAAgB,GAAG,IAAI,CAQ3F;AAED,wBAAgB,kBAAkB,CAAC,CAAC,SAAS,KAAK,EAAE,KAAK,EAAE,CAAC,GAAG,OAAO,CAGrE;AAED,wBAAgB,QAAQ,CAAC,CAAC,SAAS,KAAK,EACtC,KAAK,EAAE,CAAC,EACR,EAAE,EAAE,gBAAgB,GAAG,MAAM,GAAG,UAAU,GACzC,aAAa,CAAC,CAAC,CAAC,CAKlB;AAED,wBAAgB,WAAW,CAAC,CAAC,SAAS,KAAK,EACzC,KAAK,EAAE,CAAC,EACR,OAAO,EAAE,MAAM,GAAG,UAAU,GAC3B,gBAAgB,CAGlB"}
+{"version":3,"file":"address.d.ts","sourceRoot":"","sources":["../../src/address.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,EACL,eAAe,EACf,QAAQ,EAGT,MAAM,+BAA+B,CAAC;AAUvC,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAEtD;;;;GAIG;AACH,MAAM,WAAW,OAAO;IACtB;;;;;;OAMG;IACH,MAAM,IAAI,OAAO,CAAC;IAClB,wDAAwD;IACxD,QAAQ,IAAI,MAAM,CAAC;IACnB,uCAAuC;IACvC,YAAY,IAAI,UAAU,CAAC;IAC3B,gFAAgF;IAChF,kBAAkB,IAAI,gBAAgB,CAAC;CACxC;AAED,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,iBAAiB,CAAC;QAC1B,UAAiB,8BAA8B;SAAG;KACnD;CACF;AAED,MAAM,MAAM,eAAe,GAAG,MAAM,iBAAiB,CAAC,8BAA8B,CAAC;AAErF,wEAAwE;AACxE,KAAK,gBAAgB,CAAC,CAAC,SAAS,QAAQ,IAAI,CAAC,SAAS,eAAe,GACjE,iBAAiB,CAAC,8BAA8B,CAAC,CAAC,CAAC,GACnD,KAAK,CAAC;AAEV,oEAAoE;AACpE,MAAM,MAAM,aAAa,CAAC,CAAC,SAAS,KAAK,IAAI,gBAAgB,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC;AAElF,iDAAiD;AACjD,MAAM,MAAM,iBAAiB,CAAC,CAAC,SAAS,KAAK,IAAI,gBAAgB,GAAG,aAAa,CAAC,CAAC,CAAC,CAAC;AAErF,6CAA6C;AAC7C,MAAM,MAAM,cAAc,CAAC,CAAC,SAAS,KAAK,IAAI,iBAAiB,CAAC,CAAC,CAAC,CAAC;AAEnE;;;GAGG;AACH,MAAM,MAAM,YAAY,CAAC,CAAC,SAAS,KAAK,GAAG,KAAK,IAAI;IAClD,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC;IAClB,QAAQ,CAAC,OAAO,EAAE,iBAAiB,CAAC,CAAC,CAAC,CAAC;CACxC,CAAC;AAEF,KAAK,gBAAgB,GAAG,KAAK,EAAE,EAAE,gBAAgB,GAAG,MAAM,GAAG,UAAU,KAAK,OAAO,CAAC;AAIpF,wBAAgB,cAAc,CAAC,CAAC,SAAS,QAAQ,EAAE,QAAQ,EAAE,CAAC,EAAE,GAAG,EAAE,gBAAgB,GAAG,IAAI,CAG3F;AAED,wBAAgB,kBAAkB,CAAC,CAAC,SAAS,KAAK,EAAE,KAAK,EAAE,CAAC,GAAG,OAAO,CAGrE;AAED,6DAA6D;AAC7D,wBAAgB,QAAQ,CAAC,CAAC,SAAS,KAAK,EACtC,KAAK,EAAE,CAAC,EACR,EAAE,EAAE,gBAAgB,GAAG,MAAM,GAAG,UAAU,GACzC,aAAa,CAAC,CAAC,CAAC,CAKlB;AAED,wBAAgB,WAAW,CAAC,CAAC,SAAS,KAAK,EACzC,KAAK,EAAE,CAAC,EACR,OAAO,EAAE,MAAM,GAAG,UAAU,GAC3B,gBAAgB,CAGlB"}

package/dist/cjs/address.js

@@ -13,11 +13,8 @@ const sdk_base_1 = require("@wormhole-foundation/sdk-base");
 const universalAddress_1 = require("./universalAddress");
 const nativeFactory = new Map();
 function registerNative(platform, ctr) {
-    if (nativeFactory.has(platform)) {
-        console.warn("Native address type for platform %s has already registered", platform);
-        //throw new Error(`Native address type for platform ${platform} has already registered`);
-        return;
-    }
+    if (nativeFactory.has(platform))
+        return; //throw new Error(`Native address type for platform ${platform} has already registered`);
     nativeFactory.set(platform, ctr);
 }
 exports.registerNative = registerNative;
@@ -26,6 +23,7 @@ function nativeIsRegistered(chain) {
     return nativeFactory.has(platform);
 }
 exports.nativeIsRegistered = nativeIsRegistered;
+/** Parse an address into its NativeAddress representation */
 function toNative(chain, ua) {
     const platform = sdk_base_1.chainToPlatform.get(chain);
     const nativeCtr = nativeFactory.get(platform);

package/dist/cjs/address.js.map

@@ -1 +1 @@
-{"version":3,"file":"address.js","sourceRoot":"","sources":["../../src/address.ts"],"names":[],"mappings":";;;AAAA,4DAMuC;AAEvC,+BAA+B;AAC/B,8FAA8F;AAC9F,gDAAgD;AAChD,iGAAiG;AACjG,iGAAiG;AACjG,8FAA8F;AAC9F,6FAA6F;AAC7F,oDAAoD;AACpD,yDAAsD;AA6CtD,MAAM,aAAa,GAAG,IAAI,GAAG,EAA8B,CAAC;AAE5D,SAAgB,cAAc,CAAqB,QAAW,EAAE,GAAqB;IACnF,IAAI,aAAa,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE;QAC/B,OAAO,CAAC,IAAI,CAAC,4DAA4D,EAAE,QAAQ,CAAC,CAAC;QACrF,yFAAyF;QACzF,OAAO;KACR;IAED,aAAa,CAAC,GAAG,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;AACnC,CAAC;AARD,wCAQC;AAED,SAAgB,kBAAkB,CAAkB,KAAQ;IAC1D,MAAM,QAAQ,GAAa,0BAAe,CAAC,GAAG,CAAC,KAAK,CAAE,CAAC;IACvD,OAAO,aAAa,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;AACrC,CAAC;AAHD,gDAGC;AAED,SAAgB,QAAQ,CACtB,KAAQ,EACR,EAA0C;IAE1C,MAAM,QAAQ,GAAa,0BAAe,CAAC,GAAG,CAAC,KAAK,CAAE,CAAC;IACvD,MAAM,SAAS,GAAG,aAAa,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAC9C,IAAI,CAAC,SAAS;QAAE,MAAM,IAAI,KAAK,CAAC,kDAAkD,QAAQ,EAAE,CAAC,CAAC;IAC9F,OAAO,IAAI,SAAS,CAAC,EAAE,CAAgC,CAAC;AAC1D,CAAC;AARD,4BAQC;AAED,SAAgB,WAAW,CACzB,KAAQ,EACR,OAA4B;IAE5B,MAAM,QAAQ,GAAa,0BAAe,CAAC,GAAG,CAAC,KAAK,CAAE,CAAC;IACvD,OAAO,IAAI,mCAAgB,CAAC,OAAO,EAAE,kCAAuB,CAAC,GAAG,CAAC,QAAQ,CAAE,CAAC,CAAC;AAC/E,CAAC;AAND,kCAMC"}
+{"version":3,"file":"address.js","sourceRoot":"","sources":["../../src/address.ts"],"names":[],"mappings":";;;AAAA,4DAMuC;AAEvC,+BAA+B;AAC/B,8FAA8F;AAC9F,gDAAgD;AAChD,iGAAiG;AACjG,iGAAiG;AACjG,8FAA8F;AAC9F,6FAA6F;AAC7F,oDAAoD;AACpD,yDAAsD;AAyDtD,MAAM,aAAa,GAAG,IAAI,GAAG,EAA8B,CAAC;AAE5D,SAAgB,cAAc,CAAqB,QAAW,EAAE,GAAqB;IACnF,IAAI,aAAa,CAAC,GAAG,CAAC,QAAQ,CAAC;QAAE,OAAO,CAAC,yFAAyF;IAClI,aAAa,CAAC,GAAG,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;AACnC,CAAC;AAHD,wCAGC;AAED,SAAgB,kBAAkB,CAAkB,KAAQ;IAC1D,MAAM,QAAQ,GAAa,0BAAe,CAAC,GAAG,CAAC,KAAK,CAAE,CAAC;IACvD,OAAO,aAAa,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;AACrC,CAAC;AAHD,gDAGC;AAED,6DAA6D;AAC7D,SAAgB,QAAQ,CACtB,KAAQ,EACR,EAA0C;IAE1C,MAAM,QAAQ,GAAa,0BAAe,CAAC,GAAG,CAAC,KAAK,CAAE,CAAC;IACvD,MAAM,SAAS,GAAG,aAAa,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAC9C,IAAI,CAAC,SAAS;QAAE,MAAM,IAAI,KAAK,CAAC,kDAAkD,QAAQ,EAAE,CAAC,CAAC;IAC9F,OAAO,IAAI,SAAS,CAAC,EAAE,CAAgC,CAAC;AAC1D,CAAC;AARD,4BAQC;AAED,SAAgB,WAAW,CACzB,KAAQ,EACR,OAA4B;IAE5B,MAAM,QAAQ,GAAa,0BAAe,CAAC,GAAG,CAAC,KAAK,CAAE,CAAC;IACvD,OAAO,IAAI,mCAAgB,CAAC,OAAO,EAAE,kCAAuB,CAAC,GAAG,CAAC,QAAQ,CAAE,CAAC,CAAC;AAC/E,CAAC;AAND,kCAMC"}

package/dist/cjs/attestation.d.ts

@@ -7,8 +7,17 @@ import { AutomaticTokenBridge, TokenBridge } from "./protocols/tokenBridge";
 import { SequenceId } from "./types";
 import { UniversalAddress } from "./universalAddress";
 import { VAA } from "./vaa";
+/**
+ * The Identifier of an attestation, useful to look up the full attestation
+ */
 export type AttestationId<PN extends ProtocolName = ProtocolName> = PN extends "TokenBridge" | "AutomaticTokenBridge" | "WormholeCore" | "PorticoBridge" | "AutomaticCircleBridge" ? WormholeMessageId : PN extends "AutomaticCircleBridge" ? WormholeMessageId | CircleMessageId : PN extends "CircleBridge" ? CircleMessageId : PN extends "IbcBridge" ? IbcMessageId : never;
+/**
+ * The full attestation that represents evidence of a transaction
+ */
 export type Attestation<PN extends ProtocolName = ProtocolName> = PN extends "TokenBridge" | "AutomaticTokenBridge" ? AutomaticTokenBridge.VAA | TokenBridge.VAA : PN extends "AutomaticCircleBridge" ? AutomaticCircleBridge.VAA | CircleBridge.Attestation : PN extends "CircleBridge" ? CircleBridge.Attestation : PN extends "IbcBridge" ? IbcTransferData : PN extends "WormholeCore" ? VAA<"Uint8Array"> : PN extends "PorticoBridge" ? PorticoBridge.VAA : never;
+/**
+ * Wormhole Message Identifier used to fetch a VAA
+ */
 export type WormholeMessageId = {
     chain: Chain;
     emitter: UniversalAddress;
@@ -16,12 +25,21 @@ export type WormholeMessageId = {
 };
 export declare function isWormholeMessageId(thing: WormholeMessageId | any): thing is WormholeMessageId;
 export type getWormholeAttestation = (id: WormholeMessageId) => Promise<VAA>;
+/**
+ * Circle Message Identifier
+ * Used to fetch a Circle attestation
+ */
 export type CircleMessageId = {
     hash: string;
 };
 export declare function isCircleMessageId(thing: CircleMessageId | any): thing is CircleMessageId;
+/** Attestation from circle attestation api */
 export type CircleAttestation = string;
 export type getCircleAttestation = (id: CircleMessageId) => Promise<CircleAttestation>;
+/**
+ * Ibc Message Identifier
+ * Used to fetch a Ibc attestation
+ */
 export type IbcMessageId = {
     chain: Chain;
     srcPort: string;

package/dist/cjs/attestation.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"attestation.d.ts","sourceRoot":"","sources":["../../src/attestation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,+BAA+B,CAAC;AACtD,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAC1C,OAAO,EAAE,qBAAqB,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AAC/E,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAClD,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,oBAAoB,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAC5E,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AACrC,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,GAAG,EAAE,MAAM,OAAO,CAAC;AAG5B,MAAM,MAAM,aAAa,CAAC,EAAE,SAAS,YAAY,GAAG,YAAY,IAAI,EAAE,SAClE,aAAa,GACb,sBAAsB,GACtB,cAAc,GACd,eAAe,GACf,uBAAuB,GACvB,iBAAiB,GACjB,EAAE,SAAS,uBAAuB,GAClC,iBAAiB,GAAG,eAAe,GACnC,EAAE,SAAS,cAAc,GACzB,eAAe,GACf,EAAE,SAAS,WAAW,GACtB,YAAY,GACZ,KAAK,CAAC;AAEV,MAAM,MAAM,WAAW,CAAC,EAAE,SAAS,YAAY,GAAG,YAAY,IAAI,EAAE,SAChE,aAAa,GACb,sBAAsB,GACtB,oBAAoB,CAAC,GAAG,GAAG,WAAW,CAAC,GAAG,GAC1C,EAAE,SAAS,uBAAuB,GAClC,qBAAqB,CAAC,GAAG,GAAG,YAAY,CAAC,WAAW,GACpD,EAAE,SAAS,cAAc,GACzB,YAAY,CAAC,WAAW,GACxB,EAAE,SAAS,WAAW,GACtB,eAAe,GACf,EAAE,SAAS,cAAc,GACzB,GAAG,CAAC,YAAY,CAAC,GACjB,EAAE,SAAS,eAAe,GAC1B,aAAa,CAAC,GAAG,GACjB,KAAK,CAAC;AAIV,MAAM,MAAM,iBAAiB,GAAG;IAC9B,KAAK,EAAE,KAAK,CAAC;IACb,OAAO,EAAE,gBAAgB,CAAC;IAC1B,QAAQ,EAAE,UAAU,CAAC;CACtB,CAAC;AACF,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,iBAAiB,GAAG,GAAG,GAAG,KAAK,IAAI,iBAAiB,CAM9F;AAED,MAAM,MAAM,sBAAsB,GAAG,CAAC,EAAE,EAAE,iBAAiB,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC;AAI7E,MAAM,MAAM,eAAe,GAAG;IAC5B,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AACF,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,eAAe,GAAG,GAAG,GAAG,KAAK,IAAI,eAAe,CAExF;AAGD,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC;AAEvC,MAAM,MAAM,oBAAoB,GAAG,CAAC,EAAE,EAAE,eAAe,KAAK,OAAO,CAAC,iBAAiB,CAAC,CAAC;AAIvF,MAAM,MAAM,YAAY,GAAG;IACzB,KAAK,EAAE,KAAK,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AACF,wBAAgB,cAAc,CAAC,KAAK,EAAE,YAAY,GAAG,GAAG,GAAG,KAAK,IAAI,YAAY,CAS/E"}
+{"version":3,"file":"attestation.d.ts","sourceRoot":"","sources":["../../src/attestation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,+BAA+B,CAAC;AACtD,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAC1C,OAAO,EAAE,qBAAqB,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AAC/E,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAClD,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,oBAAoB,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAC5E,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AACrC,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,GAAG,EAAE,MAAM,OAAO,CAAC;AAE5B;;GAEG;AACH,MAAM,MAAM,aAAa,CAAC,EAAE,SAAS,YAAY,GAAG,YAAY,IAAI,EAAE,SAClE,aAAa,GACb,sBAAsB,GACtB,cAAc,GACd,eAAe,GACf,uBAAuB,GACvB,iBAAiB,GACjB,EAAE,SAAS,uBAAuB,GAClC,iBAAiB,GAAG,eAAe,GACnC,EAAE,SAAS,cAAc,GACzB,eAAe,GACf,EAAE,SAAS,WAAW,GACtB,YAAY,GACZ,KAAK,CAAC;AAEV;;GAEG;AACH,MAAM,MAAM,WAAW,CAAC,EAAE,SAAS,YAAY,GAAG,YAAY,IAAI,EAAE,SAChE,aAAa,GACb,sBAAsB,GACtB,oBAAoB,CAAC,GAAG,GAAG,WAAW,CAAC,GAAG,GAC1C,EAAE,SAAS,uBAAuB,GAClC,qBAAqB,CAAC,GAAG,GAAG,YAAY,CAAC,WAAW,GACpD,EAAE,SAAS,cAAc,GACzB,YAAY,CAAC,WAAW,GACxB,EAAE,SAAS,WAAW,GACtB,eAAe,GACf,EAAE,SAAS,cAAc,GACzB,GAAG,CAAC,YAAY,CAAC,GACjB,EAAE,SAAS,eAAe,GAC1B,aAAa,CAAC,GAAG,GACjB,KAAK,CAAC;AAEV;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,KAAK,EAAE,KAAK,CAAC;IACb,OAAO,EAAE,gBAAgB,CAAC;IAC1B,QAAQ,EAAE,UAAU,CAAC;CACtB,CAAC;AACF,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,iBAAiB,GAAG,GAAG,GAAG,KAAK,IAAI,iBAAiB,CAM9F;AAED,MAAM,MAAM,sBAAsB,GAAG,CAAC,EAAE,EAAE,iBAAiB,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC;AAE7E;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AACF,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,eAAe,GAAG,GAAG,GAAG,KAAK,IAAI,eAAe,CAExF;AAED,8CAA8C;AAC9C,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC;AAEvC,MAAM,MAAM,oBAAoB,GAAG,CAAC,EAAE,EAAE,eAAe,KAAK,OAAO,CAAC,iBAAiB,CAAC,CAAC;AAEvF;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,KAAK,EAAE,KAAK,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AACF,wBAAgB,cAAc,CAAC,KAAK,EAAE,YAAY,GAAG,GAAG,GAAG,KAAK,IAAI,YAAY,CAS/E"}

package/dist/cjs/attestation.js.map

@@ -1 +1 @@
-{"version":3,"file":"attestation.js","sourceRoot":"","sources":["../../src/attestation.ts"],"names":[],"mappings":";;;AAiDA,SAAgB,mBAAmB,CAAC,KAA8B;IAChE,OAAO,CACe,KAAM,CAAC,QAAQ,KAAK,SAAS;QAC7B,KAAM,CAAC,OAAO,KAAK,SAAS;QAC5B,KAAM,CAAC,KAAK,KAAK,SAAS,CAC/C,CAAC;AACJ,CAAC;AAND,kDAMC;AASD,SAAgB,iBAAiB,CAAC,KAA4B;IAC5D,OAAyB,KAAM,CAAC,IAAI,KAAK,SAAS,CAAC;AACrD,CAAC;AAFD,8CAEC;AAiBD,SAAgB,cAAc,CAAC,KAAyB;IACtD,OAAO,CACU,KAAM,CAAC,UAAU,KAAK,SAAS;QAC/B,KAAM,CAAC,UAAU,KAAK,SAAS;QAC/B,KAAM,CAAC,KAAK,KAAK,SAAS;QAC1B,KAAM,CAAC,OAAO,KAAK,SAAS;QAC5B,KAAM,CAAC,OAAO,KAAK,SAAS;QAC5B,KAAM,CAAC,QAAQ,KAAK,SAAS,CAC7C,CAAC;AACJ,CAAC;AATD,wCASC"}
+{"version":3,"file":"attestation.js","sourceRoot":"","sources":["../../src/attestation.ts"],"names":[],"mappings":";;;AAuDA,SAAgB,mBAAmB,CAAC,KAA8B;IAChE,OAAO,CACe,KAAM,CAAC,QAAQ,KAAK,SAAS;QAC7B,KAAM,CAAC,OAAO,KAAK,SAAS;QAC5B,KAAM,CAAC,KAAK,KAAK,SAAS,CAC/C,CAAC;AACJ,CAAC;AAND,kDAMC;AAWD,SAAgB,iBAAiB,CAAC,KAA4B;IAC5D,OAAyB,KAAM,CAAC,IAAI,KAAK,SAAS,CAAC;AACrD,CAAC;AAFD,8CAEC;AAmBD,SAAgB,cAAc,CAAC,KAAyB;IACtD,OAAO,CACU,KAAM,CAAC,UAAU,KAAK,SAAS;QAC/B,KAAM,CAAC,UAAU,KAAK,SAAS;QAC/B,KAAM,CAAC,KAAK,KAAK,SAAS;QAC1B,KAAM,CAAC,OAAO,KAAK,SAAS;QAC5B,KAAM,CAAC,OAAO,KAAK,SAAS;QAC5B,KAAM,CAAC,QAAQ,KAAK,SAAS,CAC7C,CAAC;AACJ,CAAC;AATD,wCASC"}

package/dist/cjs/chain.d.ts

@@ -1,4 +1,5 @@
-import { Chain, Network, Platform, PlatformToChains, tokens } from "@wormhole-foundation/sdk-base";
+import { Chain, Network, Platform, tokens } from "@wormhole-foundation/sdk-base";
+import { ChainToPlatform } from "@wormhole-foundation/sdk-base/src";
 import { ChainAddress, UniversalOrNative } from "./address";
 import { WormholeMessageId } from "./attestation";
 import { PlatformContext } from "./platform";
@@ -6,48 +7,180 @@ import { ProtocolName } from "./protocol";
 import { AutomaticCircleBridge, CircleBridge } from "./protocols/circleBridge";
 import { WormholeCore } from "./protocols/core";
 import { IbcBridge } from "./protocols/ibc";
+import { PorticoBridge } from "./protocols/portico";
 import { AutomaticTokenBridge, TokenBridge } from "./protocols/tokenBridge";
 import { RpcConnection } from "./rpc";
-import { ChainConfig, SignedTx, TokenId, TokenAddress } from "./types";
-import { PorticoBridge } from "./protocols/portico";
-export declare abstract class ChainContext<N extends Network, P extends Platform = Platform, C extends Chain = PlatformToChains<P>> {
+import { ChainConfig, SignedTx, TokenAddress, TokenId } from "./types";
+/**
+ * A ChainContext provides a consistent interface for interacting with a chain.
+ * It holds the configuration for the chain and cached RPC and protocol clients.
+ *
+ */
+export declare abstract class ChainContext<N extends Network, C extends Chain = Chain, P extends Platform = ChainToPlatform<C>> {
     readonly network: N;
-    readonly platform: PlatformContext<N, P>;
     readonly chain: C;
     readonly config: ChainConfig<N, C>;
+    readonly platform: PlatformContext<N, P>;
     protected rpc?: RpcConnection<P>;
-    protected coreBridge?: WormholeCore<N, P, C>;
-    protected tokenBridge?: TokenBridge<N, P, C>;
-    protected autoTokenBridge?: AutomaticTokenBridge<N, P, C>;
-    protected circleBridge?: CircleBridge<N, P, C>;
-    protected autoCircleBridge?: AutomaticCircleBridge<N, P, C>;
-    protected ibcBridge?: IbcBridge<N, P, C>;
-    protected porticoBridge?: PorticoBridge<N, P, C>;
+    protected coreBridge?: WormholeCore<N, C>;
+    protected tokenBridge?: TokenBridge<N, C>;
+    protected autoTokenBridge?: AutomaticTokenBridge<N, C>;
+    protected circleBridge?: CircleBridge<N, C>;
+    protected autoCircleBridge?: AutomaticCircleBridge<N, C>;
+    protected ibcBridge?: IbcBridge<N, C>;
+    protected porticoBridge?: PorticoBridge<N, C>;
     constructor(chain: C, platform: PlatformContext<N, P>, rpc?: RpcConnection<P>);
+    /**
+     * Get an RPC connection for this chain, uses the configuration passed in
+     * the initial constructor
+     *
+     * @returns the RPC connection for this chain
+     */
     getRpc(): Promise<RpcConnection<P>>;
-    getDecimals(token: TokenAddress<C>): Promise<bigint>;
+    /**
+     *  Get the number of decimals for a token
+     *
+     *  @param token the token to get the decimals for
+     *  @returns the number of decimals for the token
+     */
+    getDecimals(token: TokenAddress<C>): Promise<number>;
+    /**
+     * Get the balance of a token for a given address
+     *
+     * @param walletAddr the address to get the balance for
+     * @param token the token to get the balance for
+     * @returns the balance of the token for the address
+     *
+     */
     getBalance(walletAddr: string, token: TokenAddress<C>): Promise<bigint | null>;
+    /**
+     * Get the latest block number seen by the chain according to the RPC
+     *
+     * @returns the latest block number
+     */
     getLatestBlock(): Promise<number>;
+    /**
+     * Get the latest _finalized_ block number seen by the chain according to the RPC
+     *
+     * @returns the latest finalized block number
+     */
     getLatestFinalizedBlock(): Promise<number>;
+    /**
+     * Parse the Wormhole Core messages from a transaction
+     *
+     * @param txid the transaction to parse
+     * @returns the Wormhole Core messages emitted by the transaction
+     */
     parseTransaction(txid: string): Promise<WormholeMessageId[]>;
-    sendWait(stxns: SignedTx): Promise<string[]>;
+    /**
+     *  Send a transaction and wait for it to be confirmed
+     *
+     * @param stxns the signed transaction to send
+     * @returns the transaction hashes of the sent transactions
+     */
+    sendWait(stxns: SignedTx[]): Promise<string[]>;
+    /**
+     * Get the token data from the local cache if available
+     * @param symbol the symbol of the token to get
+     * @returns the token data if available
+     */
     getToken(symbol: tokens.TokenSymbol): tokens.Token | undefined;
+    /**
+     * Get the token id of the wrapped token for the native gas token
+     *
+     * @returns the wrapped token for the native gas token
+     */
     getNativeWrappedTokenId(): Promise<TokenId<C>>;
+    /**
+     * Get the token account for a given address and token
+     *
+     * @remarks
+     * This is really only useful in the context of Solana but in order
+     * to provide a consistent interface, we provide it here.
+     *
+     * @param address the address to get the token account for
+     * @param token the token to get the token account for
+     * @returns the token account for the address and token
+     */
     getTokenAccount(address: UniversalOrNative<C>, token: TokenAddress<C>): Promise<ChainAddress<C>>;
+    /**
+     * Check to see if a given protocol is supported by this chain
+     * by checking if it is registered in the platform and the configuration
+     * is available and correct
+     *
+     * @param protocolName the name of the Protocol to check for support
+     * @returns a boolean indicating if this protocol is supported
+     */
     supportsProtocol(protocolName: ProtocolName): boolean;
+    /**
+     * Check to see if the Wormhole Core protocol is supported by this chain
+     * @returns a boolean indicating if this chain supports the Wormhole Core protocol
+     */
     supportsWormholeCore: () => boolean;
-    getWormholeCore(): Promise<WormholeCore<N, P, C>>;
+    /**
+     * Get the Wormhole Core protocol client for this chain
+     * @returns the Wormhole Core protocol client for this chain
+     */
+    getWormholeCore(): Promise<WormholeCore<N, C>>;
+    /**
+     * Check to see if the Token Bridge protocol is supported by this chain
+     * @returns a boolean indicating if this chain supports the Token Bridge protocol
+     */
     supportsTokenBridge: () => boolean;
-    getTokenBridge(): Promise<TokenBridge<N, P, C>>;
+    /**
+     * Get the Token Bridge protocol client for this chain
+     * @returns the Token Bridge protocol client for this chain
+     */
+    getTokenBridge(): Promise<TokenBridge<N, C>>;
+    /**
+     * Check to see if the Automatic Token Bridge protocol is supported by this chain
+     * @returns  a boolean indicating if this chain supports the Automatic Token Bridge protocol
+     */
     supportsAutomaticTokenBridge: () => boolean;
-    getAutomaticTokenBridge(): Promise<AutomaticTokenBridge<N, P, C>>;
+    /**
+     * Get the Automatic Token Bridge protocol client for this chain
+     * @returns the Automatic Token Bridge protocol client for this chain
+     */
+    getAutomaticTokenBridge(): Promise<AutomaticTokenBridge<N, C>>;
+    /**
+     * Check to see if the Circle Bridge protocol is supported by this chain
+     * @returns a boolean indicating if this chain supports the Circle Bridge protocol
+     */
     supportsCircleBridge: () => boolean;
-    getCircleBridge(): Promise<CircleBridge<N, P, C>>;
+    /**
+     * Get the Circle Bridge protocol client for this chain
+     * @returns the Circle Bridge protocol client for this chain
+     */
+    getCircleBridge(): Promise<CircleBridge<N, C>>;
+    /**
+     * Check to see if the Automatic Circle Bridge protocol is supported by this chain
+     * @returns a boolean indicating if this chain supports the Automatic Circle Bridge protocol
+     */
     supportsAutomaticCircleBridge: () => boolean;
-    getAutomaticCircleBridge(): Promise<AutomaticCircleBridge<N, P, C>>;
+    /**
+     * Get the Automatic Circle Bridge protocol client for this chain
+     * @returns the Automatic Circle Bridge protocol client for this chain
+     */
+    getAutomaticCircleBridge(): Promise<AutomaticCircleBridge<N, C>>;
+    /**
+     * Check to see if the IBC Bridge protocol is supported by this chain
+     * @returns a boolean indicating if this chain supports the IBC Bridge protocol
+     */
     supportsIbcBridge: () => boolean;
-    getIbcBridge(): Promise<IbcBridge<N, P, C>>;
+    /**
+     * Get the IBC Bridge protocol client for this chain
+     * @returns the IBC Bridge protocol client for this chain
+     */
+    getIbcBridge(): Promise<IbcBridge<N, C>>;
+    /**
+     * Check to see if the Portico Bridge protocol is supported by this chain
+     * @returns a boolean indicating if this chain supports the Portico Bridge protocol
+     */
     supportsPorticoBridge: () => boolean;
-    getPorticoBridge(): Promise<PorticoBridge<N, P, C>>;
+    /**
+     * Get the Portico Bridge protocol client for this chain
+     * @returns the Portico Bridge protocol client for this chain
+     */
+    getPorticoBridge(): Promise<PorticoBridge<N, C>>;
 }
 //# sourceMappingURL=chain.d.ts.map

package/dist/cjs/chain.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"chain.d.ts","sourceRoot":"","sources":["../../src/chain.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,gBAAgB,EAAE,MAAM,EAAE,MAAM,+BAA+B,CAAC;AACnG,OAAO,EAAE,YAAY,EAAE,iBAAiB,EAAY,MAAM,WAAW,CAAC;AACtE,OAAO,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AAClD,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAC7C,OAAO,EAAE,YAAY,EAAwB,MAAM,YAAY,CAAC;AAChE,OAAO,EAAE,qBAAqB,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AAC/E,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAChD,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,EAAE,oBAAoB,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAC5E,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AACtC,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvE,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEpD,8BAAsB,YAAY,CAChC,CAAC,SAAS,OAAO,EACjB,CAAC,SAAS,QAAQ,GAAG,QAAQ,EAC7B,CAAC,SAAS,KAAK,GAAG,gBAAgB,CAAC,CAAC,CAAC;IAErC,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAC;IAEpB,QAAQ,CAAC,QAAQ,EAAE,eAAe,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAEzC,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC;IAClB,QAAQ,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAGnC,SAAS,CAAC,GAAG,CAAC,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC;IACjC,SAAS,CAAC,UAAU,CAAC,EAAE,YAAY,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IAC7C,SAAS,CAAC,WAAW,CAAC,EAAE,WAAW,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IAC7C,SAAS,CAAC,eAAe,CAAC,EAAE,oBAAoB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IAC1D,SAAS,CAAC,YAAY,CAAC,EAAE,YAAY,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IAC/C,SAAS,CAAC,gBAAgB,CAAC,EAAE,qBAAqB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IAC5D,SAAS,CAAC,SAAS,CAAC,EAAE,SAAS,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IACzC,SAAS,CAAC,aAAa,CAAC,EAAE,aAAa,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;gBAErC,KAAK,EAAE,CAAC,EAAE,QAAQ,EAAE,eAAe,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,aAAa,CAAC,CAAC,CAAC;IAQ7E,MAAM,IAAI,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;IAM7B,WAAW,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;IAWpD,UAAU,CAAC,UAAU,EAAE,MAAM,EAAE,KAAK,EAAE,YAAY,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAI9E,cAAc,IAAI,OAAO,CAAC,MAAM,CAAC;IAIjC,uBAAuB,IAAI,OAAO,CAAC,MAAM,CAAC;IAK1C,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC;IAK5D,QAAQ,CAAC,KAAK,EAAE,QAAQ,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAIlD,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,WAAW,GAAG,MAAM,CAAC,KAAK,GAAG,SAAS;IAMxD,uBAAuB,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;IAa9C,eAAe,CACnB,OAAO,EAAE,iBAAiB,CAAC,CAAC,CAAC,EAC7B,KAAK,EAAE,YAAY,CAAC,CAAC,CAAC,GACrB,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IAS3B,gBAAgB,CAAC,YAAY,EAAE,YAAY,GAAG,OAAO;IAIrD,oBAAoB,gBAA+C;IAC7D,eAAe,IAAI,OAAO,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IAOvD,mBAAmB,gBAA8C;IAC3D,cAAc,IAAI,OAAO,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IAQrD,4BAA4B,gBAAuD;IAC7E,uBAAuB,IAAI,OAAO,CAAC,oBAAoB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IAQvE,oBAAoB,gBAA+C;IAC7D,eAAe,IAAI,OAAO,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IAQvD,6BAA6B,gBAAwD;IAC/E,wBAAwB,IAAI,OAAO,CAAC,qBAAqB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IAQzE,iBAAiB,gBAA4C;IACvD,YAAY,IAAI,OAAO,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IAQjD,qBAAqB,gBAAgD;IAC/D,gBAAgB,IAAI,OAAO,CAAC,aAAa,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;CAM1D"}
+{"version":3,"file":"chain.d.ts","sourceRoot":"","sources":["../../src/chain.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,+BAA+B,CAAC;AACjF,OAAO,EAAE,eAAe,EAAE,MAAM,mCAAmC,CAAC;AACpE,OAAO,EAAE,YAAY,EAAE,iBAAiB,EAAY,MAAM,WAAW,CAAC;AACtE,OAAO,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AAClD,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAC7C,OAAO,EAAE,YAAY,EAAwB,MAAM,YAAY,CAAC;AAChE,OAAO,EAAE,qBAAqB,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AAC/E,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAChD,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,oBAAoB,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAC5E,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AACtC,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAEvE;;;;GAIG;AACH,8BAAsB,YAAY,CAChC,CAAC,SAAS,OAAO,EACjB,CAAC,SAAS,KAAK,GAAG,KAAK,EACvB,CAAC,SAAS,QAAQ,GAAG,eAAe,CAAC,CAAC,CAAC;IAEvC,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAC;IACpB,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC;IAClB,QAAQ,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IACnC,QAAQ,CAAC,QAAQ,EAAE,eAAe,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAGzC,SAAS,CAAC,GAAG,CAAC,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC;IACjC,SAAS,CAAC,UAAU,CAAC,EAAE,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAC1C,SAAS,CAAC,WAAW,CAAC,EAAE,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAC1C,SAAS,CAAC,eAAe,CAAC,EAAE,oBAAoB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IACvD,SAAS,CAAC,YAAY,CAAC,EAAE,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAC5C,SAAS,CAAC,gBAAgB,CAAC,EAAE,qBAAqB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IACzD,SAAS,CAAC,SAAS,CAAC,EAAE,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IACtC,SAAS,CAAC,aAAa,CAAC,EAAE,aAAa,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;gBAElC,KAAK,EAAE,CAAC,EAAE,QAAQ,EAAE,eAAe,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,aAAa,CAAC,CAAC,CAAC;IAQ7E;;;;;OAKG;IACH,MAAM,IAAI,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;IAKnC;;;;;OAKG;IACG,WAAW,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;IAU1D;;;;;;;OAOG;IACG,UAAU,CAAC,UAAU,EAAE,MAAM,EAAE,KAAK,EAAE,YAAY,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAIpF;;;;OAIG;IACG,cAAc,IAAI,OAAO,CAAC,MAAM,CAAC;IAIvC;;;;OAIG;IACG,uBAAuB,IAAI,OAAO,CAAC,MAAM,CAAC;IAIhD;;;;;OAKG;IACG,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC;IAIlE;;;;;OAKG;IACG,QAAQ,CAAC,KAAK,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAIpD;;;;OAIG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,WAAW,GAAG,MAAM,CAAC,KAAK,GAAG,SAAS;IAM9D;;;;OAIG;IAEG,uBAAuB,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;IAYpD;;;;;;;;;;OAUG;IACG,eAAe,CACnB,OAAO,EAAE,iBAAiB,CAAC,CAAC,CAAC,EAC7B,KAAK,EAAE,YAAY,CAAC,CAAC,CAAC,GACrB,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IAK3B;;;;;;;OAOG;IACH,gBAAgB,CAAC,YAAY,EAAE,YAAY,GAAG,OAAO;IAIrD;;;OAGG;IACH,oBAAoB,gBAA+C;IACnE;;;OAGG;IACG,eAAe,IAAI,OAAO,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAOpD;;;OAGG;IACH,mBAAmB,gBAA8C;IACjE;;;OAGG;IACG,cAAc,IAAI,OAAO,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAOlD;;;OAGG;IACH,4BAA4B,gBAAuD;IACnF;;;OAGG;IACG,uBAAuB,IAAI,OAAO,CAAC,oBAAoB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAOpE;;;OAGG;IACH,oBAAoB,gBAA+C;IACnE;;;OAGG;IACG,eAAe,IAAI,OAAO,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAOpD;;;OAGG;IACH,6BAA6B,gBAAwD;IACrF;;;OAGG;IACG,wBAAwB,IAAI,OAAO,CAAC,qBAAqB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAOtE;;;OAGG;IACH,iBAAiB,gBAA4C;IAC7D;;;OAGG;IACG,YAAY,IAAI,OAAO,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAO9C;;;OAGG;IACH,qBAAqB,gBAAgD;IACrE;;;OAGG;IACG,gBAAgB,IAAI,OAAO,CAAC,aAAa,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;CAMvD"}

package/dist/cjs/chain.js

@@ -4,11 +4,16 @@ exports.ChainContext = void 0;
 const sdk_base_1 = require("@wormhole-foundation/sdk-base");
 const address_1 = require("./address");
 const protocol_1 = require("./protocol");
+/**
+ * A ChainContext provides a consistent interface for interacting with a chain.
+ * It holds the configuration for the chain and cached RPC and protocol clients.
+ *
+ */
 class ChainContext {
     network;
-    platform;
     chain;
     config;
+    platform;
     // Cached Protocol clients
     rpc;
     coreBridge;
@@ -25,38 +30,81 @@ class ChainContext {
         this.network = this.config.network;
         this.rpc = rpc;
     }
+    /**
+     * Get an RPC connection for this chain, uses the configuration passed in
+     * the initial constructor
+     *
+     * @returns the RPC connection for this chain
+     */
     getRpc() {
         this.rpc = this.rpc ? this.rpc : this.platform.getRpc(this.chain);
         return this.rpc;
     }
-    // Get the number of decimals for a token
+    /**
+     *  Get the number of decimals for a token
+     *
+     *  @param token the token to get the decimals for
+     *  @returns the number of decimals for the token
+     */
     async getDecimals(token) {
         // try to find it in the token cache first
         if (this.config.tokenMap) {
             const found = sdk_base_1.tokens.getTokenByAddress(this.network, this.chain, token.toString());
             if (found)
-                return BigInt(found.decimals);
+                return found.decimals;
         }
-        return this.platform.utils().getDecimals(this.chain, this.getRpc(), token);
+        return this.platform.utils().getDecimals(this.chain, await this.getRpc(), token);
     }
-    // Get the balance of a token for a given address
+    /**
+     * Get the balance of a token for a given address
+     *
+     * @param walletAddr the address to get the balance for
+     * @param token the token to get the balance for
+     * @returns the balance of the token for the address
+     *
+     */
     async getBalance(walletAddr, token) {
         return this.platform.utils().getBalance(this.chain, await this.getRpc(), walletAddr, token);
     }
+    /**
+     * Get the latest block number seen by the chain according to the RPC
+     *
+     * @returns the latest block number
+     */
     async getLatestBlock() {
-        return this.platform.utils().getLatestBlock(this.getRpc());
+        return this.platform.utils().getLatestBlock(await this.getRpc());
     }
+    /**
+     * Get the latest _finalized_ block number seen by the chain according to the RPC
+     *
+     * @returns the latest finalized block number
+     */
     async getLatestFinalizedBlock() {
-        return this.platform.utils().getLatestFinalizedBlock(this.getRpc());
+        return this.platform.utils().getLatestFinalizedBlock(await this.getRpc());
     }
-    // Get details about the transaction
+    /**
+     * Parse the Wormhole Core messages from a transaction
+     *
+     * @param txid the transaction to parse
+     * @returns the Wormhole Core messages emitted by the transaction
+     */
     async parseTransaction(txid) {
         return this.platform.parseWormholeMessages(this.chain, await this.getRpc(), txid);
     }
-    // Send a transaction and wait for it to be confirmed
+    /**
+     *  Send a transaction and wait for it to be confirmed
+     *
+     * @param stxns the signed transaction to send
+     * @returns the transaction hashes of the sent transactions
+     */
     async sendWait(stxns) {
         return this.platform.utils().sendWait(this.chain, await this.getRpc(), stxns);
     }
+    /**
+     * Get the token data from the local cache if available
+     * @param symbol the symbol of the token to get
+     * @returns the token data if available
+     */
     getToken(symbol) {
         if (!this.config.tokenMap)
             return;
@@ -64,6 +112,11 @@ class ChainContext {
             return;
         return this.config.tokenMap[symbol];
     }
+    /**
+     * Get the token id of the wrapped token for the native gas token
+     *
+     * @returns the wrapped token for the native gas token
+     */
     async getNativeWrappedTokenId() {
         // see if we have it configured
         if (this.config.wrappedNative) {
@@ -74,66 +127,131 @@ class ChainContext {
         const tb = await this.getTokenBridge();
         return { chain: this.chain, address: await tb.getWrappedNative() };
     }
-    // Get the token account for a given address
+    /**
+     * Get the token account for a given address and token
+     *
+     * @remarks
+     * This is really only useful in the context of Solana but in order
+     * to provide a consistent interface, we provide it here.
+     *
+     * @param address the address to get the token account for
+     * @param token the token to get the token account for
+     * @returns the token account for the address and token
+     */
     async getTokenAccount(address, token) {
         // Noop by default, override in implementation if necessary
         return { chain: this.chain, address };
     }
-    //
-    // protocols
-    //
-    //
+    /**
+     * Check to see if a given protocol is supported by this chain
+     * by checking if it is registered in the platform and the configuration
+     * is available and correct
+     *
+     * @param protocolName the name of the Protocol to check for support
+     * @returns a boolean indicating if this protocol is supported
+     */
     supportsProtocol(protocolName) {
         return (0, protocol_1.protocolIsRegistered)(this.chain, protocolName);
     }
+    /**
+     * Check to see if the Wormhole Core protocol is supported by this chain
+     * @returns a boolean indicating if this chain supports the Wormhole Core protocol
+     */
     supportsWormholeCore = () => this.supportsProtocol("WormholeCore");
+    /**
+     * Get the Wormhole Core protocol client for this chain
+     * @returns the Wormhole Core protocol client for this chain
+     */
     async getWormholeCore() {
         this.coreBridge = this.coreBridge
             ? this.coreBridge
             : await this.platform.getProtocol("WormholeCore", await this.getRpc());
         return this.coreBridge;
     }
+    /**
+     * Check to see if the Token Bridge protocol is supported by this chain
+     * @returns a boolean indicating if this chain supports the Token Bridge protocol
+     */
     supportsTokenBridge = () => this.supportsProtocol("TokenBridge");
+    /**
+     * Get the Token Bridge protocol client for this chain
+     * @returns the Token Bridge protocol client for this chain
+     */
     async getTokenBridge() {
         this.tokenBridge = this.tokenBridge
             ? this.tokenBridge
             : await this.platform.getProtocol("TokenBridge", await this.getRpc());
         return this.tokenBridge;
     }
-    //
+    /**
+     * Check to see if the Automatic Token Bridge protocol is supported by this chain
+     * @returns  a boolean indicating if this chain supports the Automatic Token Bridge protocol
+     */
     supportsAutomaticTokenBridge = () => this.supportsProtocol("AutomaticTokenBridge");
+    /**
+     * Get the Automatic Token Bridge protocol client for this chain
+     * @returns the Automatic Token Bridge protocol client for this chain
+     */
     async getAutomaticTokenBridge() {
         this.autoTokenBridge = this.autoTokenBridge
             ? this.autoTokenBridge
             : await this.platform.getProtocol("AutomaticTokenBridge", await this.getRpc());
         return this.autoTokenBridge;
     }
-    //
+    /**
+     * Check to see if the Circle Bridge protocol is supported by this chain
+     * @returns a boolean indicating if this chain supports the Circle Bridge protocol
+     */
     supportsCircleBridge = () => this.supportsProtocol("CircleBridge");
+    /**
+     * Get the Circle Bridge protocol client for this chain
+     * @returns the Circle Bridge protocol client for this chain
+     */
     async getCircleBridge() {
         this.circleBridge = this.circleBridge
             ? this.circleBridge
             : await this.platform.getProtocol("CircleBridge", await this.getRpc());
         return this.circleBridge;
     }
-    //
+    /**
+     * Check to see if the Automatic Circle Bridge protocol is supported by this chain
+     * @returns a boolean indicating if this chain supports the Automatic Circle Bridge protocol
+     */
     supportsAutomaticCircleBridge = () => this.supportsProtocol("AutomaticCircleBridge");
+    /**
+     * Get the Automatic Circle Bridge protocol client for this chain
+     * @returns the Automatic Circle Bridge protocol client for this chain
+     */
     async getAutomaticCircleBridge() {
         this.autoCircleBridge = this.autoCircleBridge
             ? this.autoCircleBridge
             : await this.platform.getProtocol("AutomaticCircleBridge", await this.getRpc());
         return this.autoCircleBridge;
     }
-    //
+    /**
+     * Check to see if the IBC Bridge protocol is supported by this chain
+     * @returns a boolean indicating if this chain supports the IBC Bridge protocol
+     */
     supportsIbcBridge = () => this.supportsProtocol("IbcBridge");
+    /**
+     * Get the IBC Bridge protocol client for this chain
+     * @returns the IBC Bridge protocol client for this chain
+     */
     async getIbcBridge() {
         this.ibcBridge = this.ibcBridge
             ? this.ibcBridge
             : await this.platform.getProtocol("IbcBridge", await this.getRpc());
         return this.ibcBridge;
     }
-    //
+    /**
+     * Check to see if the Portico Bridge protocol is supported by this chain
+     * @returns a boolean indicating if this chain supports the Portico Bridge protocol
+     */
     supportsPorticoBridge = () => this.supportsProtocol("PorticoBridge");
+    /**
+     * Get the Portico Bridge protocol client for this chain
+     * @returns the Portico Bridge protocol client for this chain
+     */
     async getPorticoBridge() {
         this.porticoBridge = this.porticoBridge
             ? this.porticoBridge