TRN-862 Soulbound ERC5484 Tokens

e2e/common/index.ts

@@ -366,6 +366,15 @@ export const ERC721_PRECOMPILE_ABI = [
 
   // ERC165
   ...ERC165_ABI,
+
+  // ERC5484
+  "event PendingIssuanceCreated(address indexed to, uint256 issuanceId, uint256 quantity, uint8 burnAuth)",
+  "event Issued(address indexed from, address indexed to, uint256 indexed tokenId, uint8 burnAuth)",
+
+  "function issueSoulbound(address,uint32,uint8)",
+  "function acceptSoulboundIssuance(uint32)",
+  "function pendingIssuances(address) external view returns (uint256[] memory, (uint256 quantity, uint8)[] memory)",
+  "function burnAuth(uint256) external view returns (uint8)",
 ];
 
 export const ERC1155_PRECOMPILE_ABI = [
@@ -412,6 +421,17 @@ export const ERC1155_PRECOMPILE_ABI = [
 
   // ERC165
   ...ERC165_ABI,
+
+  // ERC5484
+  "event PendingIssuanceCreated(address indexed to, uint256 issuanceId, uint256[] tokenIds, uint256[] balances)",
+  "event Issued(address indexed from, address indexed to, uint256 indexed tokenId, uint8 burnAuth)",
+
+  "function setBurnAuth(uint256,uint8)",
+  "function issueSoulbound(address,uint256[],uint256[])",
+  "function acceptSoulboundIssuance(uint32)",
+  "function pendingIssuances(address) external view returns (uint256[] memory,(uint256[] memory,uint256[] memory,uint8[] memory)[] memory)",
+  "function burnAuth(uint256) external view returns (uint8)",
+  "function burnAsCollectionOwner(address,uint256[],uint256[])",
 ];
 
 export const FUTUREPASS_REGISTRAR_PRECOMPILE_ABI = [
@@ -828,3 +848,10 @@ export const getPrefixLength = (encoded: SubmittableExtrinsic<any>): number => {
   if (encoded.encodedLength < 66) return 6;
   return 8;
 };
+
+export enum BurnAuth {
+  TokenOwner = 0,
+  CollectionOwner,
+  Both,
+  Neither,
+}

e2e/test/ERC1155/ERC1155Precompile.test.ts

@@ -9,6 +9,7 @@ import Web3 from "web3";
 import {
   ALITH_PRIVATE_KEY,
   BOB_PRIVATE_KEY,
+  BurnAuth,
   ERC1155_PRECOMPILE_ABI,
   NodeProcess,
   ROOT_PRECOMPILE_ADDRESS,
@@ -65,7 +66,6 @@ describe("ERC1155 Precompile", function () {
                 erc1155PrecompileAddress = Web3.utils.toChecksumAddress(
                   `0xBBBBBBBB${collection_id_hex}000000000000000000000000`,
                 );
-                console.log(`SFT Collection Address: ${erc1155PrecompileAddress}`);
                 erc1155Precompile = new Contract(erc1155PrecompileAddress, ERC1155_PRECOMPILE_ABI, bobSigner);
                 resolve();
               }
@@ -764,4 +764,61 @@ describe("ERC1155 Precompile", function () {
     // console.log("TRN1155:", trn1155Id);
     // console.log("Ownable:", ownableId);
   });
+
+  it("can issue and accept issuance of soulbound tokens", async () => {
+    const receiverAddress = alithSigner.address;
+
+    const tokens = [];
+    for (let i = 0; i < 3; i++) {
+      const token = await createToken(0);
+
+      await erc1155Precompile.setBurnAuth(token, BurnAuth.Both).then((tx: any) => tx.wait());
+
+      tokens.push(token);
+    }
+
+    const amounts = tokens.map((_) => 5);
+
+    let receipt = await erc1155Precompile.issueSoulbound(receiverAddress, tokens, amounts).then((tx: any) => tx.wait());
+
+    expect(receipt).to.emit(erc1155Precompile, "PendingIssuanceCreated").withArgs(receiverAddress, 0, tokens, amounts);
+
+    const [issuanceIds, issuances] = await erc1155Precompile.pendingIssuances(receiverAddress);
+
+    // check issuance id
+    expect(issuanceIds[0]).to.eq(0);
+
+    // check issuances
+    expect(issuances[0][0]).to.deep.eq([0, 1, 2]);
+    expect(issuances[0][1]).to.deep.eq([5, 5, 5]);
+    expect(issuances[0][2]).to.deep.eq([BurnAuth.Both, BurnAuth.Both, BurnAuth.Both]);
+
+    receipt = await erc1155Precompile
+      .connect(alithSigner)
+      .acceptSoulboundIssuance(0)
+      .then((tx: any) => tx.wait());
+
+    for (const tokenId of tokens) {
+      expect(receipt)
+        .to.emit(erc1155Precompile, "Issued")
+        .withArgs(bobSigner.address, receiverAddress, tokenId, BurnAuth.Both);
+
+      expect(await erc1155Precompile.balanceOf(receiverAddress, tokenId)).to.eq(5);
+
+      expect(await erc1155Precompile.burnAuth(tokenId)).to.equal(BurnAuth.Both);
+    }
+
+    // burn as owner
+    const burnReceipt = await erc1155Precompile
+      .burnAsCollectionOwner(receiverAddress, tokens, amounts)
+      .then((tx: any) => tx.wait());
+
+    expect(burnReceipt)
+      .to.emit(erc1155Precompile, "TransferBatch")
+      .withArgs(bobSigner.address, constants.AddressZero, tokens, amounts);
+
+    for (const token of tokens) {
+      expect(await erc1155Precompile.balanceOf(receiverAddress, token)).to.eq(0);
+    }
+  });
 });

e2e/test/ERC721/ERC721Precompile.test.ts

@@ -9,6 +9,7 @@ import Web3 from "web3";
 import {
   ALITH_PRIVATE_KEY,
   BOB_PRIVATE_KEY,
+  BurnAuth,
   ERC721_PRECOMPILE_ABI,
   NFT_PRECOMPILE_ABI,
   NFT_PRECOMPILE_ADDRESS,
@@ -732,4 +733,41 @@ describe("ERC721 Precompile", function () {
     // console.log("TRN721:", trn721Id);
     // console.log("Ownable:", ownableId);
   });
+
+  it("can issue and accept soulbound tokens", async () => {
+    const receiverAddress = alithSigner.address;
+    const quantity = 3;
+    let receipt = await erc721Precompile
+      .issueSoulbound(receiverAddress, quantity, BurnAuth.Both)
+      .then((tx: any) => tx.wait());
+
+    expect(receipt)
+      .to.emit(erc721Precompile, "PendingIssuanceCreated")
+      .withArgs(receiverAddress, 0, quantity, BurnAuth.Both);
+
+    const [issuanceIds, issuances] = await erc721Precompile.pendingIssuances(receiverAddress);
+    expect(issuanceIds).to.deep.equal([0]);
+
+    expect(issuances[0][0]).to.deep.equal(quantity);
+    expect(issuances[0][1]).to.deep.equal(BurnAuth.Both);
+
+    receipt = await erc721Precompile
+      .connect(alithSigner)
+      .acceptSoulboundIssuance(0)
+      .then((tx: any) => tx.wait());
+
+    console.log(receipt);
+
+    for (let i = 0; i < 3; i++) {
+      const tokenId = receipt.events[i].args.tokenId;
+
+      expect(receipt)
+        .to.emit(erc721Precompile, "Issued")
+        .withArgs(bobSigner.address, receiverAddress, tokenId, BurnAuth.Both);
+
+      expect(await erc721Precompile.ownerOf(tokenId)).to.eq(receiverAddress);
+
+      expect(await erc721Precompile.burnAuth(tokenId)).to.eq(BurnAuth.Both);
+    }
+  });
 });