Remove Claim from Identity

Remove a claim from an ONCHAINID identity by claim ID using the identity owner’s signer. Returns the removed claim ID and transaction receipt.

onchainid.removeClaimFromIdentity(RemoveClaimFromIdentity)

Remove a claim from an ONCHAINID identity by claimId. This sends a transaction to the identity contract and requires the identity owner’s signer.

RemoveClaimFromIdentity Type Parameters

Parameter	Type	Required	Description
subjectIdentity	string	Required	The ONCHAINID identity contract address to modify.
identityController	Signer	Required	The signer authorized to remove claims from the identity (controller).
claimId	string	Required	The claim identifier, computed as keccak256(abi.encode(issuer, topic)).

Returns

Field	Type	Description
status	removed	Status of the removal.
claimId	string	Claim ID removed from the identity.
receipt	TransactionReceipt	The transaction receipt confirming claim removal.

Usage

TypeScript

import 'dotenv/config';
import { RWA, Chain, ClaimTopics, type SDKInit, type GetIdentity, type RemoveClaimFromIdentity } from '@peaq-network/rwa';
import { JsonRpcProvider, AbiCoder, keccak256, Wallet } from "ethers";

async function main() {
    // 0. Create rwa_sdk instance and get provider
    const provider = new JsonRpcProvider(process.env.HTTPS_BASE_URL);
    const init: SDKInit = { chainId: Chain.AGUNG, provider: provider };
    const rwa_sdk = new RWA(init);

    // 1. Resolve the identity for an EOA (or use a known identity address)
    const alice = process.env.ALICE_PUBLIC_ADDRESS!;
    const identityRes = await rwa_sdk.onchainid.getIdentity({ subject: alice } as GetIdentity);
    if (identityRes.status !== 'found') throw new Error('Identity not found');
    const identity = identityRes.identity;

    // 2. Identity owner signer
    const identityOwner = new Wallet(process.env.ALICE_PRIVATE_KEY!, provider);

    // 3. Compute claimId = keccak256(abi.encode(issuer, topic))
    const issuerContract = process.env.CLAIM_ISSUER_CONTRACT_ADDRESS!;
    const topic = ClaimTopics.CT_KYC_APPROVED;
    const abiCoder = new AbiCoder();
    const claimId = keccak256(abiCoder.encode(["address", "uint256"], [issuerContract, topic]));

    // 4. Remove claim from identity
    const result = await rwa_sdk.onchainid.removeClaimFromIdentity({
      subjectIdentity: identity,
      identityController: identityOwner,
      claimId
    } as RemoveClaimFromIdentity);
    console.log("Result", result);
}

main().catch((err) => {
  console.error(err);
  process.exit(1);
});

JavaScript

import 'dotenv/config';
import { RWA, Chain, ClaimTopics } from "@peaq-network/rwa";
import { JsonRpcProvider, AbiCoder, keccak256, Wallet } from "ethers";

async function main() {
    // 0. Create rwa_sdk instance and get provider
    const provider = new JsonRpcProvider(process.env.HTTPS_BASE_URL);
    const rwa_sdk = new RWA({ chainId: Chain.AGUNG, provider: provider });

    // 1. Resolve the identity for an EOA (or use a known identity address)
    const alice = process.env.ALICE_PUBLIC_ADDRESS;
    const identityRes = await rwa_sdk.onchainid.getIdentity({ subject: alice });
    if (identityRes.status !== 'found') throw new Error('Identity not found');
    const identity = identityRes.identity;

    // 2. Identity owner signer
    const identityOwner = new Wallet(process.env.ALICE_PRIVATE_KEY, provider);

    // 3. Compute claimId = keccak256(abi.encode(issuer, topic))
    const issuerContract = process.env.CLAIM_ISSUER_CONTRACT_ADDRESS;
    const topic = ClaimTopics.CT_KYC_APPROVED;
    const abiCoder = new AbiCoder();
    const claimId = keccak256(abiCoder.encode(["address", "uint256"], [issuerContract, topic]));

    // 4. Remove claim from identity
    const result = await rwa_sdk.onchainid.removeClaimFromIdentity({
      subjectIdentity: identity,
      identityController: identityOwner,
      claimId: claimId
    });
    console.log("Result", result);
}

main().catch((err) => {
  console.error(err);
  process.exit(1);
});

Example outputs

{
  status: 'removed',
  claimId: '0x8b8a9d2d3a4d1b0f9d1e3f8c1a6d58e4c1b6d95a2a4a9f2e6d0d7d2b8b1c2d3a',
  receipt: TransactionReceipt {
    ...
    hash: '0xbfb964e21d0a8f227e62752a1a5b7cca95aff0cd992430a6213d06e6ea548b9c',
    status: 1
  }
}