generated from TBD54566975/tbd-project-template
-
Notifications
You must be signed in to change notification settings - Fork 57
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' into verifiable-presentation-impl
- Loading branch information
Showing
160 changed files
with
17,678 additions
and
8,229 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,84 @@ | ||
| # For most projects, this workflow file will not need changing; you simply need | ||
| # to commit it to your repository. | ||
| # | ||
| # You may wish to alter this file to override the set of languages analyzed, | ||
| # or to provide custom queries or build logic. | ||
| # | ||
| # ******** NOTE ******** | ||
| # We have attempted to detect the languages in your repository. Please check | ||
| # the `language` matrix defined below to confirm you have the correct set of | ||
| # supported CodeQL languages. | ||
| # | ||
| name: "CodeQL" | ||
|
|
||
| on: | ||
| push: | ||
| branches: [ "main" ] | ||
| pull_request: | ||
| branches: [ "main" ] | ||
| schedule: | ||
| - cron: '28 12 * * 3' | ||
|
|
||
| jobs: | ||
| analyze: | ||
| name: Analyze | ||
| # Runner size impacts CodeQL analysis time. To learn more, please see: | ||
| # - https://gh.io/recommended-hardware-resources-for-running-codeql | ||
| # - https://gh.io/supported-runners-and-hardware-resources | ||
| # - https://gh.io/using-larger-runners | ||
| # Consider using larger runners for possible analysis time improvements. | ||
| runs-on: ${{ (matrix.language == 'swift' && 'macos-latest') || 'ubuntu-latest' }} | ||
| timeout-minutes: ${{ (matrix.language == 'swift' && 120) || 360 }} | ||
| permissions: | ||
| # required for all workflows | ||
| security-events: write | ||
|
|
||
| # only required for workflows in private repositories | ||
| actions: read | ||
| contents: read | ||
|
|
||
| strategy: | ||
| fail-fast: false | ||
| matrix: | ||
| language: [ 'javascript-typescript' ] | ||
| # CodeQL supports [ 'c-cpp', 'csharp', 'go', 'java-kotlin', 'javascript-typescript', 'python', 'ruby', 'swift' ] | ||
| # Use only 'java-kotlin' to analyze code written in Java, Kotlin or both | ||
| # Use only 'javascript-typescript' to analyze code written in JavaScript, TypeScript or both | ||
| # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support | ||
|
|
||
| steps: | ||
| - name: Checkout repository | ||
| uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 #v4.1.1 | ||
|
|
||
| # Initializes the CodeQL tools for scanning. | ||
| - name: Initialize CodeQL | ||
| uses: github/codeql-action/init@0b21cf2492b6b02c465a3e5d7c473717ad7721ba #v3.23.1 | ||
| with: | ||
| languages: ${{ matrix.language }} | ||
| # If you wish to specify custom queries, you can do so here or in a config file. | ||
| # By default, queries listed here will override any specified in a config file. | ||
| # Prefix the list here with "+" to use these queries and those in the config file. | ||
|
|
||
| # For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs | ||
| # queries: security-extended,security-and-quality | ||
|
|
||
|
|
||
| # Autobuild attempts to build any compiled languages (C/C++, C#, Go, Java, or Swift). | ||
| # If this step fails, then you should remove it and run the build manually (see below) | ||
| - name: Autobuild | ||
| uses: github/codeql-action/autobuild@0b21cf2492b6b02c465a3e5d7c473717ad7721ba #v3.23.1 | ||
|
|
||
| # ℹ️ Command-line programs to run using the OS shell. | ||
| # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun | ||
|
|
||
| # If the Autobuild fails above, remove it and uncomment the following three lines. | ||
| # modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance. | ||
|
|
||
| # - run: | | ||
| # echo "Run, Build Application using script" | ||
| # ./location_of_script_within_repo/buildscript.sh | ||
|
|
||
| - name: Perform CodeQL Analysis | ||
| uses: github/codeql-action/analyze@0b21cf2492b6b02c465a3e5d7c473717ad7721ba #v3.23.1 | ||
| with: | ||
| category: "/language:${{matrix.language}}" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -159,4 +159,7 @@ dist | |
| # IntelliJ | ||
| .idea | ||
|
|
||
| results.xml | ||
| results.xml | ||
|
|
||
| .tbdocs | ||
| temp | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| [submodule "web5-spec"] | ||
| path = web5-spec | ||
| url = https://github.com/TBD54566975/web5-spec |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -48,6 +48,23 @@ Interested in contributing instantly? You can make your updates directly without | |
|
|
||
| [](https://codesandbox.io/p/github/TBD54566975/web5-js/main) | ||
|
|
||
|
|
||
| ## Prerequisites | ||
|
|
||
| ### Cloning | ||
| This repository uses git submodules. To clone this repo with submodules | ||
| ```sh | ||
| git clone --recurse-submodules [email protected]:TBD54566975/web5-js.git | ||
| ``` | ||
| Or to add submodules after cloning | ||
| ```sh | ||
| git submodule update --init | ||
| ``` | ||
| We recommend this config which will only checkout the files relevant to web5-js | ||
| ```sh | ||
| git -C web5-spec sparse-checkout set test-vectors | ||
| ``` | ||
|
|
||
| ## Installation | ||
|
|
||
| _NPM_ | ||
|
|
@@ -177,6 +194,10 @@ Each `Record` instance has the following instance methods: | |
| - **`text`** - _`function`_: returns the data as a string. | ||
| - **`send`** - _`function`_: sends the record the instance represents to the DWeb Node endpoints of a provided DID. | ||
| - **`update`** - _`function`_: takes in a new request object matching the expected method signature of a `write` and overwrites the record. This is a convenience method that allows you to easily overwrite records with less verbosity. | ||
| - **`store`** - _`function`_: stores the record in the local DWN instance, offering the following options: | ||
| - `import`: imports the record as with an owner-signed override (still subject to Protocol rules, when a record is Protocol-based) | ||
| - **`import`** - _`function`_: signs a record with an owner override to import the record into the local DWN instance: | ||
| - `store` - _`boolean`_: when false is passed, the record will only be signed with an owner override, not stored in the local DWN instance. Defaults to `true`. | ||
|
|
||
| ### **`web5.dwn.records.query(request)`** | ||
|
|
||
|
|
@@ -477,6 +498,24 @@ The `create` method under the `did` object enables generation of DIDs for a supp | |
| const myDid = await Web5.did.create("ion"); | ||
| ``` | ||
|
|
||
| ## Working with the `web5-spec` submodule | ||
|
|
||
| ### Pulling | ||
| You may need to update the `web5-spec` submodule after pulling. | ||
| ```sh | ||
| git pull | ||
| git submodule update | ||
| ``` | ||
|
|
||
| ### Pushing | ||
| If you have made changes to the `web5-spec` submodule, you should push your changes to the `web5-spec` remote as well as pushing changes to `web5-js`. | ||
| ```sh | ||
| cd web5-spec | ||
| git push | ||
| cd .. | ||
| git push | ||
| ``` | ||
|
|
||
| ## Project Resources | ||
|
|
||
| | Resource | Description | | ||
|
|
||
Oops, something went wrong.