Token metadata
Set and remove mutable token metadata entries for DALP asset tokens using the token metadata API.
Token metadata stores asset facts such as issuer name, coupon rate, maturity type, reporting category, or other issuer-defined fields. Asset Designer can collect metadata values during asset creation. After deployment, governance operators can update only metadata that remains mutable for the issued asset.
Use the token metadata API when an integration needs to keep mutable asset facts current without redeploying the token. Immutable metadata stays locked after deployment.
Prerequisites
- A deployed token address.
- A caller with the token governance permission for metadata changes.
- A metadata key that is mutable on the issued asset.
- For user-session calls, wallet verification for the transaction-submitting wallet. API-key calls authenticate with
X-Api-Keyand do not include awalletVerificationpayload.
Set metadata entries
Call PATCH /api/v2/tokens/{tokenAddress}/metadata with a metadataValues object. Metadata keys are issuer-defined strings. Values can be strings or finite numbers.
curl -X PATCH "$DAPI_URL/api/v2/tokens/0x1111111111111111111111111111111111111111/metadata" \
-H "X-Api-Key: $DALP_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"metadataValues": {
"issuerName": "Northwind Treasury",
"couponRate": 5.5
}
}'DALP submits the metadata change through the transaction queue. When the transaction completes synchronously, the response contains the token read-back. When the transaction is accepted asynchronously, use the returned transaction tracking data to monitor completion.
Remove one metadata entry
Call DELETE /api/v2/tokens/{tokenAddress}/metadata with the metadata key to remove.
curl -X DELETE "$DAPI_URL/api/v2/tokens/0x1111111111111111111111111111111111111111/metadata" \
-H "X-Api-Key: $DALP_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"metadataKey": "issuerName"
}'metadataKey must be a non-empty string of at most 200 characters.
Permission and mutability rules
Metadata changes are governance actions. DALP checks token permissions before queuing the transaction. A caller without metadata permission receives an error before transaction submission.
The metadata schema controls which fields can change after deployment. Fields configured as immutable during asset creation cannot be updated later. Mutable fields can be updated or removed through this API when the caller passes token permission checks. User-session calls must also pass wallet verification before DALP queues the transaction.
CLI equivalent
The DALP CLI exposes the same operations for one key at a time:
dalp tokens set-metadata --address 0x1111111111111111111111111111111111111111 --key issuerName --value "Northwind Treasury"
dalp tokens remove-metadata --address 0x1111111111111111111111111111111111111111 --key issuerName