Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename methods and error messages #251

Merged
merged 2 commits into from
Aug 30, 2022
Merged

Rename methods and error messages #251

merged 2 commits into from
Aug 30, 2022

Conversation

germartinez
Copy link
Member

What it solves

Taking advantage of the next mayor release, this PR:

  • Renames methods that return a Safe transaction that modifies the Safe settings.
    Example: const safeTx = getAddOwnerTx(...) -> const safeTx = createAddOwnerTx(...)
  • Renames contract names in error messages
    Example: Error: [...] Multi Send contract [...] -> Error: [...] MultiSend contract [...]
  • Updates tests and documentation accordingly

@germartinez germartinez requested a review from iamacook August 30, 2022 11:26
@github-actions
Copy link

CLA Assistant Lite All Contributors have signed the CLA.

@@ -651,12 +651,12 @@ const txHash = await safeSdk.getTransactionHash(safeTransaction)
const owners = await safeSdk.getOwnersWhoApprovedTx(txHash)
```

### getEnableModuleTx
### createEnableModuleTx
Copy link
Member

@iamacook iamacook Aug 30, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we format these? i.e.

Suggested change
### createEnableModuleTx
### `createEnableModuleTx`

Copy link
Member Author

@germartinez germartinez Aug 30, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm personally not a fan of using `` in titles like these from the visuals perspective. I found ENS is doing it this way, but also not sure which one is better. I think I prefer to keep the method names as they are, all together.
WDYT?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, let's keep them as is.

@germartinez germartinez merged commit 4616793 into development Aug 30, 2022
@germartinez germartinez deleted the renaming branch August 30, 2022 14:07
@github-actions github-actions bot locked and limited conversation to collaborators Aug 30, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants