From 7e54150f2de7dd524126480465ad76d527d3ace0 Mon Sep 17 00:00:00 2001 From: Bruno Campos Date: Tue, 4 Jun 2024 21:02:41 -0300 Subject: [PATCH 1/3] initial coderabbitai config file and readme updated --- .coderabbit.yaml | 1 + README.md | 64 +----------------------------------------------- 2 files changed, 2 insertions(+), 63 deletions(-) create mode 100644 .coderabbit.yaml diff --git a/.coderabbit.yaml b/.coderabbit.yaml new file mode 100644 index 0000000..ffedbb0 --- /dev/null +++ b/.coderabbit.yaml @@ -0,0 +1 @@ +language: "en-US" \ No newline at end of file diff --git a/README.md b/README.md index c98bb10..509ab5c 100644 --- a/README.md +++ b/README.md @@ -58,66 +58,4 @@ kos-rs = "0.1" - `packages/kos-types/`: Package containing complex data types and helpful utilities. - `packages/kos-utils/`: Package with utility libraries for various purposes. ---- - -# Klever Bounty Program (kos-rs) - -Klever is on a quest for adept Rust developers to revamp its Rust-powered crypto wallet SDK, initially designed for WebAssembly (Wasm). The aim is to expand its compatibility for Kotlin (Android) and Swift (iOS) platforms. The ultimate objective is to streamline this transition, minimizing the manual coding interventions. - -## Rewards Distribution - -Bounty winners will be compensated with $KFI tokens. Here's the reward distribution: - -- [x] Web Wasm: 10,000 KFI -- [x] React Native Wasm): 10,000 KFI -- [ ] Kotlin Rust SDK binding: 10,000 KFI (First PR Approved only) -- [ ] Swift Rust SDK binding: 10,000 KFI (First PR Approved only) -- [ ] Code Review PR Approval: 100 KFI - -## Key Milestones - -### 1. SDK Examination - -- Perform an in-depth review of the present SDK, focusing on its architecture, features, and Wasm-specific dependencies. - -### 2. Integration & Accessibility - -- Create essential bindings and exports to make Rust functions and types accessible from Wasm, Kotlin, and Swift. - -### 3. Security Assurance - -- Probe the existing and newly-developed code for potential threats and make necessary patches. - -### 4. Automation Implementation - -- Conceptualize and establish an automatic adaptation system, preferably using Rust's attributes/macros. This should ensure the central Rust code remains universally applicable. - -### 5. Validation - -- Rigorously test the SDK for Kotlin and Swift platforms, ensuring uniformity. -- Integrate critical unit tests to validate performance. - -### 6. Documentation & Guidance - -- Deliver a detailed summary of the alterations and explain the workings of the automation tool. -- Detail the integration process for Kotlin and Swift projects. - -### 7. Evidence of Testing - -- Produce provable test results for Kotlin and Swift platforms, including unit, integration, and other relevant test artifacts. - -## Evaluation Criteria - -- Effortless SDK integration with Kotlin and Swift. -- Uniform SDK operations across Wasm, Kotlin, and Swift. -- Significant minimization of manual code changes due to the automation tool. -- Transparent and coherent documentation aiding seamless SDK integration for new developers. - -## Recommendations - -- To genuinely grasp the SDK's intricacies, having access or a sample of the existing Rust SDK is crucial. This aids in a well-informed transition. -- The program should prioritize developers familiar with Rust FFI and Kotlin/Swift compatibility. This focus promises higher-quality, viable solutions. - -### Final Words - -We're eager to witness the pioneering solutions our community will present. Accomplishing this bounty's objectives will immensely boost our SDK's adaptability and appeal, enriching both developers and end-users. +--- \ No newline at end of file From 64b05724928acf74c707bb95d8dbb714fa216ed8 Mon Sep 17 00:00:00 2001 From: Bruno Campos Date: Tue, 4 Jun 2024 21:10:56 -0300 Subject: [PATCH 2/3] added single end file to the readme --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 509ab5c..94b0e08 100644 --- a/README.md +++ b/README.md @@ -58,4 +58,4 @@ kos-rs = "0.1" - `packages/kos-types/`: Package containing complex data types and helpful utilities. - `packages/kos-utils/`: Package with utility libraries for various purposes. ---- \ No newline at end of file +--- From e3ef9bc3f847dc87bca15cf3e89fbbed058bc6f5 Mon Sep 17 00:00:00 2001 From: Bruno Campos Date: Tue, 4 Jun 2024 21:38:32 -0300 Subject: [PATCH 3/3] fix stale action params --- .github/workflows/stale.yaml | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/.github/workflows/stale.yaml b/.github/workflows/stale.yaml index f1219df..c546484 100644 --- a/.github/workflows/stale.yaml +++ b/.github/workflows/stale.yaml @@ -9,11 +9,10 @@ jobs: stale: runs-on: ubuntu-latest steps: - - uses: actions/stale@v8 + - uses: actions/stale@v9 with: repo-token: "${{ secrets.GITHUB_TOKEN }}" stale-issue-message: 'This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.' days-before-stale: 60 days-before-close: 7 stale-pr-message: 'This PR has been marked as stale due to lack of activity. It will be closed if no further activity occurs. Please check it out!' - stale-label: 'stale'