@recoillink/cosmos-sdk 0.0.0-stage → 45.0.1

package/LICENSE.md

@@ -0,0 +1,193 @@
+# Apache License
+
+_Version 2.0, January 2004_  
+_&lt;<http://www.apache.org/licenses/>&gt;_
+
+### Terms and Conditions for use, reproduction, and distribution
+
+#### 1. Definitions
+
+“License” shall mean the terms and conditions for use, reproduction, and
+distribution as defined by Sections 1 through 9 of this document.
+
+“Licensor” shall mean the copyright owner or entity authorized by the copyright
+owner that is granting the License.
+
+“Legal Entity” shall mean the union of the acting entity and all other entities
+that control, are controlled by, or are under common control with that entity.
+For the purposes of this definition, “control” means **(i)** the power, direct or
+indirect, to cause the direction or management of such entity, whether by
+contract or otherwise, or **(ii)** ownership of fifty percent (50%) or more of the
+outstanding shares, or **(iii)** beneficial ownership of such entity.
+
+“You” (or “Your”) shall mean an individual or Legal Entity exercising
+permissions granted by this License.
+
+“Source” form shall mean the preferred form for making modifications, including
+but not limited to software source code, documentation source, and configuration
+files.
+
+“Object” form shall mean any form resulting from mechanical transformation or
+translation of a Source form, including but not limited to compiled object code,
+generated documentation, and conversions to other media types.
+
+“Work” shall mean the work of authorship, whether in Source or Object form, made
+available under the License, as indicated by a copyright notice that is included
+in or attached to the work (an example is provided in the Appendix below).
+
+“Derivative Works” shall mean any work, whether in Source or Object form, that
+is based on (or derived from) the Work and for which the editorial revisions,
+annotations, elaborations, or other modifications represent, as a whole, an
+original work of authorship. For the purposes of this License, Derivative Works
+shall not include works that remain separable from, or merely link (or bind by
+name) to the interfaces of, the Work and Derivative Works thereof.
+
+“Contribution” shall mean any work of authorship, including the original version
+of the Work and any modifications or additions to that Work or Derivative Works
+thereof, that is intentionally submitted to Licensor for inclusion in the Work
+by the copyright owner or by an individual or Legal Entity authorized to submit
+on behalf of the copyright owner. For the purposes of this definition,
+“submitted” means any form of electronic, verbal, or written communication sent
+to the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control systems, and
+issue tracking systems that are managed by, or on behalf of, the Licensor for
+the purpose of discussing and improving the Work, but excluding communication
+that is conspicuously marked or otherwise designated in writing by the copyright
+owner as “Not a Contribution.”
+
+“Contributor” shall mean Licensor and any individual or Legal Entity on behalf
+of whom a Contribution has been received by Licensor and subsequently
+incorporated within the Work.
+
+#### 2. Grant of Copyright License
+
+Subject to the terms and conditions of this License, each Contributor hereby
+grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
+irrevocable copyright license to reproduce, prepare Derivative Works of,
+publicly display, publicly perform, sublicense, and distribute the Work and such
+Derivative Works in Source or Object form.
+
+#### 3. Grant of Patent License
+
+Subject to the terms and conditions of this License, each Contributor hereby
+grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
+irrevocable (except as stated in this section) patent license to make, have
+made, use, offer to sell, sell, import, and otherwise transfer the Work, where
+such license applies only to those patent claims licensable by such Contributor
+that are necessarily infringed by their Contribution(s) alone or by combination
+of their Contribution(s) with the Work to which such Contribution(s) was
+submitted. If You institute patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Work or a
+Contribution incorporated within the Work constitutes direct or contributory
+patent infringement, then any patent licenses granted to You under this License
+for that Work shall terminate as of the date such litigation is filed.
+
+#### 4. Redistribution
+
+You may reproduce and distribute copies of the Work or Derivative Works thereof
+in any medium, with or without modifications, and in Source or Object form,
+provided that You meet the following conditions:
+
+- **(a)** You must give any other recipients of the Work or Derivative Works a copy of
+  this License; and
+- **(b)** You must cause any modified files to carry prominent notices stating that You
+  changed the files; and
+- **(c)** You must retain, in the Source form of any Derivative Works that You distribute,
+  all copyright, patent, trademark, and attribution notices from the Source form
+  of the Work, excluding those notices that do not pertain to any part of the
+  Derivative Works; and
+- **(d)** If the Work includes a “NOTICE” text file as part of its distribution, then any
+  Derivative Works that You distribute must include a readable copy of the
+  attribution notices contained within such NOTICE file, excluding those notices
+  that do not pertain to any part of the Derivative Works, in at least one of the
+  following places: within a NOTICE text file distributed as part of the
+  Derivative Works; within the Source form or documentation, if provided along
+  with the Derivative Works; or, within a display generated by the Derivative
+  Works, if and wherever such third-party notices normally appear. The contents of
+  the NOTICE file are for informational purposes only and do not modify the
+  License. You may add Your own attribution notices within Derivative Works that
+  You distribute, alongside or as an addendum to the NOTICE text from the Work,
+  provided that such additional attribution notices cannot be construed as
+  modifying the License.
+
+You may add Your own copyright statement to Your modifications and may provide
+additional or different license terms and conditions for use, reproduction, or
+distribution of Your modifications, or for any such Derivative Works as a whole,
+provided Your use, reproduction, and distribution of the Work otherwise complies
+with the conditions stated in this License.
+
+#### 5. Submission of Contributions
+
+Unless You explicitly state otherwise, any Contribution intentionally submitted
+for inclusion in the Work by You to the Licensor shall be under the terms and
+conditions of this License, without any additional terms or conditions.
+Notwithstanding the above, nothing herein shall supersede or modify the terms of
+any separate license agreement you may have executed with Licensor regarding
+such Contributions.
+
+#### 6. Trademarks
+
+This License does not grant permission to use the trade names, trademarks,
+service marks, or product names of the Licensor, except as required for
+reasonable and customary use in describing the origin of the Work and
+reproducing the content of the NOTICE file.
+
+#### 7. Disclaimer of Warranty
+
+Unless required by applicable law or agreed to in writing, Licensor provides the
+Work (and each Contributor provides its Contributions) on an “AS IS” BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied,
+including, without limitation, any warranties or conditions of TITLE,
+NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are
+solely responsible for determining the appropriateness of using or
+redistributing the Work and assume any risks associated with Your exercise of
+permissions under this License.
+
+#### 8. Limitation of Liability
+
+In no event and under no legal theory, whether in tort (including negligence),
+contract, or otherwise, unless required by applicable law (such as deliberate
+and grossly negligent acts) or agreed to in writing, shall any Contributor be
+liable to You for damages, including any direct, indirect, special, incidental,
+or consequential damages of any character arising as a result of this License or
+out of the use or inability to use the Work (including but not limited to
+damages for loss of goodwill, work stoppage, computer failure or malfunction, or
+any and all other commercial damages or losses), even if such Contributor has
+been advised of the possibility of such damages.
+
+#### 9. Accepting Warranty or Additional Liability
+
+While redistributing the Work or Derivative Works thereof, You may choose to
+offer, and charge a fee for, acceptance of support, warranty, indemnity, or
+other liability obligations and/or rights consistent with this License. However,
+in accepting such obligations, You may act only on Your own behalf and on Your
+sole responsibility, not on behalf of any other Contributor, and only if You
+agree to indemnify, defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason of your
+accepting any such warranty or additional liability.
+
+_END OF TERMS AND CONDITIONS_
+
+### APPENDIX: How to apply the Apache License to your work
+
+To apply the Apache License to your work, attach the following boilerplate
+notice, with the fields enclosed by brackets `[]` replaced with your own
+identifying information. (Don't include the brackets!) The text should be
+enclosed in the appropriate comment syntax for the file format. We also
+recommend that a file or class name and description of purpose be included on
+the same “printed page” as the copyright notice for easier identification within
+third-party archives.
+
+    Copyright [yyyy] [name of copyright owner]
+
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.

package/README.md

@@ -1,3 +1,83 @@
-# Temporary Holding Version
+# Hyperlane Cosmos Module SDK
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+The Hyperlane Cosmos Module SDK is a fully typed TypeScript SDK for the [Cosmos Hyperlane Module Implementation](https://github.com/bcp-innovations/hyperlane-cosmos).
+It can be used as a standalone SDK for frontend or in backend applications which want to connect to a Cosmos SDK chain which has the Hyperlane Module installed.
+
+## Install
+
+```bash
+# Install with NPM
+npm install @recoillink/cosmos-sdk
+
+# Or with pnpm
+pnpm add @recoillink/cosmos-sdk
+```
+
+## Usage
+
+```ts
+import { CosmosNativeProvider, CosmosNativeSigner } from "@recoillink/cosmos-sdk";
+import { ChainMetadataForAltVM, ProtocolType } from "@recoillink/provider-sdk";
+import { DirectSecp256k1Wallet } from '@cosmjs/proto-signing';
+
+const metadata: ChainMetadataForAltVM = {
+  name: 'mychain',
+  protocol: ProtocolType.CosmosNative,
+  chainId: 'mychain-1',
+  domainId: 1234,
+  bech32Prefix: 'test',
+  gasPrice: {
+    amount: '0.2',
+    denom: 'denom',
+  },
+  rpcUrls: [{ http: 'https://rpc-endpoint:26657' }],
+};
+
+// using hyperlane queries without needing signers
+const client = await CosmosNativeProvider.connect(metadata);
+
+const mailbox = await client.getMailbox('mailbox-id');
+const bridgedSupply = await client.getBridgedSupply({ id: "token-id" });
+...
+
+// performing hyperlane transactions
+const wallet = await DirectSecp256k1Wallet.fromKey(PRIV_KEY);
+
+const signer = await CosmosNativeSigner.connectWithSigner(metadata, wallet);
+
+const { mailbox_id } = await signer.createMailbox({
+  owner: '...',
+  localDomain: '...',
+  defaultIsm: '...',
+});
+
+await signer.remoteTransfer({
+  sender: '...',
+  tokenAddress: '...',
+  destinationDomainId: '...',
+  recipient: '...',
+  amount: '...',
+  ...
+});
+
+// sign and broadcast custom messages
+await signer.signAndBroadcast([txs...]);
+```
+
+## Setup
+
+Node 22 or newer is required.
+
+## Testing
+
+We have a `cosmos-sdk-e2e` job in CI that first runs a local node and then runs a suite of end-to-end tests. The `hyperlane-cosmos-simapp` image is created ad-hoc by the `hypd-docker` workflow, intended to be triggered manually by a developer when a new hyperlane-cosmos release is made.
+
+> Note: When updating the `cosmos-sdk` and `cosmos-types` package to a new `hyperlane-cosmos` version, it's important to release a new `hyperlane-cosmos-simapp` image and update the tag used in the `cosmos-sdk-e2e` job. This ensures that the end-to-end tests run against the correct version of the `hyperlane-cosmos` module.
+
+## Contribute
+
+First you need to install the dependencies by running `pnpm install`.
+
+### Building the project
+
+You can build the project with `pnpm build`, the build output can be found under `dist`.

package/dist/clients/protocol.d.ts

@@ -0,0 +1,26 @@
+import { type AltVM, type ChainMetadataForAltVM, type ITransactionSubmitter, type MinimumRequiredGasByAction, type ProtocolProvider, type SignerConfig, type TransactionSubmitterConfig } from '@recoillink/provider-sdk';
+import { type IProvider } from '@recoillink/provider-sdk/altvm';
+import { type IRawHookArtifactManager } from '@recoillink/provider-sdk/hook';
+import { type IRawIsmArtifactManager } from '@recoillink/provider-sdk/ism';
+import { type IRawMailboxArtifactManager } from '@recoillink/provider-sdk/mailbox';
+import { type AnnotatedTx, type TxReceipt } from '@recoillink/provider-sdk/module';
+import { type IRawWarpArtifactManager } from '@recoillink/provider-sdk/warp';
+import { type FeeReadContext, type IRawFeeArtifactManager } from '@recoillink/provider-sdk/fee';
+import { type IRawValidatorAnnounceArtifactManager } from '@recoillink/provider-sdk/validator-announce';
+export declare class CosmosNativeProtocolProvider implements ProtocolProvider {
+    createProvider(chainMetadata: ChainMetadataForAltVM): Promise<IProvider>;
+    createSigner(chainMetadata: ChainMetadataForAltVM, config: SignerConfig): Promise<AltVM.ISigner<AnnotatedTx, TxReceipt>>;
+    createSubmitter<TConfig extends TransactionSubmitterConfig>(_chainMetadata: ChainMetadataForAltVM, _config: TConfig): Promise<ITransactionSubmitter>;
+    createIsmArtifactManager(chainMetadata: ChainMetadataForAltVM): IRawIsmArtifactManager;
+    createHookArtifactManager(chainMetadata: ChainMetadataForAltVM, context?: {
+        mailbox?: string;
+    }): IRawHookArtifactManager;
+    createWarpArtifactManager(chainMetadata: ChainMetadataForAltVM, _context?: {
+        mailbox?: string;
+    }): IRawWarpArtifactManager;
+    createMailboxArtifactManager(chainMetadata: ChainMetadataForAltVM): IRawMailboxArtifactManager;
+    createValidatorAnnounceArtifactManager(_chainMetadata: ChainMetadataForAltVM): IRawValidatorAnnounceArtifactManager | null;
+    createFeeArtifactManager(_chainMetadata: ChainMetadataForAltVM, _context: FeeReadContext): IRawFeeArtifactManager | null;
+    getMinGas(): MinimumRequiredGasByAction;
+}
+//# sourceMappingURL=protocol.d.ts.map

package/dist/clients/protocol.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"protocol.d.ts","sourceRoot":"","sources":["../../src/clients/protocol.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,KAAK,EACV,KAAK,qBAAqB,EAC1B,KAAK,qBAAqB,EAC1B,KAAK,0BAA0B,EAC/B,KAAK,gBAAgB,EACrB,KAAK,YAAY,EACjB,KAAK,0BAA0B,EAChC,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,gCAAgC,CAAC;AAChE,OAAO,EAAE,KAAK,uBAAuB,EAAE,MAAM,+BAA+B,CAAC;AAC7E,OAAO,EAAE,KAAK,sBAAsB,EAAE,MAAM,8BAA8B,CAAC;AAC3E,OAAO,EAAE,KAAK,0BAA0B,EAAE,MAAM,kCAAkC,CAAC;AACnF,OAAO,EACL,KAAK,WAAW,EAChB,KAAK,SAAS,EACf,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAAE,KAAK,uBAAuB,EAAE,MAAM,+BAA+B,CAAC;AAC7E,OAAO,EACL,KAAK,cAAc,EACnB,KAAK,sBAAsB,EAC5B,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,KAAK,oCAAoC,EAAE,MAAM,6CAA6C,CAAC;AAgBxG,qBAAa,4BAA6B,YAAW,gBAAgB;IACnE,cAAc,CAAC,aAAa,EAAE,qBAAqB,GAAG,OAAO,CAAC,SAAS,CAAC,CAEvE;IAEK,YAAY,CAChB,aAAa,EAAE,qBAAqB,EACpC,MAAM,EAAE,YAAY,GACnB,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC,CAIhD;IAED,eAAe,CAAC,OAAO,SAAS,0BAA0B,EACxD,cAAc,EAAE,qBAAqB,EACrC,OAAO,EAAE,OAAO,GACf,OAAO,CAAC,qBAAqB,CAAC,CAGhC;IAED,wBAAwB,CACtB,aAAa,EAAE,qBAAqB,GACnC,sBAAsB,CAKxB;IAED,yBAAyB,CACvB,aAAa,EAAE,qBAAqB,EACpC,OAAO,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,GAC7B,uBAAuB,CAgBzB;IAED,yBAAyB,CACvB,aAAa,EAAE,qBAAqB,EACpC,QAAQ,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,GAC9B,uBAAuB,CAIzB;IAED,4BAA4B,CAC1B,aAAa,EAAE,qBAAqB,GACnC,0BAA0B,CAY5B;IAED,sCAAsC,CACpC,cAAc,EAAE,qBAAqB,GACpC,oCAAoC,GAAG,IAAI,CAG7C;IAED,wBAAwB,CACtB,cAAc,EAAE,qBAAqB,EACrC,QAAQ,EAAE,cAAc,GACvB,sBAAsB,GAAG,IAAI,CAE/B;IAED,SAAS,IAAI,0BAA0B,CAStC;CACF"}

package/dist/clients/protocol.js

@@ -0,0 +1,72 @@
+import { assert } from '@recoillink/utils';
+import { CosmosHookArtifactManager } from '../hook/hook-artifact-manager.js';
+import { CosmosIsmArtifactManager } from '../ism/ism-artifact-manager.js';
+import { CosmosWarpArtifactManager } from '../warp/warp-artifact-manager.js';
+import { CosmosNativeProvider } from './provider.js';
+import { CosmosNativeSigner } from './signer.js';
+import { CosmosMailboxArtifactManager } from '../mailbox/mailbox-artifact-manager.js';
+// Base router deploy cost in gas units (ugas), used to size
+// getMinGas().WARP_DEPLOY_GAS. The composable per-config breakdown lives on
+// CosmosNativeProvider.getMinGasForWarpDeploy.
+const WARP_DEPLOY_BASE_UGAS = BigInt(3e6);
+export class CosmosNativeProtocolProvider {
+    createProvider(chainMetadata) {
+        return CosmosNativeProvider.connect(chainMetadata);
+    }
+    async createSigner(chainMetadata, config) {
+        const { privateKey } = config;
+        return CosmosNativeSigner.connectWithSigner(chainMetadata, privateKey);
+    }
+    createSubmitter(_chainMetadata, _config) {
+        // @TODO Implement in a follow up PR
+        throw Error('Not implemented');
+    }
+    createIsmArtifactManager(chainMetadata) {
+        assert(chainMetadata.rpcUrls, 'rpc urls undefined');
+        const rpcUrls = chainMetadata.rpcUrls.map((rpc) => rpc.http);
+        return new CosmosIsmArtifactManager(rpcUrls);
+    }
+    createHookArtifactManager(chainMetadata, context) {
+        const [mainRpcUrl, ...otherRpcUrls] = (chainMetadata.rpcUrls ?? []).map((rpc) => rpc.http);
+        assert(mainRpcUrl, 'At least one rpc url is required');
+        assert(chainMetadata.nativeToken?.denom, 'native token denom undefined');
+        const mailboxAddress = context?.mailbox;
+        const nativeTokenDenom = chainMetadata.nativeToken.denom;
+        return new CosmosHookArtifactManager({
+            rpcUrls: [mainRpcUrl, ...otherRpcUrls],
+            mailboxAddress,
+            nativeTokenDenom,
+        });
+    }
+    createWarpArtifactManager(chainMetadata, _context) {
+        assert(chainMetadata.rpcUrls, 'rpc urls undefined');
+        const rpcUrls = chainMetadata.rpcUrls.map((rpc) => rpc.http);
+        return new CosmosWarpArtifactManager(rpcUrls);
+    }
+    createMailboxArtifactManager(chainMetadata) {
+        const [rpcUrl, ...otherRpcUrls] = chainMetadata.rpcUrls?.map((rpc) => rpc.http) ?? [];
+        assert(rpcUrl, `Expected at least one rpc url for chain ${chainMetadata.name}`);
+        return new CosmosMailboxArtifactManager({
+            domainId: chainMetadata.domainId,
+            rpcUrls: [rpcUrl, ...otherRpcUrls],
+        });
+    }
+    createValidatorAnnounceArtifactManager(_chainMetadata) {
+        // Cosmos does not support validator announce
+        return null;
+    }
+    createFeeArtifactManager(_chainMetadata, _context) {
+        return null;
+    }
+    getMinGas() {
+        return {
+            CORE_DEPLOY_GAS: BigInt(1e6),
+            WARP_DEPLOY_GAS: WARP_DEPLOY_BASE_UGAS,
+            TEST_SEND_GAS: BigInt(3e5),
+            AVS_GAS: BigInt(3e6),
+            ISM_DEPLOY_GAS: BigInt(5e5),
+            HOOK_DEPLOY_GAS: BigInt(5e5),
+        };
+    }
+}
+//# sourceMappingURL=protocol.js.map

package/dist/clients/protocol.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"protocol.js","sourceRoot":"","sources":["../../src/clients/protocol.ts"],"names":[],"mappings":"AAuBA,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAE3C,OAAO,EAAE,yBAAyB,EAAE,MAAM,kCAAkC,CAAC;AAC7E,OAAO,EAAE,wBAAwB,EAAE,MAAM,gCAAgC,CAAC;AAC1E,OAAO,EAAE,yBAAyB,EAAE,MAAM,kCAAkC,CAAC;AAE7E,OAAO,EAAE,oBAAoB,EAAE,MAAM,eAAe,CAAC;AACrD,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AACjD,OAAO,EAAE,4BAA4B,EAAE,MAAM,wCAAwC,CAAC;AAEtF,4DAA4D;AAC5D,4EAA4E;AAC5E,+CAA+C;AAC/C,MAAM,qBAAqB,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;AAE1C,MAAM,OAAO,4BAA4B;IACvC,cAAc,CAAC,aAAoC;QACjD,OAAO,oBAAoB,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;IACrD,CAAC;IAED,KAAK,CAAC,YAAY,CAChB,aAAoC,EACpC,MAAoB;QAEpB,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC;QAE9B,OAAO,kBAAkB,CAAC,iBAAiB,CAAC,aAAa,EAAE,UAAU,CAAC,CAAC;IACzE,CAAC;IAED,eAAe,CACb,cAAqC,EACrC,OAAgB;QAEhB,oCAAoC;QACpC,MAAM,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACjC,CAAC;IAED,wBAAwB,CACtB,aAAoC;QAEpC,MAAM,CAAC,aAAa,CAAC,OAAO,EAAE,oBAAoB,CAAC,CAAC;QACpD,MAAM,OAAO,GAAG,aAAa,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAE7D,OAAO,IAAI,wBAAwB,CAAC,OAAO,CAAC,CAAC;IAC/C,CAAC;IAED,yBAAyB,CACvB,aAAoC,EACpC,OAA8B;QAE9B,MAAM,CAAC,UAAU,EAAE,GAAG,YAAY,CAAC,GAAG,CAAC,aAAa,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,GAAG,CACrE,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAClB,CAAC;QAEF,MAAM,CAAC,UAAU,EAAE,kCAAkC,CAAC,CAAC;QACvD,MAAM,CAAC,aAAa,CAAC,WAAW,EAAE,KAAK,EAAE,8BAA8B,CAAC,CAAC;QAEzE,MAAM,cAAc,GAAG,OAAO,EAAE,OAAO,CAAC;QACxC,MAAM,gBAAgB,GAAG,aAAa,CAAC,WAAW,CAAC,KAAK,CAAC;QAEzD,OAAO,IAAI,yBAAyB,CAAC;YACnC,OAAO,EAAE,CAAC,UAAU,EAAE,GAAG,YAAY,CAAC;YACtC,cAAc;YACd,gBAAgB;SACjB,CAAC,CAAC;IACL,CAAC;IAED,yBAAyB,CACvB,aAAoC,EACpC,QAA+B;QAE/B,MAAM,CAAC,aAAa,CAAC,OAAO,EAAE,oBAAoB,CAAC,CAAC;QACpD,MAAM,OAAO,GAAG,aAAa,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAC7D,OAAO,IAAI,yBAAyB,CAAC,OAAO,CAAC,CAAC;IAChD,CAAC;IAED,4BAA4B,CAC1B,aAAoC;QAEpC,MAAM,CAAC,MAAM,EAAE,GAAG,YAAY,CAAC,GAC7B,aAAa,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;QACtD,MAAM,CACJ,MAAM,EACN,2CAA2C,aAAa,CAAC,IAAI,EAAE,CAChE,CAAC;QAEF,OAAO,IAAI,4BAA4B,CAAC;YACtC,QAAQ,EAAE,aAAa,CAAC,QAAQ;YAChC,OAAO,EAAE,CAAC,MAAM,EAAE,GAAG,YAAY,CAAC;SACnC,CAAC,CAAC;IACL,CAAC;IAED,sCAAsC,CACpC,cAAqC;QAErC,6CAA6C;QAC7C,OAAO,IAAI,CAAC;IACd,CAAC;IAED,wBAAwB,CACtB,cAAqC,EACrC,QAAwB;QAExB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,SAAS;QACP,OAAO;YACL,eAAe,EAAE,MAAM,CAAC,GAAG,CAAC;YAC5B,eAAe,EAAE,qBAAqB;YACtC,aAAa,EAAE,MAAM,CAAC,GAAG,CAAC;YAC1B,OAAO,EAAE,MAAM,CAAC,GAAG,CAAC;YACpB,cAAc,EAAE,MAAM,CAAC,GAAG,CAAC;YAC3B,eAAe,EAAE,MAAM,CAAC,GAAG,CAAC;SAC7B,CAAC;IACJ,CAAC;CACF"}

package/dist/clients/provider.d.ts

@@ -0,0 +1,34 @@
+import { type EncodeObject } from '@cosmjs/proto-signing';
+import { type MsgSendEncodeObject } from '@cosmjs/stargate';
+import { type CometClient } from '@cosmjs/tendermint-rpc';
+import { type AltVM } from '@recoillink/provider-sdk';
+import type { ChainMetadataForAltVM } from '@recoillink/provider-sdk/chain';
+import { type WarpArtifactConfig } from '@recoillink/provider-sdk/warp';
+import { type MsgRemoteTransferEncodeObject } from '../hyperlane/warp/messages.js';
+export declare class CosmosNativeProvider implements AltVM.IProvider<EncodeObject> {
+    private readonly query;
+    private readonly registry;
+    private readonly cometClient;
+    private readonly rpcUrls;
+    protected readonly chainMetadata: ChainMetadataForAltVM;
+    private readonly stargateClients;
+    static connect(metadata: ChainMetadataForAltVM): Promise<CosmosNativeProvider>;
+    protected constructor(cometClient: CometClient, rpcUrls: [string, ...string[]], chainMetadata: ChainMetadataForAltVM);
+    getMinGasForWarpDeploy(warpConfig: WarpArtifactConfig): Promise<bigint>;
+    isHealthy(): Promise<boolean>;
+    getRpcUrls(): [string, ...string[]];
+    getHeight(): Promise<number>;
+    getBalance(req: AltVM.ReqGetBalance): Promise<bigint>;
+    getTotalSupply(req: AltVM.ReqGetTotalSupply): Promise<bigint>;
+    estimateTransactionFee(req: AltVM.ReqEstimateTransactionFee<EncodeObject>): Promise<AltVM.ResEstimateTransactionFee>;
+    private getStargateClient;
+    disconnect(): void;
+    isMessageDelivered(req: AltVM.ReqIsMessageDelivered): Promise<boolean>;
+    getToken(req: AltVM.ReqGetToken): Promise<AltVM.ResGetToken>;
+    getRemoteRouters(req: AltVM.ReqGetRemoteRouters): Promise<AltVM.ResGetRemoteRouters>;
+    getBridgedSupply(req: AltVM.ReqGetBridgedSupply): Promise<bigint>;
+    quoteRemoteTransfer(req: AltVM.ReqQuoteRemoteTransfer): Promise<AltVM.ResQuoteRemoteTransfer>;
+    getTransferTransaction(req: AltVM.ReqTransfer): Promise<MsgSendEncodeObject>;
+    getRemoteTransferTransaction(req: AltVM.ReqRemoteTransfer): Promise<MsgRemoteTransferEncodeObject>;
+}
+//# sourceMappingURL=provider.d.ts.map

package/dist/clients/provider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"provider.d.ts","sourceRoot":"","sources":["../../src/clients/provider.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,YAAY,EAAY,MAAM,uBAAuB,CAAC;AACpE,OAAO,EAEL,KAAK,mBAAmB,EAKzB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,KAAK,WAAW,EAAgB,MAAM,wBAAwB,CAAC;AAExE,OAAO,EAAE,KAAK,KAAK,EAAE,MAAM,0BAA0B,CAAC;AACtD,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,gCAAgC,CAAC;AAC5E,OAAO,EAGL,KAAK,kBAAkB,EACxB,MAAM,+BAA+B,CAAC;AAGvC,OAAO,EAAE,KAAK,6BAA6B,EAAE,MAAM,+BAA+B,CAAC;AAgCnF,qBAAa,oBAAqB,YAAW,KAAK,CAAC,SAAS,CAAC,YAAY,CAAC;IACxE,OAAO,CAAC,QAAQ,CAAC,KAAK,CAGN;IAChB,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAW;IACpC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAc;IAC1C,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAwB;IAChD,SAAS,CAAC,QAAQ,CAAC,aAAa,EAAE,qBAAqB,CAAC;IACxD,OAAO,CAAC,QAAQ,CAAC,eAAe,CAA8B;IAE9D,OAAa,OAAO,CAClB,QAAQ,EAAE,qBAAqB,GAC9B,OAAO,CAAC,oBAAoB,CAAC,CAW/B;IAED,SAAS,aACP,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,CAAC,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC,EAC9B,aAAa,EAAE,qBAAqB,EAmBrC;IAEK,sBAAsB,CAC1B,UAAU,EAAE,kBAAkB,GAC7B,OAAO,CAAC,MAAM,CAAC,CAajB;IAIK,SAAS,qBAGd;IAED,UAAU,IAAI,CAAC,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC,CAElC;IAEK,SAAS,oBAGd;IAEK,UAAU,CAAC,GAAG,EAAE,KAAK,CAAC,aAAa,GAAG,OAAO,CAAC,MAAM,CAAC,CAK1D;IAEK,cAAc,CAAC,GAAG,EAAE,KAAK,CAAC,iBAAiB,GAAG,OAAO,CAAC,MAAM,CAAC,CAKlE;IAEK,sBAAsB,CAC1B,GAAG,EAAE,KAAK,CAAC,yBAAyB,CAAC,YAAY,CAAC,GACjD,OAAO,CAAC,KAAK,CAAC,yBAAyB,CAAC,CAuD1C;IAED,OAAO,CAAC,iBAAiB;IAIzB,UAAU,IAAI,IAAI,CAGjB;IAEK,kBAAkB,CAAC,GAAG,EAAE,KAAK,CAAC,qBAAqB,GAAG,OAAO,CAAC,OAAO,CAAC,CAM3E;IAIK,QAAQ,CAAC,GAAG,EAAE,KAAK,CAAC,WAAW,GAAG,OAAO,CAAC,KAAK,CAAC,WAAW,CAAC,CAoBjE;IAEK,gBAAgB,CACpB,GAAG,EAAE,KAAK,CAAC,mBAAmB,GAC7B,OAAO,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAapC;IAEK,gBAAgB,CAAC,GAAG,EAAE,KAAK,CAAC,mBAAmB,GAAG,OAAO,CAAC,MAAM,CAAC,CAUtE;IAEK,mBAAmB,CACvB,GAAG,EAAE,KAAK,CAAC,sBAAsB,GAChC,OAAO,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAgBvC;IAEK,sBAAsB,CAC1B,GAAG,EAAE,KAAK,CAAC,WAAW,GACrB,OAAO,CAAC,mBAAmB,CAAC,CAgB9B;IAEK,4BAA4B,CAChC,GAAG,EAAE,KAAK,CAAC,iBAAiB,GAC3B,OAAO,CAAC,6BAA6B,CAAC,CAexC;CACF"}

package/dist/clients/provider.js

@@ -0,0 +1,220 @@
+import { encodeSecp256k1Pubkey } from '@cosmjs/amino';
+import { Uint53 } from '@cosmjs/math';
+import { Registry } from '@cosmjs/proto-signing';
+import { QueryClient, defaultRegistryTypes, setupBankExtension, } from '@cosmjs/stargate';
+import { connectComet } from '@cosmjs/tendermint-rpc';
+import { composeWarpDeployGas, nativeAmountFromGasUnits, } from '@recoillink/provider-sdk/warp';
+import { assert, strip0x } from '@recoillink/utils';
+import { setupCoreExtension, } from '../hyperlane/core/query.js';
+import { setupWarpExtension, } from '../hyperlane/warp/query.js';
+import { COSMOS_MODULE_MESSAGE_REGISTRY as R } from '../registry.js';
+import { getWarpTokenType } from '../warp/warp-query.js';
+import { StargateClientCache, disconnectStargateClient, shouldCacheStargateClient, } from './stargate.js';
+// Warp-deploy cost breakdown for Cosmos-native. Composed additively in
+// getMinGasForWarpDeploy() based on the WarpConfig shape. Unlike rent-metered
+// protocols, these are gas UNITS (ugas) that get multiplied by the chain's
+// gas price to yield a native-denom amount.
+//
+// TODO: fill from observed deploy — we don't have a measured breakdown for
+// feature-heavy warp deploys on Cosmos-native yet, so all extras currently
+// contribute nothing.
+const WARP_DEPLOY_BASE_UGAS = BigInt(3e6); // base router deploy
+const WARP_DEPLOY_CROSS_COLLATERAL_EXTRA_UGAS = 0n; // + crossCollateral router extras
+const WARP_DEPLOY_FEE_PROGRAM_UGAS = 0n; // + fee program (config.fee object)
+const WARP_DEPLOY_CUSTOM_ISM_UGAS = 0n; // + custom ISM (config.interchainSecurityModule object)
+const WARP_DEPLOY_CUSTOM_HOOK_UGAS = 0n; // + custom hook / IGP (config.hook object)
+export class CosmosNativeProvider {
+    query;
+    registry;
+    cometClient;
+    rpcUrls;
+    chainMetadata;
+    stargateClients = new StargateClientCache(1);
+    static async connect(metadata) {
+        const rpcUrls = (metadata.rpcUrls ?? []).map((rpc) => rpc.http);
+        const [rpcUrl, ...otherRpcUrls] = rpcUrls;
+        assert(rpcUrl, `${CosmosNativeProvider.name} got no rpcUrls`);
+        const client = await connectComet(rpcUrl);
+        return new CosmosNativeProvider(client, [rpcUrl, ...otherRpcUrls], metadata);
+    }
+    constructor(cometClient, rpcUrls, chainMetadata) {
+        this.query = QueryClient.withExtensions(cometClient, setupBankExtension, setupCoreExtension, setupWarpExtension);
+        this.registry = new Registry([...defaultRegistryTypes]);
+        // register all the custom tx types
+        Object.values(R).forEach(({ proto }) => {
+            this.registry.register(proto.type, proto.converter);
+        });
+        this.cometClient = cometClient;
+        this.rpcUrls = rpcUrls;
+        this.chainMetadata = chainMetadata;
+    }
+    async getMinGasForWarpDeploy(warpConfig) {
+        const units = composeWarpDeployGas(warpConfig, {
+            base: WARP_DEPLOY_BASE_UGAS,
+            crossCollateralExtra: WARP_DEPLOY_CROSS_COLLATERAL_EXTRA_UGAS,
+            feeProgram: WARP_DEPLOY_FEE_PROGRAM_UGAS,
+            customIsm: WARP_DEPLOY_CUSTOM_ISM_UGAS,
+            customHook: WARP_DEPLOY_CUSTOM_HOOK_UGAS,
+        });
+        assert(this.chainMetadata.gasPrice, `gasPrice not defined on chain ${this.chainMetadata.name}`);
+        return nativeAmountFromGasUnits(units, this.chainMetadata.gasPrice);
+    }
+    // ### QUERY BASE ###
+    async isHealthy() {
+        const status = await this.cometClient.status();
+        return status.syncInfo.latestBlockHeight > 0;
+    }
+    getRpcUrls() {
+        return this.rpcUrls;
+    }
+    async getHeight() {
+        const status = await this.cometClient.status();
+        return status.syncInfo.latestBlockHeight;
+    }
+    async getBalance(req) {
+        assert(req.denom, `denom required by ${CosmosNativeProvider.name}`);
+        const coin = await this.query.bank.balance(req.address, req.denom);
+        return BigInt(coin.amount);
+    }
+    async getTotalSupply(req) {
+        assert(req.denom, `denom required by ${CosmosNativeProvider.name}`);
+        const coin = await this.query.bank.supplyOf(req.denom);
+        return BigInt(coin.amount);
+    }
+    async estimateTransactionFee(req) {
+        assert(req.estimatedGasPrice, `Cosmos Native requires a estimatedGasPrice to estimate the transaction fee`);
+        assert(req.senderAddress, `Cosmos Native requires a senderAddress to estimate the transaction fee`);
+        assert(req.senderPubKey, `Cosmos Native requires a sender public key to estimate the transaction fee`);
+        const stargateClientPromise = this.getStargateClient();
+        let stargateClient;
+        try {
+            stargateClient = await stargateClientPromise;
+            const message = this.registry.encodeAsAny(req.transaction);
+            const pubKey = encodeSecp256k1Pubkey(new Uint8Array(Buffer.from(strip0x(req.senderPubKey), 'hex')));
+            const queryClient = stargateClient
+                // @ts-ignore force access to protected method
+                .forceGetQueryClient();
+            const { sequence } = await stargateClient.getSequence(req.senderAddress);
+            const { gasInfo } = await queryClient.tx.simulate([message], undefined, pubKey, sequence);
+            const gasUnits = Uint53.fromString(gasInfo?.gasUsed.toString() ?? '0').toNumber();
+            const gasPrice = parseFloat(req.estimatedGasPrice.toString());
+            return {
+                gasUnits: BigInt(gasUnits),
+                gasPrice,
+                fee: BigInt(Math.floor(gasUnits * gasPrice)),
+            };
+        }
+        catch (error) {
+            this.stargateClients.evict(this.rpcUrls[0], stargateClientPromise);
+            throw error;
+        }
+        finally {
+            if (shouldCacheStargateClient(this.rpcUrls[0])) {
+                this.stargateClients.release(stargateClientPromise);
+            }
+            else if (stargateClient) {
+                disconnectStargateClient(Promise.resolve(stargateClient));
+            }
+        }
+    }
+    getStargateClient() {
+        return this.stargateClients.get(this.rpcUrls[0]);
+    }
+    disconnect() {
+        this.cometClient.disconnect();
+        this.stargateClients.clear();
+    }
+    async isMessageDelivered(req) {
+        const { delivered } = await this.query.core.Delivered({
+            id: req.mailboxAddress,
+            message_id: req.messageId,
+        });
+        return delivered;
+    }
+    // ### QUERY WARP ###
+    async getToken(req) {
+        const { token } = await this.query.warp.Token({
+            id: req.tokenAddress,
+        });
+        assert(token, `found no token for id ${req.tokenAddress}`);
+        const token_type = await getWarpTokenType(this.query, req.tokenAddress);
+        return {
+            address: token.id,
+            owner: token.owner,
+            tokenType: token_type,
+            mailboxAddress: token.origin_mailbox,
+            ismAddress: token.ism_id,
+            hookAddress: '',
+            denom: token.origin_denom,
+            name: '',
+            symbol: '',
+            decimals: 0,
+        };
+    }
+    async getRemoteRouters(req) {
+        const { remote_routers } = await this.query.warp.RemoteRouters({
+            id: req.tokenAddress,
+        });
+        return {
+            address: req.tokenAddress,
+            remoteRouters: remote_routers.map((r) => ({
+                receiverDomainId: r.receiver_domain,
+                receiverAddress: r.receiver_contract,
+                gas: r.gas,
+            })),
+        };
+    }
+    async getBridgedSupply(req) {
+        const { bridged_supply } = await this.query.warp.BridgedSupply({
+            id: req.tokenAddress,
+        });
+        assert(bridged_supply, `found no bridged supply for token id ${req.tokenAddress}`);
+        return BigInt(bridged_supply.amount);
+    }
+    async quoteRemoteTransfer(req) {
+        const { gas_payment } = await this.query.warp.QuoteRemoteTransfer({
+            id: req.tokenAddress,
+            destination_domain: req.destinationDomainId.toString(),
+            custom_hook_id: req.customHookAddress || '',
+            custom_hook_metadata: req.customHookMetadata || '',
+        });
+        assert(gas_payment && gas_payment[0], `found no quote for token id ${req.tokenAddress} and destination domain ${req.destinationDomainId}`);
+        return {
+            denom: gas_payment[0].denom,
+            amount: BigInt(gas_payment[0].amount),
+        };
+    }
+    async getTransferTransaction(req) {
+        assert(req.denom, `denom required by ${CosmosNativeProvider.name}`);
+        return {
+            typeUrl: '/cosmos.bank.v1beta1.MsgSend',
+            value: {
+                fromAddress: req.signer,
+                toAddress: req.recipient,
+                amount: [
+                    {
+                        denom: req.denom,
+                        amount: req.amount,
+                    },
+                ],
+            },
+        };
+    }
+    async getRemoteTransferTransaction(req) {
+        return {
+            typeUrl: R.MsgRemoteTransfer.proto.type,
+            value: R.MsgRemoteTransfer.proto.converter.create({
+                sender: req.signer,
+                token_id: req.tokenAddress,
+                destination_domain: req.destinationDomainId,
+                recipient: req.recipient,
+                amount: req.amount,
+                custom_hook_id: req.customHookAddress,
+                gas_limit: req.gasLimit,
+                max_fee: req.maxFee,
+                custom_hook_metadata: req.customHookMetadata,
+            }),
+        };
+    }
+}
+//# sourceMappingURL=provider.js.map