8000 OpenAML - Labs Software Project Contribution and Onboarding · Issue #356 · finos/community · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

OpenAML - Labs Software Project Contribution and Onboarding #356

New issue

Have a ques 8000 tion about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

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

Jump to bottom
Open
juv1nsk1 opened this issue Mar 13, 2025 · 1 comment
Open

OpenAML - Labs Software Project Contribution and Onboarding #356

juv1nsk1 opened this issue Mar 13, 2025 · 1 comment
Assignees
@karlmoll
Labels
contribution labs ready-for-onboarding

Comments

@juv1nsk1
Copy link

1. Describing The Contribution

Business Problem

The increasing adoption of blockchain technology in financial systems demands a more transparent and collaborative approach to regulatory compliance, particularly in anti-money laundering (AML) efforts.
Security systems should be open, allowing contributions from all industry players to ensure financial institutions, regulators, and blockchain-based services can effectively detect and prevent illicit transactions.
Instead of relying on fragmented and proprietary solutions, the industry requires a unified standard that promotes interoperability, enabling seamless integration across blockchain networks.
A transparent and standardized approach is necessary to enhance traceability, ensuring that suspicious activities can be identified and monitored consistently across different platforms.
Furthermore, automation must be prioritized to reduce reliance on manual compliance processes, lowering operational costs and increasing efficiency in AML enforcement.
To achieve this, an open-source initiative is needed to lead the development of a comprehensive, AI-powered framework that fosters collaboration and establishes a standardized approach to AML in the blockchain ecosystem.

Proposed Solution

We propose contributing an open-source AML analytics tool to blockchain ecosystems, leveraging artificial intelligence to enhance AML monitoring, risk assessment, and regulatory compliance.

Tentative Roadmap

  • Feature Engineering: Expand the AI model with 30+ features for enhanced transaction monitoring and risk detection.
  • Data Pipeline: Automate historical transaction processing for real-time and retrospective AML analysis.
  • Compatibility: Develop a plugin for seamless integration with Hyperledger and CBDC frameworks.
  • Regulatory: Align with financial institutions’ AML workflows, incorporating KYT and global compliance standards.
  • Interface: Provide a user-friendly dashboard and a Dockerized API for streamlined deployment.

Backlog

  • Token Coverage: Extend support to memecoins and low-liquidity stablecoins, addressing unique risk factors.
  • AML Patterns: Enhance AI detection for liquidity pool usage and emerging DeFi laundering techniques.

Current State

Hackathon Prototype: Initial version developed and tested during the DTCC AI hackathon supporting basic features and manual data pipeline.

Existing Materials

Development Team

Maintainers

Confirmed contributors

Target Contributors

We are looking for industry collaborators to help us maintain and provide real-world feedback on the project.

Project Communication Channel(s)

  • Contributor to ask maintainers which communications channels they'd like to use:
  • Asynchronous
    • GitHub Issues (public)
    • GitHub Discussions (public)
  • Synchronous
    • Recurring meetings

Understanding FINOS Onboarding Requirements

As a project onboarding into FINOS, you will need to familiarize yourself and your contributor team with the following materials:

Record The Contribution (FINOS Infra)

  • (optional) Identify and Assign FINOS Strategic Advisor
  • Submit contribution to LF by opening a ticket via https://jira.linuxfoundation.org/browse/SS and marking contribution as "Exploratory"; attach a summary of the Business Problem and Proposed Solution (above) of the project.

2. Approval

The FINOS Technical Oversight Committee (TOC) is responsible for approving FINOS project contributions; feel free to check their contribution principles.

If needed, the TOC will request a follow up either via GitHub Issue comments or by inviting project leads to one of their recurrent meetings.

Tasks (for FINOS Infra/TOC)

  • Prioritise this issue on the [TOC Backlog]
  • Assign this issue to @eddie-knight
  • Add the ready-for-tsc label
  • TOC to invite contributors to present their project
  • FINOS TOC approves/rejects the contribution
  • Ask @jgavronsky to mark contribution as "Engaged" within LF systems
  • (optional) If additional socialization is required, the Executive Director may bring projects to the FINOS Governing Board
  • Update the contribution status to "Engaged" by sending another email to LF Legal Representative with the name of the project and its new status.

TOC Findings / Report

TOC to enter findings summary here.

3. Preparing For Onboarding

Before the FINOS team can onboard your project, there are a few housekeeping that need to be taken care of. These must be completed by the contributor, with help if required from the FINOS Infra.

Kick-off meeting

  • Set up kick-off meeting with project leads
  • Run kick-off meeting
    • Walk through the checklist in part 1, ensure all the questions are answered and remove items that don't apply
    • Write and send contribution proposal announcement (optional - see below)

Proposal (Lead Maintainer)

  • Lead maintainer to send out announcement to community@finos.org using this template:

    Dear FINOS Community, 

