Socket
Socket
Sign inDemoInstall

@wormhole-foundation/sdk-definitions

Package Overview
Dependencies
Maintainers
2
Versions
239
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@wormhole-foundation/sdk-definitions - npm Package Compare versions

Comparing version 0.11.0 to 0.11.1-beta.0

18

dist/cjs/protocols/portico/portico.d.ts

@@ -26,3 +26,2 @@ import type { Chain, LayoutToType, Network } from "@wormhole-foundation/sdk-base";

minAmountFinish: bigint;
amountFinish: bigint;
}

@@ -52,12 +51,23 @@ export type Quote = {

export interface PorticoBridge<N extends Network = Network, C extends Chain = Chain> {
isTransferCompleted(vaa: PorticoBridge.VAA): Promise<boolean>;
/** Initiate a transfer of some token to another chain */
transfer(sender: AccountAddress<C>, recipient: ChainAddress, token: TokenAddress<C>, amount: bigint, destToken: TokenId, quote: PorticoBridge.Quote): AsyncGenerator<UnsignedTransaction<N, C>>;
transfer(sender: AccountAddress<C>, recipient: ChainAddress, token: TokenAddress<C>, amount: bigint, destToken: TokenId, destPorticoAddress: string, quote: PorticoBridge.Quote): AsyncGenerator<UnsignedTransaction<N, C>>;
/** Redeem a transfer VAA to receive the tokens on this chain */
redeem(sender: AccountAddress<C>, vaa: PorticoBridge.VAA): AsyncGenerator<UnsignedTransaction<N, C>>;
/** quote token conversion */
quoteSwap(input: TokenAddress<C>, output: TokenAddress<C>, amount: bigint): Promise<bigint>;
quoteSwap(input: TokenAddress<C>, output: TokenAddress<C>, tokenGroup: string, amount: bigint): Promise<bigint>;
/** quote relay on destination with conversion */
quoteRelay(token: TokenAddress<C>, destination: TokenAddress<C>): Promise<bigint>;
getTransferrableToken(address: string): TokenId;
/** Get the "highway" token for this token */
getTransferrableToken(address: string): Promise<TokenId>;
/** Tokens supported on this chain */
supportedTokens(): {
group: string;
token: TokenId;
}[];
/** Get the group that a token belongs to e.g. ETH, WETH, wstETH, USDT */
getTokenGroup(address: string): string;
/** Get the Portico contract address for the token group */
getPorticoAddress(group: string): string;
}
//# sourceMappingURL=portico.d.ts.map

@@ -190,34 +190,126 @@ import type { RegisterPayloadTypes } from "./../../vaa/index.js";

export declare const namedPayloads: readonly [readonly ["Transfer", readonly [{
readonly name: "recipientChain";
readonly name: "payloadId";
readonly binary: "uint";
readonly endianness: "little";
readonly size: 2;
readonly size: 1;
readonly custom: 3;
readonly omit: true;
}, {
readonly name: "bridgeNonce";
readonly binary: "uint";
readonly endianness: "little";
readonly size: 4;
readonly name: "token";
readonly binary: "bytes";
readonly layout: readonly [{
readonly binary: "uint";
readonly size: 32;
readonly name: "amount";
}, {
readonly binary: "bytes";
readonly size: 32;
readonly custom: {
to: (val: Uint8Array) => import("../../universalAddress.js").UniversalAddress;
from: (val: import("../../universalAddress.js").UniversalAddress) => Uint8Array;
};
readonly name: "address";
}, {
readonly custom: {
to: (val: number) => "Solana" | "Ethereum" | "Terra" | "Bsc" | "Polygon" | "Avalanche" | "Oasis" | "Algorand" | "Aurora" | "Fantom" | "Karura" | "Acala" | "Klaytn" | "Celo" | "Near" | "Moonbeam" | "Neon" | "Terra2" | "Injective" | "Osmosis" | "Sui" | "Aptos" | "Arbitrum" | "Optimism" | "Gnosis" | "Pythnet" | "Xpla" | "Btc" | "Base" | "Sei" | "Rootstock" | "Scroll" | "Mantle" | "Blast" | "Xlayer" | "Linea" | "Berachain" | "Seievm" | "Snaxchain" | "Unichain" | "Wormchain" | "Cosmoshub" | "Evmos" | "Kujira" | "Neutron" | "Celestia" | "Stargaze" | "Seda" | "Dymension" | "Provenance" | "Sepolia" | "ArbitrumSepolia" | "BaseSepolia" | "OptimismSepolia" | "Holesky" | "PolygonSepolia";
from: (val: "Solana" | "Ethereum" | "Terra" | "Bsc" | "Polygon" | "Avalanche" | "Oasis" | "Algorand" | "Aurora" | "Fantom" | "Karura" | "Acala" | "Klaytn" | "Celo" | "Near" | "Moonbeam" | "Neon" | "Terra2" | "Injective" | "Osmosis" | "Sui" | "Aptos" | "Arbitrum" | "Optimism" | "Gnosis" | "Pythnet" | "Xpla" | "Btc" | "Base" | "Sei" | "Rootstock" | "Scroll" | "Mantle" | "Blast" | "Xlayer" | "Linea" | "Berachain" | "Seievm" | "Snaxchain" | "Unichain" | "Wormchain" | "Cosmoshub" | "Evmos" | "Kujira" | "Neutron" | "Celestia" | "Stargaze" | "Seda" | "Dymension" | "Provenance" | "Sepolia" | "ArbitrumSepolia" | "BaseSepolia" | "OptimismSepolia" | "Holesky" | "PolygonSepolia") => number;
};
readonly binary: "uint";
readonly size: 2;
readonly name: "chain";
}];
}, {
readonly name: "feeTierStart";
readonly binary: "uint";
readonly endianness: "little";
readonly size: 3;
readonly name: "to";
readonly binary: "bytes";
readonly layout: readonly [{
readonly binary: "bytes";
readonly size: 32;
readonly custom: {
to: (val: Uint8Array) => import("../../universalAddress.js").UniversalAddress;
from: (val: import("../../universalAddress.js").UniversalAddress) => Uint8Array;
};
readonly name: "address";
}, {
readonly custom: {
to: (val: number) => "Solana" | "Ethereum" | "Terra" | "Bsc" | "Polygon" | "Avalanche" | "Oasis" | "Algorand" | "Aurora" | "Fantom" | "Karura" | "Acala" | "Klaytn" | "Celo" | "Near" | "Moonbeam" | "Neon" | "Terra2" | "Injective" | "Osmosis" | "Sui" | "Aptos" | "Arbitrum" | "Optimism" | "Gnosis" | "Pythnet" | "Xpla" | "Btc" | "Base" | "Sei" | "Rootstock" | "Scroll" | "Mantle" | "Blast" | "Xlayer" | "Linea" | "Berachain" | "Seievm" | "Snaxchain" | "Unichain" | "Wormchain" | "Cosmoshub" | "Evmos" | "Kujira" | "Neutron" | "Celestia" | "Stargaze" | "Seda" | "Dymension" | "Provenance" | "Sepolia" | "ArbitrumSepolia" | "BaseSepolia" | "OptimismSepolia" | "Holesky" | "PolygonSepolia";
from: (val: "Solana" | "Ethereum" | "Terra" | "Bsc" | "Polygon" | "Avalanche" | "Oasis" | "Algorand" | "Aurora" | "Fantom" | "Karura" | "Acala" | "Klaytn" | "Celo" | "Near" | "Moonbeam" | "Neon" | "Terra2" | "Injective" | "Osmosis" | "Sui" | "Aptos" | "Arbitrum" | "Optimism" | "Gnosis" | "Pythnet" | "Xpla" | "Btc" | "Base" | "Sei" | "Rootstock" | "Scroll" | "Mantle" | "Blast" | "Xlayer" | "Linea" | "Berachain" | "Seievm" | "Snaxchain" | "Unichain" | "Wormchain" | "Cosmoshub" | "Evmos" | "Kujira" | "Neutron" | "Celestia" | "Stargaze" | "Seda" | "Dymension" | "Provenance" | "Sepolia" | "ArbitrumSepolia" | "BaseSepolia" | "OptimismSepolia" | "Holesky" | "PolygonSepolia") => number;
};
readonly binary: "uint";
readonly size: 2;
readonly name: "chain";
}];
}, {
readonly name: "feeTierFinish";
readonly binary: "uint";
readonly endianness: "little";
readonly size: 3;
readonly binary: "bytes";
readonly size: 32;
readonly custom: {
to: (val: Uint8Array) => import("../../universalAddress.js").UniversalAddress;
from: (val: import("../../universalAddress.js").UniversalAddress) => Uint8Array;
};
readonly name: "from";
}, import("@wormhole-foundation/sdk-base").CustomizableBytesReturn<{
readonly name: "payload";
}, readonly [{
readonly name: "flagSet";
readonly binary: "bytes";
readonly layout: readonly [{
readonly name: "recipientChain";
readonly binary: "uint";
readonly endianness: "little";
readonly size: 2;
}, {
readonly name: "bridgeNonce";
readonly binary: "uint";
readonly endianness: "little";
readonly size: 4;
}, {
readonly name: "feeTierStart";
readonly binary: "uint";
readonly endianness: "little";
readonly size: 3;
}, {
readonly name: "feeTierFinish";
readonly binary: "uint";
readonly endianness: "little";
readonly size: 3;
}, {
readonly name: "padding";
readonly binary: "bytes";
readonly size: 19;
}, {
readonly binary: "uint";
readonly size: 1;
readonly custom: {
to: (encoded: number) => import("@wormhole-foundation/sdk-base").Bitset<readonly ["shouldWrapNative", "shouldUnwrapNative"]>;
from: (obj: import("@wormhole-foundation/sdk-base").Bitset<readonly ["shouldWrapNative", "shouldUnwrapNative"]>) => number;
};
readonly name: "flags";
}];
}, {
readonly name: "padding";
readonly binary: "bytes";
readonly size: 19;
readonly size: 32;
readonly custom: {
to: (val: Uint8Array) => import("../../universalAddress.js").UniversalAddress;
from: (val: import("../../universalAddress.js").UniversalAddress) => Uint8Array;
};
readonly name: "finalTokenAddress";
}, {
readonly binary: "uint";
readonly size: 1;
readonly binary: "bytes";
readonly size: 32;
readonly custom: {
to: (encoded: number) => import("@wormhole-foundation/sdk-base").Bitset<readonly ["shouldWrapNative", "shouldUnwrapNative"]>;
from: (obj: import("@wormhole-foundation/sdk-base").Bitset<readonly ["shouldWrapNative", "shouldUnwrapNative"]>) => number;
to: (val: Uint8Array) => import("../../universalAddress.js").UniversalAddress;
from: (val: import("../../universalAddress.js").UniversalAddress) => Uint8Array;
};
readonly name: "flags";
}]]];
readonly name: "recipientAddress";
}, {
readonly binary: "uint";
readonly size: 32;
readonly name: "cannonAssetAmount";
}, {
readonly binary: "uint";
readonly size: 32;
readonly name: "minAmountFinish";
}, {
readonly binary: "uint";
readonly size: 32;
readonly name: "relayerFee";
}]>]]];
import "../../registry.js";

