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

Add README for CLI #89

Merged
merged 9 commits into from
Feb 7, 2025
Merged

Add README for CLI #89

merged 9 commits into from
Feb 7, 2025

Conversation

r-near
Copy link
Contributor

@r-near r-near commented Jan 29, 2025

closes #9

@frolvanya frolvanya requested review from kiseln and frolvanya February 4, 2025 05:03
@frolvanya frolvanya marked this pull request as ready for review February 4, 2025 05:03
@frolvanya
Copy link
Contributor

@kiseln This should be good enough for now. Please check docs and tell me if you find something strange or tell me if you think that it's better to provide more examples

bridge-cli testnet near-fin-transfer-with-evm-proof \
--chain eth \
--tx-hash 0xabc...def \
--storage-deposit-actions usdc.near:alice.near:0.1
Copy link
Contributor

Choose a reason for hiding this comment

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

Wonder if deposits need to be expanded upon

Copy link
Contributor

Choose a reason for hiding this comment

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

We can provide multiple actions in this format: token_id1:account_id1:amount1,token_id2:account_id2:amount2,...

Copy link
Contributor

Choose a reason for hiding this comment

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

We also need to explain which accounts should be the recipients of the storage deposit

bridge-cli/README.md Outdated Show resolved Hide resolved
bridge-cli/README.md Show resolved Hide resolved
bridge-cli/README.md Outdated Show resolved Hide resolved
bridge-cli/README.md Outdated Show resolved Hide resolved
bridge-cli/README.md Outdated Show resolved Hide resolved
@r-near r-near requested review from frolvanya and removed request for frolvanya February 6, 2025 19:58
@frolvanya frolvanya requested a review from kiseln February 6, 2025 22:57
Copy link
Contributor

@kiseln kiseln left a comment

Choose a reason for hiding this comment

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

Looks good now

@kiseln kiseln merged commit bcbaa4f into main Feb 7, 2025
10 checks passed
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.

[OmniBridge]: add documentation for bridge cli&sdk
3 participants