@hyperlane-xyz/deploy-sdk 0.2.0

package/dist/AltVMWarpModule.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=AltVMWarpModule.test.d.ts.map

package/dist/AltVMWarpModule.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AltVMWarpModule.test.d.ts","sourceRoot":"","sources":["../src/AltVMWarpModule.test.ts"],"names":[],"mappings":""}

package/dist/AltVMWarpModule.test.js

@@ -0,0 +1,403 @@
+import chai from 'chai';
+import chaiAsPromised from 'chai-as-promised';
+import Sinon from 'sinon';
+import { MockSigner } from '@hyperlane-xyz/provider-sdk';
+import { TokenType, } from '@hyperlane-xyz/provider-sdk/warp';
+import { AltVMWarpModule } from './AltVMWarpModule.js';
+const TestChainName = {
+    test1: 'test1',
+};
+chai.use(chaiAsPromised);
+const expect = chai.expect;
+/*
+
+TEST CASES - AltVMWarpModule tests
+
+* no updates needed if the config is the same
+* update ownership
+* new remote router with invalid config
+* new remote router
+* multiple new remote routers
+* remove existing remote router
+* update existing router address
+* update existing router gas
+* remove and add remote router at the same time
+* new ISM
+* update existing ISM
+
+*/
+describe('AltVMWarpModule', () => {
+    let signer;
+    let warpModule;
+    let chainLookup;
+    const tokenAddress = '0x726f757465725f61707000000000000000000000000000010000000000000000';
+    const actualConfig = {
+        type: TokenType.collateral,
+        owner: 'hyp1jq304cthpx0lwhpqzrdjrcza559ukyy3sc4dw5',
+        mailbox: '0x68797065726c616e650000000000000000000000000000000000000000000000',
+        token: 'uhyp',
+        remoteRouters: {
+            '1234': {
+                address: '0x726f757465725f61707000000000000000000000000000010000000000000000',
+            },
+        },
+        destinationGas: {
+            '1234': '200000',
+        },
+    };
+    let readStub;
+    beforeEach(async () => {
+        signer = await MockSigner.connectWithSigner();
+        Sinon.stub(signer, 'getSignerAddress').returns(actualConfig.owner);
+        // Create mock chainLookup
+        chainLookup = {
+            getChainMetadata: () => ({ name: TestChainName.test1, domainId: 1 }),
+            getChainName: () => TestChainName.test1,
+            getDomainId: () => 1,
+            getKnownChainNames: () => [TestChainName.test1],
+        };
+        warpModule = new AltVMWarpModule(chainLookup, signer, {
+            chain: TestChainName.test1,
+            config: actualConfig,
+            addresses: {
+                deployedTokenRoute: tokenAddress,
+            },
+        });
+        readStub = Sinon.stub(warpModule, 'read').resolves(actualConfig);
+    });
+    it('no updates needed if the config is the same', async () => {
+        // ARRANGE
+        const expectedConfig = actualConfig;
+        // ACT
+        const updateTransactions = await warpModule.update(expectedConfig);
+        // ASSERT
+        expect(updateTransactions).to.have.lengthOf(0);
+    });
+    it('update ownership', async () => {
+        // ARRANGE
+        const newOwner = 'hyp1hvg7zsnrj6h29q9ss577mhrxa04rn94hv2cm2e';
+        const expectedConfig = {
+            ...actualConfig,
+            owner: newOwner,
+        };
+        const updateOwner = Sinon.stub(signer, 'getSetTokenOwnerTransaction').resolves();
+        // ACT
+        const updateTransactions = await warpModule.update(expectedConfig);
+        // ASSERT
+        expect(updateTransactions).to.have.lengthOf(1);
+        expect(updateTransactions[0].annotation).to.include('Transferring ownership of');
+        expect(updateOwner.calledOnceWith({
+            signer: actualConfig.owner,
+            tokenAddress,
+            newOwner,
+        })).to.be.true;
+    });
+    it('new remote router with invalid config', async () => {
+        // ARRANGE
+        const newRemoteRouter = {
+            receiverDomainId: 4321,
+            receiverAddress: '0x726f757465725f61707000000000000000000000000000020000000000000000',
+            gas: '300000',
+        };
+        // only add new router to remote routers and not to destination gas
+        const expectedConfig = {
+            ...actualConfig,
+            remoteRouters: {
+                ...actualConfig.remoteRouters,
+                [newRemoteRouter.receiverDomainId]: {
+                    address: newRemoteRouter.receiverAddress,
+                },
+            },
+        };
+        // ACT & ASSERT
+        expect(warpModule.update(expectedConfig)).to.be.rejectedWith(Error);
+    });
+    it('new remote router', async () => {
+        // ARRANGE
+        const newRemoteRouter = {
+            receiverDomainId: 4321,
+            receiverAddress: '0x726f757465725f61707000000000000000000000000000020000000000000000',
+            gas: '300000',
+        };
+        const expectedConfig = {
+            ...actualConfig,
+            remoteRouters: {
+                ...actualConfig.remoteRouters,
+                [newRemoteRouter.receiverDomainId]: {
+                    address: newRemoteRouter.receiverAddress,
+                },
+            },
+            destinationGas: {
+                ...actualConfig.destinationGas,
+                [newRemoteRouter.receiverDomainId]: newRemoteRouter.gas,
+            },
+        };
+        const enrollRouter = Sinon.stub(signer, 'getEnrollRemoteRouterTransaction').resolves();
+        // ACT
+        const updateTransactions = await warpModule.update(expectedConfig);
+        // ASSERT
+        expect(updateTransactions).to.have.lengthOf(1);
+        expect(updateTransactions[0].annotation).to.include('Enrolling Router');
+        expect(enrollRouter.calledOnceWith({
+            signer: actualConfig.owner,
+            tokenAddress,
+            remoteRouter: newRemoteRouter,
+        })).to.be.true;
+    });
+    it('multiple new remote routers', async () => {
+        // ARRANGE
+        const newRemoteRouter1 = {
+            receiverDomainId: 4321,
+            receiverAddress: '0x726f757465725f61707000000000000000000000000000020000000000000000',
+            gas: '300000',
+        };
+        const newRemoteRouter2 = {
+            receiverDomainId: 5321,
+            receiverAddress: '0x726f757465725f61707000000000000000000000000000030000000000000000',
+            gas: '400000',
+        };
+        const expectedConfig = {
+            ...actualConfig,
+            remoteRouters: {
+                ...actualConfig.remoteRouters,
+                [newRemoteRouter1.receiverDomainId]: {
+                    address: newRemoteRouter1.receiverAddress,
+                },
+                [newRemoteRouter2.receiverDomainId]: {
+                    address: newRemoteRouter2.receiverAddress,
+                },
+            },
+            destinationGas: {
+                ...actualConfig.destinationGas,
+                [newRemoteRouter1.receiverDomainId]: newRemoteRouter1.gas,
+                [newRemoteRouter2.receiverDomainId]: newRemoteRouter2.gas,
+            },
+        };
+        const enrollRouter = Sinon.stub(signer, 'getEnrollRemoteRouterTransaction').resolves();
+        // ACT
+        const updateTransactions = await warpModule.update(expectedConfig);
+        // ASSERT
+        expect(updateTransactions).to.have.lengthOf(2);
+        expect(updateTransactions[0].annotation).to.include('Enrolling Router');
+        expect(updateTransactions[1].annotation).to.include('Enrolling Router');
+        expect(enrollRouter.calledWith({
+            signer: actualConfig.owner,
+            tokenAddress,
+            remoteRouter: newRemoteRouter1,
+        })).to.be.true;
+        expect(enrollRouter.calledWith({
+            signer: actualConfig.owner,
+            tokenAddress,
+            remoteRouter: newRemoteRouter2,
+        })).to.be.true;
+    });
+    it('remove existing remote router', async () => {
+        // ARRANGE
+        const expectedConfig = {
+            ...actualConfig,
+            remoteRouters: {},
+            destinationGas: {},
+        };
+        const unenrollRouter = Sinon.stub(signer, 'getUnenrollRemoteRouterTransaction').resolves();
+        // ACT
+        const updateTransactions = await warpModule.update(expectedConfig);
+        // ASSERT
+        expect(updateTransactions).to.have.lengthOf(1);
+        expect(updateTransactions[0].annotation).to.include('Unenrolling Router');
+        expect(unenrollRouter.calledOnceWith({
+            signer: actualConfig.owner,
+            tokenAddress,
+            receiverDomainId: 1234,
+        })).to.be.true;
+    });
+    it('update existing router address', async () => {
+        // ARRANGE
+        const newAddress = '0x726f757465725f61707000000000000000000000000000020000000000000000';
+        const expectedConfig = {
+            ...actualConfig,
+            remoteRouters: {
+                '1234': {
+                    address: newAddress,
+                },
+            },
+        };
+        const enrollRouter = Sinon.stub(signer, 'getEnrollRemoteRouterTransaction').resolves();
+        const unenrollRouter = Sinon.stub(signer, 'getUnenrollRemoteRouterTransaction').resolves();
+        // ACT
+        const updateTransactions = await warpModule.update(expectedConfig);
+        // ASSERT
+        expect(updateTransactions).to.have.lengthOf(2);
+        expect(updateTransactions[0].annotation).to.include('Unenrolling Router');
+        expect(updateTransactions[1].annotation).to.include('Enrolling Router');
+        expect(enrollRouter.calledOnceWith({
+            signer: actualConfig.owner,
+            tokenAddress,
+            remoteRouter: {
+                receiverDomainId: 1234,
+                receiverAddress: newAddress,
+                gas: '200000',
+            },
+        })).to.be.true;
+        expect(unenrollRouter.calledOnceWith({
+            signer: actualConfig.owner,
+            tokenAddress,
+            receiverDomainId: 1234,
+        })).to.be.true;
+    });
+    it('update existing router gas', async () => {
+        // ARRANGE
+        const newGas = '300000';
+        const expectedConfig = {
+            ...actualConfig,
+            destinationGas: {
+                '1234': newGas,
+            },
+        };
+        const enrollRouter = Sinon.stub(signer, 'getEnrollRemoteRouterTransaction').resolves();
+        const unenrollRouter = Sinon.stub(signer, 'getUnenrollRemoteRouterTransaction').resolves();
+        // ACT
+        const updateTransactions = await warpModule.update(expectedConfig);
+        // ASSERT
+        expect(updateTransactions).to.have.lengthOf(2);
+        expect(updateTransactions[0].annotation).to.include('Unenrolling Router');
+        expect(updateTransactions[1].annotation).to.include('Enrolling Router');
+        expect(enrollRouter.calledOnceWith({
+            signer: actualConfig.owner,
+            tokenAddress,
+            remoteRouter: {
+                receiverDomainId: 1234,
+                receiverAddress: '0x726f757465725f61707000000000000000000000000000010000000000000000',
+                gas: newGas,
+            },
+        })).to.be.true;
+        expect(unenrollRouter.calledOnceWith({
+            signer: actualConfig.owner,
+            tokenAddress,
+            receiverDomainId: 1234,
+        })).to.be.true;
+    });
+    it('remove and add remote router at the same time', async () => {
+        // ARRANGE
+        const expectedConfig = {
+            ...actualConfig,
+            remoteRouters: {
+                '4321': {
+                    address: '0x726f757465725f61707000000000000000000000000000020000000000000000',
+                },
+            },
+            destinationGas: {
+                '4321': '300000',
+            },
+        };
+        const enrollRouter = Sinon.stub(signer, 'getEnrollRemoteRouterTransaction').resolves();
+        const unenrollRouter = Sinon.stub(signer, 'getUnenrollRemoteRouterTransaction').resolves();
+        // ACT
+        const updateTransactions = await warpModule.update(expectedConfig);
+        // ASSERT
+        expect(updateTransactions).to.have.lengthOf(2);
+        expect(updateTransactions[0].annotation).to.include('Unenrolling Router');
+        expect(updateTransactions[1].annotation).to.include('Enrolling Router');
+        expect(enrollRouter.calledOnceWith({
+            signer: actualConfig.owner,
+            tokenAddress,
+            remoteRouter: {
+                receiverDomainId: 4321,
+                receiverAddress: '0x726f757465725f61707000000000000000000000000000020000000000000000',
+                gas: '300000',
+            },
+        })).to.be.true;
+        expect(unenrollRouter.calledOnceWith({
+            signer: actualConfig.owner,
+            tokenAddress,
+            receiverDomainId: 1234,
+        })).to.be.true;
+    });
+    it('new ISM', async () => {
+        // ARRANGE
+        const newIsmAddress = '0x726f757465725f69736d00000000000000000000000000050000000000000000';
+        const newIsm = {
+            type: 'messageIdMultisigIsm',
+            validators: ['0xe699ceCa237DD38e8f2Fa308D7d1a2BeCFC5493E'],
+            threshold: 1,
+        };
+        const expectedConfig = {
+            ...actualConfig,
+            interchainSecurityModule: newIsm,
+        };
+        const createIsm = Sinon.stub(signer, 'createMessageIdMultisigIsm').resolves({
+            ismAddress: newIsmAddress,
+        });
+        const updateIsm = Sinon.stub(signer, 'getSetTokenIsmTransaction').resolves();
+        // ACT
+        const updateTransactions = await warpModule.update(expectedConfig);
+        // ASSERT
+        expect(updateTransactions).to.have.lengthOf(1);
+        expect(updateTransactions[0].annotation).to.include('Setting ISM for Warp Route to');
+        expect(createIsm.calledOnceWith({
+            validators: newIsm.validators,
+            threshold: newIsm.threshold,
+        })).to.be.true;
+        expect(updateIsm.calledOnceWith({
+            signer: actualConfig.owner,
+            tokenAddress,
+            ismAddress: newIsmAddress,
+        })).to.be.true;
+    });
+    it('update existing ISM', async () => {
+        // ARRANGE
+        const existingIsmAddress = '0x726f757465725f69736d00000000000000000000000000040000000000000000';
+        const existingIsm = {
+            type: 'messageIdMultisigIsm',
+            validators: ['0xe699ceCa237DD38e8f2Fa308D7d1a2BeCFC5493E'],
+            threshold: 1,
+            address: existingIsmAddress,
+        };
+        const newIsmAddress = '0x726f757465725f69736d00000000000000000000000000050000000000000000';
+        const newIsm = {
+            type: 'merkleRootMultisigIsm',
+            validators: ['0xe699ceCa237DD38e8f2Fa308D7d1a2BeCFC5493E'],
+            threshold: 1,
+        };
+        readStub.restore();
+        Sinon.stub(warpModule, 'read').resolves({
+            ...actualConfig,
+            token: tokenAddress,
+            interchainSecurityModule: existingIsm,
+        });
+        const expectedConfig = {
+            ...actualConfig,
+            interchainSecurityModule: newIsm,
+        };
+        // Stub ISM reading methods
+        Sinon.stub(signer, 'getIsmType').resolves('messageIdMultisigIsm');
+        Sinon.stub(signer, 'getMessageIdMultisigIsm').resolves({
+            address: existingIsmAddress,
+            validators: existingIsm.validators,
+            threshold: existingIsm.threshold,
+        });
+        const createIsm = Sinon.stub(signer, 'createMerkleRootMultisigIsm').resolves({
+            ismAddress: newIsmAddress,
+        });
+        const updateIsm = Sinon.stub(signer, 'getSetTokenIsmTransaction').resolves();
+        // ACT
+        const updateTransactions = await warpModule.update(expectedConfig);
+        // ASSERT
+        expect(updateTransactions).to.have.lengthOf(1);
+        expect(updateTransactions[0].annotation).to.include('Setting ISM for Warp Route to');
+        // Check createIsm was called once
+        expect(createIsm.callCount).to.equal(1);
+        const createIsmCall = createIsm.getCall(0);
+        expect(createIsmCall.args[0].threshold).to.equal(newIsm.threshold);
+        expect(createIsmCall.args[0].validators.length).to.equal(newIsm.validators.length);
+        expect(createIsmCall.args[0].validators[0].toLowerCase()).to.equal(newIsm.validators[0].toLowerCase());
+        // Check updateIsm was called once
+        expect(updateIsm.callCount).to.equal(1);
+        const updateIsmCall = updateIsm.getCall(0);
+        expect(updateIsmCall.args[0]).to.deep.equal({
+            signer: actualConfig.owner,
+            tokenAddress,
+            ismAddress: newIsmAddress,
+        });
+    });
+});
+//# sourceMappingURL=AltVMWarpModule.test.js.map

