Unlock a previously locked MPT issuance, or a specific holder's balance when holder is given.
token.unlock(
params: TokenLockParams,
options?: TokenWriteOptions,
): Promise<SubmissionResult>| Parameter | Type | Required | Description |
|---|---|---|---|
mptIssuanceId | string | Yes | The MPT issuance id. |
holder | string | No | A specific holder to unlock. Omit to unlock the whole issuance. |
options is an optional second argument that sets the source account and overrides the fee.
| Option | Type | Required | Description |
|---|---|---|---|
from | AccountSelector | No | The account to act as — an r-address string, or an object { address } or { signer, account? }. Defaults to the primary signer's primary account. (For IOU operations, this is the issuer.) |
fee | FeeIntent | No | Fee override — a priority tier and/or a maxFeeDrops cap. |
idempotencyKey | string | No | A prior submission's idempotencyKey, to retry to the same intent instead of creating a duplicate. Auto-generated when omitted. |
Resolves to a SubmissionResult<{ mptIssuanceId: string; locked: boolean }>.
Every simpleXRPL write resolves to a SubmissionResult<T> — a union tagged by source, with the backend's raw response preserved verbatim. Its common fields are:
| Field | Type | Description |
|---|---|---|
intent | T | The operation-specific output — see the operation's own return fields. |
source | 'xrpld' | 'custody' | 'palisade' | Which backend produced the result; discriminates response. |
response | TxResponse | custody record | Palisade record | The backend's raw response, preserved verbatim. |
txHash | string (optional) | The XRPL transaction hash, once the transaction is on-ledger. |
intentId | string (optional) | The custodian intent id, when the path produced one. Hold onto this to resume via client.intent. |
idempotencyKey | string (optional) | The UUIDv7 this submission carried. Pass it back as a later call's idempotencyKey to retry to the same intent rather than creating a duplicate. |
For Token.unlock, the intent carries:
| Field | Type | Description |
|---|---|---|
mptIssuanceId | string | The MPT issuance id that was unlocked. |
locked | boolean | The resulting lock state (false). |
Builds and submits a single MPTokenIssuanceSet transaction with the unlock flag set.
await client.token.unlock({
mptIssuanceId: '005C...',
})