{"id":34527628,"url":"https://github.com/eclipse-xfsc/data-contract-transaction","last_synced_at":"2026-06-06T14:31:23.320Z","repository":{"id":289914000,"uuid":"963958475","full_name":"eclipse-xfsc/data-contract-transaction","owner":"eclipse-xfsc","description":"Service for Data Contract Exchange","archived":false,"fork":false,"pushed_at":"2025-04-25T17:41:43.000Z","size":5170,"stargazers_count":0,"open_issues_count":5,"forks_count":0,"subscribers_count":7,"default_branch":"main","last_synced_at":"2025-04-25T18:41:51.158Z","etag":null,"topics":["data-contract","exchange"],"latest_commit_sha":null,"homepage":null,"language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/eclipse-xfsc.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-04-10T13:25:33.000Z","updated_at":"2025-04-25T17:39:25.000Z","dependencies_parsed_at":"2025-04-25T18:52:01.489Z","dependency_job_id":"2a5070d2-0073-4dac-9162-2cd9bf879c03","html_url":"https://github.com/eclipse-xfsc/data-contract-transaction","commit_stats":null,"previous_names":["eclipse-xfsc/data-contract-transaction"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/eclipse-xfsc/data-contract-transaction","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eclipse-xfsc%2Fdata-contract-transaction","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eclipse-xfsc%2Fdata-contract-transaction/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eclipse-xfsc%2Fdata-contract-transaction/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eclipse-xfsc%2Fdata-contract-transaction/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/eclipse-xfsc","download_url":"https://codeload.github.com/eclipse-xfsc/data-contract-transaction/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eclipse-xfsc%2Fdata-contract-transaction/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33986901,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-06T02:00:07.033Z","response_time":107,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["data-contract","exchange"],"created_at":"2025-12-24T05:24:13.325Z","updated_at":"2026-06-06T14:31:23.315Z","avatar_url":"https://github.com/eclipse-xfsc.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"# DCT\n\n\n\n## Getting started\n\nTo make it easy for you to get started with GitLab, here's a list of recommended next steps.\n\nAlready a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!\n\n## Add your files\n\n- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files\n- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:\n\n```\ncd existing_repo\ngit remote add origin https://gitlab.com/gaia-x/data-infrastructure-federation-services/dct/dct.git\ngit branch -M main\ngit push -uf origin main\n```\n\n## Integrate with your tools\n\n- [ ] [Set up project integrations](https://gitlab.com/gaia-x/data-infrastructure-federation-services/dct/dct/-/settings/integrations)\n\n## Collaborate with your team\n\n- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)\n- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)\n- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)\n- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)\n- [ ] [Automatically merge when pipeline succeeds](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)\n\n## Test and Deploy\n\nUse the built-in continuous integration in GitLab.\n\n- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)\n- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing(SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)\n- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)\n- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)\n- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)\n\n***\n\n# Editing this README\n\nWhen you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!).  Thank you to [makeareadme.com](https://www.makeareadme.com/) for this template.\n\n## Suggestions for a good README\nEvery project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.\n\n## Name\nChoose a self-explaining name for your project.\n\n## Description\nLet people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.\n\n## Badges\nOn some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.\n\n## Visuals\nDepending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.\n\n## Installation\nWithin a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.\n\n## Usage\nUse examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.\n\n## Support\nTell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.\n\n## Roadmap\nIf you have ideas for releases in the future, it is a good idea to list them in the README.\n\n## Contributing\nState if you are open to contributions and what your requirements are for accepting them.\n\nFor people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.\n\nYou can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.\n\n## Authors and acknowledgment\nShow your appreciation to those who have contributed to the project.\n\n## License\nFor open source projects, say how it is licensed.\n\n## Project status\nIf you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.\n\n## Open Items:\n- FederatedCatalogAdapter needs to be implemented\n```\n/**\n*  Should return Data Asset validation result \"DataAssetStatus\",consisting of retrieving original Data Asset and compare them and check if provided Data Asset is still supported\n*/\nvalidateDataAsset(dataAsset: DataAsset): Promise\u003cDataAssetStatus\u003e;\n/**\n* Return Data Asset without consumer details that should be applied in provider's signature validation\n*/\nremoveConsumerDetails(dataAsset: IVerifiableCredential\u003cDataAsset\u003e):Promise\u003cIVerifiableCredential\u003cDataAsset\u003e\u003e;\n/**\n* Return proof that was signed by provider\n*/\ngetProviderProof(dataAsset: DataAsset): Promise\u003c{ verificationMethod: string }\u003e;\n/**\n* Return proof that was signed by consumer\n*/\ngetConsumerProof(dataAsset: DataAsset): Promise\u003c{ verificationMethod: string }\u003e;\n/**\n* The GX-DCS MUST check if the Consumer conforms to the policies, insofar that is technically feasible with fungible effort.\n*/\nisConsumerConformPolicies(dataAsset: DataAsset): Promise\u003cboolean\u003e;\n/**\n* Return true if Federated Catalog service is UP, otherwise false\n*/\nisHealthy(): Promise\u003cboolean\u003e;\n```\n- AbstractLogTokenAdapter\n```\n/**\n* Generate Log Token for provided Data Asset\n*/\ngetLogToken(dataAsset: DataAsset): Promise\u003cLogToken\u003e;\n```\n- AbstractTrustServiceAdapter\n```\n/**\n* Validate participant verifies that the user is a GX Participant\n* In general, only Gaia-X Participants must be able to interact with the GX-DCS.\n* Each participant shall be capable of registering Data Assets, negotiate,\n* or make a Data Contracts for a Data Asset and get a validation confirmation\n* for a finalized Agreement.\n*/\nvalidateParticipant(dataAsset: DataAsset, type: ParticipantType): Promise\u003cParticipantStatus\u003e;\n/**\n* Return true if Trust Service service is UP, otherwise false\n*/\nisHealthy(): Promise\u003cboolean\u003e;\n```\n\n## Installation\n\n```bash\n$ npm config set @gaia-x:registry https://gitlab.com/api/v4/projects/38989724/packages/npm/\n$ npm install\n```\n\n## Formatting\n\n```bash\n# Setting the hooksPath will run the pre-commit hook in order to standardize the formatted output\n$ git config core.hooksPath .github/hooks\n```\n\n## Running the app\n\n### Environment Variables\n```\n# General\nNODE_ENV=development # development/production\nREQUEST_SIZE=1000000 # request max size in bytes \nNX_API_ENDPOINT=http://localhost:3000/ # used in Frontend App to connect to api\nSERVER_THROTLLER_TTL=60 # throtller period\nSERVER_THROTLLER_LIMIT=10 # maximum number of requests for specified period\nLOGGER_TYPE=console # types \"console\"/\"winston\"\nLOGGER_WINSTON_LEVEL=info\nLOGGER_WINSTON_TRANSPORTS_CONSOLE=true\nLOGGER_WINSTON_TRANSPORTS_FILE=logs/app.log # filename to store logs\nCACHE_TYPE=redis # types \"memory\"/\"redis\"\nCACHE_TTL=86400 # cache time to live for gateways\nSD_CACHE_TTL=1209600000 # 14 days in milliseconds\nSD_QUEUE_DELAY=86400000 # 24 hours in milliseconds\nSD_QUEUE_RETRIES=13 # QUEUE RETRIES\nREDIS_HOST=redis-server\nREDIS_PORT=6379\nREDIS_PREFIX=cache:\nDELS_LINK=https://dels.gaia-x.com/inbox/\nDELS_REL=http://www.w3.org/ns/ldp#inbox\nDELS_CONTEXT=https://www.w3.org/ns/ldp\nDELS_ID=https://dcs.gaia-x.com/contracts/1001\nDELS_INBOX=https://dels.gaia-x.com/inbox/\nTRUST_SERVICE_URL=https://trust-service.com # Trust Service Url \nFEDERATED_CATALOG_URL=https://federated-catalog.com # Federated Catalog Url\n#Ed25519 signature configuration \nSIGNATURE_ID=did:dcs:key:123\nSIGNATURE_TYPE=Ed25519VerificationKey2018\nSIGNATURE_CONTROLLER=did:dcs:controller\nSIGNATURE_PUBLIC_KEY_BASE58=45dxsXGjMixWNfmXBtWwPnCfGgV1THf6qhdLixUmgrVZ\nSIGNATURE_PRIVATE_KEY_BASE58=3hJ4PNJm6pzUwRLDpummeZCZGeqE7c9DMdD6qSNB4qBfxrnkAUmZ1CQMpifvihdiSv8pepijdCzR5C2eAHC4Vqf9\n\nLOG_TOKEN_JWT_SECRET_KEY=somesecretkey # secret key \nLOG_TOKEN_EXPIRES_IN_MINUTES=120 # log token expiration time\n\n```\n\n```bash\n# development\n$ npm run start\n\n# docker\n$ docker-compose up --build\n\n# watch mode\n$ npm run start:dev\n\n# production mode\n$ npm run start:prod\n```\n\n#### API in dev mode\n\nAvailable APIs:\n\n- `http://localhost:3000/register`\n- `http://localhost:3000/make/contract`\n- `http://localhost:3000/negotiate`\n- `http://localhost:3000/finalize`\n- `http://localhost:3000/validate`\n- `http://localhost:3000/log/token/validate`\n- `http://localhost:3000/contracts/inbox-discovery`\n\nSwagger path:\n - `/swagger`\n\n#### UI in dev mode\n\n- Available route: `http://localhost:3001/ui`\n\n## Test\n\n```bash\n# unit tests\n$ npm run test\n\n# e2e tests\n$ npm run test:e2e\n\n# test coverage\n$ npm run test:cov\n```\n\n## Documentation\n\n```\n# available route: `http://localhost:8000/contracts-inbox/`\n$ docker compose up\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feclipse-xfsc%2Fdata-contract-transaction","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Feclipse-xfsc%2Fdata-contract-transaction","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feclipse-xfsc%2Fdata-contract-transaction/lists"}