Skip to content

Commit

Permalink
docs: Add JSDoc comments to network configuration constants
Browse files Browse the repository at this point in the history
- Added detailed JSDoc comments for MAINNET_ID, SANDBOX_ID, TESTNET_ID, USDC_IBC_DENOMS, and AKT_DENOM.
- Improved code readability and maintainability by providing type annotations and descriptions for each export.

Signed-off-by: Greg Osuri <[email protected]>
  • Loading branch information
gosuri committed Dec 10, 2024
1 parent 33ad04c commit 2e2741e
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions src/config/network.ts
Original file line number Diff line number Diff line change
@@ -1,13 +1,35 @@
import { MainnetNetworkId, NetworkId, SandboxNetworkId, TestnetNetworkId } from "../types/network";

/**
* The network ID for the mainnet environment.
* @type {MainnetNetworkId}
*/
export const MAINNET_ID: MainnetNetworkId = "mainnet";

/**
* The network ID for the sandbox environment.
* @type {SandboxNetworkId}
*/
export const SANDBOX_ID: SandboxNetworkId = "sandbox";

/**
* The network ID for the testnet environment.
* @type {TestnetNetworkId}
*/
export const TESTNET_ID: TestnetNetworkId = "testnet";

/**
* A mapping of network IDs to their respective USDC IBC denominations.
* @type {Record<NetworkId, string>}
*/
export const USDC_IBC_DENOMS: Record<NetworkId, string> = {
[MAINNET_ID]: "ibc/170C677610AC31DF0904FFE09CD3B5C657492170E7E52372E48756B71E56F2F1",
[SANDBOX_ID]: "ibc/12C6A0C374171B595A0A9E18B83FA09D295FB1F2D8C6DAA3AC28683471752D84",
[TESTNET_ID]: ""
};

/**
* The denomination for the AKT token.
* @type {string}
*/
export const AKT_DENOM = "uakt";

0 comments on commit 2e2741e

Please sign in to comment.