🎂 Rename TCKT -> KPass

Author: KimlikDAO-bot

README.md

@@ -15,7 +15,7 @@ const kimlikdao = new KimlikDAO({
 });
 
 // In an async function
-const tckt = await kimlikdao.getValidated(kimlikdao.TCKT, [
+const kpass = await kimlikdao.getValidated(kimlikdao.KPass, [
   "personInfo",
   "addressInfo",
   "contactInfo",

client/Makefile

@@ -4,7 +4,7 @@ build/client/index.js: client/index.js client/index.d.js \
     lib/crypto/sha3.js lib/crypto/secp256k1.js lib/crypto/modular.js \
     lib/crypto/wesolowski.js lib/crypto/primes.js \
     lib/did/*.js \
-    lib/ethereum/*.d.js lib/ethereum/TCKTLite.js \
+    lib/ethereum/*.d.js lib/ethereum/KPassLite.js \
     lib/ethereum/evm.js \
     lib/node/*.d.js lib/node/ipfs.js \
     lib/util/çevir.js

lib

@@ -1,33 +1,31 @@
 import jsonrpc from "/lib/api/jsonrpc";
+import { ChainId } from "/lib/crosschain/chains";
+import KPassLite from "/lib/ethereum/KPassLite";
 import evm from "/lib/ethereum/evm";
 
-/**
- * @const {string}
- * @noinline
- */
-const TCKT_ADDR = "0xcCc0a9b023177549fcf26c947edb5bfD9B230cCc";
-
 /**
  * @constructor
  *
- * @param {!Object<string, string>} nodeUrls
+ * @param {!Object<ChainId, string>} nodeUrls
  */
-function TCKT(nodeUrls) {
-  /** @const {!Object<string, string>} */
+function KPass(nodeUrls) {
+  /** @const {!Object<ChainId, string>} */
   this.nodeUrls = nodeUrls;
 }
 
+KPass.prototype.ADDRS = KPassLite.KPASS_ADDRS;
+
 /**
  * Note exposure reports are filed only on Avalanche C-chain therefore this
  * method does not take a `chainId`.
  *
  * @param {string} exposureReportID of length 64, hex encoded exposureReportID.
  * @return {!Promise<number>} the timestamp of the last exposure report or zero.
  */
-TCKT.prototype.exposureReported = function (exposureReportID) {
-  return jsonrpc.call(this.nodeUrls["0xa86a"], 'eth_call', [
+KPass.prototype.exposureReported = function (exposureReportID) {
+  return jsonrpc.call(this.nodeUrls[ChainId.x144], 'eth_call', [
     /** @type {!eth.Transaction} */({
-      to: TCKT_ADDR,
+      to: KPassLite.getAddress(ChainId.x144),
       data: "0x72797221" + exposureReportID
     }), "latest"
   ]).then((/** @type {string} */ hexValue) => parseInt(hexValue.slice(-10), 16));
@@ -40,12 +38,12 @@ TCKT.prototype.exposureReported = function (exposureReportID) {
  * @param {string} address
  * @return {!Promise<number>} the last revoke timestamp.
  */
-TCKT.prototype.lastRevokeTimestamp = function (address) {
+KPass.prototype.lastRevokeTimestamp = function (address) {
   /** @const {!Array<Promise<number>>} */
-  const promises = Object.values(this.nodeUrls).map((nodeUrl) =>
+  const promises = Object.entries(this.nodeUrls).map(([/** ChainId */ chainId, nodeUrl]) =>
     jsonrpc.call(nodeUrl, 'eth_call', [
       /** @type {!eth.Transaction} */({
-        to: TCKT_ADDR,
+        to: KPassLite.getAddress(chainId),
         data: "0x6a0d104e" + evm.address(address)
       }), "latest"
     ]).then((/** @type {string} */ hexValue) => parseInt(hexValue.slice(-10), 16))
@@ -56,19 +54,19 @@ TCKT.prototype.lastRevokeTimestamp = function (address) {
 }
 
 /**
- * @param {string} chainId
+ * @param {ChainId} chainId
  * @param {string} address
  * @return {!Promise<string>} the IPFS handle of the address, encoded as a 
  *                            length 66 hex string.
  */
-TCKT.prototype.handleOf = function (chainId, address) {
+KPass.prototype.handleOf = function (chainId, address) {
   return /** @type {!Promise<string>} */(jsonrpc.call(this.nodeUrls[chainId],
     'eth_call', [
     /** @type {!eth.Transaction} */({
-      to: TCKT_ADDR,
+      to: KPassLite.getAddress(chainId),
       data: "0xc50a1514" + evm.address(address)
     }), "latest"
   ]));
 }
 
-export { TCKT, TCKT_ADDR };
+export { KPass };

server-js/TCKT.js server-js/KPass.js

@@ -7,27 +7,27 @@ import evm from "/lib/ethereum/evm";
  * @const {string}
  * @noinline
  */
-const TCKT_SIGNERS = "0xcCc09aA0d174271259D093C598FCe9Feb2791cCc";
+const KPASS_SIGNERS = "0xcCc09aA0d174271259D093C598FCe9Feb2791cCc";
 
 /**
  * @constructor
  *
  * @param {!Object<string, string>} nodeUrls
  */
-function TCKTSigners(nodeUrls) {
+function KPassSigners(nodeUrls) {
   /** @const {!Object<string, string>} */
   this.nodeUrls = nodeUrls;
 }
 
 /**
- * Temporary validation method, before the TCKTSigners contract
+ * Temporary validation method, before the KPassSigners contract
  * is deployed.
  *
  * @param {!did.DecryptedSections} decryptedSections
  * @param {string} ownerAddress
  * @return {!Promise<!kimlikdao.ValidationReport>}
  */
-TCKTSigners.prototype.validateSignersTemporary = function (decryptedSections, ownerAddress) {
+KPassSigners.prototype.validateSignersTemporary = function (decryptedSections, ownerAddress) {
   /** @const {!kimlikdao.ValidationReport} */
   const validationReport = {
     isValid: true,
@@ -74,7 +74,7 @@ TCKTSigners.prototype.validateSignersTemporary = function (decryptedSections, ow
  * @param {string} ownerAddress
  * @return {!Promise<!kimlikdao.ValidationReport>}
  */
-TCKTSigners.prototype.validateSigners = function (decryptedSections, ownerAddress) {
+KPassSigners.prototype.validateSigners = function (decryptedSections, ownerAddress) {
   /** @const {!Set<string>} */
   const allSigners = new Set();
   /** @const {!Object<string, !Array<string>>} */
@@ -90,15 +90,15 @@ TCKTSigners.prototype.validateSigners = function (decryptedSections, ownerAddres
   /** @const {!Array<!Array<*>>} */
   const paramsList = allSignersList.map((signer) => [/** @type {!eth.Transaction} */({
     data: "0x2796d3f1" + evm.address(signer),
-    to: TCKT_SIGNERS
+    to: KPASS_SIGNERS
   }),
     "latest"]);
   paramsList.push([/** @type {!eth.Transaction} */({
     data: "0x46fc4be1", // signerCountNeeded()
-    to: TCKT_SIGNERS
+    to: KPASS_SIGNERS
   }), "latest"], [/** @type {!eth.Transaction} */({
     data: "0xc8676ec4", // signerStakeNeeded()
-    to: TCKT_SIGNERS
+    to: KPASS_SIGNERS
   }), "latest"]);
 
   return jsonrpc.callMulti(this.nodeUrls['0xa86a'],
@@ -169,4 +169,4 @@ TCKTSigners.prototype.validateSigners = function (decryptedSections, ownerAddres
   })
 }
 
-export { TCKTSigners };
+export { KPassSigners };

server-js/TCKTSigners.js server-js/KPassSigners.js

@@ -1,7 +1,7 @@
 include server-js/test/Makefile
 
 build/server-js/index.js: server-js/index.js server-js/validator.js \
-    server-js/TCKT.js server-js/TCKTSigners.js \
+    server-js/KPass.js server-js/KPassSigners.js \
     api/*.d.js api/error.js api/validationReport.js \
     lib/api/jsonrpc.d.js lib/api/jsonrpc.js \
     lib/crosschain/*.js \

server-js/Makefile

@@ -0,0 +1,26 @@
+import { KPass } from "../KPass";
+import { ChainId } from "/lib/crosschain/chains";
+import { assertEq } from "/lib/testing/assert";
+
+const testHandleOf = () => {
+  const kpass = new KPass({
+    [ChainId.xa86a]: "https://api.avax.network/ext/bc/C/rpc"
+  });
+  return kpass.handleOf(ChainId.xa86a, "0x9697bde39a925ee3feb7a1d6230b00fbed99fd31")
+    .then((handle) =>
+      assertEq(handle, "0xa56d70606509f963753cf6079c736def8f26823a2c544fd70eab41faf82d4a25"))
+    .catch(console.log);
+}
+
+const testLastRevokeTimestamp = () => {
+  const kpass = new KPass({
+    [ChainId.xa86a]: "https://api.avax.network/ext/bc/C/rpc"
+  });
+  return kpass.lastRevokeTimestamp("0x79883d9acbc4abac6d2d216693f66fcc5a0bcbc1")
+    .then((timestamp) =>
+      assertEq(timestamp, 1687827423))
+    .catch(console.log);
+}
+
+testHandleOf();
+testLastRevokeTimestamp();

server-js/test/KPass.compiled-test.js

@@ -1,8 +1,9 @@
-build/server-js/test/TCKT.compiled-test.js: server-js/test/TCKT.compiled-test.js \
-    server-js/TCKT.js \
+build/server-js/test/KPass.compiled-test.js: server-js/test/KPass.compiled-test.js \
+    server-js/KPass.js \
     lib/api/jsonrpc.d.js lib/api/jsonrpc.js \
+    lib/crosschain/*.js \
     lib/crypto/sha3.js lib/crypto/secp256k1.js lib/crypto/modular.js \
-    lib/ethereum/eth.d.js lib/ethereum/transaction.d.js lib/ethereum/evm.js \
+    lib/ethereum/*.js \
     lib/testing/assert.js lib/testing/nodejs.d.js \
     lib/util/çevir.js
 	mkdir -p $(dir $@)
@@ -20,4 +21,4 @@ build/server-js/test/TCKT.compiled-test.js: server-js/test/TCKT.compiled-test.js
 	bun $@
 
 .PHONY: server-js/test
-server-js/test: build/server-js/test/TCKT.compiled-test.js
+server-js/test: build/server-js/test/KPass.compiled-test.js

server-js/test/Makefile

@@ -6,28 +6,29 @@
 
 import { ErrorCode, err } from "../api/error";
 import { reportError } from "../api/validationReport";
-import { TCKT, TCKT_ADDR } from "./TCKT";
-import { TCKTSigners } from "./TCKTSigners";
+import { KPass } from "./KPass";
+import { KPassSigners } from "./KPassSigners";
+import { ChainId } from "/lib/crosschain/chains";
 import evm from "/lib/ethereum/evm";
 
 /**
  * @constructor
  * @struct
  *
- * @param {!Object<string, string>} nodeUrls
+ * @param {!Object<ChainId, string>} nodeUrls
  * @param {Array<string>} acceptedContracts
  * @param {function(!kimlikdao.Challenge):boolean=} validateChallenge
  * @param {boolean=} allowUnauthenticated
  */
 function Validator(nodeUrls, acceptedContracts, validateChallenge, allowUnauthenticated) {
   /** @const {!Object<string, string>} */
   this.nodeUrls = nodeUrls;
+  /** @const {!KPass} */
+  this.kpass = new KPass(nodeUrls);
+  /** @const {!KPassSigners} */
+  this.kpassSigners = new KPassSigners(nodeUrls);
   /** @const {!Set<string>} */
-  this.acceptedContracts = new Set(acceptedContracts || [TCKT_ADDR]);
-  /** @const {!TCKT} */
-  this.tckt = new TCKT(nodeUrls);
-  /** @const {!TCKTSigners} */
-  this.tcktSigners = new TCKTSigners(nodeUrls);
+  this.acceptedContracts = new Set(acceptedContracts || this.kpass.ADDRS);
 
   /**
    * Record the user provided challenge validator. If none provided, use the
@@ -55,12 +56,12 @@ function Validator(nodeUrls, acceptedContracts, validateChallenge, allowUnauthen
 Validator.prototype.validateWithAddress = function (ownerAddress, isAuthenticated, decryptedSections) {
   /** @const {!Array<!Promise<*>>} */
   const promises = [
-    this.tckt.lastRevokeTimestamp(ownerAddress),
+    this.kpass.lastRevokeTimestamp(ownerAddress),
     decryptedSections["personInfo"]
-      ? this.tckt.exposureReported(
+      ? this.kpass.exposureReported(
         /** @type {!did.PersonInfo} */(decryptedSections["personInfo"]).exposureReportID)
       : Promise.resolve(0),
-    this.tcktSigners.validateSignersTemporary(decryptedSections, ownerAddress),
+    this.kpassSigners.validateSignersTemporary(decryptedSections, ownerAddress),
   ];
 
   return Promise.all(promises)