Skip to main content

bridge/interfaces/UnwrapTokenOptions.md

Options for unwrapping a token (e.g., GMUSIC → MUSIC)

Unwrapping transfers a token from the asset channel back to its native channel, converting it from the wrapped version to the original.

Example​

const result = await wrapService.unwrapToken({
tokenId: '$GMUSIC|Unit|none|none',
amount: '50',
});

Properties​

PropertyTypeDescription
amountstringAmount to unwrap (decimal string, e.g., "50")
recipient?stringOptional GalaChain recipient address (defaults to the sender)
tokenIdTokenClassKeyInputToken to unwrap (wrapped token on asset channel), by its class key: the pipe form ("$GMUSIC|Unit|none|none") or the object. A bare symbol is refused (INVALID_TOKEN_REFERENCE).