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.

Sign up for GitHub

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

Jump to bottom

package: add types definition #61

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

package: add types definition #61

wants to merge 1 commit into from

Conversation

BrianCraig
Copy link
Contributor

Add types defintion for the package

BrianCraig
BrianCraig commented Dec 7, 2021
View reviewed changes
index.d.ts
pubkeyScript: Uint8Array
}

interface Inputs {
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Is this interface correct?

BrianCraig
BrianCraig commented Dec 7, 2021
View reviewed changes
index.d.ts
value: "20000000" // satoshis as a decimal string,
}

type Outputs = OurOutput | TheirsOutput
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Is this correct?

@benma benma self-requested a review December 7, 2021 16:35
@benma
Copy link
Contributor

benma commented Dec 7, 2021

I'll review the types tomorrow or latest Thursday, but in the meantime:

Does this constitute a minor or major version bump? Can this break downstream users of this package when upgrading?

@thisconnect
Copy link
Collaborator

Does this constitute a minor or major version bump? Can this break downstream users of this package when upgrading?

In worst case I assume it could break a CI, better make it a major bump IMO.

@BrianCraig
Copy link
Contributor Author

I'll review the types tomorrow or latest Thursday, but in the meantime:

Does this constitute a minor or major version bump? Can this break downstream users of this package when upgrading?

If we cover all usages, it shouldn't break CI, only where there it is a bad usage.
But something that i don't know is what types does GopherJS understand as a byte[], because we are using Uint8Array, but it may be accepting more than that (does accept number[]?)

@benma
Copy link
Contributor

benma commented Dec 15, 2021

Discussed offline - this PR is paused for a few weeks pending other changes to the package that will impact the types.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@benma benma Awaiting requested review from benma

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@BrianCraig @benma @thisconnect