chore: generate docs

JoinColony · Oct 23, 2024 · f05ede7 · f05ede7
1 parent 749b250
commit f05ede7
Show file tree

Hide file tree

Showing 7 changed files with 11 additions and 11 deletions.
diff --git a/packages/colony-js/docs/api/enums/ColonyRpcEndpoint.md b/packages/colony-js/docs/api/enums/ColonyRpcEndpoint.md
@@ -6,7 +6,7 @@ Official Colony RPC2 endpoint (node)
 
 ### ArbitrumOne
 
-• **ArbitrumOne** = ``"https://arbitrum.colony.io/publicrpc/"``
+• **ArbitrumOne** = ``"https://app.colony.io/publicrpc/"``
 
 Colony's own RPC2 endpoint for Arbitrum One
 

diff --git a/packages/colony-js/docs/api/enums/MetaTxBroadCasterEndpoint.md b/packages/colony-js/docs/api/enums/MetaTxBroadCasterEndpoint.md
@@ -6,7 +6,7 @@ HTTP endpoint of the official Colony MetaTransaction (gasless transaction) broad
 
 ### ArbitrumOne
 
-• **ArbitrumOne** = ``"https://arbitrum.colony.io/metatransaction/arbitrum-one"``
+• **ArbitrumOne** = ``"https://app.colony.io/metatransaction/arbitrum-one"``
 
 The metatransaction broadcaster endpoint on Arbitrum One
 

diff --git a/packages/colony-js/docs/api/enums/ReputationOracleEndpoint.md b/packages/colony-js/docs/api/enums/ReputationOracleEndpoint.md
@@ -6,7 +6,7 @@ HTTP endpoint of the official Colony reputation oracle
 
 ### ArbitrumOne
 
-• **ArbitrumOne** = ``"https://arbitrum.colony.io/reputation/arbitrum-one"``
+• **ArbitrumOne** = ``"https://app.colony.io/reputation/arbitrum-one"``
 
 ___
 

diff --git a/packages/sdk/docs/api/classes/Colony.md b/packages/sdk/docs/api/classes/Colony.md
@@ -582,7 +582,7 @@ Get the xDAI balance of the team number 2
 ```typescript
 import { constants } from 'ethers';
 import { toEth } from '@colony/sdk';
-// The `AddressZero` means ETH on mainnet and xDAI on Gnosis chain
+// The `AddressZero` means ETH on most networks
 const balance = await colony.getBalance(constants.AddressZero, 2);
 // This will format the balance as a string in eth and not wei (i.e. 1.0 vs. 1000000000000000000)
 console.info(toEth(balance));

diff --git a/packages/sdk/docs/api/classes/ColonyNetwork.md b/packages/sdk/docs/api/classes/ColonyNetwork.md
@@ -17,8 +17,8 @@ From here you should be able to instantiate all the required instances for Colon
 import { providers } from 'ethers';
 import { ColonyNetwork, ColonyRpcEndpoint, Tokens } from '@colony/sdk';
 
-// Connect directly to the deployed Colony Network on Gnosis Chain
-const provider = new providers.JsonRpcProvider(ColonyRpcEndpoint.Gnosis);
+// Connect directly to the deployed Colony Network on Arbitrum One
+const provider = new providers.JsonRpcProvider(ColonyRpcEndpoint.ArbitrumOne);
 const colonyNetwork = new ColonyNetwork(provider);
 // Now you could call functions on the colonyNetwork, like `colonyNetwork.getMetaColony()`
 ```
@@ -44,7 +44,7 @@ ___
 
 • **network**: [`Network`](../enums/Network.md)
 
-The network the client is connected to. Defaults to Gnosis chain
+The network the client is connected to. Defaults to Arbitrum One
 
 ___
 
@@ -149,7 +149,7 @@ See the [Colony Creation Guide](../../guides/colony-creation.md).
   // Create a colony
   // (forced transaction example)
   await colonyNetwork
-    // Use USDC on Gnosis chain as the native token
+    // Use USDC on Arbitrum One as the native token
     .createColony('0xDDAfbb505ad214D7b80b1f830fcCc89B60fb7A83', 'coolony')
     .tx().mined();
 })();

diff --git a/packages/sdk/docs/api/classes/OneTxPayment.md b/packages/sdk/docs/api/classes/OneTxPayment.md
@@ -61,13 +61,13 @@ import { Id, Tokens, w } from '@colony/sdk';
 
 // Immediately executing async function
 (async function() {
-  // Pay 10 XDAI (on Gnosis chain) from the root domain to the following address
+  // Pay 10 CLNY (on ArbitrumOne chain) from the root domain to the following address
   // (forced transaction example)
   await colony.ext.oneTx.pay(
      '0xb77D57F4959eAfA0339424b83FcFaf9c15407461',
      w`10`,
      Id.RootDomain,
-     Tokens.Gnosis.XDAI,
+     Tokens.ArbitrumOne.CLNY,
   ).tx().mined();
 })();
 ```

diff --git a/packages/sdk/docs/api/enums/ColonyRpcEndpoint.md b/packages/sdk/docs/api/enums/ColonyRpcEndpoint.md
@@ -6,7 +6,7 @@ Official Colony RPC2 endpoint (node)
 
 ### ArbitrumOne
 
-• **ArbitrumOne** = ``"https://arbitrum.colony.io/publicrpc/"``
+• **ArbitrumOne** = ``"https://app.colony.io/publicrpc/"``
 
 Colony's own RPC2 endpoint for Arbitrum One
-Original file line number
+Diff line change
@@ Expand Up / @@ -6,7 +6,7 @@ HTTP endpoint of the official Colony reputation oracle @@
     ### ArbitrumOne
-    • **ArbitrumOne** = ``"https://arbitrum.colony.io/reputation/arbitrum-one"``
+    • **ArbitrumOne** = ``"https://app.colony.io/reputation/arbitrum-one"``
     ___
@@ Expand Down @@