chore(bin): rename mm2 binaries to kdf #2126

shamardy · 2024-05-24T12:00:33Z

This PR renames mm2 binaries and libs to kdf

laruh · 2024-05-24T12:20:14Z

Should these paths also be renamed?

shamardy · 2024-05-24T12:24:25Z

Should these paths also be renamed?

Thanks for finding these, I am not sure they are used but will rename them.

borngraced · 2024-05-24T12:30:45Z

What about renaming mm2_* crates name too?

laruh · 2024-05-24T12:37:42Z

What about renaming mm2_* crates name too?

I think it will be a rabbit hole for this pr :D wallet team asked for the binaries at least. But its up to Omer

shamardy · 2024-05-24T12:46:05Z

What about renaming mm2_* crates name too?

We will do the renaming gradually whenever a need for renaming arises, this way we don't create much conflicts in current open PRs.

onur-ozkan

Making this change will break many deployment setups. We should make sure people (specially notary node and our devops people) aware that we are going to rename the binary.

shamardy · 2024-05-24T12:58:23Z

Making this change will break many deployment setups. We should make sure people (specially notary node and our devops people) aware that we are going to rename the binary.

Already informed @KomodoPlatform/qa to update docs and they will be responsible for informing other people. I will include the breaking changes in the release notes too, should we change next release to v3.0.0-beta to follow semantic versioning?

laruh · 2024-05-24T13:03:38Z

should we change next release to v3.0.0-beta to follow semantic versioning

yes, def should do it. as its breaking change and its not stable, then 3 0 0 beta version should be

onur-ozkan · 2024-05-24T13:06:45Z

Providing a copy with mm2 name next to kdf binary would be fine for a while (~3 months). I don't think we should bump the major version just because we renamed the binary (it's breaking change for deployments not the application logic).

laruh · 2024-05-24T13:30:00Z

https://semver.org/#spec-item-8

Major version X (X.y.z | X > 0) MUST be incremented if any backward incompatible changes are introduced to the public API. It MAY also include minor and patch level changes. Patch and minor versions MUST be reset to 0 when major version is incremented.

additional source
https://www.infoq.com/articles/breaking-changes-are-broken-semver/

As I see any breaking changes that can cause existing systems or scripts to fail (changes in binary names, config parameters, or deployment paths, as these can disrupt automated processes and user workflows etc) should be treated as Major version changes.

onur-ozkan · 2024-05-24T13:34:26Z

https://semver.org/#spec-item-8

Major version X (X.y.z | X > 0) MUST be incremented if any backward incompatible changes are introduced to the public API. It MAY also include minor and patch level changes. Patch and minor versions MUST be reset to 0 when major version is incremented.

additional source https://www.infoq.com/articles/breaking-changes-are-broken-semver/

As I see any breaking changes that can cause existing systems or scripts to fail (changes in binary names, config parameters, or deployment paths, as these can disrupt automated processes and user workflows etc) should be treated as Major version changes.

We don't change the API that's the point. With major bump, you want to inform people that you made a breaking change, right? How are we supposed to get the version information? The binary name has been changed :) You version the application, here we don't change the application. As I said, this is breaking change for deployments not application itself.

shamardy · 2024-05-24T14:06:51Z

Providing a copy with mm2 name next to kdf binary would be fine for a while (~3 months)

This is for the release artifacts, right? we don't need to do this in CI, or did you mean that?

shamardy · 2024-05-24T14:10:59Z

As I see any breaking changes that can cause existing systems or scripts to fail (changes in binary names, config parameters, or deployment paths, as these can disrupt automated processes and user workflows etc) should be treated as Major version changes.

That's correct, but I am not sure we need this currently while we are beta, the first stable release will start at 1.0.0 again and then we will need to make sure semver is right with every new release. Usually for our beta version if we made a big change like the p2p network upgrade we would bump the major version indicating a big change otherwise we just bump the minor version.

onur-ozkan · 2024-05-24T14:25:41Z

mm2src/mm2_bin_lib/Cargo.toml

 [[bin]]
-name = "mm2"
+name = "kdf"
 path = "src/mm2_bin.rs"
 test = false
 doctest = false
 bench = false


Providing a copy with mm2 name next to kdf binary would be fine for a while (~3 months)

