Cancel a request

Recover tokens from a stale, still-pending request after its TTL has elapsed.

A subscription or redemption request can be cancelled by its investor or receiver, provided it is still pending (not yet approved or denied) and its cancellation TTL has elapsed. This lets users recover tokens from stale requests.

function cancelSubscription(uint256 id) external; // returns escrowed assets to the investor
function cancelRedemption(uint256 id) external;   // returns escrowed shares to the investor

The TTL after which a request becomes cancellable is the cancelableFrom timestamp in the request's creation event (timestamp + subscriptionRequestTtl / + redemptionRequestTtl). Calling before then reverts with RequestNotPastTtl; calling on a non-pending request reverts with RequestNotPending.

viem

import { createWalletClient, http, parseAbi } from "viem";
import { privateKeyToAccount } from "viem/accounts";
import { mainnet } from "viem/chains";

const SHARES = "0x...";
const abi = parseAbi([
  "function cancelSubscription(uint256 id)",
  "function cancelRedemption(uint256 id)",
]);

const account = privateKeyToAccount("0x...");
const wallet = createWalletClient({ account, chain: mainnet, transport: http() });

await wallet.writeContract({ address: SHARES, abi, functionName: "cancelSubscription", args: [42n] });

ethers.js

import { ethers } from "ethers";

const SHARES = "0x...";
const abi = ["function cancelSubscription(uint256 id)", "function cancelRedemption(uint256 id)"];

const provider = new ethers.JsonRpcProvider("https://eth.llamarpc.com");
const signer = new ethers.Wallet("0x...", provider);
const shares = new ethers.Contract(SHARES, abi, signer);

await (await shares.cancelSubscription(42n)).wait();

Python

from web3 import Web3

SHARES = "0x..."
abi = [
    {"name": "cancelSubscription", "type": "function", "stateMutability": "nonpayable",
     "inputs": [{"name": "id", "type": "uint256"}], "outputs": []},
    {"name": "cancelRedemption", "type": "function", "stateMutability": "nonpayable",
     "inputs": [{"name": "id", "type": "uint256"}], "outputs": []},
]

w3 = Web3(Web3.HTTPProvider("https://eth.llamarpc.com"))
acct = w3.eth.account.from_key("0x...")
shares = w3.eth.contract(address=SHARES, abi=abi)

tx = shares.functions.cancelSubscription(42).build_transaction({"from": acct.address})
# ... sign & send tx ...

Events

Cancelling emits a SubscriptionCancellation or RedemptionCancellation event with the request id and the canceller's address.