(chore): update developer documentation #25

Jipperism · 2024-12-14T17:31:18Z

Updates developer documentation for contributing to the sdk.
Updates developer documentation for consuming the SDK.
Removes redundant references to env vars.
Removes redundant references to outdated package manager yarn.
Updates typedoc version and configuration to include handwritten guides in the generated docs.
Removes outdated github templates.
Updates JSDoc annotations.
Bump version number.

.vscode/settings.json

CONTRIBUTING.md

doc/_media/cancelOrders.md

pheuberger

Looks like you're not only removing old code, but also bumping the version number and changing some magic number. I would advocate for even more granular commits, because I don't know why you're doing any of that (except the version bump).

pheuberger

Great stuff. Thank you so much for making this! It's mostly just nits and a couple of clarifying questions from my side. Being new to the project, I have big gaps in my knowledge and understanding which shows in my questions. Feel free to not elaborate on some of them if you think they're just too preposterous to cover hehe.

Please also don't be put off by the amount of comments. I was very thorough and highlighted very minor things. Generally this is great!

src/utils/api.ts

.gitignore

README.md

guides/orderValidity.md

src/HypercertExchangeClient.ts

src/utils/api.ts

typedoc.json

Jipperism · 2024-12-26T14:13:20Z

@pheuberger Had a look at all the comments and implemented the feedback. Please close all conversations on the PR that you consider resolved.

Looks like you're not only removing old code, but also bumping the version number and changing some magic number. I would advocate for even more granular commits, because I don't know why you're doing any of that (except the version bump).