@@ -224,0 +316,0 @@ declare module "../../registry.js" {

@@ -7,2 +7,3 @@ "use strict";

const index_js_2 = require("./../../vaa/index.js");
const tokenBridgeLayout_js_1 = require("../tokenBridge/tokenBridgeLayout.js");
//weirdly, if defined in place, the type is not inferred properly

@@ -38,3 +39,5 @@ const flagsItem = (0, sdk_base_1.bitsetItem)(["shouldWrapNative", "shouldUnwrapNative"]);

];
exports.namedPayloads = [["Transfer", exports.porticoFlagSetLayout]];
exports.namedPayloads = [
["Transfer", (0, tokenBridgeLayout_js_1.transferWithPayloadLayout)(exports.porticoPayloadLayout)],
];
// factory registration:

@@ -41,0 +44,0 @@ require("../../registry.js");

@@ -26,3 +26,2 @@ import type { Chain, LayoutToType, Network } from "@wormhole-foundation/sdk-base";

minAmountFinish: bigint;
amountFinish: bigint;
}

@@ -52,12 +51,23 @@ export type Quote = {

export interface PorticoBridge<N extends Network = Network, C extends Chain = Chain> {
isTransferCompleted(vaa: PorticoBridge.VAA): Promise<boolean>;
/** Initiate a transfer of some token to another chain */
transfer(sender: AccountAddress<C>, recipient: ChainAddress, token: TokenAddress<C>, amount: bigint, destToken: TokenId, quote: PorticoBridge.Quote): AsyncGenerator<UnsignedTransaction<N, C>>;
transfer(sender: AccountAddress<C>, recipient: ChainAddress, token: TokenAddress<C>, amount: bigint, destToken: TokenId, destPorticoAddress: string, quote: PorticoBridge.Quote): AsyncGenerator<UnsignedTransaction<N, C>>;
/** Redeem a transfer VAA to receive the tokens on this chain */
redeem(sender: AccountAddress<C>, vaa: PorticoBridge.VAA): AsyncGenerator<UnsignedTransaction<N, C>>;
/** quote token conversion */
quoteSwap(input: TokenAddress<C>, output: TokenAddress<C>, amount: bigint): Promise<bigint>;
quoteSwap(input: TokenAddress<C>, output: TokenAddress<C>, tokenGroup: string, amount: bigint): Promise<bigint>;
/** quote relay on destination with conversion */
quoteRelay(token: TokenAddress<C>, destination: TokenAddress<C>): Promise<bigint>;
getTransferrableToken(address: string): TokenId;
/** Get the "highway" token for this token */
getTransferrableToken(address: string): Promise<TokenId>;
/** Tokens supported on this chain */
supportedTokens(): {
group: string;
token: TokenId;
}[];
/** Get the group that a token belongs to e.g. ETH, WETH, wstETH, USDT */
getTokenGroup(address: string): string;
/** Get the Portico contract address for the token group */
getPorticoAddress(group: string): string;
}
//# sourceMappingURL=portico.d.ts.map

@@ -190,34 +190,126 @@ import type { RegisterPayloadTypes } from "./../../vaa/index.js";

export declare const namedPayloads: readonly [readonly ["Transfer", readonly [{
readonly name: "recipientChain";
readonly name: "payloadId";
readonly binary: "uint";
readonly endianness: "little";
readonly size: 2;
readonly size: 1;
readonly custom: 3;
readonly omit: true;
}, {
readonly name: "bridgeNonce";
readonly binary: "uint";
readonly endianness: "little";
readonly size: 4;
readonly name: "token";
readonly binary: "bytes";
readonly layout: readonly [{
readonly binary: "uint";
readonly size: 32;
readonly name: "amount";
}, {
readonly binary: "bytes";
readonly size: 32;
readonly custom: {
to: (val: Uint8Array) => import("../../universalAddress.js").UniversalAddress;
from: (val: import("../../universalAddress.js").UniversalAddress) => Uint8Array;
};
readonly name: "address";
}, {
readonly custom: {
to: (val: number) => "Solana" | "Ethereum" | "Terra" | "Bsc" | "Polygon" | "Avalanche" | "Oasis" | "Algorand" | "Aurora" | "Fantom" | "Karura" | "Acala" | "Klaytn" | "Celo" | "Near" | "Moonbeam" | "Neon" | "Terra2" | "Injective" | "Osmosis" | "Sui" | "Aptos" | "Arbitrum" | "Optimism" | "Gnosis" | "Pythnet" | "Xpla" | "Btc" | "Base" | "Sei" | "Rootstock" | "Scroll" | "Mantle" | "Blast" | "Xlayer" | "Linea" | "Berachain" | "Seievm" | "Snaxchain" | "Unichain" | "Wormchain" | "Cosmoshub" | "Evmos" | "Kujira" | "Neutron" | "Celestia" | "Stargaze" | "Seda" | "Dymension" | "Provenance" | "Sepolia" | "ArbitrumSepolia" | "BaseSepolia" | "OptimismSepolia" | "Holesky" | "PolygonSepolia";
from: (val: "Solana" | "Ethereum" | "Terra" | "Bsc" | "Polygon" | "Avalanche" | "Oasis" | "Algorand" | "Aurora" | "Fantom" | "Karura" | "Acala" | "Klaytn" | "Celo" | "Near" | "Moonbeam" | "Neon" | "Terra2" | "Injective" | "Osmosis" | "Sui" | "Aptos" | "Arbitrum" | "Optimism" | "Gnosis" | "Pythnet" | "Xpla" | "Btc" | "Base" | "Sei" | "Rootstock" | "Scroll" | "Mantle" | "Blast" | "Xlayer" | "Linea" | "Berachain" | "Seievm" | "Snaxchain" | "Unichain" | "Wormchain" | "Cosmoshub" | "Evmos" | "Kujira" | "Neutron" | "Celestia" | "Stargaze" | "Seda" | "Dymension" | "Provenance" | "Sepolia" | "ArbitrumSepolia" | "BaseSepolia" | "OptimismSepolia" | "Holesky" | "PolygonSepolia") => number;
};
readonly binary: "uint";
readonly size: 2;
readonly name: "chain";
}];
}, {
readonly name: "feeTierStart";
readonly binary: "uint";
readonly endianness: "little";
readonly size: 3;
readonly name: "to";
readonly binary: "bytes";
readonly layout: readonly [{
readonly binary: "bytes";
readonly size: 32;
readonly custom: {
to: (val: Uint8Array) => import("../../universalAddress.js").UniversalAddress;
from: (val: import("../../universalAddress.js").UniversalAddress) => Uint8Array;
};
readonly name: "address";
}, {
readonly custom: {
to: (val: number) => "Solana" | "Ethereum" | "Terra" | "Bsc" | "Polygon" | "Avalanche" | "Oasis" | "Algorand" | "Aurora" | "Fantom" | "Karura" | "Acala" | "Klaytn" | "Celo" | "Near" | "Moonbeam" | "Neon" | "Terra2" | "Injective" | "Osmosis" | "Sui" | "Aptos" | "Arbitrum" | "Optimism" | "Gnosis" | "Pythnet" | "Xpla" | "Btc" | "Base" | "Sei" | "Rootstock" | "Scroll" | "Mantle" | "Blast" | "Xlayer" | "Linea" | "Berachain" | "Seievm" | "Snaxchain" | "Unichain" | "Wormchain" | "Cosmoshub" | "Evmos" | "Kujira" | "Neutron" | "Celestia" | "Stargaze" | "Seda" | "Dymension" | "Provenance" | "Sepolia" | "ArbitrumSepolia" | "BaseSepolia" | "OptimismSepolia" | "Holesky" | "PolygonSepolia";
from: (val: "Solana" | "Ethereum" | "Terra" | "Bsc" | "Polygon" | "Avalanche" | "Oasis" | "Algorand" | "Aurora" | "Fantom" | "Karura" | "Acala" | "Klaytn" | "Celo" | "Near" | "Moonbeam" | "Neon" | "Terra2" | "Injective" | "Osmosis" | "Sui" | "Aptos" | "Arbitrum" | "Optimism" | "Gnosis" | "Pythnet" | "Xpla" | "Btc" | "Base" | "Sei" | "Rootstock" | "Scroll" | "Mantle" | "Blast" | "Xlayer" | "Linea" | "Berachain" | "Seievm" | "Snaxchain" | "Unichain" | "Wormchain" | "Cosmoshub" | "Evmos" | "Kujira" | "Neutron" | "Celestia" | "Stargaze" | "Seda" | "Dymension" | "Provenance" | "Sepolia" | "ArbitrumSepolia" | "BaseSepolia" | "OptimismSepolia" | "Holesky" | "PolygonSepolia") => number;
};
readonly binary: "uint";
readonly size: 2;
readonly name: "chain";
}];
}, {
readonly name: "feeTierFinish";
readonly binary: "uint";
readonly endianness: "little";
readonly size: 3;
readonly binary: "bytes";
readonly size: 32;
readonly custom: {
to: (val: Uint8Array) => import("../../universalAddress.js").UniversalAddress;
from: (val: import("../../universalAddress.js").UniversalAddress) => Uint8Array;
};
readonly name: "from";
}, import("@wormhole-foundation/sdk-base").CustomizableBytesReturn<{
readonly name: "payload";
}, readonly [{
readonly name: "flagSet";
readonly binary: "bytes";
readonly layout: readonly [{
readonly name: "recipientChain";
readonly binary: "uint";
readonly endianness: "little";
readonly size: 2;
}, {
readonly name: "bridgeNonce";
readonly binary: "uint";
readonly endianness: "little";
readonly size: 4;
}, {
readonly name: "feeTierStart";
readonly binary: "uint";
readonly endianness: "little";
readonly size: 3;
}, {
readonly name: "feeTierFinish";
readonly binary: "uint";
readonly endianness: "little";
readonly size: 3;
}, {
readonly name: "padding";
readonly binary: "bytes";
readonly size: 19;
}, {
readonly binary: "uint";
readonly size: 1;
readonly custom: {
to: (encoded: number) => import("@wormhole-foundation/sdk-base").Bitset<readonly ["shouldWrapNative", "shouldUnwrapNative"]>;
from: (obj: import("@wormhole-foundation/sdk-base").Bitset<readonly ["shouldWrapNative", "shouldUnwrapNative"]>) => number;
};
readonly name: "flags";
}];
}, {
readonly name: "padding";
readonly binary: "bytes";
readonly size: 19;
readonly size: 32;
readonly custom: {
to: (val: Uint8Array) => import("../../universalAddress.js").UniversalAddress;
from: (val: import("../../universalAddress.js").UniversalAddress) => Uint8Array;
};
readonly name: "finalTokenAddress";
}, {
readonly binary: "uint";
readonly size: 1;
readonly binary: "bytes";
readonly size: 32;
readonly custom: {
to: (encoded: number) => import("@wormhole-foundation/sdk-base").Bitset<readonly ["shouldWrapNative", "shouldUnwrapNative"]>;
from: (obj: import("@wormhole-foundation/sdk-base").Bitset<readonly ["shouldWrapNative", "shouldUnwrapNative"]>) => number;
to: (val: Uint8Array) => import("../../universalAddress.js").UniversalAddress;
from: (val: import("../../universalAddress.js").UniversalAddress) => Uint8Array;
};
readonly name: "flags";
}]]];
readonly name: "recipientAddress";
}, {
readonly binary: "uint";
readonly size: 32;
readonly name: "cannonAssetAmount";
}, {
readonly binary: "uint";
readonly size: 32;
readonly name: "minAmountFinish";
}, {
readonly binary: "uint";
readonly size: 32;
readonly name: "relayerFee";
}]>]]];
import "../../registry.js";

@@ -224,0 +316,0 @@ declare module "../../registry.js" {

import { bitsetItem } from "@wormhole-foundation/sdk-base";
import { amountItem, universalAddressItem } from "./../../layout-items/index.js";
import { registerPayloadTypes } from "./../../vaa/index.js";
import { transferWithPayloadLayout } from "../tokenBridge/tokenBridgeLayout.js";
//weirdly, if defined in place, the type is not inferred properly

@@ -34,3 +35,5 @@ const flagsItem = bitsetItem(["shouldWrapNative", "shouldUnwrapNative"]);

];
export const namedPayloads = [["Transfer", porticoFlagSetLayout]];
export const namedPayloads = [
["Transfer", transferWithPayloadLayout(porticoPayloadLayout)],
];
// factory registration:

@@ -37,0 +40,0 @@ import "../../registry.js";

{
"name": "@wormhole-foundation/sdk-definitions",
"version": "0.11.0",
"version": "0.11.1-beta.0",
"repository": {

@@ -89,5 +89,5 @@ "type": "git",

"@noble/curves": "^1.4.0",
"@wormhole-foundation/sdk-base": "0.11.0"
"@wormhole-foundation/sdk-base": "0.11.1-beta.0"
},
"type": "module"
}

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc