freeWithdraw -> !payForTransport

One is the property of the bridge, one is the property of the function call, it's like the opposite angle of looking at it.

But I'll still change it so that the name is the same. So freeWithdraw -> !payForTransport everywhere. It's better that way.

Author: jtakalai

README.md

@@ -360,11 +360,11 @@ const dataUnion = client.getDataUnion(dataUnionAddress)
 <!-- This stuff REALLY isn't for those who use our infrastructure, neither DU admins nor DU client devs. It's only relevant if you're setting up your own sidechain.
 These DataUnion-specific options can be given to `new StreamrClient` options:
 
-| Property                            | Default                                                | Description                                                                                                      |
-| :---------------------------------- | :----------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------- |
-| dataUnion.minimumWithdrawTokenWei   | 1000000                                                | Threshold value set in AMB configs, smallest token amount that can pass over the bridge                          |
-| dataUnion.freeWithdraw              | false                                                  | true = someone else pays for the gas when transporting the withdraw tx to mainnet |
-|                                     |                                                        | false = client does the transport as self-service and pays the mainnet gas costs |
+| Property                            | Default                                                | Description                                                                                |
+| :---------------------------------- | :----------------------------------------------------- | :----------------------------------------------------------------------------------------- |
+| dataUnion.minimumWithdrawTokenWei   | 1000000                                                | Threshold value set in AMB configs, smallest token amount that can pass over the bridge    |
+| dataUnion.payForTransport           | true                                                   | true = client does the transport as self-service and pays the mainnet gas costs            |
+|                                     |                                                        | false = someone else pays for the gas when transporting the withdraw tx to mainnet         |
 -->
 
 ### Admin Functions

src/Config.ts

@@ -65,7 +65,7 @@ export type StrictStreamrClientOptions = {
          * otherwise the client does the transport as self-service and pays the mainnet gas costs
          */
         minimumWithdrawTokenWei: BigNumber|number|string
-        freeWithdraw: boolean
+        payForTransport: boolean
         factoryMainnetAddress: EthereumAddress
         factorySidechainAddress: EthereumAddress
         templateMainnetAddress: EthereumAddress
@@ -137,7 +137,7 @@ export const STREAM_CLIENT_DEFAULTS: StrictStreamrClientOptions = {
     tokenSidechainAddress: '0xE4a2620edE1058D61BEe5F45F6414314fdf10548',
     dataUnion: {
         minimumWithdrawTokenWei: '1000000',
-        freeWithdraw: false,
+        payForTransport: true,
         factoryMainnetAddress: '0x7d55f9981d4E10A193314E001b96f72FCc901e40',
         factorySidechainAddress: '0x1b55587Beea0b5Bc96Bb2ADa56bD692870522e9f',
         templateMainnetAddress: '0x5FE790E3751dd775Cb92e9086Acd34a2adeB8C7b',

src/dataunion/DataUnion.ts

@@ -606,8 +606,8 @@ export class DataUnion {
         const {
             pollingIntervalMs = 1000,
             retryTimeoutMs = 300000,
-            // by default, transport the signatures if freeWithdraw isn't supported by the sidechain
-            payForTransport = !this.client.options.dataUnion.freeWithdraw,
+            // by default, transport the signatures if payForTransport=false isn't supported by the sidechain
+            payForTransport = this.client.options.dataUnion.payForTransport,
             waitUntilTransportIsComplete = true,
             sendToMainnet = true,
         } = options
@@ -637,8 +637,8 @@ export class DataUnion {
 
         const messageHash = ambHashes[0]
 
+        // expect someone else to do the transport for us
         if (!payForTransport) {
-            // expect someone else to do the transport for us (corresponds to dataUnion.freeWithdraw=true)
             if (waitUntilTransportIsComplete) {
                 log(`Waiting for balance=${balanceBefore.toString()} change (poll every ${pollingIntervalMs}ms, timeout after ${retryTimeoutMs}ms)`)
                 await until(async () => !(await getBalanceFunc()).eq(balanceBefore), retryTimeoutMs, pollingIntervalMs).catch((e) => {
@@ -648,7 +648,7 @@ export class DataUnion {
                 return null
             }
 
-            // instead of waiting, hand out the messageHash so that someone else might do the transport using it
+            // instead of waiting, hand out the messageHash so that we can pass it on to that who does the transportMessage(messageHash)
             return messageHash
         }