This is for the release artifacts, right? we don't need to do this in CI, or did you mean that?

For anything (release, CI builds, containers, etc). If you duplicate this [[bin]] block with old name, cargo should produce 2 binaries (mm2 and kdf). I think we don't spend too much time on building the final binary output, so build time should not increase too much.

cargo should produce 2 binaries (mm2 and kdf)

It does that, but I get a warning

warning: /atomicDEX-API/mm2src/mm2_bin_lib/Cargo.toml: file found to be present in multiple build targets: /atomicDEX-API/mm2src/mm2_bin_lib/src/mm2_bin.rs

I will leave it. I can't duplicate the [lib] block so I will leave it as kdflib only. Will work on CI and others now.

For windows, I renamed the exe only to mm2 as the dll should remain kdflib based on the lib name. For wasm, I don't think we can have both kdflib_bg.wasm and mm2lib_bg.wasm without having 2 build crates so I decided to have only one with kdf prefix. For all other targets, we now have 2 binaries.

laruh · 2024-05-26T05:38:19Z

As I see any breaking changes that can cause existing systems or scripts to fail (changes in binary names, config parameters, or deployment paths, as these can disrupt automated processes and user workflows etc) should be treated as Major version changes.

That's correct, but I am not sure we need this currently while we are beta, the first stable release will start at 1.0.0 again and then we will need to make sure semver is right with every new release. Usually for our beta version if we made a big change like the p2p network upgrade we would bump the major version indicating a big change otherwise we just bump the minor version.

So, if I understand you correctly, we will strictly follow the semver rules starting with the "stable" version, and our "beta" allows for some flexibility. This approach is fine with me, since we will be moving to the stable version soon. I don't insist on the current version as long as we have clear rules for the stable releases.

laruh

one question

.docker/Dockerfile.release

onur-ozkan · 2024-05-28T12:10:00Z

.docker/Dockerfile.dev-release

-WORKDIR /mm2
-COPY target/release/mm2 /usr/local/bin/mm2
+WORKDIR /kdf
+COPY target/release/kdf /usr/local/bin/kdf


Let's ship mm2 binary into containers as well:

Suggested change

COPY target/release/kdf /usr/local/bin/kdf

COPY target/release/kdf /usr/local/bin/kdf

COPY target/release/mm2 /usr/local/bin/mm2

laruh · 2024-05-28T12:38:20Z

a1e288c Now we have two Dockerfiles with identical commands

But they are used in diff build.yml 🤔

shamardy · 2024-05-28T13:13:02Z

a1e288c Now we have two Dockerfiles with identical commands

Let's leave them in case we ever need different commands for dev or release.

laruh

LGTM!

shamardy · 2024-07-02T21:24:49Z

@onur-ozkan can you please give this PR another/last review? I will inform the GUI team about the changes before merging so that they are ready.

onur-ozkan

LGTM

cc @smk762 (you may want to be aware of this merge.)