package/dist/AltVMWarpModule.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AltVMWarpModule.test.js","sourceRoot":"","sources":["../src/AltVMWarpModule.test.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,cAAc,MAAM,kBAAkB,CAAC;AAC9C,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,OAAO,EAAS,UAAU,EAAE,MAAM,6BAA6B,CAAC;AAGhE,OAAO,EAEL,SAAS,GAEV,MAAM,kCAAkC,CAAC;AAE1C,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAEvD,MAAM,aAAa,GAAG;IACpB,KAAK,EAAE,OAAO;CACN,CAAC;AAEX,IAAI,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;AACzB,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;AAE3B;;;;;;;;;;;;;;;;EAgBE;AAEF,QAAQ,CAAC,iBAAiB,EAAE,GAAG,EAAE;IAC/B,IAAI,MAA6C,CAAC;IAClD,IAAI,UAA2B,CAAC;IAChC,IAAI,WAAwB,CAAC;IAE7B,MAAM,YAAY,GAChB,oEAAoE,CAAC;IAEvE,MAAM,YAAY,GAAe;QAC/B,IAAI,EAAE,SAAS,CAAC,UAAU;QAC1B,KAAK,EAAE,4CAA4C;QACnD,OAAO,EACL,oEAAoE;QACtE,KAAK,EAAE,MAAM;QACb,aAAa,EAAE;YACb,MAAM,EAAE;gBACN,OAAO,EACL,oEAAoE;aACvE;SACF;QACD,cAAc,EAAE;YACd,MAAM,EAAE,QAAQ;SACjB;KACF,CAAC;IAEF,IAAI,QAAyB,CAAC;IAE9B,UAAU,CAAC,KAAK,IAAI,EAAE;QACpB,MAAM,GAAG,MAAM,UAAU,CAAC,iBAAiB,EAAE,CAAC;QAE9C,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;QAEnE,0BAA0B;QAC1B,WAAW,GAAG;YACZ,gBAAgB,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,aAAa,CAAC,KAAK,EAAE,QAAQ,EAAE,CAAC,EAAE,CAAC;YACpE,YAAY,EAAE,GAAG,EAAE,CAAC,aAAa,CAAC,KAAK;YACvC,WAAW,EAAE,GAAG,EAAE,CAAC,CAAC;YACpB,kBAAkB,EAAE,GAAG,EAAE,CAAC,CAAC,aAAa,CAAC,KAAK,CAAC;SACzC,CAAC;QAET,UAAU,GAAG,IAAI,eAAe,CAAC,WAAW,EAAE,MAAM,EAAE;YACpD,KAAK,EAAE,aAAa,CAAC,KAAK;YAC1B,MAAM,EAAE,YAAY;YACpB,SAAS,EAAE;gBACT,kBAAkB,EAAE,YAAY;aACjC;SACF,CAAC,CAAC;QAEH,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC,QAAQ,CAChD,YAAiC,CAClC,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6CAA6C,EAAE,KAAK,IAAI,EAAE;QAC3D,UAAU;QACV,MAAM,cAAc,GAAG,YAAY,CAAC;QAEpC,MAAM;QACN,MAAM,kBAAkB,GAAG,MAAM,UAAU,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;QAEnE,SAAS;QACT,MAAM,CAAC,kBAAkB,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IACjD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kBAAkB,EAAE,KAAK,IAAI,EAAE;QAChC,UAAU;QACV,MAAM,QAAQ,GAAG,4CAA4C,CAAC;QAE9D,MAAM,cAAc,GAAG;YACrB,GAAG,YAAY;YACf,KAAK,EAAE,QAAQ;SAChB,CAAC;QAEF,MAAM,WAAW,GAAG,KAAK,CAAC,IAAI,CAC5B,MAAM,EACN,6BAA6B,CAC9B,CAAC,QAAQ,EAAE,CAAC;QAEb,MAAM;QACN,MAAM,kBAAkB,GAAG,MAAM,UAAU,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;QAEnE,SAAS;QACT,MAAM,CAAC,kBAAkB,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;QAC/C,MAAM,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,OAAO,CACjD,2BAA2B,CAC5B,CAAC;QACF,MAAM,CACJ,WAAW,CAAC,cAAc,CAAC;YACzB,MAAM,EAAE,YAAY,CAAC,KAAK;YAC1B,YAAY;YACZ,QAAQ;SACT,CAAC,CACH,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC;IACf,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uCAAuC,EAAE,KAAK,IAAI,EAAE;QACrD,UAAU;QACV,MAAM,eAAe,GAAG;YACtB,gBAAgB,EAAE,IAAI;YACtB,eAAe,EACb,oEAAoE;YACtE,GAAG,EAAE,QAAQ;SACd,CAAC;QAEF,mEAAmE;QACnE,MAAM,cAAc,GAAG;YACrB,GAAG,YAAY;YACf,aAAa,EAAE;gBACb,GAAG,YAAY,CAAC,aAAa;gBAC7B,CAAC,eAAe,CAAC,gBAAgB,CAAC,EAAE;oBAClC,OAAO,EAAE,eAAe,CAAC,eAAe;iBACzC;aACF;SACF,CAAC;QAEF,eAAe;QACf,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;IACtE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mBAAmB,EAAE,KAAK,IAAI,EAAE;QACjC,UAAU;QACV,MAAM,eAAe,GAAG;YACtB,gBAAgB,EAAE,IAAI;YACtB,eAAe,EACb,oEAAoE;YACtE,GAAG,EAAE,QAAQ;SACd,CAAC;QAEF,MAAM,cAAc,GAAG;YACrB,GAAG,YAAY;YACf,aAAa,EAAE;gBACb,GAAG,YAAY,CAAC,aAAa;gBAC7B,CAAC,eAAe,CAAC,gBAAgB,CAAC,EAAE;oBAClC,OAAO,EAAE,eAAe,CAAC,eAAe;iBACzC;aACF;YACD,cAAc,EAAE;gBACd,GAAG,YAAY,CAAC,cAAc;gBAC9B,CAAC,eAAe,CAAC,gBAAgB,CAAC,EAAE,eAAe,CAAC,GAAG;aACxD;SACF,CAAC;QAEF,MAAM,YAAY,GAAG,KAAK,CAAC,IAAI,CAC7B,MAAM,EACN,kCAAkC,CACnC,CAAC,QAAQ,EAAE,CAAC;QAEb,MAAM;QACN,MAAM,kBAAkB,GAAG,MAAM,UAAU,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;QAEnE,SAAS;QACT,MAAM,CAAC,kBAAkB,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;QAC/C,MAAM,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;QACxE,MAAM,CACJ,YAAY,CAAC,cAAc,CAAC;YAC1B,MAAM,EAAE,YAAY,CAAC,KAAK;YAC1B,YAAY;YACZ,YAAY,EAAE,eAAe;SAC9B,CAAC,CACH,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC;IACf,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6BAA6B,EAAE,KAAK,IAAI,EAAE;QAC3C,UAAU;QACV,MAAM,gBAAgB,GAAG;YACvB,gBAAgB,EAAE,IAAI;YACtB,eAAe,EACb,oEAAoE;YACtE,GAAG,EAAE,QAAQ;SACd,CAAC;QACF,MAAM,gBAAgB,GAAG;YACvB,gBAAgB,EAAE,IAAI;YACtB,eAAe,EACb,oEAAoE;YACtE,GAAG,EAAE,QAAQ;SACd,CAAC;QAEF,MAAM,cAAc,GAAG;YACrB,GAAG,YAAY;YACf,aAAa,EAAE;gBACb,GAAG,YAAY,CAAC,aAAa;gBAC7B,CAAC,gBAAgB,CAAC,gBAAgB,CAAC,EAAE;oBACnC,OAAO,EAAE,gBAAgB,CAAC,eAAe;iBAC1C;gBACD,CAAC,gBAAgB,CAAC,gBAAgB,CAAC,EAAE;oBACnC,OAAO,EAAE,gBAAgB,CAAC,eAAe;iBAC1C;aACF;YACD,cAAc,EAAE;gBACd,GAAG,YAAY,CAAC,cAAc;gBAC9B,CAAC,gBAAgB,CAAC,gBAAgB,CAAC,EAAE,gBAAgB,CAAC,GAAG;gBACzD,CAAC,gBAAgB,CAAC,gBAAgB,CAAC,EAAE,gBAAgB,CAAC,GAAG;aAC1D;SACF,CAAC;QAEF,MAAM,YAAY,GAAG,KAAK,CAAC,IAAI,CAC7B,MAAM,EACN,kCAAkC,CACnC,CAAC,QAAQ,EAAE,CAAC;QAEb,MAAM;QACN,MAAM,kBAAkB,GAAG,MAAM,UAAU,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;QAEnE,SAAS;QACT,MAAM,CAAC,kBAAkB,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;QAC/C,MAAM,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;QACxE,MAAM,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;QAExE,MAAM,CACJ,YAAY,CAAC,UAAU,CAAC;YACtB,MAAM,EAAE,YAAY,CAAC,KAAK;YAC1B,YAAY;YACZ,YAAY,EAAE,gBAAgB;SAC/B,CAAC,CACH,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC;QAEb,MAAM,CACJ,YAAY,CAAC,UAAU,CAAC;YACtB,MAAM,EAAE,YAAY,CAAC,KAAK;YAC1B,YAAY;YACZ,YAAY,EAAE,gBAAgB;SAC/B,CAAC,CACH,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC;IACf,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,+BAA+B,EAAE,KAAK,IAAI,EAAE;QAC7C,UAAU;QACV,MAAM,cAAc,GAAG;YACrB,GAAG,YAAY;YACf,aAAa,EAAE,EAAE;YACjB,cAAc,EAAE,EAAE;SACnB,CAAC;QAEF,MAAM,cAAc,GAAG,KAAK,CAAC,IAAI,CAC/B,MAAM,EACN,oCAAoC,CACrC,CAAC,QAAQ,EAAE,CAAC;QAEb,MAAM;QACN,MAAM,kBAAkB,GAAG,MAAM,UAAU,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;QAEnE,SAAS;QACT,MAAM,CAAC,kBAAkB,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;QAC/C,MAAM,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,oBAAoB,CAAC,CAAC;QAC1E,MAAM,CACJ,cAAc,CAAC,cAAc,CAAC;YAC5B,MAAM,EAAE,YAAY,CAAC,KAAK;YAC1B,YAAY;YACZ,gBAAgB,EAAE,IAAI;SACvB,CAAC,CACH,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC;IACf,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gCAAgC,EAAE,KAAK,IAAI,EAAE;QAC9C,UAAU;QACV,MAAM,UAAU,GACd,oEAAoE,CAAC;QAEvE,MAAM,cAAc,GAAG;YACrB,GAAG,YAAY;YACf,aAAa,EAAE;gBACb,MAAM,EAAE;oBACN,OAAO,EAAE,UAAU;iBACpB;aACF;SACF,CAAC;QAEF,MAAM,YAAY,GAAG,KAAK,CAAC,IAAI,CAC7B,MAAM,EACN,kCAAkC,CACnC,CAAC,QAAQ,EAAE,CAAC;QACb,MAAM,cAAc,GAAG,KAAK,CAAC,IAAI,CAC/B,MAAM,EACN,oCAAoC,CACrC,CAAC,QAAQ,EAAE,CAAC;QAEb,MAAM;QACN,MAAM,kBAAkB,GAAG,MAAM,UAAU,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;QAEnE,SAAS;QACT,MAAM,CAAC,kBAAkB,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;QAC/C,MAAM,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,oBAAoB,CAAC,CAAC;QAC1E,MAAM,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;QAExE,MAAM,CACJ,YAAY,CAAC,cAAc,CAAC;YAC1B,MAAM,EAAE,YAAY,CAAC,KAAK;YAC1B,YAAY;YACZ,YAAY,EAAE;gBACZ,gBAAgB,EAAE,IAAI;gBACtB,eAAe,EAAE,UAAU;gBAC3B,GAAG,EAAE,QAAQ;aACd;SACF,CAAC,CACH,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC;QAEb,MAAM,CACJ,cAAc,CAAC,cAAc,CAAC;YAC5B,MAAM,EAAE,YAAY,CAAC,KAAK;YAC1B,YAAY;YACZ,gBAAgB,EAAE,IAAI;SACvB,CAAC,CACH,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC;IACf,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4BAA4B,EAAE,KAAK,IAAI,EAAE;QAC1C,UAAU;QACV,MAAM,MAAM,GAAG,QAAQ,CAAC;QAExB,MAAM,cAAc,GAAG;YACrB,GAAG,YAAY;YACf,cAAc,EAAE;gBACd,MAAM,EAAE,MAAM;aACf;SACF,CAAC;QAEF,MAAM,YAAY,GAAG,KAAK,CAAC,IAAI,CAC7B,MAAM,EACN,kCAAkC,CACnC,CAAC,QAAQ,EAAE,CAAC;QACb,MAAM,cAAc,GAAG,KAAK,CAAC,IAAI,CAC/B,MAAM,EACN,oCAAoC,CACrC,CAAC,QAAQ,EAAE,CAAC;QAEb,MAAM;QACN,MAAM,kBAAkB,GAAG,MAAM,UAAU,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;QAEnE,SAAS;QACT,MAAM,CAAC,kBAAkB,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;QAC/C,MAAM,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,oBAAoB,CAAC,CAAC;QAC1E,MAAM,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;QAExE,MAAM,CACJ,YAAY,CAAC,cAAc,CAAC;YAC1B,MAAM,EAAE,YAAY,CAAC,KAAK;YAC1B,YAAY;YACZ,YAAY,EAAE;gBACZ,gBAAgB,EAAE,IAAI;gBACtB,eAAe,EACb,oEAAoE;gBACtE,GAAG,EAAE,MAAM;aACZ;SACF,CAAC,CACH,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC;QAEb,MAAM,CACJ,cAAc,CAAC,cAAc,CAAC;YAC5B,MAAM,EAAE,YAAY,CAAC,KAAK;YAC1B,YAAY;YACZ,gBAAgB,EAAE,IAAI;SACvB,CAAC,CACH,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC;IACf,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,+CAA+C,EAAE,KAAK,IAAI,EAAE;QAC7D,UAAU;QACV,MAAM,cAAc,GAAG;YACrB,GAAG,YAAY;YACf,aAAa,EAAE;gBACb,MAAM,EAAE;oBACN,OAAO,EACL,oEAAoE;iBACvE;aACF;YACD,cAAc,EAAE;gBACd,MAAM,EAAE,QAAQ;aACjB;SACF,CAAC;QAEF,MAAM,YAAY,GAAG,KAAK,CAAC,IAAI,CAC7B,MAAM,EACN,kCAAkC,CACnC,CAAC,QAAQ,EAAE,CAAC;QACb,MAAM,cAAc,GAAG,KAAK,CAAC,IAAI,CAC/B,MAAM,EACN,oCAAoC,CACrC,CAAC,QAAQ,EAAE,CAAC;QAEb,MAAM;QACN,MAAM,kBAAkB,GAAG,MAAM,UAAU,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;QAEnE,SAAS;QACT,MAAM,CAAC,kBAAkB,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;QAC/C,MAAM,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,oBAAoB,CAAC,CAAC;QAC1E,MAAM,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;QAExE,MAAM,CACJ,YAAY,CAAC,cAAc,CAAC;YAC1B,MAAM,EAAE,YAAY,CAAC,KAAK;YAC1B,YAAY;YACZ,YAAY,EAAE;gBACZ,gBAAgB,EAAE,IAAI;gBACtB,eAAe,EACb,oEAAoE;gBACtE,GAAG,EAAE,QAAQ;aACd;SACF,CAAC,CACH,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC;QAEb,MAAM,CACJ,cAAc,CAAC,cAAc,CAAC;YAC5B,MAAM,EAAE,YAAY,CAAC,KAAK;YAC1B,YAAY;YACZ,gBAAgB,EAAE,IAAI;SACvB,CAAC,CACH,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC;IACf,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,SAAS,EAAE,KAAK,IAAI,EAAE;QACvB,UAAU;QACV,MAAM,aAAa,GACjB,oEAAoE,CAAC;QACvE,MAAM,MAAM,GAAG;YACb,IAAI,EAAE,sBAA+B;YACrC,UAAU,EAAE,CAAC,4CAA4C,CAAC;YAC1D,SAAS,EAAE,CAAC;SACb,CAAC;QAEF,MAAM,cAAc,GAAG;YACrB,GAAG,YAAY;YACf,wBAAwB,EAAE,MAAM;SACjC,CAAC;QAEF,MAAM,SAAS,GAAG,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,4BAA4B,CAAC,CAAC,QAAQ,CACzE;YACE,UAAU,EAAE,aAAa;SAC1B,CACF,CAAC;QACF,MAAM,SAAS,GAAG,KAAK,CAAC,IAAI,CAC1B,MAAM,EACN,2BAA2B,CAC5B,CAAC,QAAQ,EAAE,CAAC;QAEb,MAAM;QACN,MAAM,kBAAkB,GAAG,MAAM,UAAU,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;QAEnE,SAAS;QACT,MAAM,CAAC,kBAAkB,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;QAC/C,MAAM,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,OAAO,CACjD,+BAA+B,CAChC,CAAC;QACF,MAAM,CACJ,SAAS,CAAC,cAAc,CAAC;YACvB,UAAU,EAAE,MAAM,CAAC,UAAU;YAC7B,SAAS,EAAE,MAAM,CAAC,SAAS;SAC5B,CAAC,CACH,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC;QACb,MAAM,CACJ,SAAS,CAAC,cAAc,CAAC;YACvB,MAAM,EAAE,YAAY,CAAC,KAAK;YAC1B,YAAY;YACZ,UAAU,EAAE,aAAa;SAC1B,CAAC,CACH,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC;IACf,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qBAAqB,EAAE,KAAK,IAAI,EAAE;QACnC,UAAU;QACV,MAAM,kBAAkB,GACtB,oEAAoE,CAAC;QACvE,MAAM,WAAW,GAAG;YAClB,IAAI,EAAE,sBAA+B;YACrC,UAAU,EAAE,CAAC,4CAA4C,CAAC;YAC1D,SAAS,EAAE,CAAC;YACZ,OAAO,EAAE,kBAAkB;SAC5B,CAAC;QAEF,MAAM,aAAa,GACjB,oEAAoE,CAAC;QACvE,MAAM,MAAM,GAAG;YACb,IAAI,EAAE,uBAAgC;YACtC,UAAU,EAAE,CAAC,4CAA4C,CAAC;YAC1D,SAAS,EAAE,CAAC;SACb,CAAC;QAEF,QAAQ,CAAC,OAAO,EAAE,CAAC;QACnB,KAAK,CAAC,IAAI,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC,QAAQ,CAAC;YACtC,GAAG,YAAY;YACf,KAAK,EAAE,YAAY;YACnB,wBAAwB,EAAE,WAAW;SACjB,CAAC,CAAC;QAExB,MAAM,cAAc,GAAG;YACrB,GAAG,YAAY;YACf,wBAAwB,EAAE,MAAM;SACjC,CAAC;QAEF,2BAA2B;QAC3B,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC,QAAQ,CAAC,sBAA6B,CAAC,CAAC;QACzE,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,yBAAyB,CAAC,CAAC,QAAQ,CAAC;YACrD,OAAO,EAAE,kBAAkB;YAC3B,UAAU,EAAE,WAAW,CAAC,UAAU;YAClC,SAAS,EAAE,WAAW,CAAC,SAAS;SACjC,CAAC,CAAC;QAEH,MAAM,SAAS,GAAG,KAAK,CAAC,IAAI,CAC1B,MAAM,EACN,6BAA6B,CAC9B,CAAC,QAAQ,CAAC;YACT,UAAU,EAAE,aAAa;SAC1B,CAAC,CAAC;QACH,MAAM,SAAS,GAAG,KAAK,CAAC,IAAI,CAC1B,MAAM,EACN,2BAA2B,CAC5B,CAAC,QAAQ,EAAE,CAAC;QAEb,MAAM;QACN,MAAM,kBAAkB,GAAG,MAAM,UAAU,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;QAEnE,SAAS;QACT,MAAM,CAAC,kBAAkB,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;QAC/C,MAAM,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,OAAO,CACjD,+BAA+B,CAChC,CAAC;QAEF,kCAAkC;QAClC,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACxC,MAAM,aAAa,GAAG,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;QAC3C,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QACnE,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,KAAK,CACtD,MAAM,CAAC,UAAU,CAAC,MAAM,CACzB,CAAC;QACF,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAChE,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CACnC,CAAC;QAEF,kCAAkC;QAClC,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACxC,MAAM,aAAa,GAAG,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;QAC3C,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC;YAC1C,MAAM,EAAE,YAAY,CAAC,KAAK;YAC1B,YAAY;YACZ,UAAU,EAAE,aAAa;SAC1B,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/AltVMWarpRouteReader.d.ts

