MET-685: Add new parameters #15

MarkSackerberg · 2025-03-11T12:54:44Z

Adding displayOptions for

displayOptions.showUnverifiedCollections
showCollectionMetadata
showFungible
showInscription
onlyVerified

vercel · 2025-03-11T12:54:49Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
digital-asset-standard-api-js-docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Apr 2, 2025 9:28am

clients/js/src/types.ts

clients/js/test/getAssetsByCreator.test.ts

clients/js/test/getAssetsByOwner.test.ts

clients/js/test/searchAssets.test.ts

clients/js/test/getAsset.test.ts

coderabbitai · 2025-04-02T08:59:28Z

Summary by CodeRabbit

New Features
- Expanded asset queries to support customizable display options, including refined filtering for collection visibility, metadata inclusion, and token type selection.
Refactor
- Updated asset retrieval interfaces with flexible input parameters and improved error handling, ensuring robust pagination validation.
Chores
- Enhanced environment variable checks to prevent runtime errors and improve overall system stability.

Walkthrough

The updates modify the asset API by changing method signatures in the decorator and type definitions to accept structured input objects that include additional properties such as display options. The pagination validation is now encapsulated in a dedicated function. New types—including display options, asset input types, and token types—have been introduced, and several existing type definitions have been refactored. Across the test suite, asset IDs, expected interfaces, and assertion logic have been updated and expanded to cover scenarios like unverified collections and collection metadata. The test setup now also includes extra checks for valid endpoint configurations.

Changes

File(s)	Change Summary
`clients/js/src/decorator.ts`	Refactored `createDasApiDecorator` to extract asset IDs and display options from input objects; updated `getAsset` and `getAssets` method signatures; integrated a new `validatePagination` function for pagination parameter validation.
`clients/js/src/types.ts`	Added new types (`DisplayOptions`, `GetAssetRpcInput`, `GetAssetsRpcInput`, `TokenType`); updated existing input types (e.g., `SearchAssetsRpcInput`, `GetAssetsBy*RpcInput`) with additional properties such as `displayOptions` and modified several property names.
`clients/js/test/_setup.ts`	Changed endpoint initialization by removing direct non-null assertions on `process.env` values and adding a conditional check for defined URLs before adding to the endpoints array.
`clients/js/test/getAsset.test.ts`	Updated asset ID and expected interface; added tests for asset fetching with display options; modified assertions to check for properties like `mutable` and `burnt`.
`clients/js/test/getAssets.test.ts`	Updated asset IDs; refactored assertions for clarity; added new tests for multiple asset fetching with specific display options.
`clients/js/test/getAssetsByAuthority.test.ts`	Added tests for fetching assets with various display options, including unverified collections and collection metadata.
`clients/js/test/getAssetsByCreator.test.ts`	Introduced tests for fetching assets based on creator verification status and display options.
`clients/js/test/getAssetsByGroup.test.ts`	Added tests for fetching assets with and without unverified collections and with collection metadata.
`clients/js/test/getAssetsByOwner.test.ts`	Enhanced tests for fetching assets based on ownership and display options, including fungible tokens.
`clients/js/test/searchAssets.test.ts`	Added tests for searching assets with display options related to unverified collections.

Sequence Diagram(s)

sequenceDiagram
    participant U as User
    participant D as DasApiDecorator
    participant V as validatePagination
    participant R as RPC Service

    U ->> D: getAsset({ assetId, displayOptions })
    alt Pagination parameters present
        D ->> V: validatePagination(params)
    end
    D ->> R: Request asset data with assetId & displayOptions
    alt Asset found
        R -->> D: Return asset data
        D -->> U: Return asset data
    else Asset missing
        R -->> D: Return error/empty response
        D -->> U: Throw DasApiError
    end

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai plan to trigger planning for file edits and PR creation.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai

Actionable comments posted: 5

🔭 Outside diff range comments (5)

clients/js/test/searchAssets.test.ts (1)
1-146: ⚠️ Potential issue

Fix code style issues

There are code style issues reported by the pipeline. Please run Prettier on the file to ensure consistent formatting.
#!/bin/bash
# Run Prettier on this file to fix the formatting issues
npx prettier --write clients/js/test/searchAssets.test.ts
🧰 Tools

🪛 GitHub Actions: Main

[warning] Code style issues found. Forgot to run Prettier?
clients/js/test/getAssetsByCreator.test.ts (1)
1-184: 💡 Verification agent
🧩 Analysis chain

Run Prettier to fix code style issues.

The pipeline has flagged code style issues. Please run Prettier on this file to ensure consistent formatting.

