Merge pull request #710 from alleslabs/feat/refactor-address

feat: refactor addr types

CHANGELOG.md

@@ -41,6 +41,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Improvements
 
+- [#709](https://github.com/alleslabs/celatone-frontend/pull/709) refactor all address types
+
 ### Bug fixes
 
 ## v1.4.1

src/lib/amplitude/track-event/trackInteraction.ts

@@ -3,7 +3,7 @@ import big from "big.js";
 import { amp } from "../Amplitude";
 import { AmpEvent } from "../types";
 import type { SearchResultType } from "lib/services/searchService";
-import type { MoveAccountAddr, Option, Token } from "lib/types";
+import type { Addr, Option, Token } from "lib/types";
 import { isHexModuleAddress, isHexWalletAddress } from "lib/utils";
 
 export const trackUseMainSearch = (
@@ -197,7 +197,7 @@ export const trackUseToggle = (name: string, isActive: boolean) =>
   amp.track(AmpEvent.USE_TOGGLE, { name, isActive });
 
 export const trackUseModuleSelectionInputFill = (
-  address: MoveAccountAddr,
+  address: Addr,
   manualModuleName: boolean,
   manualFunctionName: boolean
 ) =>

src/lib/app-fns/tx/clearAdmin.tsx

@@ -10,16 +10,16 @@ import { EstimatedFeeRender } from "lib/components/EstimatedFeeRender";
 import { ExplorerLink } from "lib/components/ExplorerLink";
 import { CustomIcon } from "lib/components/icon";
 import { TxStreamPhase } from "lib/types";
-import type { TxResultRendering, ContractAddr, HumanAddr } from "lib/types";
+import type { BechAddr20, BechAddr32, TxResultRendering } from "lib/types";
 import { feeFromStr } from "lib/utils";
 
 import { catchTxError } from "./common";
 import { postTx } from "./common/post";
 import { sendingTx } from "./common/sending";
 
 interface ClearAdminTxParams {
-  address: HumanAddr;
-  contractAddress: ContractAddr;
+  address: BechAddr20;
+  contractAddress: BechAddr32;
   fee: StdFee;
   memo?: string;
   client: SigningCosmWasmClient;

src/lib/app-fns/tx/execute.tsx

@@ -10,15 +10,15 @@ import { EstimatedFeeRender } from "lib/components/EstimatedFeeRender";
 import { ExplorerLink } from "lib/components/ExplorerLink";
 import { CustomIcon } from "lib/components/icon";
 import type { Activity } from "lib/stores/contract";
-import type { ContractAddr, HumanAddr, TxResultRendering } from "lib/types";
+import type { BechAddr20, BechAddr32, TxResultRendering } from "lib/types";
 import { TxStreamPhase } from "lib/types";
 import { encode, feeFromStr, getCurrentDate } from "lib/utils";
 
 import { catchTxError, postTx, sendingTx } from "./common";
 
 interface ExecuteTxParams {
-  address: HumanAddr;
-  contractAddress: ContractAddr;
+  address: BechAddr20;
+  contractAddress: BechAddr32;
   fee: StdFee;
   msg: object;
   funds: Coin[];

src/lib/app-fns/tx/migrate.tsx

@@ -9,7 +9,7 @@ import type { Observable } from "rxjs";
 import { EstimatedFeeRender } from "lib/components/EstimatedFeeRender";
 import { ExplorerLink } from "lib/components/ExplorerLink";
 import { CustomIcon } from "lib/components/icon";
-import type { ContractAddr, HumanAddr, TxResultRendering } from "lib/types";
+import type { BechAddr20, BechAddr32, TxResultRendering } from "lib/types";
 import { TxStreamPhase } from "lib/types";
 import { feeFromStr } from "lib/utils";
 
@@ -18,8 +18,8 @@ import { postTx } from "./common/post";
 import { sendingTx } from "./common/sending";
 
 interface MigrateTxParams {
-  sender: HumanAddr;
-  contractAddress: ContractAddr;
+  sender: BechAddr20;
+  contractAddress: BechAddr32;
   codeId: number;
   migrateMsg: object;
   fee: StdFee;

src/lib/app-fns/tx/move/executeModule.tsx

@@ -11,11 +11,11 @@ import { EstimatedFeeRender } from "lib/components/EstimatedFeeRender";
 import { ExplorerLink } from "lib/components/ExplorerLink";
 import { CustomIcon } from "lib/components/icon";
 import { TxStreamPhase } from "lib/types";
-import type { HumanAddr, TxResultRendering } from "lib/types";
+import type { BechAddr20, TxResultRendering } from "lib/types";
 import { feeFromStr } from "lib/utils";
 
 interface ExecuteModuleTxParams {
-  address: HumanAddr;
+  address: BechAddr20;
   messages: EncodeObject[];
   fee: StdFee;
   client: SigningCosmWasmClient;

src/lib/app-fns/tx/publish.tsx

@@ -4,13 +4,21 @@ import type { StdFee } from "@cosmjs/stargate";
 import { pipe } from "@rx-stream/pipe";
 import type { Observable } from "rxjs";
 
-import type { PublishSucceedCallback } from "lib/app-provider/tx/publish";
-import type { HumanAddr, TxResultRendering } from "lib/types";
+import type { BechAddr20, Option, TxResultRendering } from "lib/types";
 
 import { catchTxError, postTx, sendingTx } from "./common";
 
+export interface PublishTxInternalResult {
+  txHash: string;
+  txFee: Option<string>;
+}
+
+export type PublishSucceedCallback = (
+  txResult: PublishTxInternalResult
+) => void;
+
 interface PublishModuleTxParams {
-  address: HumanAddr;
+  address: BechAddr20;
   client: SigningCosmWasmClient;
   onTxSucceed?: PublishSucceedCallback;
   onTxFailed?: () => void;

src/lib/app-fns/tx/resend.tsx

@@ -8,14 +8,14 @@ import type { Observable } from "rxjs";
 import { EstimatedFeeRender } from "lib/components/EstimatedFeeRender";
 import { ExplorerLink } from "lib/components/ExplorerLink";
 import { CustomIcon } from "lib/components/icon";
-import type { HumanAddr, TxResultRendering } from "lib/types";
+import type { BechAddr20, TxResultRendering } from "lib/types";
 import { TxStreamPhase } from "lib/types";
 import { feeFromStr } from "lib/utils";
 
 import { catchTxError, postTx, sendingTx } from "./common";
 
 interface ResendTxParams {
-  address: HumanAddr;
+  address: BechAddr20;
   client: SigningCosmWasmClient;
   fee: StdFee;
   messages: EncodeObject[];

src/lib/app-fns/tx/script.tsx

@@ -7,14 +7,14 @@ import type { Observable } from "rxjs";
 import { EstimatedFeeRender } from "lib/components/EstimatedFeeRender";
 import { ExplorerLink } from "lib/components/ExplorerLink";
 import { CustomIcon } from "lib/components/icon";
-import type { HumanAddr, TxResultRendering } from "lib/types";
+import type { BechAddr20, TxResultRendering } from "lib/types";
 import { TxStreamPhase } from "lib/types";
 import { feeFromStr } from "lib/utils";
 
 import { catchTxError, postTx, sendingTx } from "./common";
 
 interface DeployScriptTxParams {
-  address: HumanAddr;
+  address: BechAddr20;
   client: SigningCosmWasmClient;
   onTxSucceed?: () => void;
   onTxFailed?: () => void;

src/lib/app-fns/tx/upload.tsx → src/lib/app-fns/tx/storeCode.tsx

@@ -3,31 +3,47 @@ import type { DeliverTxResponse, logs, StdFee } from "@cosmjs/stargate";
 import { pipe } from "@rx-stream/pipe";
 import type { Observable } from "rxjs";
 
-import type { UploadSucceedCallback } from "lib/app-provider";
 import { EstimatedFeeRender } from "lib/components/EstimatedFeeRender";
 import { ExplorerLink } from "lib/components/ExplorerLink";
 import { CustomIcon } from "lib/components/icon";
 import { TxStreamPhase } from "lib/types";
-import type { HumanAddr, TxResultRendering, ComposedMsg } from "lib/types";
+import type {
+  BechAddr,
+  ComposedMsg,
+  Option,
+  TxResultRendering,
+} from "lib/types";
 import { feeFromStr, findAttr } from "lib/utils";
 
 import { catchTxError } from "./common";
 import { postTx } from "./common/post";
 import { sendingTx } from "./common/sending";
 
-interface UploadTxParams {
-  address: HumanAddr;
+export interface StoreCodeTxInternalResult {
+  codeDisplayName: string;
+  codeId: string;
+  codeHash: string;
+  txHash: string;
+  txFee: Option<string>;
+}
+
+export type StoreCodeSucceedCallback = (
+  txResult: StoreCodeTxInternalResult
+) => void;
+
+interface StoreCodeTxParams {
+  address: BechAddr;
   codeName: string;
   messages: ComposedMsg[];
   wasmFileName: string;
   fee: StdFee;
   memo?: string;
   client: SigningCosmWasmClient;
   isMigrate: boolean;
-  onTxSucceed: UploadSucceedCallback;
+  onTxSucceed: StoreCodeSucceedCallback;
 }
 
-export const uploadContractTx = ({
+export const storeCodeTx = ({
   address,
   codeName,
   messages,
@@ -37,7 +53,7 @@ export const uploadContractTx = ({
   client,
   isMigrate,
   onTxSucceed,
-}: UploadTxParams): Observable<TxResultRendering> => {
+}: StoreCodeTxParams): Observable<TxResultRendering> => {
   return pipe(
     sendingTx(fee),
     postTx<DeliverTxResponse>({

src/lib/app-fns/tx/submitProposal.tsx

@@ -8,14 +8,14 @@ import type { Observable } from "rxjs";
 import { EstimatedFeeRender } from "lib/components/EstimatedFeeRender";
 import { ExplorerLink } from "lib/components/ExplorerLink";
 import { CustomIcon } from "lib/components/icon";
-import type { HumanAddr, Nullable, TxResultRendering } from "lib/types";
+import type { BechAddr20, Nullable, TxResultRendering } from "lib/types";
 import { TxStreamPhase } from "lib/types";
 import { feeFromStr, findAttr } from "lib/utils";
 
 import { catchTxError, postTx, sendingTx } from "./common";
 
 interface SubmitWhitelistProposalTxParams {
-  address: HumanAddr;
+  address: BechAddr20;
   client: SigningCosmWasmClient;
   fee: StdFee;
   messages: EncodeObject[];
@@ -106,7 +106,7 @@ export const submitWhitelistProposalTx = ({
 };
 
 interface SubmitStoreCodeProposalTxParams {
-  address: HumanAddr;
+  address: BechAddr20;
   client: SigningCosmWasmClient;
   fee: StdFee;
   chainName: string;

src/lib/app-fns/tx/updateAdmin.tsx

@@ -10,9 +10,9 @@ import { EstimatedFeeRender } from "lib/components/EstimatedFeeRender";
 import { ExplorerLink } from "lib/components/ExplorerLink";
 import { CustomIcon } from "lib/components/icon";
 import type {
-  Addr,
-  ContractAddr,
-  HumanAddr,
+  BechAddr,
+  BechAddr20,
+  BechAddr32,
   TxResultRendering,
 } from "lib/types";
 import { TxStreamPhase } from "lib/types";
@@ -21,9 +21,9 @@ import { feeFromStr } from "lib/utils";
 import { catchTxError, postTx, sendingTx } from "./common";
 
 interface UpdateAdminTxParams {
-  address: HumanAddr;
-  contractAddress: ContractAddr;
-  newAdmin: Addr;
+  address: BechAddr20;
+  contractAddress: BechAddr32;
+  newAdmin: BechAddr;
   fee: StdFee;
   client: SigningCosmWasmClient;
   onTxSucceed?: () => void;

src/lib/app-provider/hooks/useCurrentChain.ts

@@ -1,11 +1,21 @@
+import type { ChainContext as CosmosChainContext } from "@cosmos-kit/core";
 import { useChain } from "@cosmos-kit/react";
 
 import { useCelatoneApp } from "../contexts";
+import type { BechAddr20, Option } from "lib/types";
 
-export const useCurrentChain = () => {
+interface ChainContext extends Omit<CosmosChainContext, "address"> {
+  address: Option<BechAddr20>;
+}
+
+export const useCurrentChain = (): ChainContext => {
   const {
     chainConfig: { registryChainName },
   } = useCelatoneApp();
 
-  return useChain(registryChainName);
+  const { address, ...res } = useChain(registryChainName);
+  return {
+    address: address as Option<BechAddr20>,
+    ...res,
+  };
 };

src/lib/app-provider/hooks/useDummyWallet.ts

@@ -2,14 +2,14 @@ import { DirectSecp256k1HdWallet } from "@cosmjs/proto-signing";
 import { useEffect, useState } from "react";
 
 import { DUMMY_MNEMONIC } from "env";
-import type { HumanAddr } from "lib/types";
+import type { BechAddr20 } from "lib/types";
 
 import { useCurrentChain } from "./useCurrentChain";
 
 export const useDummyWallet = () => {
   const { chain } = useCurrentChain();
   const [dummyWallet, setDummyWallet] = useState<DirectSecp256k1HdWallet>();
-  const [dummyAddress, setDummyAddress] = useState<HumanAddr>();
+  const [dummyAddress, setDummyAddress] = useState<BechAddr20>();
   useEffect(() => {
     (async () => {
       if (DUMMY_MNEMONIC) {
@@ -23,7 +23,7 @@ export const useDummyWallet = () => {
         setDummyWallet(wallet);
 
         const { address } = (await wallet.getAccounts())[0];
-        setDummyAddress(address as HumanAddr);
+        setDummyAddress(address as BechAddr20);
       }
     })();
   }, [chain.bech32_prefix]);

src/lib/app-provider/hooks/useExampleAddresses.ts

@@ -1,7 +1,7 @@
 import { toBech32 } from "@cosmjs/encoding";
 import { useMemo } from "react";
 
-import type { ContractAddr, HumanAddr } from "lib/types";
+import type { BechAddr20, BechAddr32 } from "lib/types";
 import { addrToValoper } from "lib/utils";
 
 import { useCurrentChain } from "./useCurrentChain";
@@ -16,13 +16,13 @@ export const useExampleAddresses = () => {
     const user = toBech32(
       prefix,
       new Uint8Array(bytes.slice(0, 20))
-    ) as HumanAddr;
+    ) as BechAddr20;
 
     // reverse the bytes so the initial characters are different from the user address
     const contract = toBech32(
       prefix,
       new Uint8Array(bytes.reverse())
-    ) as ContractAddr;
+    ) as BechAddr32;
 
     const validator = addrToValoper(user);