Add explicit nameing and fix fn description (#236)

* Add explicit nameing and fix website description * fix build --------- Co-authored-by: phoebe <[email protected]>
massalabs · Jan 31, 2025 · 9faeabe · 9faeabe
1 parent aada304
commit 9faeabe
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 10 deletions.
diff --git a/cli/src/lib/index/index.ts b/cli/src/lib/index/index.ts
@@ -10,20 +10,20 @@ import { storageCostForEntry } from '../utils/storage'
 import { updateWebsiteFunctionName } from './const'
 import { addressToOwnerBaseKey, indexByOwnerBaseKey } from './keys'
 import { getWebsiteOwner } from './read'
-import { getOwnerFromWebsiteSC, getSCAddress } from './utils'
+import { getOwnerFromWebsiteSC, getIndexSCAddress } from './utils'
 
 /**
- * Get the owner of a website using its 'OWNER' storage key
+ * Update the index smart contract with the given address of a website.
  * @param provider - The provider instance
  * @param address - The address of the website
  */
-export async function updateWebsite(
+export async function updateIndexScWebsite(
   provider: Provider,
   address: string
 ): Promise<Operation> {
   const args = new Args().addString(address)
 
-  const scAddress = getSCAddress((await provider.networkInfos()).chainId)
+  const scAddress = getIndexSCAddress((await provider.networkInfos()).chainId)
   const sc = new SmartContract(provider, scAddress)
 
   const estimatedCost = await estimateCost(sc, address)

diff --git a/cli/src/lib/index/read.ts b/cli/src/lib/index/read.ts
@@ -1,7 +1,7 @@
 import { bytesToStr, PublicProvider } from '@massalabs/massa-web3'
 
 import { addressToOwnerBaseKey, indexByOwnerBaseKey } from './keys'
-import { getSCAddress } from './utils'
+import { getIndexSCAddress } from './utils'
 
 /**
  * Get the owner of a website according to the index smart contract.
@@ -13,7 +13,7 @@ export async function getWebsiteOwner(
   provider: PublicProvider,
   address: string
 ): Promise<string> {
-  const scAddress = getSCAddress((await provider.networkInfos()).chainId)
+  const scAddress = getIndexSCAddress((await provider.networkInfos()).chainId)
   const prefix = addressToOwnerBaseKey(address)
 
   const keys = await provider.getStorageKeys(scAddress, prefix)
@@ -36,7 +36,7 @@ export async function getAddressWebsites(
   provider: PublicProvider,
   owner: string
 ): Promise<string[]> {
-  const scAddress = getSCAddress((await provider.networkInfos()).chainId)
+  const scAddress = getIndexSCAddress((await provider.networkInfos()).chainId)
   const prefix = indexByOwnerBaseKey(owner)
 
   const keys = await provider.getStorageKeys(scAddress, prefix)

diff --git a/cli/src/lib/index/utils.ts b/cli/src/lib/index/utils.ts
@@ -25,7 +25,7 @@ export async function getOwnerFromWebsiteSC(
  * @param chainId - The chain id of the network to get the index smart contract address for
  * @returns The index smart contract address
  */
-export function getSCAddress(chainId: bigint): string {
+export function getIndexSCAddress(chainId: bigint): string {
   switch (chainId) {
     case CHAIN_ID.Mainnet:
       return MAINNET_INDEX_ADDRESS

diff --git a/cli/src/tasks/deploy.ts b/cli/src/tasks/deploy.ts
@@ -2,7 +2,7 @@ import { ListrEnquirerPromptAdapter } from '@listr2/prompt-adapter-enquirer'
 import { formatMas } from '@massalabs/massa-web3'
 import { ListrTask } from 'listr2'
 
-import { updateWebsite } from '../lib/index'
+import { updateIndexScWebsite } from '../lib/index'
 import { deployCost, deploySC } from '../lib/website/deploySC'
 
 import { UploadCtx } from './tasks'
@@ -70,7 +70,7 @@ export function deploySCTask(): ListrTask {
 
               subTask.output =
                 'Updating the DeWeb Index with the new SC address'
-              await updateWebsite(provider, ctx.sc.address)
+              await updateIndexScWebsite(provider, ctx.sc.address)
             },
             rendererOptions: {
               outputBar: Infinity,