🏁 Script executed:
#!/bin/bash
# Check if prettier is installed and run it on the file
if command -v npx &> /dev/null; then
  echo "Running Prettier check on getAssetsByCreator.test.ts"
  npx prettier --check "clients/js/test/getAssetsByCreator.test.ts"
else
  echo "npx not found. Please ensure npm is installed."
fi
Length of output: 442
Action Required: Format Code with Prettier

The Prettier check flagged formatting issues in clients/js/test/getAssetsByCreator.test.ts. Please run the following command to automatically fix the formatting:
npx prettier --write clients/js/test/getAssetsByCreator.test.ts
This will update the file to adhere to our project's style guidelines.

🧰 Tools

🪛 Biome (1.9.4)

[error] 166-166: Forbidden non-null assertion.

Unsafe fix: Replace with optional chain operator ?. This operator includes runtime checks, so it is safer than the compile-only non-null assertion operator

(lint/style/noNonNullAssertion)

🪛 GitHub Actions: Main

[warning] Code style issues found. Forgot to run Prettier?
clients/js/test/getAssets.test.ts (2)
28-72: 🧹 Nitpick (assertive)

Replace non-null assertions with optional chaining.

Multiple uses of non-null assertions (!) were flagged by static analysis. These should be replaced with optional chaining (?.) for better type safety.

For example:
-t.deepEqual(compressedAsset!.interface, 'V1_NFT');
+t.deepEqual(compressedAsset?.interface, 'V1_NFT');
This should be applied to all instances of non-null assertions in the file (lines 28-29, 30, 37, 47-48, 52-53, 56-58, 63, 66-67, 71-72).

🧰 Tools

🪛 Biome (1.9.4)

[error] 28-28: Forbidden non-null assertion.

Unsafe fix: Replace with optional chain operator ?. This operator includes runtime checks, so it is safer than the compile-only non-null assertion operator

(lint/style/noNonNullAssertion)

[error] 29-29: Forbidden non-null assertion.

Unsafe fix: Replace with optional chain operator ?. This operator includes runtime checks, so it is safer than the compile-only non-null assertion operator

(lint/style/noNonNullAssertion)

[error] 30-30: Forbidden non-null assertion.

Unsafe fix: Replace with optional chain operator ?. This operator includes runtime checks, so it is safer than the compile-only non-null assertion operator

(lint/style/noNonNullAssertion)

[error] 37-37: Forbidden non-null assertion.

Unsafe fix: Replace with optional chain operator ?. This operator includes runtime checks, so it is safer than the compile-only non-null assertion operator

(lint/style/noNonNullAssertion)

[error] 47-47: Forbidden non-null assertion.

Unsafe fix: Replace with optional chain operator ?. This operator includes runtime checks, so it is safer than the compile-only non-null assertion operator

(lint/style/noNonNullAssertion)

[error] 48-48: Forbidden non-null assertion.

Unsafe fix: Replace with optional chain operator ?. This operator includes runtime checks, so it is safer than the compile-only non-null assertion operator

(lint/style/noNonNullAssertion)

[error] 52-52: Forbidden non-null assertion.

Unsafe fix: Replace with optional chain operator ?. This operator includes runtime checks, so it is safer than the compile-only non-null assertion operator

(lint/style/noNonNullAssertion)

[error] 53-53: Forbidden non-null assertion.

Unsafe fix: Replace with optional chain operator ?. This operator includes runtime checks, so it is safer than the compile-only non-null assertion operator

(lint/style/noNonNullAssertion)

[error] 56-56: Forbidden non-null assertion.

Unsafe fix: Replace with optional chain operator ?. This operator includes runtime checks, so it is safer than the compile-only non-null assertion operator

(lint/style/noNonNullAssertion)

[error] 57-57: Forbidden non-null assertion.

Unsafe fix: Replace with optional chain operator ?. This operator includes runtime checks, so it is safer than the compile-only non-null assertion operator

(lint/style/noNonNullAssertion)

[error] 58-58: Forbidden non-null assertion.

Unsafe fix: Replace with optional chain operator ?. This operator includes runtime checks, so it is safer than the compile-only non-null assertion operator

(lint/style/noNonNullAssertion)

[error] 63-63: Forbidden non-null assertion.

Unsafe fix: Replace with optional chain operator ?. This operator includes runtime checks, so it is safer than the compile-only non-null assertion operator

(lint/style/noNonNullAssertion)

[error] 66-66: Forbidden non-null assertion.