@@ -0,0 +1,52 @@
+import { AltVM } from '@hyperlane-xyz/provider-sdk';
+import { ChainLookup } from '@hyperlane-xyz/provider-sdk/chain';
+import { HypReader } from '@hyperlane-xyz/provider-sdk/module';
+import { DerivedWarpConfig, DestinationGas, RemoteRouters, TokenRouterModuleType, TokenType } from '@hyperlane-xyz/provider-sdk/warp';
+import { Address, rootLogger } from '@hyperlane-xyz/utils';
+import { AltVMHookReader } from './AltVMHookReader.js';
+import { AltVMIsmReader } from './AltVMIsmReader.js';
+export declare class AltVMWarpRouteReader implements HypReader<TokenRouterModuleType> {
+    protected readonly provider: AltVM.IProvider;
+    protected readonly logger: ReturnType<typeof rootLogger.child>;
+    hookReader: AltVMHookReader;
+    ismReader: AltVMIsmReader;
+    constructor(chainLookup: ChainLookup, provider: AltVM.IProvider);
+    /**
+     * Reads the configuration for a Warp Route at the given address.
+     * Implements the HypReader interface.
+     *
+     * @param address - The address of the Warp Route contract.
+     * @returns The derived Warp Route configuration.
+     */
+    read(address: string): Promise<DerivedWarpConfig>;
+    /**
+     * Derives the configuration for a Hyperlane ERC20 router contract at the given address.
+     *
+     * @param warpRouteAddress - The address of the Hyperlane ERC20 router contract.
+     * @returns The configuration for the Hyperlane ERC20 router.
+     *
+     */
+    deriveWarpRouteConfig(warpRouteAddress: Address): Promise<DerivedWarpConfig>;
+    /**
+     * Derives the token type for a given Warp Route address using specific methods
+     *
+     * @param warpRouteAddress - The Warp Route address to derive the token type for.
+     * @returns The derived TokenType, which can be either 'collateral' or 'synthetic'.
+     * @throws Error if the token type is not supported (i.e., not collateral or synthetic).
+     */
+    deriveTokenType(warpRouteAddress: Address): Promise<TokenType>;
+    /**
+     * Fetches the base metadata for a Warp Route contract.
+     *
+     * @param routerAddress - The address of the Warp Route contract.
+     * @returns The base metadata for the Warp Route contract, including the mailbox, owner, hook, and ism.
+     */
+    fetchMailboxClientConfig(routerAddress: Address): Promise<{
+        mailbox: string;
+        owner: string;
+        interchainSecurityModule?: any;
+    }>;
+    fetchRemoteRouters(warpRouteAddress: Address): Promise<RemoteRouters>;
+    fetchDestinationGas(warpRouteAddress: Address): Promise<DestinationGas>;
+}
+//# sourceMappingURL=AltVMWarpRouteReader.d.ts.map

