SettleMint
API referenceEvents

asset.pause.final

An asset was paused, blocking every transfer, mint and burn until it is unpaused; sent once the chain finality watermark reaches the source block.

Delivery contract

FieldValue
Event typeasset.pause.final
Version1
Lifecycle statefinal
Counter-signed receiptsNo event-specific advice
SDK typeWebhook.AssetPauseFinalV1

The receipt recommendation does not change delivery behavior. DALP waits for a counter-signed receipt only if the webhook endpoint's counterSignedReceipts value is true when DALP queues the delivery. When the value is false, a normal 2xx response completes the delivery.

Related references:

  • idxr_token

Payload schema

The schema and examples describe the full payload. Thin delivery omits personal data fields. Use the payload-shape guidance to choose the endpoint configuration.

{
  "type": "object",
  "properties": {
    "chainId": {
      "type": "integer",
      "exclusiveMinimum": 0
    },
    "transactionHash": {
      "type": "string",
      "pattern": "^0x[a-fA-F0-9]{64}$"
    },
    "blockNumber": {
      "type": "integer",
      "minimum": 0
    },
    "logIndex": {
      "type": "integer",
      "minimum": 0
    },
    "assetAddress": {
      "type": "string",
      "minLength": 42,
      "maxLength": 42,
      "pattern": "^0x[a-fA-F0-9]{40}$",
      "description": "A valid Ethereum address (42 characters, starting with 0x)",
      "examples": ["0x71C7656EC7ab88b098defB751B7401B5f6d8976F"]
    },
    "operator": {
      "anyOf": [
        {
          "type": "string",
          "minLength": 42,
          "maxLength": 42,
          "pattern": "^0x[a-fA-F0-9]{40}$",
          "description": "A valid Ethereum address (42 characters, starting with 0x)",
          "examples": ["0x71C7656EC7ab88b098defB751B7401B5f6d8976F"]
        },
        {
          "type": "null"
        }
      ]
    },
    "paused": {
      "type": "boolean"
    }
  },
  "required": ["chainId", "transactionHash", "blockNumber", "logIndex", "assetAddress", "operator", "paused"],
  "additionalProperties": true
}

TypeScript SDK example

Use the request's raw body and headers with your endpoint's webhook secret. This handler illustrates verification and event selection. Before writing downstream state, deduplicate deliveries by evt_id and recognize replayed outcomes by their domain identifiers.

const result = await verifyWebhook({
  rawBody,
  headers,
  secret: process.env.DALP_WEBHOOK_SECRET!,
});

if (!result.ok) {
  throw new Error(`Webhook verification failed: ${result.code}`);
}

if (result.event.type === "asset.pause.final") {
  const event: Webhook.Event<"asset.pause.final"> = result.event;
  console.log(event.payload);
}

HTTP delivery example

This illustrative request shows the delivery shape. Its timestamp and signature are placeholders; a verifier rejects them. Use a signed platform delivery to verify your endpoint.

curl -X POST https://consumer.example.com/dalp/webhooks \
  -H "content-type: application/json" \
  -H "webhook-id: evt_1325395aaaca3f2d02311f0edc49f63b" \
  -H "webhook-timestamp: 1778112000" \
  -H "webhook-signature: v1,docs-example-signature" \
  --data '{"evt_id":"evt_1325395aaaca3f2d02311f0edc49f63b","source_id":"example:asset.pause.final@1:0","lifecycle_state":"final","payload":{"assetAddress":"0x1111111111111111111111111111111111111111","chainId":537001,"operator":"0x2222222222222222222222222222222222222222","paused":true,"transactionHash":"0xcccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccc","blockNumber":18445270,"logIndex":0},"related":{"idxr_token":"idxr_token_example"},"type":"asset.pause.final","version":1,"request":{"idempotency_key":"idem_01JZP7R5W8M9N0P1Q2R3S4T5"}}'

Version and manifest

This page documents version 1 of asset.pause.final. This event type is not deprecated. The DALP events manifest contains the machine-readable AsyncAPI entry.

On this page