Unsafe fix: Replace with optional chain operator ?. This operator includes runtime checks, so it is safer than the compile-only non-null assertion operator

(lint/style/noNonNullAssertion)

[error] 67-67: Forbidden non-null assertion.

Unsafe fix: Replace with optional chain operator ?. This operator includes runtime checks, so it is safer than the compile-only non-null assertion operator

(lint/style/noNonNullAssertion)

[error] 71-71: Forbidden non-null assertion.

Unsafe fix: Replace with optional chain operator ?. This operator includes runtime checks, so it is safer than the compile-only non-null assertion operator

(lint/style/noNonNullAssertion)

[error] 72-72: Forbidden non-null assertion.

Unsafe fix: Replace with optional chain operator ?. This operator includes runtime checks, so it is safer than the compile-only non-null assertion operator

(lint/style/noNonNullAssertion)

🪛 GitHub Actions: Main

[warning] Code style issues found. Forgot to run Prettier?

1-173: 💡 Verification agent
🧩 Analysis chain

Run Prettier to fix code style issues.

The pipeline has flagged code style issues. Please run Prettier on this file to ensure consistent formatting.

🏁 Script executed:
#!/bin/bash
# Check if prettier is installed and run it on the file
if command -v npx &> /dev/null; then
  echo "Running Prettier check on getAssets.test.ts"
  npx prettier --check "clients/js/test/getAssets.test.ts"
else
  echo "npx not found. Please ensure npm is installed."
fi
Length of output: 318
Action Required: Fix Prettier Formatting Issues

The file clients/js/test/getAssets.test.ts currently has code style issues as flagged by Prettier. Please run the following command to automatically fix the formatting:
npx prettier --write clients/js/test/getAssets.test.ts
Once formatted, ensure that the file passes the Prettier check before committing.

🧰 Tools

🪛 Biome (1.9.4)

[error] 28-28: Forbidden non-null assertion.

Unsafe fix: Replace with optional chain operator ?. This operator includes runtime checks, so it is safer than the compile-only non-null assertion operator

(lint/style/noNonNullAssertion)

[error] 29-29: Forbidden non-null assertion.

Unsafe fix: Replace with optional chain operator ?. This operator includes runtime checks, so it is safer than the compile-only non-null assertion operator

(lint/style/noNonNullAssertion)

[error] 30-30: Forbidden non-null assertion.

Unsafe fix: Replace with optional chain operator ?. This operator includes runtime checks, so it is safer than the compile-only non-null assertion operator

(lint/style/noNonNullAssertion)

[error] 37-37: Forbidden non-null assertion.

Unsafe fix: Replace with optional chain operator ?. This operator includes runtime checks, so it is safer than the compile-only non-null assertion operator

(lint/style/noNonNullAssertion)

[error] 47-47: Forbidden non-null assertion.

Unsafe fix: Replace with optional chain operator ?. This operator includes runtime checks, so it is safer than the compile-only non-null assertion operator

(lint/style/noNonNullAssertion)

[error] 48-48: Forbidden non-null assertion.

Unsafe fix: Replace with optional chain operator ?. This operator includes runtime checks, so it is safer than the compile-only non-null assertion operator

(lint/style/noNonNullAssertion)

[error] 52-52: Forbidden non-null assertion.

Unsafe fix: Replace with optional chain operator ?. This operator includes runtime checks, so it is safer than the compile-only non-null assertion operator

(lint/style/noNonNullAssertion)

[error] 53-53: Forbidden non-null assertion.

Unsafe fix: Replace with optional chain operator ?. This operator includes runtime checks, so it is safer than the compile-only non-null assertion operator

(lint/style/noNonNullAssertion)

[error] 56-56: Forbidden non-null assertion.

Unsafe fix: Replace with optional chain operator ?. This operator includes runtime checks, so it is safer than the compile-only non-null assertion operator

(lint/style/noNonNullAssertion)

[error] 57-57: Forbidden non-null assertion.

Unsafe fix: Replace with optional chain operator ?. This operator includes runtime checks, so it is safer than the compile-only non-null assertion operator

(lint/style/noNonNullAssertion)

[error] 58-58: Forbidden non-null assertion.

Unsafe fix: Replace with optional chain operator ?. This operator includes runtime checks, so it is safer than the compile-only non-null assertion operator

(lint/style/noNonNullAssertion)

[error] 63-63: Forbidden non-null assertion.

Unsafe fix: Replace with optional chain operator ?. This operator includes runtime checks, so it is safer than the compile-only non-null assertion operator

(lint/style/noNonNullAssertion)

[error] 66-66: Forbidden non-null assertion.

