@cheqd/sdk 2.1.0 → 2.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (127) hide show
  1. package/README.md +33 -6
  2. package/build/{index.d.ts → cjs/index.d.ts} +8 -3
  3. package/build/cjs/index.d.ts.map +1 -0
  4. package/build/cjs/index.js +144 -0
  5. package/build/cjs/index.js.map +1 -0
  6. package/build/{modules → cjs/modules}/_.d.ts +1 -1
  7. package/build/cjs/modules/_.d.ts.map +1 -0
  8. package/build/{modules → cjs/modules}/_.js +3 -0
  9. package/build/cjs/modules/_.js.map +1 -0
  10. package/build/{modules → cjs/modules}/did.d.ts +4 -2
  11. package/build/cjs/modules/did.d.ts.map +1 -0
  12. package/build/{modules → cjs/modules}/did.js +42 -25
  13. package/build/cjs/modules/did.js.map +1 -0
  14. package/build/{modules → cjs/modules}/resource.d.ts +2 -2
  15. package/build/cjs/modules/resource.d.ts.map +1 -0
  16. package/build/{modules → cjs/modules}/resource.js +13 -5
  17. package/build/cjs/modules/resource.js.map +1 -0
  18. package/build/cjs/querier.d.ts.map +1 -0
  19. package/build/cjs/querier.js.map +1 -0
  20. package/build/cjs/registry.d.ts.map +1 -0
  21. package/build/cjs/registry.js.map +1 -0
  22. package/build/cjs/signer.d.ts.map +1 -0
  23. package/build/cjs/signer.js.map +1 -0
  24. package/build/{types.d.ts → cjs/types.d.ts} +1 -1
  25. package/build/cjs/types.d.ts.map +1 -0
  26. package/build/cjs/types.js.map +1 -0
  27. package/build/{utils.d.ts → cjs/utils.d.ts} +11 -0
  28. package/build/cjs/utils.d.ts.map +1 -0
  29. package/build/{utils.js → cjs/utils.js} +45 -5
  30. package/build/cjs/utils.js.map +1 -0
  31. package/build/types/index.d.ts +45 -0
  32. package/build/types/index.d.ts.map +1 -0
  33. package/build/types/modules/_.d.ts +20 -0
  34. package/build/types/modules/_.d.ts.map +1 -0
  35. package/build/types/modules/did.d.ts +109 -0
  36. package/build/types/modules/did.d.ts.map +1 -0
  37. package/build/types/modules/resource.d.ts +62 -0
  38. package/build/types/modules/resource.d.ts.map +1 -0
  39. package/build/types/querier.d.ts +11 -0
  40. package/build/types/querier.d.ts.map +1 -0
  41. package/build/types/registry.d.ts +4 -0
  42. package/build/types/registry.d.ts.map +1 -0
  43. package/build/types/signer.d.ts +36 -0
  44. package/build/types/signer.d.ts.map +1 -0
  45. package/build/types/types.d.ts +80 -0
  46. package/build/types/types.d.ts.map +1 -0
  47. package/build/types/utils.d.ts +29 -0
  48. package/build/types/utils.d.ts.map +1 -0
  49. package/package.json +48 -25
  50. package/.github/ISSUE_TEMPLATE/bug-report.yml +0 -74
  51. package/.github/ISSUE_TEMPLATE/config.yml +0 -14
  52. package/.github/ISSUE_TEMPLATE/feature-request.yaml +0 -27
  53. package/.github/dependabot.yml +0 -42
  54. package/.github/linters/.commitlint.rules.js +0 -37
  55. package/.github/linters/.eslintrc.json +0 -18
  56. package/.github/linters/.markdown-lint.yml +0 -139
  57. package/.github/linters/mlc_config.json +0 -13
  58. package/.github/workflows/build.yml +0 -30
  59. package/.github/workflows/cleanup-actions.yml +0 -45
  60. package/.github/workflows/cleanup-cache-automatic.yml +0 -24
  61. package/.github/workflows/cleanup-cache-manual.yml +0 -21
  62. package/.github/workflows/codeql.yml +0 -40
  63. package/.github/workflows/dispatch.yml +0 -30
  64. package/.github/workflows/lint.yml +0 -51
  65. package/.github/workflows/pull-request.yml +0 -33
  66. package/.github/workflows/release.yml +0 -42
  67. package/.github/workflows/test.yml +0 -66
  68. package/.releaserc.json +0 -56
  69. package/CHANGELOG.md +0 -263
  70. package/CODE_OF_CONDUCT.md +0 -81
  71. package/NOTICE.md +0 -10
  72. package/SECURITY.md +0 -12
  73. package/build/index.d.ts.map +0 -1
  74. package/build/index.js +0 -97
  75. package/build/index.js.map +0 -1
  76. package/build/modules/_.d.ts.map +0 -1
  77. package/build/modules/_.js.map +0 -1
  78. package/build/modules/did.d.ts.map +0 -1
  79. package/build/modules/did.js.map +0 -1
  80. package/build/modules/resource.d.ts.map +0 -1
  81. package/build/modules/resource.js.map +0 -1
  82. package/build/querier.d.ts.map +0 -1
  83. package/build/querier.js.map +0 -1
  84. package/build/registry.d.ts.map +0 -1
  85. package/build/registry.js.map +0 -1
  86. package/build/signer.d.ts.map +0 -1
  87. package/build/signer.js.map +0 -1
  88. package/build/types.d.ts.map +0 -1
  89. package/build/types.js.map +0 -1
  90. package/build/utils.d.ts.map +0 -1
  91. package/build/utils.js.map +0 -1
  92. package/docker/Dockerfile +0 -55
  93. package/docker/entrypoint.sh +0 -58
  94. package/docker/localnet/build-latest.env +0 -7
  95. package/docker/localnet/container-env/observer-0.env +0 -13
  96. package/docker/localnet/container-env/seed-0.env +0 -17
  97. package/docker/localnet/container-env/validator-0.env +0 -13
  98. package/docker/localnet/container-env/validator-1.env +0 -13
  99. package/docker/localnet/container-env/validator-2.env +0 -13
  100. package/docker/localnet/container-env/validator-3.env +0 -13
  101. package/docker/localnet/docker-compose.yml +0 -281
  102. package/docker/localnet/gen-network-config.sh +0 -259
  103. package/docker/localnet/import-keys.sh +0 -31
  104. package/jest.config.js +0 -6
  105. package/src/index.ts +0 -128
  106. package/src/modules/_.ts +0 -55
  107. package/src/modules/did.ts +0 -564
  108. package/src/modules/resource.ts +0 -213
  109. package/src/querier.ts +0 -33
  110. package/src/registry.ts +0 -15
  111. package/src/signer.ts +0 -258
  112. package/src/types.ts +0 -101
  113. package/src/utils.ts +0 -243
  114. package/tests/index.test.ts +0 -135
  115. package/tests/modules/did.test.ts +0 -965
  116. package/tests/modules/resource.test.ts +0 -785
  117. package/tests/signer.test.ts +0 -179
  118. package/tests/testutils.test.ts +0 -24
  119. package/tests/utils.test.ts +0 -66
  120. package/tsconfig.json +0 -80
  121. /package/build/{querier.d.ts → cjs/querier.d.ts} +0 -0
  122. /package/build/{querier.js → cjs/querier.js} +0 -0
  123. /package/build/{registry.d.ts → cjs/registry.d.ts} +0 -0
  124. /package/build/{registry.js → cjs/registry.js} +0 -0
  125. /package/build/{signer.d.ts → cjs/signer.d.ts} +0 -0
  126. /package/build/{signer.js → cjs/signer.js} +0 -0
  127. /package/build/{types.js → cjs/types.js} +0 -0
