transportSignature -> payForTransport

because the method to do it is transportMessage and that's really all it means, so either it should be the SAME name, or else a bit more descriptive

Author: jtakalai

README.md

@@ -442,7 +442,7 @@ const receipt = await dataUnion.withdrawAllToSigned(memberAddress, recipientAddr
 The `messageHash` argument to `transportMessage` will come from the withdraw function with the specific options. The following is equivalent to the above withdraw line:
 ```js
 const messageHash = await dataUnion.withdrawAllToSigned(memberAddress, recipientAddress, signature, {
-    transportSignatures: false,
+    payForTransport: false,
     waitUntilTransportIsComplete: false,
 }) // only pay for sidechain gas
 const receipt = await dataUnion.transportMessage(messageHash) // only pay for mainnet gas
@@ -477,7 +477,7 @@ The functions `withdrawAll`, `withdrawAllTo`, `withdrawAllToMember`, `withdrawAl
 | Name              | Default               | Description                                                                           |
 | :---------------- | :-------------------- | :----------------------------------------------------------------------------------   |
 | sendToMainnet     | true                  | Whether to send the withdrawn DATA tokens to mainnet address (or sidechain address)   |
-| transportSignatures | true                | Whether to pay for the withdraw transaction signature transport to mainnet over the bridge |
+| payForTransport   | true                  | Whether to pay for the withdraw transaction signature transport to mainnet over the bridge |
 | waitUntilTransportIsComplete | true       | Whether to wait until the withdrawn DATA tokens are visible in mainnet                |
 | pollingIntervalMs | 1000 (1 second)  | How often requests are sent to find out if the withdraw has completed                 |
 | retryTimeoutMs    | 60000 (1 minute) | When to give up when waiting for the withdraw to complete                             |

src/dataunion/DataUnion.ts

@@ -39,7 +39,7 @@ export interface JoinResponse {
 export interface DataUnionWithdrawOptions {
     pollingIntervalMs?: number
     retryTimeoutMs?: number
-    transportSignatures?: boolean
+    payForTransport?: boolean
     waitUntilTransportIsComplete?: boolean
     sendToMainnet?: boolean
 }
@@ -144,7 +144,7 @@ export class DataUnion {
     /**
      * Withdraw all your earnings
      * @returns the sidechain withdraw transaction receipt IF called with sendToMainnet=false,
-     *          ELSE the message hash IF called with transportSignatures=false and waitUntilTransportIsComplete=false,
+     *          ELSE the message hash IF called with payForTransport=false and waitUntilTransportIsComplete=false,
      *          ELSE the mainnet AMB signature execution transaction receipt IF we did the transport ourselves,
      *          ELSE null IF transport to mainnet was done by someone else (in which case the receipt is lost)
      */
@@ -181,7 +181,7 @@ export class DataUnion {
     /**
      * Withdraw earnings and "donate" them to the given address
      * @returns the sidechain withdraw transaction receipt IF called with sendToMainnet=false,
-     *          ELSE the message hash IF called with transportSignatures=false and waitUntilTransportIsComplete=false,
+     *          ELSE the message hash IF called with payForTransport=false and waitUntilTransportIsComplete=false,
      *          ELSE the mainnet AMB signature execution transaction receipt IF we did the transport ourselves,
      *          ELSE null IF transport to mainnet was done by someone else (in which case the receipt is lost)
      */
@@ -410,7 +410,7 @@ export class DataUnion {
      * TODO: add test
      * @param memberAddress - the other member who gets their tokens out of the Data Union
      * @returns the sidechain withdraw transaction receipt IF called with sendToMainnet=false,
-     *          ELSE the message hash IF called with transportSignatures=false and waitUntilTransportIsComplete=false,
+     *          ELSE the message hash IF called with payForTransport=false and waitUntilTransportIsComplete=false,
      *          ELSE the mainnet AMB signature execution transaction receipt IF we did the transport ourselves,
      *          ELSE null IF transport to mainnet was done by someone else (in which case the receipt is lost)
      */
@@ -443,7 +443,7 @@ export class DataUnion {
      * @param recipientAddress - the address to receive the tokens in mainnet
      * @param signature - from member, produced using signWithdrawAllTo
      * @returns the sidechain withdraw transaction receipt IF called with sendToMainnet=false,
-     *          ELSE the message hash IF called with transportSignatures=false and waitUntilTransportIsComplete=false,
+     *          ELSE the message hash IF called with payForTransport=false and waitUntilTransportIsComplete=false,
      *          ELSE the mainnet AMB signature execution transaction receipt IF we did the transport ourselves,
      *          ELSE null IF transport to mainnet was done by someone else (in which case the receipt is lost)
      */
@@ -578,7 +578,7 @@ export class DataUnion {
      * Template for withdraw functions
      * @private
      * @returns the sidechain withdraw transaction receipt IF called with sendToMainnet=false,
-     *          ELSE the message hash IF called with transportSignatures=false and waitUntilTransportIsComplete=false,
+     *          ELSE the message hash IF called with payForTransport=false and waitUntilTransportIsComplete=false,
      *          ELSE the mainnet AMB signature execution transaction receipt IF we did the transport ourselves,
      *          ELSE null IF transport to mainnet was done by someone else (in which case the receipt is lost)
      */
@@ -591,7 +591,7 @@ export class DataUnion {
             pollingIntervalMs = 1000,
             retryTimeoutMs = 60000,
             // by default, transport the signatures if freeWithdraw isn't supported by the sidechain
-            transportSignatures = !this.client.options.dataUnion.freeWithdraw,
+            payForTransport = !this.client.options.dataUnion.freeWithdraw,
             waitUntilTransportIsComplete = true,
             sendToMainnet = true,
         } = options
@@ -621,7 +621,7 @@ export class DataUnion {
 
         const messageHash = ambHashes[0]
 
-        if (!transportSignatures) {
+        if (!payForTransport) {
             // expect someone else to do the transport for us (corresponds to dataUnion.freeWithdraw=true)
             if (waitUntilTransportIsComplete) {
                 log(`Waiting for balance ${balanceBefore.toString()} to change`)