* dev: feat(nft-swap): add standalone maker contract and proxy support (#2100) feat(ETH): add `gas_limit` coins param to override default values (#2137) feat(tendermint): implement better sequence resolving logic (#2164) ci(artifact): add target for macos on apple silicon (#2163) fix(helpers): extend http to ws address conversion (#2166) fix(makerbot): add "testcoin" to provider options (#2161) fix(hd_wallet): make extended pubkey of hd wallet generic (#2159) fix(docker-tests): implement containers runtime directories (#2162) feat(tendermint): improve the `max` handling for tendermint withdraw (#2155) revert #2158 (comment) (#2160) ci(artifacts): upload build artifacts with in-tree script (#2158) test(tendermint): migrate to local/offline containerized testnets (#2128) use easingthemes/ssh-deploy@v5.0.3 for all builds except windows (#2157) chore(bin): rename mm2 binaries to kdf (#2126)

rename mm2 binaries to kdf

4bde2c1

shamardy added the in progress Changes will be made from the author label May 24, 2024

rename mm2 to kdf in some scripts

3b9b575

shamardy added under review and removed in progress Changes will be made from the author labels May 24, 2024

shamardy requested review from onur-ozkan and laruh May 24, 2024 12:47

onur-ozkan reviewed May 24, 2024

View reviewed changes

onur-ozkan added the breaking-change might require breaking backward compatibility label May 24, 2024

onur-ozkan reviewed May 24, 2024

View reviewed changes

build and deploy both mm2 and kdf named bins

92e4b16

shamardy added in progress Changes will be made from the author and removed under review labels May 24, 2024

shamardy added 2 commits May 24, 2024 20:28

add -r (recursive) option to cp command for wasm build jobs

f418593

for wasm provide only kdf named files

d993eb9

shamardy added under review and removed in progress Changes will be made from the author labels May 24, 2024

laruh reviewed May 26, 2024

View reviewed changes

.docker/Dockerfile.release Outdated Show resolved Hide resolved

Update dev-release Dockerfile: replace 'mm2' with 'kdf'

a1e288c

onur-ozkan reviewed May 28, 2024

View reviewed changes

Update releases Dockerfiles: ship mm2 binary into containers as well

fbb227f

laruh approved these changes Jun 17, 2024

View reviewed changes

onur-ozkan approved these changes Jul 3, 2024

View reviewed changes

shamardy merged commit bc8757a into dev Jul 3, 2024
21 of 25 checks passed

shamardy deleted the rename-mm2-bin-kdf branch July 3, 2024 19:49

shamardy mentioned this pull request Jul 25, 2024

Rename mm2 binaries and commands in docs to kdf KomodoPlatform/komodo-docs-mdx#301

Open

shamardy mentioned this pull request Aug 1, 2024

chore(release): v2.1.0-beta #2043

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore(bin): rename mm2 binaries to kdf #2126

chore(bin): rename mm2 binaries to kdf #2126

shamardy commented May 24, 2024

laruh commented May 24, 2024

shamardy commented May 24, 2024

borngraced commented May 24, 2024

laruh commented May 24, 2024

shamardy commented May 24, 2024

onur-ozkan left a comment

shamardy commented May 24, 2024

laruh commented May 24, 2024

onur-ozkan commented May 24, 2024

laruh commented May 24, 2024

onur-ozkan commented May 24, 2024

shamardy commented May 24, 2024

shamardy commented May 24, 2024

onur-ozkan May 24, 2024 •

edited

Loading

shamardy May 24, 2024 •

edited

Loading

shamardy May 24, 2024 •

edited

Loading

laruh commented May 26, 2024 •

edited

Loading

laruh left a comment

onur-ozkan May 28, 2024

shamardy May 28, 2024

laruh commented May 28, 2024

shamardy commented May 28, 2024

laruh left a comment

shamardy commented Jul 2, 2024

onur-ozkan left a comment

	COPY target/release/kdf /usr/local/bin/kdf
	COPY target/release/kdf /usr/local/bin/kdf
	COPY target/release/mm2 /usr/local/bin/mm2

chore(bin): rename mm2 binaries to kdf #2126

chore(bin): rename mm2 binaries to kdf #2126

Conversation

shamardy commented May 24, 2024

laruh commented May 24, 2024

shamardy commented May 24, 2024

borngraced commented May 24, 2024

laruh commented May 24, 2024

shamardy commented May 24, 2024

onur-ozkan left a comment

Choose a reason for hiding this comment

shamardy commented May 24, 2024

laruh commented May 24, 2024

onur-ozkan commented May 24, 2024

laruh commented May 24, 2024

onur-ozkan commented May 24, 2024

shamardy commented May 24, 2024

shamardy commented May 24, 2024

onur-ozkan May 24, 2024 • edited Loading

Choose a reason for hiding this comment

shamardy May 24, 2024 • edited Loading

Choose a reason for hiding this comment

shamardy May 24, 2024 • edited Loading

Choose a reason for hiding this comment

laruh commented May 26, 2024 • edited Loading

laruh left a comment

Choose a reason for hiding this comment

onur-ozkan May 28, 2024

Choose a reason for hiding this comment

shamardy May 28, 2024

Choose a reason for hiding this comment

laruh commented May 28, 2024

shamardy commented May 28, 2024

laruh left a comment

Choose a reason for hiding this comment

shamardy commented Jul 2, 2024

onur-ozkan left a comment

Choose a reason for hiding this comment

onur-ozkan May 24, 2024 •

edited

Loading

shamardy May 24, 2024 •

edited

Loading

shamardy May 24, 2024 •

edited

Loading

laruh commented May 26, 2024 •

edited

Loading