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 - Milestone 1 #47

Merged
merged 1 commit into from
Oct 3, 2021
Merged

Conversation

nduplessis
Copy link
Contributor

@nduplessis nduplessis commented Sep 28, 2021

New Tool: Build a Flow SDK - Milestone 1

Description

This PR is for issue #20.

This version of the Ruby SDK provides gRPC communication and a number of the SDK user stories, including script execution and single sig transaction signing and sending.

Usage documentation is available at https://github.com/glucode/flow_client

Features:

Blocks:

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

Collections:

  • retrieve a collection by ID

Events:

  • retrieve events by name in the block height range

Scripts:

  • submit a script and parse the response
  • submit a script with arguments and parse the response

Accounts:

  • retrieve an account by address
  • create a new account
  • deploy a new contract to the account
  • remove a contract from the account
  • update an existing contract on the account

Transactions:

  • retrieve a transaction by ID
  • sign a transaction (single payer, proposer, authorizer or combination of multiple)
  • submit a signed transaction
  • sign a transaction with arguments and submit it

Milestones

  • 1: Implement the gRPC layer of the SDK, allowing communication with the Flow blockchain
  • 2: Accomplish transaction signing in a way that handles the complex algorithm / hashing / encoding for the user.
  • 3: Meet and exceed Flow SDK guidelines
  • 4: Complete documentation and common usage examples are available

@nduplessis nduplessis changed the title [New Tool: Build a Flow SDK] - Milestone 1 New Tool: Build a Flow SDK - Milestone 1 Sep 28, 2021
@psiemens psiemens requested a review from sideninja September 28, 2021 15:28
Copy link
Contributor

@sideninja sideninja left a comment

Choose a reason for hiding this comment

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

LGTM 🚀 good work. Just a flag before you start documentation I will provide some guidance on that part so it will be easier for you to accomplish that.

@psiemens psiemens merged commit 541aded into onflow:main Oct 3, 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