package/dist/AltVMWarpRouteReader.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AltVMWarpRouteReader.d.ts","sourceRoot":"","sources":["../src/AltVMWarpRouteReader.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,6BAA6B,CAAC;AACpD,OAAO,EAAE,WAAW,EAAE,MAAM,mCAAmC,CAAC;AAChE,OAAO,EAAE,SAAS,EAAE,MAAM,oCAAoC,CAAC;AAC/D,OAAO,EAGL,iBAAiB,EACjB,cAAc,EACd,aAAa,EACb,qBAAqB,EACrB,SAAS,EACV,MAAM,kCAAkC,CAAC;AAC1C,OAAO,EAAE,OAAO,EAAY,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAErE,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAErD,qBAAa,oBAAqB,YAAW,SAAS,CAAC,qBAAqB,CAAC;IAOzE,SAAS,CAAC,QAAQ,CAAC,QAAQ,EAAE,KAAK,CAAC,SAAS;IAN9C,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC,OAAO,UAAU,CAAC,KAAK,CAAC,CAAC;IAC/D,UAAU,EAAE,eAAe,CAAC;IAC5B,SAAS,EAAE,cAAc,CAAC;gBAGxB,WAAW,EAAE,WAAW,EACL,QAAQ,EAAE,KAAK,CAAC,SAAS;IAa9C;;;;;;OAMG;IACG,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAIvD;;;;;;OAMG;IACG,qBAAqB,CACzB,gBAAgB,EAAE,OAAO,GACxB,OAAO,CAAC,iBAAiB,CAAC;IAuD7B;;;;;;OAMG;IACG,eAAe,CAAC,gBAAgB,EAAE,OAAO,GAAG,OAAO,CAAC,SAAS,CAAC;IAiBpE;;;;;OAKG;IACG,wBAAwB,CAAC,aAAa,EAAE,OAAO,GAAG,OAAO,CAAC;QAC9D,OAAO,EAAE,MAAM,CAAC;QAChB,KAAK,EAAE,MAAM,CAAC;QACd,wBAAwB,CAAC,EAAE,GAAG,CAAC;KAChC,CAAC;IAkBI,kBAAkB,CAAC,gBAAgB,EAAE,OAAO,GAAG,OAAO,CAAC,aAAa,CAAC;IAerE,mBAAmB,CACvB,gBAAgB,EAAE,OAAO,GACxB,OAAO,CAAC,cAAc,CAAC;CAY3B"}

