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

chore: update docs #48

Merged
merged 5 commits into from
Jan 19, 2024
Merged

chore: update docs #48

merged 5 commits into from
Jan 19, 2024

Conversation

ashuralyk
Copy link
Contributor

@ashuralyk ashuralyk commented Jan 18, 2024

Description

arrange documentations, and add some debug printings in Spore contract

@ashuralyk
Copy link
Contributor Author

ashuralyk commented Jan 18, 2024

@linnnsss please help check README.md, I feel like it has a big improvement room to describe more accurate

@@ -9,6 +9,7 @@ pub enum Error {
Encoding,

// common
InvalidClusterData,
Copy link
Contributor

Choose a reason for hiding this comment

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

Will error-num change affect spore-sdk?
@ShookLyngs

Copy link
Collaborator

@ShookLyngs ShookLyngs Jan 18, 2024

Choose a reason for hiding this comment

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

Yes it will, because the contracts need to be redeployed.
And then the sdk need to upadte the referenced contracts' info.

Copy link
Contributor Author

@ashuralyk ashuralyk Jan 18, 2024

Choose a reason for hiding this comment

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

slightly changes will influent code hash of contracts, it's a little inconvenient for a minor update, what do you think of we let SDK fetch contract info from a version service?

for example, after I deployed contracts, a version file will be generated automatically in the root dir, and you can just use a url to read from it?

Copy link
Collaborator

Choose a reason for hiding this comment

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

Personally, I believe that hardcoded code hashes can assist in identifying errors returned by RPC.
Maybe this can be seen as a "left hand or right hand" problem, you cannot have both.

Copy link
Contributor Author

@ashuralyk ashuralyk Jan 18, 2024

Choose a reason for hiding this comment

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

make sense, it leads to that we have to be cautious with our version upgrade, it's better to combine some changes to a upgrade package

@ashuralyk ashuralyk force-pushed the chore/deployment-publish branch from 16d1f93 to 430076a Compare January 18, 2024 14:25
@ashuralyk
Copy link
Contributor Author

@ShookLyngs please use contracts deployment information in this PR and update SDK again, current on-chain deployment information isn't the latest one

@ashuralyk ashuralyk merged commit aa7ae61 into master Jan 19, 2024
2 checks passed
@ashuralyk ashuralyk deleted the chore/deployment-publish branch January 19, 2024 06:23
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