I updated the git commit description for fe6ed4b, hopefully that makes things clearer. I think splitting this up in more granular commits would also entail purposely releasing broken versions to NPM, as each commit would require a version bump (otherwise we have version on github that don't exist on NPM)? I can see both sides of the story but maybe that's not necessary for now, let me know what you think.

README.md

guides/cancelOrders.md

typedoc.json

pheuberger · 2025-01-03T12:00:40Z

@pheuberger Had a look at all the comments and implemented the feedback. Please close all conversations on the PR that you consider resolved.

Looks like you're not only removing old code, but also bumping the version number and changing some magic number. I would advocate for even more granular commits, because I don't know why you're doing any of that (except the version bump).

I updated the git commit description for fe6ed4b, hopefully that makes things clearer. I think splitting this up in more granular commits would also entail purposely releasing broken versions to NPM, as each commit would require a version bump (otherwise we have version on github that don't exist on NPM)? I can see both sides of the story but maybe that's not necessary for now, let me know what you think.

Thank you, @Jipperism! I closed all the conversations that are implemented/answered :)

Can you explain why we would need to release broken versions to NPM? Not every commit needs to be a release, nor have a version bump, unless I'm missing something?

README.md

LICENSE.md

README.md

guides/cancelOrders.md

bitbeckers · 2025-02-04T11:48:56Z

guides/createFractionalSaleMakerAsk.md

+const order = await hypercertExchangeClient.createFractionalSaleMakerAsk({
+  startTime: Date.now() / 1000, // Use it to create an order that will be valid in the future (Optional, Default to now)
+  endTime: Date.now() / 1000 + 60 * 60, // If you use a timestamp in ms, the function will revert (this order will be valid for one hour)
+  price: '10', // Note that this is the price per hypercert unit in wei


There's also documentation on this on the specific strategy contract. It might be good to explain here what the strategy does

guides/executeTrade.md

src/HypercertExchangeClient.ts

src/utils/api.ts

README.md

guides/cancelOrders.md

src/HypercertExchangeClient.ts

src/utils/calls/nonces.ts

guides/faq.md

guides/createMakerAsk.md

guides/createFractionalSaleMakerAsk.md

guides/createDirectFractionsSaleMakerAsk.md

bitbeckers · 2025-02-07T17:48:36Z

As you've release 0.4.0 that'd also need to be merged in here since this PR also influences business logic

Jipperism · 2025-02-11T19:38:49Z

@bitbeckers has been updated to incorporate changes from 0.4.0

Updates outdated strategy IDs. As we aren't using hypercertFractionAllowlist strategy currently, it wasn't noticed that it's outdated. This fixes that already for when we decide to start using it. Removes outdated code that's related to: - Batch transfers - Subset nonces - Remove amounts argument when creating a makerask, as in the case of hypercerts it will always be an array of 1's. - Bump version number

Updates developer documentation for contributing to the sdk. Updates developer documentation for consuming the SDK. Removes redundant references to env vars. Removes redundant references to outdated package manager yarn. Updates typedoc version and configuration to include handwritten guides in the generated docs. Removes outdated github templates. Updates JSDoc annotations.

Jipperism mentioned this pull request Dec 14, 2024

(chore): update developer documentation #24

Closed

Jipperism self-assigned this Dec 14, 2024

Jipperism requested review from pheuberger and bitbeckers December 14, 2024 17:32

Jipperism force-pushed the feature/developer-docs branch 4 times, most recently from b1c8fa0 to aff056d Compare December 14, 2024 17:48

bitbeckers requested changes Dec 16, 2024

View reviewed changes

.vscode/settings.json Outdated Show resolved Hide resolved

CONTRIBUTING.md Outdated Show resolved Hide resolved

CONTRIBUTING.md Outdated Show resolved Hide resolved

doc/_media/cancelOrders.md Outdated Show resolved Hide resolved

Jipperism force-pushed the feature/developer-docs branch 20 times, most recently from f37c9fe to c75bfff Compare December 19, 2024 13:44

pheuberger reviewed Dec 19, 2024

View reviewed changes

Jipperism force-pushed the feature/developer-docs branch from c75bfff to cbc28cc Compare December 26, 2024 14:08

pheuberger reviewed Jan 3, 2025

View reviewed changes

README.md Outdated Show resolved Hide resolved

README.md Show resolved Hide resolved

guides/cancelOrders.md Show resolved Hide resolved

pheuberger reviewed Jan 3, 2025

View reviewed changes

typedoc.json Outdated Show resolved Hide resolved

pheuberger reviewed Jan 22, 2025

View reviewed changes

README.md Outdated Show resolved Hide resolved

bitbeckers reviewed Feb 4, 2025

View reviewed changes

Jipperism force-pushed the feature/developer-docs branch 2 times, most recently from b42a8b8 to 832b15b Compare February 6, 2025 13:49

bitbeckers mentioned this pull request Feb 6, 2025

Cleanup last supabase types #29

Closed

Jipperism force-pushed the feature/developer-docs branch 2 times, most recently from 363f313 to a4c2d96 Compare February 6, 2025 14:05

bitbeckers requested changes Feb 6, 2025

View reviewed changes

Jipperism force-pushed the feature/developer-docs branch 2 times, most recently from f5ceb97 to f72ab83 Compare February 6, 2025 15:10

Jipperism force-pushed the feature/developer-docs branch 2 times, most recently from 8656be9 to b0eb32e Compare February 10, 2025 15:50

Jipperism mentioned this pull request Feb 11, 2025

Get tests to run #30

Open

Jipperism force-pushed the feature/developer-docs branch from b0eb32e to b702a1a Compare February 11, 2025 19:37

Jipperism added 4 commits February 11, 2025 16:39

chore: bump version number

09fb3e2

(chore): update gitignore to include vscode configuration files

853c46f

Jipperism force-pushed the feature/developer-docs branch from b702a1a to 853c46f Compare February 11, 2025 19:39

bitbeckers approved these changes Feb 12, 2025

View reviewed changes

chore: remove guides as they will be in hypercerts-org repo

1e46062

Jipperism merged commit 5b36795 into main Feb 12, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

(chore): update developer documentation #25

(chore): update developer documentation #25

Jipperism commented Dec 14, 2024 •

edited

Loading

pheuberger left a comment

pheuberger left a comment •

edited

Loading

Jipperism commented Dec 26, 2024

pheuberger commented Jan 3, 2025 •

edited

Loading

bitbeckers Feb 4, 2025

bitbeckers commented Feb 7, 2025

Jipperism commented Feb 11, 2025 •

edited

Loading

(chore): update developer documentation #25

(chore): update developer documentation #25

Conversation

Jipperism commented Dec 14, 2024 • edited Loading

pheuberger left a comment

Choose a reason for hiding this comment

pheuberger left a comment • edited Loading

Choose a reason for hiding this comment

Jipperism commented Dec 26, 2024

pheuberger commented Jan 3, 2025 • edited Loading

bitbeckers Feb 4, 2025

Choose a reason for hiding this comment

bitbeckers commented Feb 7, 2025

Jipperism commented Feb 11, 2025 • edited Loading

Jipperism commented Dec 14, 2024 •

edited

Loading

pheuberger left a comment •

edited

Loading

pheuberger commented Jan 3, 2025 •

edited

Loading

Jipperism commented Feb 11, 2025 •

edited

Loading