package/dist/AltVMWarpRouteReader.js

@@ -0,0 +1,145 @@
+import { AltVM } from '@hyperlane-xyz/provider-sdk';
+import { TokenType, } from '@hyperlane-xyz/provider-sdk/warp';
+import { ensure0x, rootLogger } from '@hyperlane-xyz/utils';
+import { AltVMHookReader } from './AltVMHookReader.js';
+import { AltVMIsmReader } from './AltVMIsmReader.js';
+export class AltVMWarpRouteReader {
+    provider;
+    logger;
+    hookReader;
+    ismReader;
+    constructor(chainLookup, provider) {
+        this.provider = provider;
+        this.hookReader = new AltVMHookReader(chainLookup.getChainMetadata, provider);
+        this.ismReader = new AltVMIsmReader(chainLookup.getChainName, provider);
+        this.logger = rootLogger.child({
+            module: AltVMWarpRouteReader.name,
+        });
+    }
+    /**
+     * Reads the configuration for a Warp Route at the given address.
+     * Implements the HypReader interface.
+     *
+     * @param address - The address of the Warp Route contract.
+     * @returns The derived Warp Route configuration.
+     */
+    async read(address) {
+        return this.deriveWarpRouteConfig(address);
+    }
+    /**
+     * Derives the configuration for a Hyperlane ERC20 router contract at the given address.
+     *
+     * @param warpRouteAddress - The address of the Hyperlane ERC20 router contract.
+     * @returns The configuration for the Hyperlane ERC20 router.
+     *
+     */
+    async deriveWarpRouteConfig(warpRouteAddress) {
+        // Fetch token info once - this gives us type, metadata, owner, mailbox, ISM, etc.
+        const token = await this.provider.getToken({
+            tokenAddress: warpRouteAddress,
+        });
+        const remoteRouters = await this.fetchRemoteRouters(warpRouteAddress);
+        const destinationGas = await this.fetchDestinationGas(warpRouteAddress);
+        // Derive ISM config if present, otherwise use zero address
+        const interchainSecurityModule = token.ismAddress
+            ? await this.ismReader.deriveIsmConfig(token.ismAddress)
+            : // TODO: replace with protocol-specific zero address
+                '0x0000000000000000000000000000000000000000';
+        // Hook address is not exposed by providers yet, use zero address as placeholder
+        // TODO: replace with protocol-specific zero address
+        const hook = '0x0000000000000000000000000000000000000000';
+        const baseConfig = {
+            owner: token.owner,
+            mailbox: token.mailboxAddress,
+            interchainSecurityModule,
+            hook,
+            remoteRouters,
+            destinationGas,
+            name: token.name ?? undefined,
+            symbol: token.symbol ?? undefined,
+            decimals: token.decimals ?? undefined,
+        };
+        // Return discriminated union based on type
+        switch (token.tokenType) {
+            case AltVM.TokenType.collateral: {
+                const collateralConfig = {
+                    ...baseConfig,
+                    type: TokenType.collateral,
+                    token: token.denom, // The underlying collateral denom
+                };
+                return collateralConfig;
+            }
+            case AltVM.TokenType.synthetic: {
+                const syntheticConfig = {
+                    ...baseConfig,
+                    type: TokenType.synthetic,
+                };
+                return syntheticConfig;
+            }
+            default:
+                throw new Error(`Failed to determine token type for address ${warpRouteAddress}`);
+        }
+    }
+    /**
+     * Derives the token type for a given Warp Route address using specific methods
+     *
+     * @param warpRouteAddress - The Warp Route address to derive the token type for.
+     * @returns The derived TokenType, which can be either 'collateral' or 'synthetic'.
+     * @throws Error if the token type is not supported (i.e., not collateral or synthetic).
+     */
+    async deriveTokenType(warpRouteAddress) {
+        const token = await this.provider.getToken({
+            tokenAddress: warpRouteAddress,
+        });
+        switch (token.tokenType) {
+            case AltVM.TokenType.collateral:
+                return TokenType.collateral;
+            case AltVM.TokenType.synthetic:
+                return TokenType.synthetic;
+            default:
+                throw new Error(`Failed to determine token type for address ${warpRouteAddress}`);
+        }
+    }
+    /**
+     * Fetches the base metadata for a Warp Route contract.
+     *
+     * @param routerAddress - The address of the Warp Route contract.
+     * @returns The base metadata for the Warp Route contract, including the mailbox, owner, hook, and ism.
+     */
+    async fetchMailboxClientConfig(routerAddress) {
+        const token = await this.provider.getToken({
+            tokenAddress: routerAddress,
+        });
+        const config = {
+            mailbox: token.mailboxAddress,
+            owner: token.owner,
+        };
+        if (token.ismAddress) {
+            const derivedIsm = await this.ismReader.deriveIsmConfig(token.ismAddress);
+            config.interchainSecurityModule = derivedIsm;
+        }
+        return config;
+    }
+    async fetchRemoteRouters(warpRouteAddress) {
+        const { remoteRouters } = await this.provider.getRemoteRouters({
+            tokenAddress: warpRouteAddress,
+        });
+        const routers = {};
+        for (const router of remoteRouters) {
+            routers[router.receiverDomainId] = {
+                address: ensure0x(router.receiverAddress),
+            };
+        }
+        return routers;
+    }
+    async fetchDestinationGas(warpRouteAddress) {
+        const { remoteRouters } = await this.provider.getRemoteRouters({
+            tokenAddress: warpRouteAddress,
+        });
+        return Object.fromEntries(remoteRouters.map((routerConfig) => [
+            routerConfig.receiverDomainId,
+            routerConfig.gas,
+        ]));
+    }
+}
+//# sourceMappingURL=AltVMWarpRouteReader.js.map

