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

Stop updating old ICRC1 index canister candid #805

Merged
merged 1 commit into from
Jan 6, 2025
Merged

Conversation

dskloetd
Copy link
Collaborator

@dskloetd dskloetd commented Jan 6, 2025

Motivation

The old ICRC1 index canister was deleted in dfinity/ic#3286
This caused the automatic candid update job to fail when it tried to download the candid for this canister:
https://github.com/dfinity/ic-js/actions/runs/12626049412/job/35178612469

I think it will be good to keep the canister in ic-js for backwards compatibility, at least for a while.
But since the canister code is deleted, the candid definitely won't be changing anymore so we can stop automatically updating it.

Changes

Stop updating the candid for the old ICRC1 index canister in scripts/import-candid.

Tests

Ran the script before and after and saw that it started working again.

Todos

  • Add entry to changelog (if necessary).
    not necessary

@dskloetd dskloetd marked this pull request as ready for review January 6, 2025 10:20
@dskloetd dskloetd requested review from a team as code owners January 6, 2025 10:20
@dskloetd dskloetd enabled auto-merge (squash) January 6, 2025 10:21
Copy link
Contributor

github-actions bot commented Jan 6, 2025

size-limit report 📦

Path Size
@dfinity/ckbtc 8.11 KB (0%)
@dfinity/cketh 3.68 KB (0%)
@dfinity/cmc 1.41 KB (0%)
@dfinity/ledger-icrc 4.33 KB (0%)
@dfinity/ledger-icp 15.43 KB (0%)
@dfinity/nns 37.02 KB (0%)
@dfinity/nns-proto 140.98 KB (0%)
@dfinity/sns 16.98 KB (0%)
@dfinity/utils 4.67 KB (0%)
@dfinity/ic-management 3.19 KB (0%)

Copy link
Contributor

@yhabib yhabib left a comment

Choose a reason for hiding this comment

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

Thanks

@dskloetd dskloetd merged commit b744e3b into main Jan 6, 2025
12 checks passed
@dskloetd dskloetd deleted the kloet/index-old branch January 6, 2025 10:52
@peterpeterparker
Copy link
Member

Are you going to clean up the library in other PR(s) as well?

@dskloetd
Copy link
Collaborator Author

dskloetd commented Jan 6, 2025

Are you going to clean up the library in other PR(s) as well?

No, that was not my intention. That's why I wrote this in the PR description:

I think it will be good to keep the canister in ic-js for backwards compatibility, at least for a while.

@peterpeterparker
Copy link
Member

Alright, let's try to not forget about it 😉

@dskloetd
Copy link
Collaborator Author

dskloetd commented Jan 6, 2025

There is no way to know if anyone is still using the old canister so this could potentially continue to be useful to somebody forever...

@peterpeterparker
Copy link
Member

The DID file seems to be used only for implementing get_account_transactions, balance and ledger_id. The definition of both balance and ledger_id is the same in both NG and non-NG versions - i.e. only get_account_transactions is different.

I assume most Index canisters now implement the NG version, notably because get_account_transactions used to support only update calls in its old version. Additionally, most—or perhaps none—meme coins have an Index canister anyway.

Long story short, I agree with you that we can wait a bit before cleaning up the library. That said, I feel it might already be possible to proceed without causing any issues.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants