READMEs docs #99
READMEs docs #99
Conversation
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the WalkthroughThe changes encompass textual updates and structural reorganizations across several README files and a Kotlin source file. Enhancements include corrected typographical errors, expanded sections for clarity, and improved navigation features. Notably, the documentation now provides detailed guidance on SDK functionalities, while code examples and integration instructions have been elaborated. The updates aim to enhance usability and accessibility for developers using the Flow JVM SDK. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant FlowSDK
participant FlowEmulator
participant API
User->>FlowSDK: Request transaction result
FlowSDK->>API: Get transaction result by ID
API-->>FlowSDK: Return transaction result
FlowSDK-->>User: Provide transaction result
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Caution
Inline review comments failed to post
Actionable comments posted: 2
Outside diff range, codebase verification and nitpick comments (2)
java-example/README.md (1)
35-112: LGTM!The new "Examples summary" section is a valuable addition that enhances the usability and accessibility of the documentation. The categorization and links to the code files make it easier for users to understand and implement specific functionalities.
Consider addressing the following minor issues to further improve the documentation:
The heading level for "Get Blocks" (line 39) should be changed from h4 to h3 to maintain consistent heading increments throughout the document.
The phrases "Get transaction" (line 75), "Send transaction" (line 82), and "Multiple parties" (line 110) are duplicated. Consider rewording these lines to avoid repetition.
The sentences starting with "Get" (lines 43, 51, 59) and "Execute" (line 89) are repeated three times in succession. Consider rewording these sentences or using synonyms to improve readability.
Tools
LanguageTool
[style] ~43-~43: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ock/GetBlockAccessAPIConnector.java) - Get the latest sealed block - Get block by ...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~51-~51: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...t/GetAccountAccessAPIConnector.java) - Get account balance - Get account from the ...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~59-~59: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ent/GetEventAccessAPIConnector.java) - Get events for height range - Get events fo...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~67-~67: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ollectionAccessAPIConnector.java) #### Get Network Parameters [Get the current ne...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[grammar] ~75-~75: This phrase is duplicated. You should probably use “Get transaction” only once.
Context: ...tTransactionAccessAPIConnector.java) - Get transaction - Get transaction result #### Sending Transactions [Sen...(PHRASE_REPETITION)
[grammar] ~82-~82: This phrase is duplicated. You should probably use “Send transaction” only once.
Context: ...saction/SendTransactionExample.java) - Send transaction - Send transaction with arguments #### Execute Script [E...(PHRASE_REPETITION)
[style] ~89-~89: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...xecuteScriptAccessAPIConnector.java) - Execute a simple Cadence script - Execute a mor...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[grammar] ~110-~110: This phrase is duplicated. You should probably use “Multiple parties” only once.
Context: ...e - Single party, multiple signatures - Multiple parties - Multiple parties, 2 authorizers - Multiple parties, mult...(PHRASE_REPETITION)
Markdownlint
39-39: Expected: h3; Actual: h4
Heading levels should only increment by one level at a time(MD001, heading-increment)
README.md (1)
31-33: Suggestion: Use the conventional spelling "submodules".The static analysis tool LanguageTool correctly points out that "sub-modules" is normally spelled as one word.
Consider applying this change:
-The common utils module contains resources shared across all 3 above sub-modules, such as Cadence scripts and testing infrastructure. +The common utils module contains resources shared across all 3 above submodules, such as Cadence scripts and testing infrastructure.Tools
LanguageTool
[misspelling] ~32-~32: This word is normally spelled as one.
Context: ...ins resources shared across all 3 above sub-modules, such as Cadence scripts and testing in...(EN_COMPOUNDS_SUB_MODULES)
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (5)
- README.md (2 hunks)
- java-example/README.md (1 hunks)
- kotlin-example/README.md (1 hunks)
- kotlin-example/src/main/kotlin/org/onflow/examples/kotlin/getEvent/GetEventAccessAPIConnector.kt (1 hunks)
- sdk/README.md (2 hunks)
Files skipped from review due to trivial changes (1)
- kotlin-example/src/main/kotlin/org/onflow/examples/kotlin/getEvent/GetEventAccessAPIConnector.kt
Additional context used
LanguageTool
java-example/README.md
[duplication] ~8-~8: Possible typo: you repeated a word
Context: ...allation](#installation) - Running the examples - Examples summary - [Get bl...(ENGLISH_WORD_REPEAT_RULE)
[style] ~43-~43: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ock/GetBlockAccessAPIConnector.java) - Get the latest sealed block - Get block by ...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~51-~51: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...t/GetAccountAccessAPIConnector.java) - Get account balance - Get account from the ...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~59-~59: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ent/GetEventAccessAPIConnector.java) - Get events for height range - Get events fo...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~67-~67: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ollectionAccessAPIConnector.java) #### Get Network Parameters [Get the current ne...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[grammar] ~75-~75: This phrase is duplicated. You should probably use “Get transaction” only once.
Context: ...tTransactionAccessAPIConnector.java) - Get transaction - Get transaction result #### Sending Transactions [Sen...(PHRASE_REPETITION)
[grammar] ~82-~82: This phrase is duplicated. You should probably use “Send transaction” only once.
Context: ...saction/SendTransactionExample.java) - Send transaction - Send transaction with arguments #### Execute Script [E...(PHRASE_REPETITION)
[style] ~89-~89: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...xecuteScriptAccessAPIConnector.java) - Execute a simple Cadence script - Execute a mor...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[grammar] ~110-~110: This phrase is duplicated. You should probably use “Multiple parties” only once.
Context: ...e - Single party, multiple signatures - Multiple parties - Multiple parties, 2 authorizers - Multiple parties, mult...(PHRASE_REPETITION)
sdk/README.md
[style] ~155-~155: Style-wise, it’s not ideal to insert an adverb (‘automatically’) in the middle of an infinitive construction (‘to create’). Try moving the adverb to avoid split infinitives.
Context: ...ount credentials -@FlowTestAccount- used to automatically create an account in the emulator and inject a `TestAccou...(SPLIT_INFINITIVE)
kotlin-example/README.md
[duplication] ~8-~8: Possible typo: you repeated a word
Context: ...allation](#installation) - Running the examples - Examples summary - [Get ...(ENGLISH_WORD_REPEAT_RULE)
[style] ~43-~43: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...Block/GetBlockAccessAPIConnector.kt) - Get the latest sealed block - Get block by ...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~51-~51: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...unt/GetAccountAccessAPIConnector.kt) - Get account balance - Get account from the ...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~59-~59: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...Event/GetEventAccessAPIConnector.kt) - Get events for height range - Get events fo...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~67-~67: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...tCollectionAccessAPIConnector.kt) #### Get Network Parameters [Get the current ne...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[grammar] ~75-~75: This phrase is duplicated. You should probably use “Get transaction” only once.
Context: ...GetTransactionAccessAPIConnector.kt) - Get transaction - Get transaction result #### Sending Transactions [Sen...(PHRASE_REPETITION)
[grammar] ~82-~82: This phrase is duplicated. You should probably use “Send transaction” only once.
Context: ...ansaction/SendTransactionExample.kt) - Send transaction - Send transaction with arguments #### Execute Script [E...(PHRASE_REPETITION)
[style] ~89-~89: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: .../ExecuteScriptAccessAPIConnector.kt) - Execute a simple Cadence script - Execute a mor...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[grammar] ~110-~110: This phrase is duplicated. You should probably use “Multiple parties” only once.
Context: ...e - Single party, multiple signatures - Multiple parties - Multiple parties, 2 authorizers - Multiple parties, mult...(PHRASE_REPETITION)
README.md
[misspelling] ~32-~32: This word is normally spelled as one.
Context: ...ins resources shared across all 3 above sub-modules, such as Cadence scripts and testing in...(EN_COMPOUNDS_SUB_MODULES)
[grammar] ~137-~137: This phrase is duplicated. You should probably use “Multiple parties” only once.
Context: ...e - Single party, multiple signatures - Multiple parties - Multiple parties, 2 authorizers - Multiple parties, mult...(PHRASE_REPETITION)
[uncategorized] ~170-~170: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...TED- The transaction has been executed but the result has not yet been sealed.SE...(COMMA_COMPOUND_SENTENCE_2)
[uncategorized] ~171-~171: Use a comma before “and” if it connects two independent clauses (unless they are closely connected and short).
Context: ...LED` - The transaction has been executed and the result is sealed in a block. ```ko...(COMMA_COMPOUND_SENTENCE_2)
[uncategorized] ~234-~234: Loose punctuation mark.
Context: ...ontains the following fields:address:FlowAddress- The account address. `b...(UNLIKELY_OPENING_PUNCTUATION)
Markdownlint
java-example/README.md
39-39: Expected: h3; Actual: h4
Heading levels should only increment by one level at a time(MD001, heading-increment)
kotlin-example/README.md
39-39: Expected: h3; Actual: h4
Heading levels should only increment by one level at a time(MD001, heading-increment)
7-7: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
10-10: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
11-11: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
12-12: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
13-13: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
14-14: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
15-15: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
16-16: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
17-17: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
18-18: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
19-19: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
20-20: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
21-21: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
22-22: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
Additional comments not posted (17)
java-example/README.md (4)
1-3: LGTM!The changes to the title and introduction improve clarity and accuracy.
5-21: LGTM!The new "Table of Contents" section enhances the organization and navigation of the document. The links to the subsections are correctly formatted.
Tools
LanguageTool
[duplication] ~8-~8: Possible typo: you repeated a word
Context: ...allation](#installation) - Running the examples - Examples summary - [Get bl...(ENGLISH_WORD_REPEAT_RULE)
23-29: LGTM!The "Running the emulator with the Flow CLI" section provides more detailed and relevant information compared to the previous "Usage" section. The installation instructions for the Cadence 1.0 CLI are a helpful addition.
31-33: LGTM!The expanded section on running examples, including information about test files, IntelliJ IDEA recommendations, and command-line instructions, enhances the clarity and usability of the documentation.
sdk/README.md (3)
71-71: LGTM!The change to the section header is approved as it better reflects the content that follows.
73-74: LGTM!The change to the phrase is approved as it reinforces the focus on practical coding demonstrations.
78-80: LGTM!The changes are approved as they enhance clarity and provide useful information for users.
kotlin-example/README.md (4)
1-1: LGTM!The title change from "Kotlin Example" to "Kotlin Examples" is appropriate as it indicates a broader scope of multiple examples.
3-3: LGTM!The rewritten introduction provides a clear and concise overview of the package and its purpose.
27-29: LGTM!The expanded installation instructions provide useful information about the Cadence 1.0 CLI, which is necessary for running the examples.
31-34: LGTM!The expanded section on running the examples provides useful information for developers new to the SDK by explaining how to execute tests using Gradle and suggesting the use of IntelliJ IDEA for development.
README.md (6)
8-8: LGTM!The change to use a relative path for the BREAKING_CHANGES.md link is approved.
17-23: LGTM!The change from "Repository modules" to "Repository structure" enhances the clarity and accuracy of the documentation. This modification is also highlighted in the AI-generated summary.
38-241: Excellent work on expanding the documentation! The new sections with code examples are a significant improvement.The newly added sections provide detailed guidance on various SDK functionalities, including installation instructions, key generation, account creation, transaction signing, and querying capabilities. The included Kotlin code snippets offer practical examples that greatly enhance the documentation's usability and facilitate developers' understanding and implementation.
These additions are also prominently highlighted in the AI-generated summary as a key enhancement in this PR.
The static analysis tool LanguageTool flagged a few potential issues in these segments, but upon closer examination, they appear to be false positives in this context and can be safely ignored.
Overall, these changes represent a substantial improvement in the documentation quality and developer experience.
Tools
LanguageTool
[grammar] ~137-~137: This phrase is duplicated. You should probably use “Multiple parties” only once.
Context: ...e - Single party, multiple signatures - Multiple parties - Multiple parties, 2 authorizers - Multiple parties, mult...(PHRASE_REPETITION)
[uncategorized] ~170-~170: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...TED- The transaction has been executed but the result has not yet been sealed.SE...(COMMA_COMPOUND_SENTENCE_2)
[uncategorized] ~171-~171: Use a comma before “and” if it connects two independent clauses (unless they are closely connected and short).
Context: ...LED` - The transaction has been executed and the result is sealed in a block. ```ko...(COMMA_COMPOUND_SENTENCE_2)
[uncategorized] ~234-~234: Loose punctuation mark.
Context: ...ontains the following fields:address:FlowAddress- The account address. `b...(UNLIKELY_OPENING_PUNCTUATION)
234-234: Disregard the static analysis hint. The use of the colon is appropriate here.The static analysis tool LanguageTool incorrectly flags the colon after "address" as an unlikely opening punctuation. However, in this context, the colon is used appropriately to introduce the type and description of the "address" field.
This suggestion can be safely ignored as a false positive.
Tools
LanguageTool
[uncategorized] ~234-~234: Loose punctuation mark.
Context: ...ontains the following fields:address:FlowAddress- The account address. `b...(UNLIKELY_OPENING_PUNCTUATION)
239-241: LGTM!The addition of the Examples Summary section is a helpful improvement. It enhances the discoverability of the available examples and provides a convenient reference for users to explore the various use cases demonstrated in the repository.
Linking to the kotlin-example module's README is an effective way to direct users to the comprehensive list of supported examples.
242-242: LGTM!Adding a newline at the end of the file is a best practice and adheres to the POSIX standard. This change is approved.
Comments failed to post (2)
kotlin-example/README.md (2)
5-22: Great addition of the "Table of Contents" section!
The "Table of Contents" section is a great addition that improves the documentation's structure and navigation by organizing the content into easily navigable sections and providing a brief description and link for each example.
However, there are some indentation issues in the list that should be fixed.
Please apply the following changes to fix the indentation issues:
## Table of Contents -- [Running the emulator with the Flow CLI](#running-the-emulator-with-the-flow-cli) - - [Installation](#installation) + - [Running the emulator with the Flow CLI](#running-the-emulator-with-the-flow-cli) + - [Installation](#installation) -- [Running the examples](#running-the-examples) -- [Examples summary](#examples-summary) - - [Get blocks](#get-blocks) - - [Get accounts](#get-accounts) - - [Get events](#get-events) - - [Get collection](#get-collection) - - [Get network parameters](#get-network-parameters) - - [Get transactions](#get-transactions) - - [Sending transactions](#sending-transactions) - - [Execute script](#execute-script) - - [Create account](#create-account) - - [Add account key](#add-account-key) - - [Deploy contract](#deploy-contract) - - [Transaction signing](#transaction-signing) - - + - [Running the examples](#running-the-examples) + - [Examples summary](#examples-summary) + - [Get blocks](#get-blocks) + - [Get accounts](#get-accounts) + - [Get events](#get-events) + - [Get collection](#get-collection) + - [Get network parameters](#get-network-parameters) + - [Get transactions](#get-transactions) + - [Sending transactions](#sending-transactions) + - [Execute script](#execute-script) + - [Create account](#create-account) + - [Add account key](#add-account-key) + - [Deploy contract](#deploy-contract) + - [Transaction signing](#transaction-signing)Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.## Table of Contents - [Running the emulator with the Flow CLI](#running-the-emulator-with-the-flow-cli) - [Installation](#installation) - [Running the examples](#running-the-examples) - [Examples summary](#examples-summary) - [Get blocks](#get-blocks) - [Get accounts](#get-accounts) - [Get events](#get-events) - [Get collection](#get-collection) - [Get network parameters](#get-network-parameters) - [Get transactions](#get-transactions) - [Sending transactions](#sending-transactions) - [Execute script](#execute-script) - [Create account](#create-account) - [Add account key](#add-account-key) - [Deploy contract](#deploy-contract) - [Transaction signing](#transaction-signing)Tools
LanguageTool
[duplication] ~8-~8: Possible typo: you repeated a word
Context: ...allation](#installation) - Running the examples - Examples summary - [Get ...(ENGLISH_WORD_REPEAT_RULE)
Markdownlint
7-7: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
10-10: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
11-11: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
12-12: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
13-13: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
14-14: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
15-15: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
16-16: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
17-17: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
18-18: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
19-19: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
20-20: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
21-21: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
22-22: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
35-112: Great addition of the "Examples summary" section!
The "Examples summary" section is a great addition that provides a comprehensive overview of the available examples and their functionalities by listing all Kotlin code examples currently supported in the repo, along with a brief description and a link to the corresponding source file for each example.
However, there are some issues flagged by the static analysis tool that should be fixed:
- The heading levels should only increment by one level at a time. Please change the heading level of "Get Blocks" and the subsequent headings from h4 to h3.
- The phrases "Get transaction", "Send transaction", and "Multiple parties" are duplicated. Please remove the duplicates.
Please apply the following changes to fix the issues:
-#### Get Blocks +### Get Blocks -#### Get Accounts +### Get Accounts -#### Get Events +### Get Events -#### Get Collection +### Get Collection -#### Get Network Parameters +### Get Network Parameters -#### Get Transactions +### Get Transactions -- Get transaction +- Get transaction -- Get transaction result +- Get transaction result -#### Sending Transactions +### Sending Transactions -- Send transaction +- Send transaction -- Send transaction with arguments +- Send transaction with arguments -#### Execute Script +### Execute Script -#### Create Account +### Create Account -#### Add Account Key +### Add Account Key -#### Deploy Contract +### Deploy Contract -#### Transaction Signing +### Transaction Signing -- Multiple parties +- Multiple parties -- Multiple parties, 2 authorizers +- Multiple parties, 2 authorizers -- Multiple parties, multiple signatures +- Multiple parties, multiple signaturesCommittable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.## Examples summary Below is a list of all Kotlin code examples currently supported in this repo: ### Get Blocks [Get blocks by ID, height, or latest sealed.](src/main/kotlin/org/onflow/examples/kotlin/getBlock/GetBlockAccessAPIConnector.kt) - Get the latest sealed block - Get block by ID - Get block by height ### Get Accounts [Get accounts by address.](src/main/kotlin/org/onflow/examples/kotlin/getAccount/GetAccountAccessAPIConnector.kt) - Get account balance - Get account from the latest block - Get account from block by height ### Get Events [Get events emitted by transactions.](src/main/kotlin/org/onflow/examples/kotlin/getEvent/GetEventAccessAPIConnector.kt) - Get events for height range - Get events for block IDs - Get events directly from transaction result ### Get Collection [Get collections by ID.](src/main/kotlin/org/onflow/examples/kotlin/getCollection/GetCollectionAccessAPIConnector.kt) ### Get Network Parameters [Get the current network parameters.](src/main/kotlin/org/onflow/examples/kotlin/getNetworkParams/GetNetworkParametersAccessAPIConnector.kt) ### Get Transactions [Get transactions.](src/main/kotlin/org/onflow/examples/kotlin/getTransaction/GetTransactionAccessAPIConnector.kt) - Get transaction - Get transaction result ### Sending Transactions [Sending transactions.](src/main/kotlin/org/onflow/examples/kotlin/sendTransaction/SendTransactionExample.kt) - Send transaction - Send transaction with arguments ### Execute Script [Execute a Cadence script.](src/main/kotlin/org/onflow/examples/kotlin/executeScript/ExecuteScriptAccessAPIConnector.kt) - Execute a simple Cadence script - Execute a more complex Cadence script with arguments ### Create Account [Create a new account on Flow.](src/main/kotlin/org/onflow/examples/kotlin/createAccount/CreateAccountExample.kt) ### Add Account Key [Add a key to an existing account.](src/main/kotlin/org/onflow/examples/kotlin/addKey/AddAccountKeyExample.kt) ### Deploy Contract [Deploy a Cadence smart contract.](src/main/kotlin/org/onflow/examples/kotlin/deployContract/DeployContractExample.kt) ### Transaction Signing [Common paradigms for signing transactions.](src/main/kotlin/org/onflow/examples/kotlin/signTransaction/SignTransactionExample.kt) - Single party, single signature - Single party, multiple signatures - Multiple parties - Multiple parties, 2 authorizers - Multiple parties, multiple signaturesTools
LanguageTool
[style] ~43-~43: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...Block/GetBlockAccessAPIConnector.kt) - Get the latest sealed block - Get block by ...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~51-~51: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...unt/GetAccountAccessAPIConnector.kt) - Get account balance - Get account from the ...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~59-~59: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...Event/GetEventAccessAPIConnector.kt) - Get events for height range - Get events fo...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~67-~67: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...tCollectionAccessAPIConnector.kt) #### Get Network Parameters [Get the current ne...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[grammar] ~75-~75: This phrase is duplicated. You should probably use “Get transaction” only once.
Context: ...GetTransactionAccessAPIConnector.kt) - Get transaction - Get transaction result #### Sending Transactions [Sen...(PHRASE_REPETITION)
[grammar] ~82-~82: This phrase is duplicated. You should probably use “Send transaction” only once.
Context: ...ansaction/SendTransactionExample.kt) - Send transaction - Send transaction with arguments #### Execute Script [E...(PHRASE_REPETITION)
[style] ~89-~89: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: .../ExecuteScriptAccessAPIConnector.kt) - Execute a simple Cadence script - Execute a mor...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[grammar] ~110-~110: This phrase is duplicated. You should probably use “Multiple parties” only once.
Context: ...e - Single party, multiple signatures - Multiple parties - Multiple parties, 2 authorizers - Multiple parties, mult...(PHRASE_REPETITION)
Markdownlint
39-39: Expected: h3; Actual: h4
Heading levels should only increment by one level at a time(MD001, heading-increment)
SDK Examples Unit Test Results26 files ±0 26 suites ±0 5m 4s ⏱️ ±0s For more details on these failures, see this check. Results for commit d13384b. ± Comparison against base commit 703ae4a. ♻️ This comment has been updated with latest results. |
| - [Querying Accounts](#querying-accounts) | ||
| - [Examples Summary](#examples-summary) | ||
| - [Credit](#credit) | ||
|
|
There was a problem hiding this comment.
Let's add a section below called 'Unsupported features'. We can summarize the missing support for Websockets and Event streaming APIs for now.
Co-authored-by: j pimmel <frankly.watson@gmail.com>
Co-authored-by: j pimmel <frankly.watson@gmail.com>
Co-authored-by: j pimmel <frankly.watson@gmail.com>
Description
Update main repo READMEs and add general documentation of SDK functionality.
For contributor use:
masterbranchFiles changedin the Github PR explorerSummary by CodeRabbit