package/dist/AltVMWarpRouteReader.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AltVMWarpRouteReader.js","sourceRoot":"","sources":["../src/AltVMWarpRouteReader.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,6BAA6B,CAAC;AAGpD,OAAO,EAOL,SAAS,GACV,MAAM,kCAAkC,CAAC;AAC1C,OAAO,EAAW,QAAQ,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAErE,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAErD,MAAM,OAAO,oBAAoB;IAOV;IANF,MAAM,CAAsC;IAC/D,UAAU,CAAkB;IAC5B,SAAS,CAAiB;IAE1B,YACE,WAAwB,EACL,QAAyB;QAAzB,aAAQ,GAAR,QAAQ,CAAiB;QAE5C,IAAI,CAAC,UAAU,GAAG,IAAI,eAAe,CACnC,WAAW,CAAC,gBAAgB,EAC5B,QAAQ,CACT,CAAC;QACF,IAAI,CAAC,SAAS,GAAG,IAAI,cAAc,CAAC,WAAW,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC;QAExE,IAAI,CAAC,MAAM,GAAG,UAAU,CAAC,KAAK,CAAC;YAC7B,MAAM,EAAE,oBAAoB,CAAC,IAAI;SAClC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,IAAI,CAAC,OAAe;QACxB,OAAO,IAAI,CAAC,qBAAqB,CAAC,OAAO,CAAC,CAAC;IAC7C,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,qBAAqB,CACzB,gBAAyB;QAEzB,kFAAkF;QAClF,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC;YACzC,YAAY,EAAE,gBAAgB;SAC/B,CAAC,CAAC;QAEH,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,gBAAgB,CAAC,CAAC;QACtE,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,mBAAmB,CAAC,gBAAgB,CAAC,CAAC;QAExE,2DAA2D;QAC3D,MAAM,wBAAwB,GAAG,KAAK,CAAC,UAAU;YAC/C,CAAC,CAAC,MAAM,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC,KAAK,CAAC,UAAU,CAAC;YACxD,CAAC,CAAC,oDAAoD;gBACpD,4CAA4C,CAAC;QAEjD,gFAAgF;QAChF,oDAAoD;QACpD,MAAM,IAAI,GAAG,4CAA4C,CAAC;QAE1D,MAAM,UAAU,GAAG;YACjB,KAAK,EAAE,KAAK,CAAC,KAAK;YAClB,OAAO,EAAE,KAAK,CAAC,cAAc;YAC7B,wBAAwB;YACxB,IAAI;YACJ,aAAa;YACb,cAAc;YACd,IAAI,EAAE,KAAK,CAAC,IAAI,IAAI,SAAS;YAC7B,MAAM,EAAE,KAAK,CAAC,MAAM,IAAI,SAAS;YACjC,QAAQ,EAAE,KAAK,CAAC,QAAQ,IAAI,SAAS;SACtC,CAAC;QAEF,2CAA2C;QAC3C,QAAQ,KAAK,CAAC,SAAS,EAAE,CAAC;YACxB,KAAK,KAAK,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC;gBAChC,MAAM,gBAAgB,GAAgC;oBACpD,GAAG,UAAU;oBACb,IAAI,EAAE,SAAS,CAAC,UAAU;oBAC1B,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,kCAAkC;iBACvD,CAAC;gBACF,OAAO,gBAAgB,CAAC;YAC1B,CAAC;YACD,KAAK,KAAK,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,CAAC;gBAC/B,MAAM,eAAe,GAA+B;oBAClD,GAAG,UAAU;oBACb,IAAI,EAAE,SAAS,CAAC,SAAS;iBAC1B,CAAC;gBACF,OAAO,eAAe,CAAC;YACzB,CAAC;YACD;gBACE,MAAM,IAAI,KAAK,CACb,8CAA8C,gBAAgB,EAAE,CACjE,CAAC;QACN,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,eAAe,CAAC,gBAAyB;QAC7C,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC;YACzC,YAAY,EAAE,gBAAgB;SAC/B,CAAC,CAAC;QAEH,QAAQ,KAAK,CAAC,SAAS,EAAE,CAAC;YACxB,KAAK,KAAK,CAAC,SAAS,CAAC,UAAU;gBAC7B,OAAO,SAAS,CAAC,UAAU,CAAC;YAC9B,KAAK,KAAK,CAAC,SAAS,CAAC,SAAS;gBAC5B,OAAO,SAAS,CAAC,SAAS,CAAC;YAC7B;gBACE,MAAM,IAAI,KAAK,CACb,8CAA8C,gBAAgB,EAAE,CACjE,CAAC;QACN,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,wBAAwB,CAAC,aAAsB;QAKnD,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC;YACzC,YAAY,EAAE,aAAa;SAC5B,CAAC,CAAC;QAEH,MAAM,MAAM,GAAQ;YAClB,OAAO,EAAE,KAAK,CAAC,cAAc;YAC7B,KAAK,EAAE,KAAK,CAAC,KAAK;SACnB,CAAC;QAEF,IAAI,KAAK,CAAC,UAAU,EAAE,CAAC;YACrB,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;YAC1E,MAAM,CAAC,wBAAwB,GAAG,UAAU,CAAC;QAC/C,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,KAAK,CAAC,kBAAkB,CAAC,gBAAyB;QAChD,MAAM,EAAE,aAAa,EAAE,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,gBAAgB,CAAC;YAC7D,YAAY,EAAE,gBAAgB;SAC/B,CAAC,CAAC;QAEH,MAAM,OAAO,GAAwC,EAAE,CAAC;QACxD,KAAK,MAAM,MAAM,IAAI,aAAa,EAAE,CAAC;YACnC,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAC,GAAG;gBACjC,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,eAAe,CAAC;aAC1C,CAAC;QACJ,CAAC;QAED,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,KAAK,CAAC,mBAAmB,CACvB,gBAAyB;QAEzB,MAAM,EAAE,aAAa,EAAE,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,gBAAgB,CAAC;YAC7D,YAAY,EAAE,gBAAgB;SAC/B,CAAC,CAAC;QAEH,OAAO,MAAM,CAAC,WAAW,CACvB,aAAa,CAAC,GAAG,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC;YAClC,YAAY,CAAC,gBAAgB;YAC7B,YAAY,CAAC,GAAG;SACjB,CAAC,CACH,CAAC;IACJ,CAAC;CACF"}

package/dist/core-module.d.ts

@@ -0,0 +1,5 @@
+import { ChainLookup } from '@hyperlane-xyz/provider-sdk/chain';
+import { CoreModuleType } from '@hyperlane-xyz/provider-sdk/core';
+import { ModuleProvider } from '@hyperlane-xyz/provider-sdk/module';
+export declare function coreModuleProvider(chainLookup: ChainLookup, chainName: string): ModuleProvider<CoreModuleType>;
+//# sourceMappingURL=core-module.d.ts.map

package/dist/core-module.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"core-module.d.ts","sourceRoot":"","sources":["../src/core-module.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,mCAAmC,CAAC;AAChE,OAAO,EAAc,cAAc,EAAE,MAAM,kCAAkC,CAAC;AAC9E,OAAO,EAKL,cAAc,EAEf,MAAM,oCAAoC,CAAC;AAmC5C,wBAAgB,kBAAkB,CAChC,WAAW,EAAE,WAAW,EACxB,SAAS,EAAE,MAAM,GAChB,cAAc,CAAC,cAAc,CAAC,CAEhC"}