We would like to propose a new FINOS project. Please review the proposal details at (_TODO: add link to the GitHub issue proposal_).

If you're interested in participating, please :+1: the GitHub issue proposal and drop a comment with your name, org and email

Thanks a lot,

Logo / Trademarks

  • Sign the project contribution agreement to allow FINOS to act on behalf of the contributor for accounts related to the project (e.g., GitHub, domain names, social media) and to optionally manage trademark assignment
  • Request logo design from help@finos.org (if needed)
  • The codebase doesn’t include any patent or copyright that conflicts with FINOS Governance and bylaws. (Infra team to validate with FINOS Legal team if anything important is raised)

FINOS Project Blueprint

Add documentation here

4. FINOS Onboarding

This is performed by FINOS Infra once the three previous stages are complete, with support from the contributor and the FINOS Infra team.

Maintainers, Contributors and CLAs

  • Identify other existing contributors (assuming there's a contribution history (eg Git history)
  • Check if maintainers and other contributors are all covered by FINOS CLA
  • Engage with FINOS Legal team to figure out what’s needed to cover all maintainers and contributors with FINOS CLA
  • Reach out to contributors and employers to coordinate CLA signatures
  • Invite GitHub usernames to GitHub FINOS Org
  • Create <project-name>-maintainers GitHub team and invite users

Validation (only if code is contributed)

  • Backup (even with screenshot) GitHub permissions of the repository to transfer
  • Check GitHub repository transfer requirements:
    • finos-admin has Admin to all repositories to transfer
    • finos-admin ia allowed to transfer repositories out of the org
    • if the repository is owned by a user (and not an org), the user must be able to transfer the repository to finos-admin
  • The codebase doesn’t have HIGH or CRITICAL CVEs across direct and transitive libraries
  • The codebase doesn’t have any unfriendly licenses across direct and transitive libraries
  • (optional - if a build system is provided) The build process runs successfully
  • The codebase doesn’t include any patent or copyright that conflicts with FINOS Governance and bylaws (to be validated with FINOS Legal team)
  • All incubating criteria are met (review documentation provided above)

Code transfer

  • Transfer all code assets as GitHub repositories under github.com/finos
  • Rename main branch to main (instead of master)
  • Configure finos-admins (Maintain role) and finos-staff (Triage role) team permissions

Project Communication Channel(s)

  • Create the identified communication channels during infra set up
  • Create mailing-list on lists.finos.org (if requested)
  • Create Slack channels if requested.
  • Link communication channels linked front-and-center in the project README.md

Repository setup

  • Enable EasyCLA
  • Add project to metadata
  • Add identities, orgs and affiliations to metadata (deprecated by EasyCLA)
  • Add logo to FINOS landscape
    • Create staging branch on finos/finos-landscape
    • Merge finos/metadata changes on master (will udpdate landscape.yml in finos/finos-landscape)
    • Create PR from staging branch on finos/finos-landscape
    • Review Netlify preview
    • Merge PR
  • Add project maintainers emails to finos-project-maintainers@finos.org list
  • Add project maintainers GitHub usernames to the project-maintainers Team
  • Ask @jgavronsky to mark contribution as "Active" within LF systems
  • (best effort) Update release coordinates and code namespace to include finos
  • Check that CVE (and preferably static code analysis, if applicable) scanning is in place
  • Enable automated dependency update, using Renovate
  • Enable branch protection (Require a pull request before merging)
  • (optional) Enable meeting attendance tracking
  • (optional) Onboard into legend.finos.org/studio

5. Announcement

(Lead: Project Lead and FINOS Infra team)

  • Update the contribution status to "Active" by sending another email to LF Legal Representative with the name of the project and its new status.
  • Lead maintainer works with FINOS marketing to send out announcement to announce@finos.org , checkout announcement template at the Contribution page
  • Notify FINOS marketing (@grizzwolf + finos-marketing internal Slack channel)
@mindthegab mindthegab assigned mindthegab and karlmoll and unassigned karlmoll and mindthegab May 14, 2025
@mindthegab mindthegab changed the title OpenAML - Software Project Contribution and Onboarding OpenAML - Labs Software Project Contribution and Onboarding May 14, 2025
@mindthegab
Copy link
Member

Thanks to @juv1nsk1 and other contributing team for the presentation at @finos/toc on Wed.

As discussed, I am assigning this to @karlmoll to simplify the description and checklist to actually reflect this is a contribution that will go in FINOS-labs vs FINOS, and work with @TheJuanAndOnly99 to finalize onboarding.

@karlmoll please work with @TheJuanAndOnly99 to complete onboarding and @opoupeney to coordinate announcements.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@karlmoll karlmoll

Labels
contribution labs ready-for-onboarding
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@mindthegab @juv1nsk1 @karlmoll
0