DREL-264 MATIC to POL docs rename (#3100)

fonty1 · web-flow · commit f557ec842cfb · 2025-05-05T08:45:54.000+03:00
## Summary

MATIC -&gt; POL in docs, it won't affect anything else.
diff --git a/docs/docs/guides/become-an-operator.md b/docs/docs/guides/become-an-operator.md
@@ -6,7 +6,7 @@ sidebar_position: 7
 **TL;DR 👨‍💻 Do these things to become an earning Streamr node Operator:**
 - Deploy an Operator smart contract.
 - Run Streamr node(s) and pair them with your Operator.
-- Stake `DATA` tokens on your Operator and give your node address a few `MATIC`
+- Stake `DATA` tokens on your Operator and give your node address a few `POL`
 - Join Sponsorships through your Operator that will earn you DATA tokens.
 
 ## Operator setup instructions
@@ -19,7 +19,7 @@ The wallet/account that you use to make the Operator creation transaction will b
 
 You'll need to decide on your [owner's cut](../streamr-network/network-roles/operators.md#owners-cut) at the time of your Operator deployment. You'll be able to change this value later on, as long as you unstake from all Sponsorships first. The average cut Operators are choosing appears to be around 10%.
 
-You can also practice your Operator deployment in the Polygon Amoy testnet environment with the [Streamr Hub](https://streamr.network/hub) (select "Polygon Amoy testnet" on the Streamr Hub). You'll need Amoy `MATIC` - widely available with [public faucets](https://faucet.polygon.technology/) and you'll need ` TEST` tokens (the Amoy network's worthless `DATA` tokens) - There is a `TEST` token faucet on the [Streamr Discord](https://discord.gg/gZAm8P7hK8).
+You can also practice your Operator deployment in the Polygon Amoy testnet environment with the [Streamr Hub](https://streamr.network/hub) (select "Polygon Amoy testnet" on the Streamr Hub). You'll need Amoy `POL` - widely available with [public faucets](https://faucet.polygon.technology/) and you'll need ` TEST` tokens (the Amoy network's worthless `DATA` tokens) - There is a `TEST` token faucet on the [Streamr Discord](https://discord.gg/gZAm8P7hK8).
 
 ### Step 2: Run a Streamr node
 Spin up a Streamr node using the **[How to run a Streamr node guide](./how-to-run-streamr-node.md#streamr-node-hardware-recommendations)**.
@@ -56,7 +56,7 @@ The format of your node config file should match [this template](./how-to-run-st
 After any config file change you should restart your node. If you're building your Operator in Amoy (for testing purposes), copy and paste [this config snippet](#amoy-node-config) instead.
 
 ### Step 4: Fund your Node address
-You’ll need a some `MATIC` (the gas token of Polygon) in your node address since the node(s) will periodically make transactions. 5 to 10 `MATIC` is recommended since the nodes will be making a few transactions per day.
+You’ll need a some `POL` (the gas token of Polygon) in your node address since the node(s) will periodically make transactions. 5 to 10 `POL` is recommended since the nodes will be making a few transactions per day.
 
 If the node runs out of gas while they’re a part of an active Sponsorship, then a penalty may be applied to your unclaimed earnings. See [Operator value maintenance](../streamr-network/network-roles/operators.md#operator-maintenance).
 
@@ -121,7 +121,7 @@ While the Streamr team provides regular updates on the **#node-announcements** D
 ## The Amoy test environment
 The [Streamr Hub](https://streamr.network/hub) is the place to test out your Operator before creating it on Polygon with real tokens, just select "Polygon Amoy testnet" from top-right network selector. You'll need to use the [Amoy node config](./how-to-run-streamr-node.md#amoy-node-config).
 
-You'll need Amoy `MATIC` - widely available with [public faucets](https://faucet.polygon.technology/) and you'll need ` TEST` tokens (the Amoy network's worthless `DATA` tokens) - There is a `TEST` token faucet on the [Streamr Discord](https://discord.gg/gZAm8P7hK8).
+You'll need Amoy `POL` - widely available with [public faucets](https://faucet.polygon.technology/) and you'll need ` TEST` tokens (the Amoy network's worthless `DATA` tokens) - There is a `TEST` token faucet on the [Streamr Discord](https://discord.gg/gZAm8P7hK8).
 
 ## Amoy node config
 Below is the template you can use to override and replace the contents of your config file with. You can copy this snippet or download the [JSON file](../../static/assets/testnet-default.json).
diff --git a/docs/docs/guides/how-to-stake-and-earn.md b/docs/docs/guides/how-to-stake-and-earn.md
@@ -26,7 +26,7 @@ Sponsorships are the source of incentivization. These are visible on [The Hub](h
 ### The Amoy test environment
 The [Streamr Hub](https://streamr.network/hub) is the place to test out your Operator before creating it on Polygon with real tokens, just select "Polygon Amoy testnet" from the top-right dropdown.
 
-You'll need Amoy `MATIC` - widely available with [public faucets](https://faucet.polygon.technology/) and you'll need ` TEST` tokens (the Amoy network's worthless `DATA` tokens) - There is a `TEST` token faucet on the [Streamr Discord](https://discord.gg/gZAm8P7hK8).
+You'll need Amoy `POL` - widely available with [public faucets](https://faucet.polygon.technology/) and you'll need ` TEST` tokens (the Amoy network's worthless `DATA` tokens) - There is a `TEST` token faucet on the [Streamr Discord](https://discord.gg/gZAm8P7hK8).
 
 ### Community resources
 - Tutorial videos. Follow at your own risk. Note that version numbers and exact instructions may change over time.
diff --git a/docs/docs/guides/nodejs.md b/docs/docs/guides/nodejs.md
@@ -8,10 +8,10 @@ This is a quickstart guide on creating your first stream using the Streamr TypeS
 **Prerequisites:**
 -   NPM v8 or greater
 -   NodeJS 18.13.x or greater (version 20 and later ideally)
--   A small amount of `MATIC` to pay for gas on Polygon mainnet. You can reachout to us on the #dev channel of [Discord](https://discord.gg/gZAm8P7hK8) for some tokens.
+-   A small amount of `POL` to pay for gas on Polygon mainnet. You can reachout to us on the #dev channel of [Discord](https://discord.gg/gZAm8P7hK8) for some tokens.
 
 :::tip Key Point:
-If you'd like to test out Streamr without needing `MATIC` to pay for stream creation and access control transactions then you can configure any Streamr app or node to be on Polygon Amoy. 
+If you'd like to test out Streamr without needing `POL` to pay for stream creation and access control transactions then you can configure any Streamr app or node to be on Polygon Amoy. 
 
 Note that streams that are registered on one chain, cannot see or interact with streams on another chain (including the stream mentioned in this guide). 
 
@@ -50,7 +50,7 @@ User identity on Streamr is established via cryptographic keys. An Ethereum acco
 A stream is simply a **sequence of data points in time**, i.e. an append only log. This is semantically equivalent to **topics** in traditional pub/sub networks.
 
 ```ts
-// Requires MATIC tokens (Polygon blockchain gas token)
+// Requires POL tokens (Polygon blockchain gas token)
 const stream = await streamr.createStream({
     id: "/foo/bar",
 })
@@ -78,7 +78,7 @@ const stream = await streamr.getOrCreateStream({
 By default, the creator of the stream has full read, write and manage permissions over the stream, but if you'd like different addresses or public access controls to read and write (publish and subscribe) to your stream, then you'll need to add these permissions.
 
 ```ts
-// Requires MATIC tokens (Polygon blockchain gas token)
+// Requires POL tokens (Polygon blockchain gas token)
 await stream.grantPermissions({
     userId: "0x12345...",
     permissions: [StreamPermission.PUBLISH],
diff --git a/docs/docs/guides/use-any-language-or-device.md b/docs/docs/guides/use-any-language-or-device.md
@@ -11,7 +11,7 @@ This tutorial will show you how to publish data into the Streamr Network from in
 -   NPM v8 or greater
 -   NodeJS 18.x or greater (Ideally v20+)
 -   MacOS/Linux environments (Windows environments may require minor adjustments)
--   A small amount of `MATIC` to pay for gas on Polygon mainnet. You can reachout to us on the #dev channel of [Discord](https://discord.gg/gZAm8P7hK8) for some tokens.
+-   A small amount of `POL` to pay for gas on Polygon mainnet. You can reachout to us on the #dev channel of [Discord](https://discord.gg/gZAm8P7hK8) for some tokens.
 -   A MQTT library of your choice (this tutorial uses [MQTT.js](https://www.npmjs.com/package/mqtt))
 
 If you have a Helium setup, you may benefit from reading this blog post first, [Helium x Streamr](https://blog.helium.com/helium-x-streamr-ea89c4b61a14)
@@ -67,7 +67,7 @@ $ npm install @streamr/sdk
 Having trouble installing the client? Maybe our [troubleshooting](../usage/sdk/how-to-use#Troubleshooting) section will help.
 
 :::note
-Make sure the `PRIVATE_KEY` you add has a small amount of `MATIC` (the native token of the Polygon blockchain) in its wallet to pay for gas to create the stream and make the permission assignment.
+Make sure the `PRIVATE_KEY` you add has a small amount of `POL` (the native token of the Polygon blockchain) in its wallet to pay for gas to create the stream and make the permission assignment.
 :::
 
 TODO: ** Create a stream widget **
@@ -92,7 +92,7 @@ const stream = await streamr.getOrCreateStream({
 
 #### Assign permission to your Streamr node
 
-The Streamr node **needs permission to publish data to your stream**. We will be granting the Streamr node `PUBLISH` and `SUBSCRIBE` permissions on the stream we just created. This step will consume a small amount of `MATIC` tokens.
+The Streamr node **needs permission to publish data to your stream**. We will be granting the Streamr node `PUBLISH` and `SUBSCRIBE` permissions on the stream we just created. This step will consume a small amount of `POL` tokens.
 
 :::note
 Take care to not confuse `stream` with `streamr` ;)
diff --git a/docs/docs/guides/web-app-frameworks.md b/docs/docs/guides/web-app-frameworks.md
@@ -10,7 +10,7 @@ In this quickstart guide, you'll be using Streamr in a **ReactJS** web applicati
 -   NPM v8 or greater
 -   NodeJS 18.x or greater (Ideally v20+)
 -   A basic understanding of ReactJS or NextJS
--   A small amount of `MATIC` to pay for gas on Polygon mainnet. You can reachout to us on the #dev channel of [Discord](https://discord.gg/gZAm8P7hK8) for some tokens.
+-   A small amount of `POL` to pay for gas on Polygon mainnet. You can reachout to us on the #dev channel of [Discord](https://discord.gg/gZAm8P7hK8) for some tokens.
 
 ## Setup & installation
 
diff --git a/docs/docs/help/operator-faq.md b/docs/docs/help/operator-faq.md
@@ -140,14 +140,14 @@ Yes.
 #### Can we share private key for 25 nodes? In this case will the Operator recognize 1 node or 25 nodes?
 Node addresses do not equal nodes. In other words, yes, you can share private keys among all your nodes.
 
-#### Is there any benefit to having two or more node addresses added to the Operator and managing MATIC balance on multiple wallets instead of having a single node address for all nodes in my fleet?
+#### Is there any benefit to having two or more node addresses added to the Operator and managing POL balance on multiple wallets instead of having a single node address for all nodes in my fleet?
 It is perhaps easier to debug if something goes wrong but there's no other benefits to having multiple addresses for each of your fleet nodes.
 
 #### As an Operator, can I generate the node signing key in memory?
 No. The node signing key must be known and persist so that it can be paired with the Operator Contract.
 
 #### Which address do I need to fund?
-You need to fund your node address(es) with a small amount of `MATIC` tokens.
+You need to fund your node address(es) with a small amount of `POL` tokens.
 
 ### Troubleshooting common issues
 #### Issue:
@@ -245,7 +245,7 @@ The delegators will then simply leave and delegate to someone else, as they are
 No, you will need to periodically check and claim your uncollected earnings from the Operator(s) that you have staked/delegated on.
 
 #### How does the auto collect earnings work?
-Nodes work on a collection trigger which is based on how much value there is to collect. The limit to decide whether the earnings are collected upon checking is configurable, and this is defined relative to the limit. The default is halfway to the limit, meaning that uncollected earnings are collected when they equal at least 2.5% of Operator stake. If nodes are running and have enough `MATIC` to pay for gas, then the 5% uncollected limit should not be exceeded.
+Nodes work on a collection trigger which is based on how much value there is to collect. The limit to decide whether the earnings are collected upon checking is configurable, and this is defined relative to the limit. The default is halfway to the limit, meaning that uncollected earnings are collected when they equal at least 2.5% of Operator stake. If nodes are running and have enough `POL` to pay for gas, then the 5% uncollected limit should not be exceeded.
 
 These check runs every hour by default. 
 
diff --git a/docs/docs/streamr-network/network-roles/operators.md b/docs/docs/streamr-network/network-roles/operators.md
@@ -75,7 +75,7 @@ The Operator’s cut is the percentage taken by the Operator from all earnings.
 #### Operator uncollected earnings limit
 Operators continuously earn rewards from Sponsorships on every block. For the Operator’s total value to be correctly reflected on-chain, those earnings must be periodically collected to limit the error between the recorded on-chain value and the ‘real-time’ value of the Operator, which constantly changes due to uncollected earnings accumulating.
 
-Normally, the node software handles this earnings collection and maintenance of Operator value automatically. The Operator is responsible for ensuring that this happens by ensuring their nodes are running and the wallets of their nodes have enough `MATIC` to pay gas for transactions.
+Normally, the node software handles this earnings collection and maintenance of Operator value automatically. The Operator is responsible for ensuring that this happens by ensuring their nodes are running and the wallets of their nodes have enough `POL` to pay gas for transactions.
 
 The uncollected earnings limit has been set to 5% and this value is subject to change by Streamr DAO governance vote.
 
@@ -90,7 +90,7 @@ This reward is set to 25% and this value is subject to change by Streamr DAO gov
 Streamr nodes are also the validators in the Streamr Network. They inspect and validate that other nodes in the same [sponsored stream] are doing the work
 If an operator fails completely (all their nodes go offline), they will eventually get flagged in all the sponsorships where they are staked. So yes more Sponsorships means more flagging in this case.
 
-If the flags are raised by the random inspection process, it's likely that the flags will be raised evenly by all the other operators, so no one operator's MATIC balance gets a major unexpected drain.
+If the flags are raised by the random inspection process, it's likely that the flags will be raised evenly by all the other operators, so no one operator's POL balance gets a major unexpected drain.
 
 By default, nodes inspect each other quite lazily (pick one operator-sponsorship-partition triplet every 15 minutes). However, correctly flagging and voting is profitable, so more 'eager' flaggers might appear in the network, with smarter inspection strategies - for example if a node gets slashed in one sponsorship, it might be worthwhile for someone to inspect them in all their other sponsorships too, and raise flags if the inspection fails.
 How to earn DATA tokens by being an Operator
diff --git a/docs/docs/usage/streams/creating-streams.md b/docs/docs/usage/streams/creating-streams.md
@@ -4,7 +4,7 @@ sidebar_position: 2
 
 # Creating streams
 ```ts
-// Requires MATIC tokens (Polygon blockchain gas token)
+// Requires POL tokens (Polygon blockchain gas token)
 const stream = await streamr.createStream({
   id: '/foo/bar',
 });
@@ -15,7 +15,7 @@ console.log(stream.id); // e.g. `0x12345.../foo/bar`
 You can also create a stream by defining the address in the provided id. Please note that the creation will only succeed if you specify the same address as provided for authentication when creating the `streamr` instance:
 
 ```ts
-// Requires MATIC tokens (Polygon blockchain gas token)
+// Requires POL tokens (Polygon blockchain gas token)
 const stream = await streamr.createStream({
   id: `${address}/foo/bar`,
 });
diff --git a/docs/docs/usage/streams/interacting-with-streams.md b/docs/docs/usage/streams/interacting-with-streams.md
@@ -13,7 +13,7 @@ const stream = await streamr.getStream(streamId);
 The method getOrCreateStream gets the stream if it exists, and if not, creates it:
 
 ```ts
-// May require MATIC tokens (Polygon blockchain gas token)
+// May require POL tokens (Polygon blockchain gas token)
 const stream = await streamr.getOrCreateStream({
   id: streamId,
 });
@@ -23,7 +23,7 @@ const stream = await streamr.getOrCreateStream({
 To update the description of a stream:
 
 ```ts
-// Requires MATIC tokens (Polygon blockchain gas token)
+// Requires POL tokens (Polygon blockchain gas token)
 await stream.update({
   description: 'New description',
 });
@@ -33,6 +33,6 @@ await stream.update({
 To delete a stream:
 
 ```ts
-// Requires MATIC tokens (Polygon blockchain gas token)
+// Requires POL tokens (Polygon blockchain gas token)
 await stream.delete();
 ```
diff --git a/docs/docs/usage/streams/partitioning.md b/docs/docs/usage/streams/partitioning.md
@@ -31,7 +31,7 @@ Create new partions if your messages extend approx. 100 msg/sec per partition.
 By default, streams only have 1 partition when they are created. The partition count can be set to any number between 1 and 100. An example of creating a partitioned stream:
 
 ```ts
-// Requires MATIC tokens (Polygon blockchain gas token)
+// Requires POL tokens (Polygon blockchain gas token)
 const stream = await streamr.createStream({
   id: `/foo/bar`,
   partitions: 10,
diff --git a/docs/docs/usage/streams/permissions.md b/docs/docs/usage/streams/permissions.md
@@ -4,7 +4,7 @@ sidebar_position: 6
 
 # Permissions
 
-Stream permissioning relates to who gets to read, write and edit streams on the Network. This access control is enforced by the [on-chain stream registry](../../streamr-network/smart-contracts.md). Since every permission update is a modification to the on-chain registry, it requires a small amount of `MATIC` tokens to fund the transaction.
+Stream permissioning relates to who gets to read, write and edit streams on the Network. This access control is enforced by the [on-chain stream registry](../../streamr-network/smart-contracts.md). Since every permission update is a modification to the on-chain registry, it requires a small amount of `POL` tokens to fund the transaction.
 
 User's are identified by their Ethereum public key address. It is these addresses that are given permission to read/write/edit streams.
 
diff --git a/packages/node/src/config/ConfigWizard.ts b/packages/node/src/config/ConfigWizard.ts
@@ -99,7 +99,7 @@ export async function start(): Promise<void> {
         if (operator) {
             const resume = animateLine((spinner) =>
                 style(
-                    `> Your node address has *${spinner} MATIC* _– checking balance…_`
+                    `> Your node address has *${spinner} POL* _– checking balance…_`
                 )
             )
 
@@ -111,13 +111,13 @@ export async function start(): Promise<void> {
 
                 const content = `Your node address has *${Number(
                     formatEther(balance)
-                ).toFixed(2)} MATIC*`
+                ).toFixed(2)} POL*`
 
                 resume()
 
                 if (balance < MIN_BALANCE) {
                     log(`
-                        > ! ${content}. You'll need to fund it with a small amount of MATIC tokens.
+                        > ! ${content}. You'll need to fund it with a small amount of POL tokens.
                     `)
                 } else {
                     log(`> ${content}`)
diff --git a/packages/sdk/README.md b/packages/sdk/README.md
@@ -79,7 +79,7 @@ const streamr = new StreamrClient()
 
 ### Creating a stream
 ```js
-// Requires MATIC tokens (Polygon blockchain gas token)
+// Requires POL tokens (Polygon blockchain gas token)
 const stream = await streamr.createStream({
     id: '/foo/bar'
 })
@@ -100,7 +100,7 @@ streamr.subscribe(streamId, (message) => {
 Publishing messages requires your Ethereum account to have permission to publish. See the [stream permission docs](https://docs.streamr.network/usage/streams/permissions) for more information.
 
 ```js
-// Requires MATIC tokens (Polygon blockchain gas token)
+// Requires POL tokens (Polygon blockchain gas token)
 const stream = await streamr.createStream({
     id: '/foo/bar'
 })