@@ -1,30 +0,0 @@
1
- name: "Build & Test"
2
- on:
3
- workflow_call:
4
- defaults:
5
- run:
6
- shell: bash
7
-
8
- jobs:
9
- build:
10
- name: "Build Node.js"
11
- runs-on: ubuntu-latest
12
-
13
- steps:
14
- - uses: actions/checkout@v3
15
-
16
- - uses: actions/setup-node@v3
17
- with:
18
- node-version: 18
19
- cache: 'npm'
20
- cache-dependency-path: '**/package-lock.json'
21
-
22
- - name: "Clean install dependencies"
23
- run: npm ci
24
-
25
- - name: "Run npm build"
26
- run: npm run build
27
-
28
- # - name: "Run npm test"
29
- # run: npm test
30
-
@@ -1,45 +0,0 @@
1
- name: "Cleanup - Actions"
2
- on:
3
- workflow_dispatch:
4
- inputs:
5
- days:
6
- description: 'Retain days'
7
- required: true
8
- type: string
9
- default: 30
10
- minimum_runs:
11
- description: 'Minimum runs to keep for each workflow'
12
- required: true
13
- type: string
14
- default: 0
15
- delete_workflow_pattern:
16
- description: 'Name/filename of workflow. Default is all.'
17
- required: false
18
- type: string
19
- delete_workflow_by_state_pattern:
20
- description: 'Remove workflow by state: active, deleted, disabled_fork, disabled_inactivity, disabled_manually'
21
- required: true
22
- default: All
23
- type: choice
24
- options:
25
- - All
26
- - active
27
- - deleted
28
- - disabled_inactivity
29
- - disabled_manually
30
-
31
- jobs:
32
-
33
- delete-runs:
34
- name: "Delete old workflow runs"
35
- runs-on: ubuntu-latest
36
-
37
- steps:
38
- - uses: Mattraks/delete-workflow-runs@v2
39
- with:
40
- token: ${{ github.token }}
41
- repository: ${{ github.repository }}
42
- retain_days: ${{ github.event.inputs.days }}
43
- keep_minimum_runs: ${{ github.event.inputs.minimum_runs }}
44
- delete_workflow_pattern: ${{ github.event.inputs.delete_workflow_pattern }}
45
- delete_workflow_by_state_pattern: ${{ github.event.inputs.delete_workflow_by_state_pattern }}
@@ -1,24 +0,0 @@
1
- name: "Cache Cleanup - Automatic"
2
- on:
3
- pull_request:
4
- types:
5
- - closed
6
- defaults:
7
- run:
8
- shell: bash
9
-
10
-
11
- jobs:
12
-
13
- cache-purge:
14
- name: "Purge Actions cache"
15
- runs-on: ubuntu-latest
16
-
17
- steps:
18
-
19
- - name: "Delete Branch Cache Action"
20
- uses: snnaplab/delete-branch-cache-action@v1.0.0
21
- with:
22
- # Specify explicitly because the ref at the time of merging will be a branch name such as 'main', 'develop'
23
- ref: refs/pull/${{ github.event.number }}/merge
24
- github-token: ${{ secrets.GITHUB_TOKEN }}
@@ -1,21 +0,0 @@
1
- name: "Cache Cleanup - Manual"
2
- on:
3
- workflow_dispatch:
4
- inputs:
5
- dry-run:
6
- description: "Dry run only?"
7
- required: true
8
- type: boolean
9
- default: false
10
-
11
- jobs:
12
-
13
- delete-caches:
14
- name: "Delete Actions caches"
15
- runs-on: ubuntu-latest
16
-
17
- steps:
18
- - name: "Wipe Github Actions cache"
19
- uses: easimon/wipe-cache@v1
20
- with:
21
- dry-run: ${{ github.event.inputs.dry-run }}
@@ -1,40 +0,0 @@
1
- name: "CodeQL"
2
- on:
3
- push:
4
- branches:
5
- - main
6
- - develop
7
- concurrency:
8
- group: ${{ github.workflow }}-${{ github.ref }}
9
- cancel-in-progress: true
10
- defaults:
11
- run:
12
- shell: bash
13
-
14
-
15
- jobs:
16
-
17
- codeql-analysis:
18
- name: "CodeQL Analysis"
19
- runs-on: ubuntu-latest
20
- permissions:
21
- security-events: write
22
-
23
- steps:
24
- - uses: actions/checkout@v3
25
- with:
26
- fetch-depth: 0
27
-
28
- - name: Initialise CodeQL
29
- uses: github/codeql-action/init@v2
30
- with:
31
- languages: 'javascript'
32
- queries: security-and-quality
33
-
34
- - name: Build
35
- run: |
36
- npm ci
37
- npm run build
38
-
39
- - name: Perform CodeQL Analysis
40
- uses: github/codeql-action/analyze@v2
@@ -1,30 +0,0 @@
1
- name: "Workflow Dispatch"
2
- on: push
3
- concurrency:
4
- group: ${{ github.workflow }}-${{ github.ref }}
5
- cancel-in-progress: true
6
-
7
-
8
- jobs:
9
-
10
- call-lint:
11
- name: "Lint"
12
- uses: ./.github/workflows/lint.yml
13
-
14
- call-build:
15
- name: "Build & Test"
16
- needs: call-lint
17
- uses: ./.github/workflows/build.yml
18
-
19
- call-test:
20
- name: "Tests"
21
- needs: call-build
22
- uses: ./.github/workflows/test.yml
23
- secrets: inherit
24
-
25
- call-release:
26
- name: "Release"
27
- needs: call-test
28
- if: ${{ github.ref_protected == true }}
29
- uses: ./.github/workflows/release.yml
30
- secrets: inherit
@@ -1,51 +0,0 @@
1
- name: "Lint"
2
- on:
3
- workflow_call:
4
- defaults:
5
- run:
6
- shell: bash
7
-
8
-
9
- jobs:
10
-
11
- md-link-check:
12
- name: "Broken Markdown links"
13
- runs-on: ubuntu-latest
14
-
15
- steps:
16
- - uses: actions/checkout@v3
17
-
18
- - name: Run Markdown link check
19
- uses: gaurav-nelson/github-action-markdown-link-check@v1
20
- with:
21
- config-file: '.github/linters/mlc_config.json'
22
- use-quiet-mode: 'yes'
23
-
24
- super-lint:
25
- name: "Super Linter"
26
- runs-on: ubuntu-latest
27
-
28
- steps:
29
- - uses: actions/checkout@v3
30
- with:
31
- fetch-depth: 0 # Required to fetch version
32
-
33
- - name: Run Super Linter
34
- uses: github/super-linter/slim@v4
35
- env:
36
- IGNORE_GITIGNORED_FILES: true
37
- DEFAULT_BRANCH: main
38
- LINTER_RULES_PATH: '.github/linters'
39
- GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
40
- LOG_LEVEL: WARN
41
- VALIDATE_ALL_CODEBASE: true
42
- MULTI_STATUS: true
43
-
44
- VALIDATE_GITHUB_ACTIONS: true
45
- VALIDATE_JAVASCRIPT_ES: true
46
- VALIDATE_JSONC: true
47
- VALIDATE_JSX: true
48
- VALIDATE_MARKDOWN: true
49
- VALIDATE_TSX: true
50
- VALIDATE_TYPESCRIPT_ES: true
51
- VALIDATE_YAML: true
@@ -1,33 +0,0 @@
1
- name: "PR Title Check"
2
- on:
3
- pull_request_target:
4
- branches:
5
- - main
6
- - develop
7
- types:
8
- - opened
9
- - reopened
10
- - edited
11
- - synchronize
12
- - ready_for_review
13
- - review_requested
14
- concurrency:
15
- group: ${{ github.workflow }}-${{ github.ref }}
16
- cancel-in-progress: true
17
-
18
- jobs:
19
- lint-pr:
20
- name: "PR format check"
21
- runs-on: ubuntu-latest
22
- steps:
23
- - uses: actions/checkout@v3
24
- # check for the most recent release: https://github.com/CondeNast/conventional-pull-request-action/releases
25
- # replace vX.X.X below with the most recently released version
26
- - uses: CondeNast/conventional-pull-request-action@v0.1.2
27
- env:
28
- GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
29
- with:
30
- # to override config-conventional rules, specify a relative path to your rules module, actions/checkout is required for this setting!
31
- commitlintRulesPath: "./.github/linters/.commitlint.rules.js" # default: undefined
32
- # if the PR contains a single commit, fail if the commit message and the PR title do not match
33
- commitTitleMatch: false # default: 'true'
@@ -1,42 +0,0 @@
1
- name: "Release"
2
- on:
3
- workflow_call:
4
- defaults:
5
- run:
6
- shell: bash
7
-
8
- jobs:
9
- release:
10
- name: "Semantic Release"
11
- runs-on: ubuntu-latest
12
-
13
- steps:
14
- - uses: actions/checkout@v3
15
- with:
16
- fetch-depth: 0
17
- persist-credentials: false
18
-
19
- - uses: actions/setup-node@v3
20
- with:
21
- node-version: 18
22
- cache: 'npm'
23
- cache-dependency-path: '**/package-lock.json'
24
-
25
- - name: "Obtain Github App token"
26
- id: app-token
27
- uses: getsentry/action-github-app-token@v2.0.0
28
- with:
29
- app_id: ${{ secrets.BOT_APP_ID }}
30
- private_key: ${{ secrets.BOT_APP_PRIVATE_KEY }}
31
-
32
- - name: "Clean install dependencies"
33
- run: npm ci
34
-
35
- - name: "Run npm build"
36
- run: npm run build
37
-
38
- - name: "Execute Semantic Release"
39
- run: npx semantic-release
40
- env:
41
- GITHUB_TOKEN: ${{ steps.app-token.outputs.token }}
42
- NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
@@ -1,66 +0,0 @@
1
- name: "Tests"
2
- on:
3
- workflow_call:
4
- defaults:
5
- run:
6
- shell: bash
7
- env:
8
- RUNNER_BIN_DIR: /home/runner/.local/bin
9
- permissions:
10
- contents: write
11
- packages: read
12
- checks: write
13
-
14
- jobs:
15
-
16
- integration-tests:
17
- name: "Integration Tests"
18
- runs-on: ubuntu-20.04
19
-
20
- steps:
21
- - uses: actions/checkout@v3
22
-
23
- - uses: actions/setup-node@v3
24
- with:
25
- node-version: 18
26
- cache: 'npm'
27
- cache-dependency-path: '**/package-lock.json'
28
-
29
- - name: Download binary artifact
30
- run: |
31
- mkdir -p ${{ env.RUNNER_BIN_DIR }}
32
- CHEQD_NODE_VERSION="$(cut -c2- <<< "$(jq -r 'map(select(.prerelease)) | first | .tag_name' <<< "$(curl --silent https://api.github.com/repos/cheqd/cheqd-node/releases)")")"
33
- wget -c "https://github.com/cheqd/cheqd-node/releases/download/v$CHEQD_NODE_VERSION/cheqd-noded-.$CHEQD_NODE_VERSION-.linux-x86_64.tar.gz"
34
- tar -xvf "cheqd-noded-.$CHEQD_NODE_VERSION-.linux-x86_64.tar.gz" -C ${{ env.RUNNER_BIN_DIR }}
35
- sudo chmod +x ${{ env.RUNNER_BIN_DIR }}/cheqd-noded
36
-
37
- - name: Restore binary permissions
38
- run: sudo chmod +x ${{ env.RUNNER_BIN_DIR }}/cheqd-noded
39
-
40
- - name: Generate localnet configs
41
- working-directory: ./docker/localnet
42
- run: |
43
- bash gen-network-config.sh
44
- sudo chown -R 1000:1000 network-config
45
-
46
- - name: Set up Docker localnet
47
- working-directory: ./docker/localnet
48
- run: |
49
- CHEQD_NODE_VERSION="$(cut -c2- <<< "$(jq -r 'map(select(.prerelease)) | first | .tag_name' <<< "$(curl --silent https://api.github.com/repos/cheqd/cheqd-node/releases)")")"
50
- BUILD_IMAGE="ghcr.io/cheqd/cheqd-node:$CHEQD_NODE_VERSION"
51
- export BUILD_IMAGE
52
- docker compose up --detach
53
-
54
- - name: Import keys
55
- working-directory: ./docker/localnet
56
- run: |
57
- bash import-keys.sh
58
-
59
- - name: "Clean install dependencies"
60
- run: npm ci
61
-
62
- - name: "Run npm build"
63
- run: npm run build
64
-
65
- - name: Run Tests
66
- run: npm test
package/.releaserc.json DELETED
@@ -1,56 +0,0 @@
1
- {
2
- "branches": [
3
- "main",
4
- {
5
- "name": "develop",
6
- "channel": "beta",
7
- "prerelease": true
8
- }
9
- ],
10
- "tagFormat": "${version}",
11
- "ci": true,
12
- "preset": "conventionalcommits",
13
- "plugins": [
14
- [ "@semantic-release/commit-analyzer",
15
- {
16
- "parserOpts": "./.github/linters/.commitlint.rules.js",
17
- "releaseRules": [
18
- { "breaking": true, "release": "major" },
19
- { "type": "feat", "release": "minor" },
20
- { "type": "fix", "release": "patch" },
21
- { "type": "perf", "release": "patch" },
22
- { "type": "build", "release": "patch" },
23
- { "scope": "security", "release": "patch" },
24
- { "type": "chore", "release": false },
25
- { "type": "ci", "release": false },
26
- { "type": "docs", "release": false },
27
- { "type": "refactor", "release": false },
28
- { "type": "revert", "release": false },
29
- { "type": "style", "release": false },
30
- { "type": "test", "release": false },
31
- { "scope": "no-release", "release": false },
32
- { "scope": "release", "release": "patch" }
33
- ],
34
- "presetConfig": true
35
- }
36
- ],
37
- [ "@semantic-release/release-notes-generator",
38
- {
39
- "presetConfig": true
40
- }
41
- ],
42
- [ "@semantic-release/changelog",
43
- {
44
- "changelogTitle": "# Changelog"
45
- }
46
- ],
47
- "@semantic-release/npm",
48
- [ "@semantic-release/git",
49
- {
50
- "assets": [ "package.json", "CHANGELOG.md" ],
51
- "message": "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
52
- }
53
- ],
54
- "@semantic-release/github"
55
- ]
56
- }