@hyperbridge/sdk 1.5.0-rc0000000001 → 1.5.0-rc0000000002

package/dist/browser/index.d.ts

@@ -3479,11 +3479,12 @@ type Params = {
  * @param params.recipient - Recipient address
  * @param params.amount - Amount to teleport
  * @param params.timeout - Operation timeout
+ * @param params.extrinsics - An array of SubmittableExtrinsic to prepend to the teleport transaction
  * @param params.tokenGatewayAddress - Gateway contract address
+ * @param options - Signer options
  * @param params.relayerFee - Fee for the relayer
  * @param params.redeem - Whether to redeem on arrival
  * @param params.callData - Optional additional call data
- * @param options - Signer options
  * @yields {HyperbridgeTxEvents} Stream of events indicating transaction status
  * @throws Error when asset ID is unknown or transaction fails
  */
@@ -3492,45 +3493,8 @@ declare function teleport(teleport_param: {
     params: Params;
     apiPromise: ApiPromise;
     options: Partial<SignerOptions>;
+    extrinsics: Array<SubmittableExtrinsic<"promise", ISubmittableResult>>;
 }): Promise<ReadableStream<HyperbridgeTxEvents>>;
-/**
- * Teleports assets from Substrate to other chains via the token gateway
- *
- * Note: There is no guarantee that both Dispatched and Finalized events will be yielded.
- * Consumers should listen for either one of these events instead of expecting both.
- *
- *
- * @param apiPromise - Polkadot API instance
- * @param params - Teleport parameters
- * @param params.symbol - Asset symbol
- * @param params.destination - Target state machine ID
- * @param params.recipient - Recipient address
- * @param params.amount - Amount to teleport
- * @param params.timeout - Operation timeout
- * @param params.tokenGatewayAddress - Gateway contract address
- * @param params.relayerFee - Fee for the relayer
- * @param params.redeem - Whether to redeem on arrival
- * @param params.callData - Optional additional call data
- * @yields {HyperbridgeTxEvents} Stream of events indicating transaction status
- * @throws Error when asset ID is unknown or transaction fails
- */
-declare function makeTeleportExtrinsics(teleport_param: {
-    params: Params;
-    apiPromise: ApiPromise;
-}): Promise<SubmittableExtrinsic<"promise", ISubmittableResult>>;
-/**
- *
- * @param extrinsic - SubmittableExtrinsic
- * @param who - SS58Address
- * @param options - Signer options
- * @returns
- */
-declare function submitExtrinsics({ extrinsics: tx, who, options, apiPromise, }: {
-    extrinsics: SubmittableExtrinsic<"promise", any>;
-    apiPromise: ApiPromise;
-    who: string;
-    options: Partial<SignerOptions>;
-}): ReadableStream<HyperbridgeTxEvents>;
 
 declare enum Chains {
     BSC_CHAPEL = "EVM-97",
@@ -3669,4 +3633,4 @@ declare const popularTokens: {
     "EVM-130": string[];
 };
 
-export { ADDRESS_ZERO, type AllStatusKey, type AssetTeleported, type AssetTeleportedResponse, type BlockMetadata, type CancelOptions, type ChainConfig, ChainConfigService, type ChainId, Chains, type ClientConfig, DEFAULT_ADDRESS, DEFAULT_GRAFFITI, DUMMY_PRIVATE_KEY, type DecodedOrderPlacedLog, type DecodedPostRequestEvent, type DecodedPostResponseEvent, type DispatchGet, type DispatchPost, ERC20Method, type EstimateGasCallData, EvmChain, type EvmChainParams, type ExecutionResult, type FillOptions, type FillerConfig, type GetRequestResponse, type GetRequestWithStatus, type GetResponseByRequestIdResponse, type GetResponseStorageValues, type HexString, type HostParams, HyperClientStatus, type HyperbridgeTxEvents, type IChain, type IConfig, type IEvmConfig, type IGetRequest, type IGetRequestMessage, type IGetResponse, type IGetResponseMessage, type IHyperbridgeConfig, type IIsmpMessage, type IMessage, type IPostRequest, type IPostResponse, type IProof, type IRequestMessage, type ISubstrateConfig, type ITimeoutPostRequestMessage, IndexerClient, type IndexerQueryClient, IntentGateway, type IntentGatewayParams, type IsmpRequest, type NewDeployment, type Order, type OrderResponse, OrderStatus, type OrderStatusMetadata, type OrderWithStatus, type Params, type PaymentInfo, type PostRequestStatus, type PostRequestTimeoutStatus, type PostRequestWithStatus, type QuoteNativeResult, REQUEST_COMMITMENTS_SLOT, REQUEST_RECEIPTS_SLOT, RESPONSE_COMMITMENTS_SLOT, RESPONSE_RECEIPTS_SLOT, type RequestBody, type RequestCommitment, RequestKind, type RequestResponse, RequestStatus, type RequestStatusKey, type RequestStatusWithMetadata, type ResponseCommitmentWithValues, type RetryConfig, STATE_COMMITMENTS_SLOT, type StateMachineHeight, type StateMachineIdParams, type StateMachineResponse, type StateMachineUpdate, type StorageFacade, SubstrateChain, TESTNET_CHAINS, type TeleportParams, TeleportStatus, TimeoutStatus, type TimeoutStatusKey, TokenGateway, type TokenGatewayAssetTeleportedResponse, type TokenGatewayAssetTeleportedWithStatus, type TokenInfo, type TokenPrice, type TokenPricesResponse, type TokenRegistry, type TokenRegistryResponse, type Transaction, USE_ETHERSCAN_CHAINS, WrappedNativeDecimals, type XcmGatewayParams, __test, addresses, adjustFeeDecimals, assets, bytes20ToBytes32, bytes32ToBytes20, chainIds, coingeckoIds, consensusStateIds, constructRedeemEscrowRequestBody, convertCodecToIGetRequest, convertCodecToIProof, convertIGetRequestToCodec, convertIProofToCodec, convertStateIdToStateMachineId, convertStateMachineEnumToString, convertStateMachineIdToEnum, createChain, createEvmChain, createIndexerClient, createQueryClient, createRpcUrls, encodeISMPMessage, estimateGasForPost, fetchPrice, generateRootWithProof, getChain, getGasPriceFromEtherscan, getOrderPlacedFromTx, getPostRequestEventFromTx, getPostResponseEventFromTx, getRequestCommitment, getStateCommitmentFieldSlot, getStateCommitmentSlot, getStorageSlot, hexToString, makeTeleportExtrinsics, maxBigInt, orderCommitment, popularTokens, postRequestCommitment, queryAssetTeleported, queryGetRequest, queryPostRequest, requestCommitmentKey, retryPromise, submitExtrinsics, teleport, teleportDot, viemChains };
+export { ADDRESS_ZERO, type AllStatusKey, type AssetTeleported, type AssetTeleportedResponse, type BlockMetadata, type CancelOptions, type ChainConfig, ChainConfigService, type ChainId, Chains, type ClientConfig, DEFAULT_ADDRESS, DEFAULT_GRAFFITI, DUMMY_PRIVATE_KEY, type DecodedOrderPlacedLog, type DecodedPostRequestEvent, type DecodedPostResponseEvent, type DispatchGet, type DispatchPost, ERC20Method, type EstimateGasCallData, EvmChain, type EvmChainParams, type ExecutionResult, type FillOptions, type FillerConfig, type GetRequestResponse, type GetRequestWithStatus, type GetResponseByRequestIdResponse, type GetResponseStorageValues, type HexString, type HostParams, HyperClientStatus, type HyperbridgeTxEvents, type IChain, type IConfig, type IEvmConfig, type IGetRequest, type IGetRequestMessage, type IGetResponse, type IGetResponseMessage, type IHyperbridgeConfig, type IIsmpMessage, type IMessage, type IPostRequest, type IPostResponse, type IProof, type IRequestMessage, type ISubstrateConfig, type ITimeoutPostRequestMessage, IndexerClient, type IndexerQueryClient, IntentGateway, type IntentGatewayParams, type IsmpRequest, type NewDeployment, type Order, type OrderResponse, OrderStatus, type OrderStatusMetadata, type OrderWithStatus, type Params, type PaymentInfo, type PostRequestStatus, type PostRequestTimeoutStatus, type PostRequestWithStatus, type QuoteNativeResult, REQUEST_COMMITMENTS_SLOT, REQUEST_RECEIPTS_SLOT, RESPONSE_COMMITMENTS_SLOT, RESPONSE_RECEIPTS_SLOT, type RequestBody, type RequestCommitment, RequestKind, type RequestResponse, RequestStatus, type RequestStatusKey, type RequestStatusWithMetadata, type ResponseCommitmentWithValues, type RetryConfig, STATE_COMMITMENTS_SLOT, type StateMachineHeight, type StateMachineIdParams, type StateMachineResponse, type StateMachineUpdate, type StorageFacade, SubstrateChain, TESTNET_CHAINS, type TeleportParams, TeleportStatus, TimeoutStatus, type TimeoutStatusKey, TokenGateway, type TokenGatewayAssetTeleportedResponse, type TokenGatewayAssetTeleportedWithStatus, type TokenInfo, type TokenPrice, type TokenPricesResponse, type TokenRegistry, type TokenRegistryResponse, type Transaction, USE_ETHERSCAN_CHAINS, WrappedNativeDecimals, type XcmGatewayParams, __test, addresses, adjustFeeDecimals, assets, bytes20ToBytes32, bytes32ToBytes20, chainIds, coingeckoIds, consensusStateIds, constructRedeemEscrowRequestBody, convertCodecToIGetRequest, convertCodecToIProof, convertIGetRequestToCodec, convertIProofToCodec, convertStateIdToStateMachineId, convertStateMachineEnumToString, convertStateMachineIdToEnum, createChain, createEvmChain, createIndexerClient, createQueryClient, createRpcUrls, encodeISMPMessage, estimateGasForPost, fetchPrice, generateRootWithProof, getChain, getGasPriceFromEtherscan, getOrderPlacedFromTx, getPostRequestEventFromTx, getPostResponseEventFromTx, getRequestCommitment, getStateCommitmentFieldSlot, getStateCommitmentSlot, getStorageSlot, hexToString, maxBigInt, orderCommitment, popularTokens, postRequestCommitment, queryAssetTeleported, queryGetRequest, queryPostRequest, requestCommitmentKey, retryPromise, teleport, teleportDot, viemChains };

package/dist/browser/index.js

@@ -13366,7 +13366,7 @@ async function getPostResponseEventFromTx(client, txHash) {
 var TeleportParams = Struct({
   /// StateMachine
   destination: StateMachine,
-  /// Receipient
+  /// Recipient
   recepient: H256,
   /// Amount
   amount: u128,
@@ -13397,7 +13397,7 @@ async function fetchLocalAssetId(params) {
   return null;
 }
 async function teleport(teleport_param) {
-  const { who, options, params, apiPromise } = teleport_param;
+  const { params, apiPromise, extrinsics = [] } = teleport_param;
   const substrateComplianceAddr = (address, stateMachine) => {
     if (stateMachine.startsWith("EVM-")) return pad(address, { size: 32, dir: "left" });
     return address;
@@ -13421,14 +13421,15 @@ async function teleport(teleport_param) {
   };
   const encoded = TeleportParams.enc(teleportParams);
   const fullCallData = new Uint8Array([...scaleEncodedAssetId, ...encoded]);
-  const tx = apiPromise.tx.tokenGateway.teleport(fullCallData);
+  const token_gateway_extrinsics = apiPromise.tx.tokenGateway.teleport(fullCallData);
+  const tx = extrinsics.length === 0 ? token_gateway_extrinsics : apiPromise.tx.utility.batchAll([...extrinsics, token_gateway_extrinsics]);
   let unsub = () => {
   };
   let closed = false;
   const stream = new ReadableStream(
     {
       async start(controller) {
-        unsub = await tx.signAndSend(who, options, async (result) => {
+        unsub = await tx.signAndSend(teleport_param.who, teleport_param.options, async (result) => {
           try {
             const { isInBlock, isError, dispatchError, txHash, isFinalized, status } = result;
             const events = result.events;
@@ -13500,107 +13501,6 @@ function readIsmpCommitmentHash(events) {
     }
   }
 }
-async function makeTeleportExtrinsics(teleport_param) {
-  const { params, apiPromise } = teleport_param;
-  const substrateComplianceAddr = (address, stateMachine) => {
-    if (stateMachine.startsWith("EVM-")) return pad(address, { size: 32, dir: "left" });
-    return address;
-  };
-  const assetId = keccakAsU8a(params.symbol);
-  const scaleEncodedAssetId = await fetchLocalAssetId({ api: apiPromise, assetId });
-  if (scaleEncodedAssetId === null) {
-    throw new Error("Unknown asset id provided");
-  }
-  const destination = convertStateMachineIdToEnum(params.destination);
-  const recipient = hexToBytes(substrateComplianceAddr(params.recipient, params.destination));
-  const teleportParams = {
-    destination,
-    recepient: Array.from(recipient),
-    amount: params.amount,
-    timeout: BigInt(params.timeout),
-    tokenGatewayAddress: Array.from(params.tokenGatewayAddress),
-    relayerFee: BigInt(params.relayerFee),
-    redeem: params.redeem,
-    callData: params.callData ? Array.from(params.callData) : void 0
-  };
-  const encoded = TeleportParams.enc(teleportParams);
-  const fullCallData = new Uint8Array([...scaleEncodedAssetId, ...encoded]);
-  return apiPromise.tx.tokenGateway.teleport(fullCallData);
-}
-function submitExtrinsics({
-  extrinsics: tx,
-  who,
-  options,
-  apiPromise
-}) {
-  let unsub = () => {
-  };
-  let closed = false;
-  const stream = new ReadableStream(
-    {
-      async start(controller) {
-        unsub = await tx.signAndSend(who, options, async (result) => {
-          try {
-            const { isInBlock, isError, dispatchError, txHash, isFinalized, status } = result;
-            const events = result.events;
-            if (isError) {
-              console.error("Transaction failed: ", dispatchError);
-              controller.enqueue({ kind: "Error", error: dispatchError });
-              unsub?.();
-              controller.close();
-              closed = true;
-              return;
-            }
-            if (status.type === "Ready") {
-              controller.enqueue({
-                kind: "Ready",
-                transaction_hash: txHash.toHex()
-              });
-            }
-            if (isInBlock || isFinalized) {
-              const commitment_hash = readIsmpCommitmentHash(events);
-              const blockHash = isInBlock ? status.asInBlock.toHex() : status.asFinalized.toHex();
-              if (!commitment_hash) {
-                controller.enqueue({
-                  kind: "Error",
-                  error: new Error("Commitment Hash missing")
-                });
-                return controller.close();
-              }
-              const header = await apiPromise.rpc.chain.getHeader(blockHash);
-              controller.enqueue({
-                kind: isInBlock ? "Dispatched" : "Finalized",
-                transaction_hash: txHash.toHex(),
-                block_number: header.number.toBigInt(),
-                commitment: commitment_hash
-              });
-              if (isFinalized) {
-                unsub?.();
-                controller.close();
-                closed = true;
-                return;
-              }
-            }
-          } catch (err) {
-            if (closed) {
-              return;
-            }
-            controller.enqueue({
-              kind: "Error",
-              error: String(err)
-            });
-          }
-        });
-      },
-      cancel: () => unsub?.()
-    },
-    {
-      highWaterMark: 3,
-      size: () => 1
-    }
-  );
-  return stream;
-}
 var MultiAccount = Struct({
   substrate_account: Bytes(32),
   evm_account: Bytes(20),
@@ -13761,6 +13661,6 @@ async function teleportDot(param_) {
   return stream;
 }
 
-export { ADDRESS_ZERO, ChainConfigService, Chains, DEFAULT_ADDRESS, DEFAULT_GRAFFITI, DUMMY_PRIVATE_KEY, ERC20Method, EvmChain, HyperClientStatus, IndexerClient, IntentGateway, OrderStatus, REQUEST_COMMITMENTS_SLOT, REQUEST_RECEIPTS_SLOT, RESPONSE_COMMITMENTS_SLOT, RESPONSE_RECEIPTS_SLOT, RequestKind, RequestStatus, STATE_COMMITMENTS_SLOT, SubstrateChain, TESTNET_CHAINS, TeleportStatus, TimeoutStatus, TokenGateway, USE_ETHERSCAN_CHAINS, WrappedNativeDecimals, __test, addresses, adjustFeeDecimals, assets, bytes20ToBytes32, bytes32ToBytes20, chainIds, coingeckoIds, consensusStateIds, constructRedeemEscrowRequestBody, convertCodecToIGetRequest, convertCodecToIProof, convertIGetRequestToCodec, convertIProofToCodec, convertStateIdToStateMachineId, convertStateMachineEnumToString, convertStateMachineIdToEnum, createChain, createEvmChain, createIndexerClient, createQueryClient, createRpcUrls, encodeISMPMessage, estimateGasForPost, fetchPrice, generateRootWithProof, getChain, getGasPriceFromEtherscan, getOrderPlacedFromTx, getPostRequestEventFromTx, getPostResponseEventFromTx, getRequestCommitment, getStateCommitmentFieldSlot, getStateCommitmentSlot, getStorageSlot, hexToString, makeTeleportExtrinsics, maxBigInt, orderCommitment, popularTokens, postRequestCommitment, queryAssetTeleported, queryGetRequest, queryPostRequest, requestCommitmentKey, retryPromise, submitExtrinsics, teleport, teleportDot, viemChains };
+export { ADDRESS_ZERO, ChainConfigService, Chains, DEFAULT_ADDRESS, DEFAULT_GRAFFITI, DUMMY_PRIVATE_KEY, ERC20Method, EvmChain, HyperClientStatus, IndexerClient, IntentGateway, OrderStatus, REQUEST_COMMITMENTS_SLOT, REQUEST_RECEIPTS_SLOT, RESPONSE_COMMITMENTS_SLOT, RESPONSE_RECEIPTS_SLOT, RequestKind, RequestStatus, STATE_COMMITMENTS_SLOT, SubstrateChain, TESTNET_CHAINS, TeleportStatus, TimeoutStatus, TokenGateway, USE_ETHERSCAN_CHAINS, WrappedNativeDecimals, __test, addresses, adjustFeeDecimals, assets, bytes20ToBytes32, bytes32ToBytes20, chainIds, coingeckoIds, consensusStateIds, constructRedeemEscrowRequestBody, convertCodecToIGetRequest, convertCodecToIProof, convertIGetRequestToCodec, convertIProofToCodec, convertStateIdToStateMachineId, convertStateMachineEnumToString, convertStateMachineIdToEnum, createChain, createEvmChain, createIndexerClient, createQueryClient, createRpcUrls, encodeISMPMessage, estimateGasForPost, fetchPrice, generateRootWithProof, getChain, getGasPriceFromEtherscan, getOrderPlacedFromTx, getPostRequestEventFromTx, getPostResponseEventFromTx, getRequestCommitment, getStateCommitmentFieldSlot, getStateCommitmentSlot, getStorageSlot, hexToString, maxBigInt, orderCommitment, popularTokens, postRequestCommitment, queryAssetTeleported, queryGetRequest, queryPostRequest, requestCommitmentKey, retryPromise, teleport, teleportDot, viemChains };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map