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

chore: docs for marmalade client utils #2234

Merged
merged 4 commits into from
Aug 29, 2024
Merged

chore: docs for marmalade client utils #2234

merged 4 commits into from
Aug 29, 2024

Conversation

wooglie
Copy link
Member

@wooglie wooglie commented Jun 5, 2024

Wrote the documentation of marmalade client-utils to showcase how to use all the different functions

@vercel Vercel
Copy link

vercel bot commented Jun 5, 2024 •
edited

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
dev-wallet ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 14, 2024 10:13am
explorer ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 14, 2024 10:13am
kadena-js-marmalade-marketplace ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 14, 2024 10:13am
marmalade-marketplace ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 14, 2024 10:13am
proof-of-us ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 14, 2024 10:13am
tools ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 14, 2024 10:13am
2 Ignored Deployments
Name Status Preview Comments Updated (UTC)
alpha-docs ⬜️ Ignored (Inspect) Visit Preview 💬 Add feedback Jun 14, 2024 10:13am
react-ui ⬜️ Ignored (Inspect) Visit Preview Jun 14, 2024 10:13am

@changeset-bot changeset-bot
Copy link

changeset-bot bot commented Jun 5, 2024 •
edited

⚠️ No Changeset found

Latest commit: bdfb0b0

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

lsgunnlsgunn
lsgunnlsgunn approved these changes Jun 12, 2024
View reviewed changes
Copy link
Contributor

@lsgunnlsgunn lsgunnlsgunn left a comment

Choose a reason for hiding this comment

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

Mostly just bumping things up a level and some wording suggestions.
I didn't go through all of the tables in this PR.

packages/libs/client-utils/src/marmalade/README.md Outdated Show resolved Hide resolved
packages/libs/client-utils/src/marmalade/README.md Outdated Show resolved Hide resolved
packages/libs/client-utils/src/marmalade/README.md Outdated Show resolved Hide resolved
packages/libs/client-utils/src/marmalade/README.md Outdated Show resolved Hide resolved
packages/libs/client-utils/src/marmalade/README.md Outdated Show resolved Hide resolved
packages/libs/client-utils/src/marmalade/README.md Outdated
boolean
```

#### Example
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
#### Example
### Example

packages/libs/client-utils/src/marmalade/README.md Outdated
Comment on lines 1338 to 1341

### Withdraw Token

The `withdrawToken` function allows a seller to withdraw a token from a sale.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
### Withdraw Token
The `withdrawToken` function allows a seller to withdraw a token from a sale.
## withdrawToken
Use `withdrawToken` to withdraw a specified token from a sale.

packages/libs/client-utils/src/marmalade/README.md Outdated
withdrawToken(inputs, config): IEmitterWrapper
```

#### Inputs
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
#### Inputs
### Inputs

packages/libs/client-utils/src/marmalade/README.md Outdated
| seller | object | seller account with guard |
| chainId | ChainId | origin |

#### Output
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
#### Output
### Output

packages/libs/client-utils/src/marmalade/README.md Outdated
boolean
```

#### Example
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
#### Example
### Example

lsgunnlsgunn
lsgunnlsgunn approved these changes Jun 12, 2024
View reviewed changes
packages/libs/client-utils/src/marmalade/README.md Outdated Show resolved Hide resolved
packages/libs/client-utils/src/marmalade/README.md Outdated Show resolved Hide resolved
packages/libs/client-utils/src/marmalade/README.md Outdated Show resolved Hide resolved
@github-actions GitHub Actions
Copy link
Contributor

This PR is stale because it is open for 60 days with no activity

@Randynamic Randynamic merged commit 8e70e80 into main Aug 29, 2024
17 checks passed
@Randynamic Randynamic deleted the chore/docs-for-marmalade-client-utils branch August 29, 2024 13:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Randynamic Randynamic Randynamic approved these changes

@lsgunnlsgunn lsgunnlsgunn lsgunnlsgunn approved these changes

@alber70g alber70g Awaiting requested review from alber70g

@javadkh2 javadkh2 Awaiting requested review from javadkh2

@jessevanmuijden jessevanmuijden Awaiting requested review from jessevanmuijden

@jermaine150 jermaine150 Awaiting requested review from jermaine150

@ggobugi27 ggobugi27 Awaiting requested review from ggobugi27

Assignees
No one assigned
Labels
no-pr-activity
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@wooglie @Randynamic @lsgunnlsgunn