Replace API3 -> Api3 (except when the token is being referred) (#539)

Author: bbenligiray

.env.example

@@ -12,11 +12,11 @@ REACT_APP_SENTRY_DSN=
 # Wallet Connect project ID
 REACT_APP_PROJECT_ID=e7e6e90622ec8e65c4d02e829a68529a
 
-# The RPC URL will be visible in the browser network tab (leaking the API key). It is advised to whitelist only API3 DAO
+# The RPC URL will be visible in the browser network tab (leaking the API key). It is advised to whitelist only Api3 DAO
 # contracts making the RPC URL useless for others. To support Wallet Connect with MM wallet without errors a few
 # additional supporting contracts need whitelisted as well.
 #
 # Specifically, the following contracts need to be whitelisted:
-#   1. All API3 DAO contracts = https://github.com/api3dao/api3-dao-dashboard/blob/7cfc7157bfb2869a88ecc5f92de95d8e2de9a645/src/contract-deployments/mainnet-dao.json
+#   1. All Api3 DAO contracts = https://github.com/api3dao/api3-dao-dashboard/blob/7cfc7157bfb2869a88ecc5f92de95d8e2de9a645/src/contract-deployments/mainnet-dao.json
 #   2. Mainnet support contracts = https://github.com/wagmi-dev/viem/blob/dd8bccc77d616f973703b5e7b39ffbd0f24a4bdb/src/chains/definitions/mainnet.ts#L34
 REACT_APP_MAINNET_PROVIDER_URL=

Dockerfile

@@ -1,4 +1,4 @@
-# This Dockerfile builds a mainnet version for API3 DAO dashboard
+# This Dockerfile builds a mainnet version for Api3 DAO dashboard
 
 FROM node:16-alpine as builder
 ARG REACT_APP_MAINNET_PROVIDER_URL

README.md

@@ -11,11 +11,11 @@ You can find development instructions in a separate [dev-README](./dev-README.md
 
 ## Running the dashboard on Mainnet in a Docker container
 
-The decentralized approach to being a DAO member is to run API3 dashboard on your local machine. For that you will just
+The decentralized approach to being a DAO member is to run Api3 dashboard on your local machine. For that you will just
 need `docker` and, optionally, `git`.
 
 There are two approaches to running the dashboard locally. The first involves using the prebuilt Docker image, while the
-second involves building the image from source. In either case, the end result is a API3 dashboard running on port 7770
+second involves building the image from source. In either case, the end result is a Api3 dashboard running on port 7770
 of your localhost where it is safe to connect your wallet.
 
 Currently, it's only possible to build the Docker image on a UNIX-like OS. If you use Windows, you can use WSL2.
@@ -83,7 +83,7 @@ dashboard and what our ENS record is pointing towards.
 
 ## Error Monitoring
 
-Please note that the API3 core team tracks application errors on test and production environments using
+Please note that the Api3 core team tracks application errors on test and production environments using
 [Sentry](https://sentry.io). This is solely used to fix errors and improve the experience of our users.
 
 **NOTE: No identifying user information is collected**

cypress/e2e/malicious-proposal-validation.cy.ts

@@ -10,36 +10,36 @@ describe('Malicious proposal validation', () => {
       Decoded EVM script: transfer(address,int32)
      */
     cy.exec(
-      `yarn create-proposal --type secondary --title 'API3 DAO BD-API Team Proposal' --description 'https://ipfs.fleek.co/ipfs/bafybeicfguu3bfhk3fyz5zn5wlujpksqxsaokse37674fhylouvsqnwd2m' --target-signature 'transfer(address,int32)' --parameters '["0xCB943E4Fb0bCf7eC3C2E6D263c275b27F07701c6", "111363670000"]' --target-address 0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48 --target-value 0 --script 0x00000001556ecbb0311d350491ba0ec7e019c354d7723ce0000000e4b61d27f6000000000000000000000000a0b86991c6218b36c1d19d4a2e9eb0ce3606eb48000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000600000000000000000000000000000000000000000000000000000000000000044a9059cbb000000000000000000000000cb943e4fb0bcf7ec3c2e6d263c275b27f07701c600000000000000000000000000000000000000000000000000000019edcabff000000000000000000000000000000000000000000000000000000000`
+      `yarn create-proposal --type secondary --title 'Api3 DAO BD-API Team Proposal' --description 'https://ipfs.fleek.co/ipfs/bafybeicfguu3bfhk3fyz5zn5wlujpksqxsaokse37674fhylouvsqnwd2m' --target-signature 'transfer(address,int32)' --parameters '["0xCB943E4Fb0bCf7eC3C2E6D263c275b27F07701c6", "111363670000"]' --target-address 0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48 --target-value 0 --script 0x00000001556ecbb0311d350491ba0ec7e019c354d7723ce0000000e4b61d27f6000000000000000000000000a0b86991c6218b36c1d19d4a2e9eb0ce3606eb48000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000600000000000000000000000000000000000000000000000000000000000000044a9059cbb000000000000000000000000cb943e4fb0bcf7ec3c2e6d263c275b27f07701c600000000000000000000000000000000000000000000000000000019edcabff000000000000000000000000000000000000000000000000000000000`
     );
 
     cy.findAllByText('Governance').filter(':visible').click();
     // Navigate to proposal
-    cy.findByRole('link', { name: 'API3 DAO BD-API Team Proposal' }).click();
+    cy.findByRole('link', { name: 'Api3 DAO BD-API Team Proposal' }).click();
     cy.findByText(/This proposal is potentially malicious/i).should('exist');
   });
 
   it('shows a warning if the original EVM script has an additional function call', () => {
     cy.increaseTimeAndRelogin(EPOCH_LENGTH + 60 * 60); // skip the genesis epoch (add 1 hour just to be sure)
     cy.exec(
-      `yarn create-proposal --type secondary --title 'API3 DAO BD-API Team Proposal' --description 'https://ipfs.fleek.co/ipfs/bafybeicfguu3bfhk3fyz5zn5wlujpksqxsaokse37674fhylouvsqnwd2m' --target-signature 'transfer(address,uint256)' --parameters '["0xCB943E4Fb0bCf7eC3C2E6D263c275b27F07701c6", "111363670000"]' --target-address 0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48 --target-value 0 --script 0x00000001556ecbb0311d350491ba0ec7e019c354d7723ce0000000e4b61d27f6000000000000000000000000a0b86991c6218b36c1d19d4a2e9eb0ce3606eb48000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000600000000000000000000000000000000000000000000000000000000000000044a9059cbb000000000000000000000000cb943e4fb0bcf7ec3c2e6d263c275b27f07701c600000000000000000000000000000000000000000000000000000019edcabff000000000000000000000000000000000000000000000000000000000556ecbb0311d350491ba0ec7e019c354d7723ce0000000e4b61d27f6000000000000000000000000a0b86991c6218b36c1d19d4a2e9eb0ce3606eb48000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000600000000000000000000000000000000000000000000000000000000000000044a9059cbb000000000000000000000000cb943e4fb0bcf7ec3c2e6d263c275b27f07701c600000000000000000000000000000000000000000000000000000019edcabff000000000000000000000000000000000000000000000000000000000`
+      `yarn create-proposal --type secondary --title 'Api3 DAO BD-API Team Proposal' --description 'https://ipfs.fleek.co/ipfs/bafybeicfguu3bfhk3fyz5zn5wlujpksqxsaokse37674fhylouvsqnwd2m' --target-signature 'transfer(address,uint256)' --parameters '["0xCB943E4Fb0bCf7eC3C2E6D263c275b27F07701c6", "111363670000"]' --target-address 0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48 --target-value 0 --script 0x00000001556ecbb0311d350491ba0ec7e019c354d7723ce0000000e4b61d27f6000000000000000000000000a0b86991c6218b36c1d19d4a2e9eb0ce3606eb48000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000600000000000000000000000000000000000000000000000000000000000000044a9059cbb000000000000000000000000cb943e4fb0bcf7ec3c2e6d263c275b27f07701c600000000000000000000000000000000000000000000000000000019edcabff000000000000000000000000000000000000000000000000000000000556ecbb0311d350491ba0ec7e019c354d7723ce0000000e4b61d27f6000000000000000000000000a0b86991c6218b36c1d19d4a2e9eb0ce3606eb48000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000600000000000000000000000000000000000000000000000000000000000000044a9059cbb000000000000000000000000cb943e4fb0bcf7ec3c2e6d263c275b27f07701c600000000000000000000000000000000000000000000000000000019edcabff000000000000000000000000000000000000000000000000000000000`
     );
 
     cy.findAllByText('Governance').filter(':visible').click();
     // Navigate to proposal
-    cy.findByRole('link', { name: 'API3 DAO BD-API Team Proposal' }).click();
+    cy.findByRole('link', { name: 'Api3 DAO BD-API Team Proposal' }).click();
     cy.findByText(/This proposal is potentially malicious/i).should('exist');
   });
 
   it('does not show a warning if the original EVM script and the decoded EVM script matches up', () => {
     cy.increaseTimeAndRelogin(EPOCH_LENGTH + 60 * 60); // skip the genesis epoch (add 1 hour just to be sure)
     cy.exec(
-      `yarn create-proposal --type secondary --title 'API3 DAO BD-API Team Proposal' --description 'https://ipfs.fleek.co/ipfs/bafybeicfguu3bfhk3fyz5zn5wlujpksqxsaokse37674fhylouvsqnwd2m' --target-signature 'transfer(address,uint256)' --parameters '["0xCB943E4Fb0bCf7eC3C2E6D263c275b27F07701c6", "111363670000"]' --target-address 0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48 --target-value 10`
+      `yarn create-proposal --type secondary --title 'Api3 DAO BD-API Team Proposal' --description 'https://ipfs.fleek.co/ipfs/bafybeicfguu3bfhk3fyz5zn5wlujpksqxsaokse37674fhylouvsqnwd2m' --target-signature 'transfer(address,uint256)' --parameters '["0xCB943E4Fb0bCf7eC3C2E6D263c275b27F07701c6", "111363670000"]' --target-address 0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48 --target-value 10`
     );
 
     cy.findAllByText('Governance').filter(':visible').click();
     // Navigate to proposal
-    cy.findByRole('link', { name: 'API3 DAO BD-API Team Proposal' }).click();
+    cy.findByRole('link', { name: 'Api3 DAO BD-API Team Proposal' }).click();
     cy.findByText(/This proposal is potentially malicious/i).should('not.exist');
   });
 });

public/index.html

@@ -15,7 +15,7 @@
     />
     <meta name="viewport" content="width=device-width, initial-scale=1" />
     <meta name="theme-color" content="#000000" />
-    <meta name="description" content="API3 DAO staking and voting dashboard" />
+    <meta name="description" content="Api3 DAO staking and voting dashboard" />
     <!--
       Notice the use of %PUBLIC_URL% in the tags above.
       It will be replaced with the URL of the `public` folder during the build.

src/app.tsx

@@ -85,7 +85,7 @@ const App = () => {
         <HelmetProvider>
           {/* Helmet children can be overridden in components lower down the tree */}
           <Helmet>
-            <title>API3 DAO</title>
+            <title>Api3 DAO</title>
             {/* Preload any important images here */}
             {/* https://web.dev/preload-responsive-images/ */}
             {(Object.keys(images) as Array<keyof typeof images>).map((image) => {

src/components/external-link/external-link.test.tsx

@@ -3,38 +3,38 @@ import ExternalLink from './external-link';
 
 describe('<ExternalLink />', () => {
   it('accepts an URL that starts with "https://"', () => {
-    render(<ExternalLink href="https://api3.org">API3</ExternalLink>);
-    expect(screen.getByRole('link', { name: 'API3' })).toHaveAttribute('href', 'https://api3.org');
+    render(<ExternalLink href="https://api3.org">Api3</ExternalLink>);
+    expect(screen.getByRole('link', { name: 'Api3' })).toHaveAttribute('href', 'https://api3.org');
   });
 
   it('accepts an URL that starts with "http://"', () => {
-    render(<ExternalLink href="http://api3.org">API3</ExternalLink>);
-    expect(screen.getByRole('link', { name: 'API3' })).toHaveAttribute('href', 'http://api3.org');
+    render(<ExternalLink href="http://api3.org">Api3</ExternalLink>);
+    expect(screen.getByRole('link', { name: 'Api3' })).toHaveAttribute('href', 'http://api3.org');
   });
 
   it('accepts a mixed-case URL', () => {
-    render(<ExternalLink href="Https://api3.org">API3</ExternalLink>);
-    expect(screen.getByRole('link', { name: 'API3' })).toHaveAttribute('href', 'Https://api3.org');
+    render(<ExternalLink href="Https://api3.org">Api3</ExternalLink>);
+    expect(screen.getByRole('link', { name: 'Api3' })).toHaveAttribute('href', 'Https://api3.org');
   });
 
   it('accepts an URL that is padded with whitespace', () => {
-    render(<ExternalLink href=" https://api3.org ">API3</ExternalLink>);
-    expect(screen.getByRole('link', { name: 'API3' })).toHaveAttribute('href', 'https://api3.org');
+    render(<ExternalLink href=" https://api3.org ">Api3</ExternalLink>);
+    expect(screen.getByRole('link', { name: 'Api3' })).toHaveAttribute('href', 'https://api3.org');
   });
 
   it('rejects a javascript URL', () => {
     // eslint-disable-next-line no-script-url
-    render(<ExternalLink href="javascript:alert('xss')">API3</ExternalLink>);
-    expect(screen.getByRole('link', { name: 'API3' })).toHaveAttribute('href', 'about:blank');
+    render(<ExternalLink href="javascript:alert('xss')">Api3</ExternalLink>);
+    expect(screen.getByRole('link', { name: 'Api3' })).toHaveAttribute('href', 'about:blank');
   });
 
   it('rejects a data URL', () => {
-    render(<ExternalLink href="data:text/html,<script>alert('xss')</script>">API3</ExternalLink>);
-    expect(screen.getByRole('link', { name: 'API3' })).toHaveAttribute('href', 'about:blank');
+    render(<ExternalLink href="data:text/html,<script>alert('xss')</script>">Api3</ExternalLink>);
+    expect(screen.getByRole('link', { name: 'Api3' })).toHaveAttribute('href', 'about:blank');
   });
 
   it('rejects an URL without protocol', () => {
-    render(<ExternalLink href="api3.org">API3</ExternalLink>);
-    expect(screen.getByRole('link', { name: 'API3' })).toHaveAttribute('href', 'about:blank');
+    render(<ExternalLink href="api3.org">Api3</ExternalLink>);
+    expect(screen.getByRole('link', { name: 'Api3' })).toHaveAttribute('href', 'about:blank');
   });
 });

src/components/layout/layout.tsx

@@ -51,7 +51,7 @@ export const BaseLayout = ({ children, title }: BaseLayoutProps) => {
   return (
     <>
       <Helmet>
-        <title>{`API3 DAO | ${title}`}</title>
+        <title>{`Api3 DAO | ${title}`}</title>
       </Helmet>
 
       <div className={styles.layout}>

src/logic/proposals/encoding/encoding.test.ts

@@ -387,7 +387,7 @@ describe('isEvmScriptValid', () => {
       const metadata = {
         description: 'https://ipfs.fleek.co/ipfs/bafybeicfguu3bfhk3fyz5zn5wlujpksqxsaokse37674fhylouvsqnwd2m',
         targetSignature: 'transfer(address,uint256)',
-        title: 'API3 DAO BD-API Team Proposal',
+        title: 'Api3 DAO BD-API Team Proposal',
         version,
       };
       const decodedEvmScript = await decodeEvmScript(mockedProvider, script, metadata);
@@ -420,7 +420,7 @@ describe('isEvmScriptValid', () => {
       const metadata = {
         description: 'https://ipfs.fleek.co/ipfs/bafybeicfguu3bfhk3fyz5zn5wlujpksqxsaokse37674fhylouvsqnwd2m',
         targetSignature: 'transfer(address,int32)',
-        title: 'API3 DAO BD-API Team Proposal',
+        title: 'Api3 DAO BD-API Team Proposal',
         version,
       };
       const decodedEvmScript = await decodeEvmScript(mockedProvider, script, metadata);
@@ -449,7 +449,7 @@ describe('isEvmScriptValid', () => {
       const metadata = {
         description: 'https://ipfs.fleek.co/ipfs/bafybeicfguu3bfhk3fyz5zn5wlujpksqxsaokse37674fhylouvsqnwd2m',
         targetSignature: 'transfer(address,uint256)',
-        title: 'API3 DAO BD-API Team Proposal',
+        title: 'Api3 DAO BD-API Team Proposal',
         version,
       };
 
@@ -474,7 +474,7 @@ describe('isEvmScriptValid', () => {
         const metadata = {
           description: 'https://ipfs.fleek.co/ipfs/bafybeicfguu3bfhk3fyz5zn5wlujpksqxsaokse37674fhylouvsqnwd2m',
           targetSignature: 'transfer(address,uint256)',
-          title: 'API3 DAO BD-API Team Proposal',
+          title: 'Api3 DAO BD-API Team Proposal',
           version,
         };
         const decodedEvmScript = await decodeEvmScript(mockedProvider, script, metadata);
@@ -511,7 +511,7 @@ describe('isEvmScriptValid', () => {
         const metadata = {
           description: 'https://ipfs.fleek.co/ipfs/bafybeicfguu3bfhk3fyz5zn5wlujpksqxsaokse37674fhylouvsqnwd2m',
           targetSignature: 'transfer(address,int32)',
-          title: 'API3 DAO BD-API Team Proposal',
+          title: 'Api3 DAO BD-API Team Proposal',
           version,
         };
         const decodedEvmScript = await decodeEvmScript(mockedProvider, script, metadata);

src/logic/proposals/encoding/index.ts

@@ -1,6 +1,6 @@
 /**
  * Aragon voting contracts are flexible but this makes it a bit harder to work with its contracts. We have created a
- * simple encoding and decoding scheme (convention) for the API3 proposals. The implementation of these utilities is
+ * simple encoding and decoding scheme (convention) for the Api3 proposals. The implementation of these utilities is
  * inspired by https://github.com/bbenligiray/proposal-test.
  *
  * Check out the documentation in the source files for more documentation and details.