Unsafe fix: Replace with optional chain operator ?. This operator includes runtime checks, so it is safer than the compile-only non-null assertion operator

(lint/style/noNonNullAssertion)

[error] 67-67: Forbidden non-null assertion.

Unsafe fix: Replace with optional chain operator ?. This operator includes runtime checks, so it is safer than the compile-only non-null assertion operator

(lint/style/noNonNullAssertion)

[error] 71-71: Forbidden non-null assertion.

Unsafe fix: Replace with optional chain operator ?. This operator includes runtime checks, so it is safer than the compile-only non-null assertion operator

(lint/style/noNonNullAssertion)

[error] 72-72: Forbidden non-null assertion.

Unsafe fix: Replace with optional chain operator ?. This operator includes runtime checks, so it is safer than the compile-only non-null assertion operator

(lint/style/noNonNullAssertion)

🪛 GitHub Actions: Main

[warning] Code style issues found. Forgot to run Prettier?
clients/js/src/decorator.ts (1)
1-306: ⚠️ Potential issue

Run Prettier to fix code style issues.

The pipeline is reporting code style issues. Please run Prettier to ensure consistent formatting.
#!/bin/bash
# Run Prettier to fix formatting issues
npx prettier --write clients/js/src/decorator.ts
🧰 Tools

🪛 GitHub Actions: Main

[warning] Code style issues found. Forgot to run Prettier?

📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9ab5a34 and dcf2427.

📒 Files selected for processing (10)

clients/js/src/decorator.ts (2 hunks)
clients/js/src/types.ts (9 hunks)
clients/js/test/_setup.ts (1 hunks)
clients/js/test/getAsset.test.ts (2 hunks)
clients/js/test/getAssets.test.ts (2 hunks)
clients/js/test/getAssetsByAuthority.test.ts (2 hunks)
clients/js/test/getAssetsByCreator.test.ts (1 hunks)
clients/js/test/getAssetsByGroup.test.ts (1 hunks)
clients/js/test/getAssetsByOwner.test.ts (1 hunks)
clients/js/test/searchAssets.test.ts (2 hunks)

🧰 Additional context used

🧬 Code Definitions (8)

clients/js/test/getAssetsByGroup.test.ts (2)

clients/js/test/_setup.ts (1)

createUmi (17-18)

clients/js/src/types.ts (1)

DasApiAsset (241-306)

clients/js/test/getAssetsByAuthority.test.ts (1)

clients/js/test/_setup.ts (1)

createUmi (17-18)

clients/js/test/searchAssets.test.ts (1)

clients/js/test/_setup.ts (1)

createUmi (17-18)

clients/js/test/getAssets.test.ts (1)

clients/js/src/types.ts (2)

DasApiAssetContent (440-451)

DasApiAssetCompression (458-467)

clients/js/src/decorator.ts (2)

clients/js/src/types.ts (11)

GetAssetRpcInput (207-217)

DasApiAsset (241-306)

GetAssetsRpcInput (222-232)

GetAssetsByAuthorityRpcInput (29-39)

DasApiAssetList (355-377)

GetAssetsByCreatorRpcInput (41-56)

GetAssetsByGroupRpcInput (58-73)

GetAssetsByOwnerRpcInput (75-85)

SearchAssetsRpcInput (87-202)

GetAssetSignaturesRpcInput (550-600)

GetAssetSignaturesRpcResponse (608-633)

clients/js/src/errors.ts (1)

DasApiError (1-3)

clients/js/test/getAsset.test.ts (2)

clients/js/src/types.ts (1)

DasApiAsset (241-306)

clients/js/test/_setup.ts (1)

createUmi (17-18)

clients/js/test/getAssetsByCreator.test.ts (1)

clients/js/test/_setup.ts (1)

createUmi (17-18)

clients/js/test/getAssetsByOwner.test.ts (2)

clients/js/test/_setup.ts (1)

createUmi (17-18)

clients/js/src/types.ts (1)

DasApiAsset (241-306)

🪛 GitHub Actions: Main

clients/js/test/searchAssets.test.ts

[warning] Code style issues found. Forgot to run Prettier?

clients/js/test/getAssets.test.ts

[warning] Code style issues found. Forgot to run Prettier?

clients/js/src/decorator.ts

[warning] Code style issues found. Forgot to run Prettier?

clients/js/test/getAssetsByCreator.test.ts

[warning] Code style issues found. Forgot to run Prettier?

🪛 Biome (1.9.4)

clients/js/test/getAssets.test.ts

[error] 28-28: Forbidden non-null assertion.