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

New Tool: Build a Flow SDK [Rust] - Milestone 2 #60

Merged
merged 2 commits into from
Nov 10, 2021
Merged

New Tool: Build a Flow SDK [Rust] - Milestone 2 #60

merged 2 commits into from
Nov 10, 2021

Conversation

fee1-dead
Copy link
Contributor

@fee1-dead fee1-dead commented Oct 10, 2021

This PR is for issue #20.

flow-sdk has met the requirements for Milestone 2.

Submission Links & Documents

See rendered and the flow.rs repository.

User stories checklist:

Blocks - See examples/blocks.rs:

  • retrieve a block by ID
  • retrieve a block by height
  • retrieve the latest block

Collections - See examples/collections.rs:

  • retrieve a collection by ID

Events - See examples/events.rs:

  • retrieve events by name in the block height range

Scripts:

  • submit a script and parse the response - Needs parsing
  • submit a script with arguments and parse the response - Needs parsing

Accounts - See examples/accounts.rs:

  • retrieve an account by address
  • create a new account - A transaction with provided cadence template
  • deploy a new contract to the account - A transaction with provided cadence template
  • remove a contract from the account - A transaction with provided cadence template
  • update an existing contract on the account - A transaction with provided cadence template

Transactions - See examples/transactions.rs:

  • retrieve a transaction by ID - Arguments of the transaction will eventually be parsed or used as plain text only
  • sign a transaction (single payer, proposer, authorizer or combination of multiple)
  • submit a signed transaction
  • sign a transaction with arguments and submit it - Requires Cryptography and Access API - Arguments need to be serialized as Cadence-JSON

Requirements Check

  • Have have you met the milestone requirements? YES
  • Have you included tests (if applicable)? Not yet for this milestone

Other Details

  • Is there anything specific you'd like the PoC to know or review for?
  • Are there other references, documentation, or relevant artificats to mention for this PR (ie. external links to justify design decisions, etc.)?

None at the moment.

@fee1-dead
Copy link
Contributor Author

@sideninja: I just updated the PR description to link to the examples. If you would like to give the examples a try, you can take a look at the project's README for details on how to set the project up.

@sideninja
Copy link
Contributor

Hi @fee1-dead I've finished a first version of docs template, please check it out here https://github.com/onflow/sdks/tree/main/templates/documentation
Try to fill in the blanks in the template and add it to your repo, let me know if you need any help

@kerrywei kerrywei changed the title New Tool: Build a Flow SDK - Milestone 2 New Tool: Build a Flow SDK [Rust] - Milestone 2 Nov 10, 2021
@kerrywei
Copy link

merge in the PR as milestone has been achieved

@kerrywei kerrywei merged commit 7f982b3 into onflow:main Nov 10, 2021
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