From 06505abb3790acb9044bd437162152339544de32 Mon Sep 17 00:00:00 2001 From: martin0995 Date: Wed, 8 Jan 2025 12:00:15 -0300 Subject: [PATCH] Replace all references to Connect SDK with Typescript SDK --- README.md | 6 +++--- connect/package.json | 8 ++++---- core/base/package.json | 6 +++--- core/definitions/package.json | 6 +++--- core/icons/package.json | 6 +++--- docs/index.html | 6 +++--- docs/modules/_wormhole_foundation_sdk.html | 6 +++--- docs/modules/_wormhole_foundation_sdk_connect.html | 6 +++--- examples/README.md | 2 +- examples/package.json | 8 ++++---- platforms/algorand/package.json | 6 +++--- platforms/algorand/protocols/core/package.json | 6 +++--- platforms/algorand/protocols/tokenBridge/package.json | 6 +++--- platforms/aptos/package.json | 6 +++--- platforms/aptos/protocols/core/package.json | 6 +++--- platforms/aptos/protocols/tokenBridge/package.json | 6 +++--- platforms/cosmwasm/package.json | 6 +++--- platforms/cosmwasm/protocols/core/package.json | 6 +++--- platforms/cosmwasm/protocols/ibc/package.json | 6 +++--- platforms/cosmwasm/protocols/tokenBridge/package.json | 6 +++--- platforms/evm/package.json | 6 +++--- platforms/evm/protocols/cctp/package.json | 6 +++--- platforms/evm/protocols/core/package.json | 6 +++--- platforms/evm/protocols/portico/package.json | 6 +++--- platforms/evm/protocols/tokenBridge/package.json | 6 +++--- platforms/solana/package.json | 6 +++--- platforms/solana/protocols/cctp/package.json | 6 +++--- platforms/solana/protocols/core/package.json | 6 +++--- platforms/solana/protocols/tokenBridge/package.json | 6 +++--- platforms/sui/package.json | 6 +++--- platforms/sui/protocols/core/package.json | 6 +++--- platforms/sui/protocols/tokenBridge/package.json | 6 +++--- sdk/README.md | 6 +++--- sdk/package.json | 8 ++++---- tokenRegistry/package.json | 6 +++--- 35 files changed, 106 insertions(+), 106 deletions(-) diff --git a/README.md b/README.md index c8206a715..93f41a384 100644 --- a/README.md +++ b/README.md @@ -106,7 +106,7 @@ Understanding several higher level concepts of the SDK will help in using it eff Every chain is its own special snowflake but many of them share similar functionality. The `Platform` modules provide a consistent interface for interacting with the chains that share a platform. Each platform can be installed separately so that dependencies can stay as slim as possible. -See all supported platforms [here](https://github.com/wormhole-foundation/connect-sdk/tree/main/platforms) +See all supported platforms [here](https://github.com/wormhole-foundation/wormhole-sdk-ts/tree/main/platforms) ### Chain Context @@ -205,7 +205,7 @@ export interface SignAndSendSigner { } ``` -See the testing signers ([Evm](https://github.com/wormhole-foundation/connect-sdk/blob/main/platforms/evm/src/signer.ts), [Solana](https://github.com/wormhole-foundation/connect-sdk/blob/main/platforms/solana/src/signer.ts), ...) for an example of how to implement a signer for a specific chain or platform. +See the testing signers ([Evm](https://github.com/wormhole-foundation/wormhole-sdk-ts/blob/main/platforms/evm/src/signer.ts), [Solana](https://github.com/wormhole-foundation/wormhole-sdk-ts/blob/main/platforms/solana/src/signer.ts), ...) for an example of how to implement a signer for a specific chain or platform. ### VAAs @@ -400,7 +400,7 @@ const txGenerator = tb.createAttestation(token); // => AsyncGenerator TxHash[] ``` -Supported protocols are defined in the [definitions module](https://github.com/wormhole-foundation/connect-sdk/tree/main/core/definitions/src/protocols). +Supported protocols are defined in the [definitions module](https://github.com/wormhole-foundation/wormhole-sdk-ts/tree/main/core/definitions/src/protocols). ## Transfers diff --git a/connect/package.json b/connect/package.json index fdc9646da..ad2be5a1d 100644 --- a/connect/package.json +++ b/connect/package.json @@ -3,12 +3,12 @@ "version": "1.0.3", "repository": { "type": "git", - "url": "git+https://github.com/wormhole-foundation/connect-sdk.git" + "url": "git+https://github.com/wormhole-foundation/wormhole-sdk-ts.git" }, "bugs": { - "url": "https://github.com/wormhole-foundation/connect-sdk/issues" + "url": "https://github.com/wormhole-foundation/wormhole-sdk-ts/issues" }, - "homepage": "https://github.com/wormhole-foundation/connect-sdk#readme", + "homepage": "https://github.com/wormhole-foundation/wormhole-sdk-ts#readme", "directories": { "test": "__tests__" }, @@ -17,7 +17,7 @@ "types": "./dist/cjs/index.d.ts", "module": "./dist/esm/index.js", "author": "", - "description": "The core package for the Connect SDK, used in conjunction with 1 or more of the chain packages", + "description": "The core package for the Typescript SDK, used in conjunction with 1 or more of the chain packages", "exports": { ".": { "react-native": { diff --git a/core/base/package.json b/core/base/package.json index 6632a6847..c12f39e4c 100644 --- a/core/base/package.json +++ b/core/base/package.json @@ -3,12 +3,12 @@ "version": "1.0.3", "repository": { "type": "git", - "url": "git+https://github.com/wormhole-foundation/connect-sdk.git" + "url": "git+https://github.com/wormhole-foundation/wormhole-sdk-ts.git" }, "bugs": { - "url": "https://github.com/wormhole-foundation/connect-sdk/issues" + "url": "https://github.com/wormhole-foundation/wormhole-sdk-ts/issues" }, - "homepage": "https://github.com/wormhole-foundation/connect-sdk#readme", + "homepage": "https://github.com/wormhole-foundation/wormhole-sdk-ts#readme", "directories": { "test": "__tests__" }, diff --git a/core/definitions/package.json b/core/definitions/package.json index f47c08b86..6c9c73eef 100644 --- a/core/definitions/package.json +++ b/core/definitions/package.json @@ -3,12 +3,12 @@ "version": "1.0.3", "repository": { "type": "git", - "url": "git+https://github.com/wormhole-foundation/connect-sdk.git" + "url": "git+https://github.com/wormhole-foundation/wormhole-sdk-ts.git" }, "bugs": { - "url": "https://github.com/wormhole-foundation/connect-sdk/issues" + "url": "https://github.com/wormhole-foundation/wormhole-sdk-ts/issues" }, - "homepage": "https://github.com/wormhole-foundation/connect-sdk#readme", + "homepage": "https://github.com/wormhole-foundation/wormhole-sdk-ts#readme", "directories": { "test": "__tests__" }, diff --git a/core/icons/package.json b/core/icons/package.json index 40ffcc352..04328889d 100644 --- a/core/icons/package.json +++ b/core/icons/package.json @@ -3,12 +3,12 @@ "version": "1.0.3", "repository": { "type": "git", - "url": "git+https://github.com/wormhole-foundation/connect-sdk.git" + "url": "git+https://github.com/wormhole-foundation/wormhole-sdk-ts.git" }, "bugs": { - "url": "https://github.com/wormhole-foundation/connect-sdk/issues" + "url": "https://github.com/wormhole-foundation/wormhole-sdk-ts/issues" }, - "homepage": "https://github.com/wormhole-foundation/connect-sdk#readme", + "homepage": "https://github.com/wormhole-foundation/wormhole-sdk-ts#readme", "directories": { "test": "__tests__" }, diff --git a/docs/index.html b/docs/index.html index a91e80121..4b247d847 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,5 +1,5 @@ Wormhole TS SDK - v0.7.0

Wormhole TS SDK - v0.7.0

Wormhole TS SDK

The Wormhole Typescript SDK is useful for interacting with the chains Wormhole supports and the protocols built on top of Wormhole.

-

Warning

:warning: This package is a Work in Progress so the interface may change and there are likely bugs. Please report any issues you find. :warning:

+

Warning

:warning: This package is a Work in Progress so the interface may change and there are likely bugs. Please report any issues you find. :warning:

Installation

Basic

Install the (meta) package

npm install @wormhole-foundation/sdk
 
@@ -59,7 +59,7 @@

Signers

In order to sign transactions, an object that fulfils the Signer interface is required. This is a simple interface that can be implemented by wrapping a web wallet or other signing mechanism.

// A Signer is an interface that must be provided to certain methods
// in the SDK to sign transactions. It can be either a SignOnlySigner
// or a SignAndSendSigner depending on circumstances.
// A Signer can be implemented by wrapping an existing offline wallet
// or a web wallet
export type Signer = SignOnlySigner | SignAndSendSigner;

// A SignOnlySender is for situations where the signer is not
// connected to the network or does not wish to broadcast the
// transactions themselves
export interface SignOnlySigner {
chain(): ChainName;
address(): string;
// Accept an array of unsigned transactions and return
// an array of signed and serialized transactions.
// The transactions may be inspected or altered before
// signing.
// Note: The serialization is chain specific, if in doubt,
// see the example implementations linked below
sign(tx: UnsignedTransaction[]): Promise<SignedTx[]>;
}

// A SignAndSendSigner is for situations where the signer is
// connected to the network and wishes to broadcast the
// transactions themselves
export interface SignAndSendSigner {
chain(): ChainName;
address(): string;
// Accept an array of unsigned transactions and return
// an array of transaction ids in the same order as the
// UnsignedTransactions array.
signAndSend(tx: UnsignedTransaction[]): Promise<TxHash[]>;
}
-

See the testing signers (Evm, Solana, ...) for an example of how to implement a signer for a specific chain or platform.

+

See the testing signers (Evm, Solana, ...) for an example of how to implement a signer for a specific chain or platform.

Protocols

While Wormhole itself is a Generic Message Passing protocol, a number of protocols have been built on top of it to provide specific functionality.

Each Protocol, if available, will have a Platform specific implementation. These implementations provide methods to generate transactions or read state from the contract on-chain.

Wormhole Core

The protocol that underlies all Wormhole activity is the Core protocol. This protocol is responsible for emitting the message containing the information necessary to perform bridging including Emitter address, the Sequence number for the message and the Payload of the message itself.

@@ -75,7 +75,7 @@

Using the WormholeTransfer abstractions is the recommended way to interact with these protocols but it is possible to use them directly

import { signSendWait } from "@wormhole-foundation/sdk";

// ...

const tb = await srcChain.getTokenBridge(); // => TokenBridge<'Evm'>

const token = "0xdeadbeef...";
const txGenerator = tb.createAttestation(token); // => AsyncGenerator<UnsignedTransaction, ...>
const txids = await signSendWait(srcChain, txGenerator, src.signer); // => TxHash[]
-

Supported protocols are defined in the definitions module.

+

Supported protocols are defined in the definitions module.

Transfers

While using the ChainContext and Protocol clients directly is possible, to do things like transfer tokens, the SDK provides some helpful abstractions.

The WormholeTransfer interface provides a convenient abstraction to encapsulate the steps involved in a cross-chain transfer.

Token Transfers

Performing a Token Transfer is trivial for any source and destination chains.

diff --git a/docs/modules/_wormhole_foundation_sdk.html b/docs/modules/_wormhole_foundation_sdk.html index 4a242125b..7ffe20957 100644 --- a/docs/modules/_wormhole_foundation_sdk.html +++ b/docs/modules/_wormhole_foundation_sdk.html @@ -1,5 +1,5 @@ @wormhole-foundation/sdk - v0.7.0 | Wormhole TS SDK - v0.7.0

Module @wormhole-foundation/sdk - v0.7.0

Wormhole TS SDK

The Wormhole Typescript SDK is useful for interacting with the chains Wormhole supports and the protocols built on top of Wormhole.

-

Warning

:warning: This package is a Work in Progress so the interface may change and there are likely bugs. Please report any issues you find. :warning:

+

Warning

:warning: This package is a Work in Progress so the interface may change and there are likely bugs. Please report any issues you find. :warning:

Installation

Basic

Install the (meta) package

npm install @wormhole-foundation/sdk
 
@@ -59,7 +59,7 @@

Signers

In order to sign transactions, an object that fulfils the Signer interface is required. This is a simple interface that can be implemented by wrapping a web wallet or other signing mechanism.

// A Signer is an interface that must be provided to certain methods
// in the SDK to sign transactions. It can be either a SignOnlySigner
// or a SignAndSendSigner depending on circumstances.
// A Signer can be implemented by wrapping an existing offline wallet
// or a web wallet
export type Signer = SignOnlySigner | SignAndSendSigner;

// A SignOnlySender is for situations where the signer is not
// connected to the network or does not wish to broadcast the
// transactions themselves
export interface SignOnlySigner {
chain(): ChainName;
address(): string;
// Accept an array of unsigned transactions and return
// an array of signed and serialized transactions.
// The transactions may be inspected or altered before
// signing.
// Note: The serialization is chain specific, if in doubt,
// see the example implementations linked below
sign(tx: UnsignedTransaction[]): Promise<SignedTx[]>;
}

// A SignAndSendSigner is for situations where the signer is
// connected to the network and wishes to broadcast the
// transactions themselves
export interface SignAndSendSigner {
chain(): ChainName;
address(): string;
// Accept an array of unsigned transactions and return
// an array of transaction ids in the same order as the
// UnsignedTransactions array.
signAndSend(tx: UnsignedTransaction[]): Promise<TxHash[]>;
}
-

See the testing signers (Evm, Solana, ...) for an example of how to implement a signer for a specific chain or platform.

+

See the testing signers (Evm, Solana, ...) for an example of how to implement a signer for a specific chain or platform.

Protocols

While Wormhole itself is a Generic Message Passing protocol, a number of protocols have been built on top of it to provide specific functionality.

Each Protocol, if available, will have a Platform specific implementation. These implementations provide methods to generate transactions or read state from the contract on-chain.

Wormhole Core

The protocol that underlies all Wormhole activity is the Core protocol. This protocol is responsible for emitting the message containing the information necessary to perform bridging including Emitter address, the Sequence number for the message and the Payload of the message itself.

@@ -75,7 +75,7 @@

Using the WormholeTransfer abstractions is the recommended way to interact with these protocols but it is possible to use them directly

import { signSendWait } from "@wormhole-foundation/sdk";

// ...

const tb = await srcChain.getTokenBridge(); // => TokenBridge<'Evm'>

const token = "0xdeadbeef...";
const txGenerator = tb.createAttestation(token); // => AsyncGenerator<UnsignedTransaction, ...>
const txids = await signSendWait(srcChain, txGenerator, src.signer); // => TxHash[]
-

Supported protocols are defined in the definitions module.

+

Supported protocols are defined in the definitions module.

Transfers

While using the ChainContext and Protocol clients directly is possible, to do things like transfer tokens, the SDK provides some helpful abstractions.

The WormholeTransfer interface provides a convenient abstraction to encapsulate the steps involved in a cross-chain transfer.

Token Transfers

Performing a Token Transfer is trivial for any source and destination chains.

diff --git a/docs/modules/_wormhole_foundation_sdk_connect.html b/docs/modules/_wormhole_foundation_sdk_connect.html index b2f4ddf61..1e9079a28 100644 --- a/docs/modules/_wormhole_foundation_sdk_connect.html +++ b/docs/modules/_wormhole_foundation_sdk_connect.html @@ -1,5 +1,5 @@ @wormhole-foundation/sdk-connect - v0.7.0 | Wormhole TS SDK - v0.7.0

Module @wormhole-foundation/sdk-connect - v0.7.0

Wormhole TS SDK

The Wormhole Typescript SDK is useful for interacting with the chains Wormhole supports and the protocols built on top of Wormhole.

-

Warning

:warning: This package is a Work in Progress so the interface may change and there are likely bugs. Please report any issues you find. :warning:

+

Warning

:warning: This package is a Work in Progress so the interface may change and there are likely bugs. Please report any issues you find. :warning:

Installation

Basic

Install the (meta) package

npm install @wormhole-foundation/sdk
 
@@ -59,7 +59,7 @@

Signers

In order to sign transactions, an object that fulfils the Signer interface is required. This is a simple interface that can be implemented by wrapping a web wallet or other signing mechanism.

// A Signer is an interface that must be provided to certain methods
// in the SDK to sign transactions. It can be either a SignOnlySigner
// or a SignAndSendSigner depending on circumstances.
// A Signer can be implemented by wrapping an existing offline wallet
// or a web wallet
export type Signer = SignOnlySigner | SignAndSendSigner;

// A SignOnlySender is for situations where the signer is not
// connected to the network or does not wish to broadcast the
// transactions themselves
export interface SignOnlySigner {
chain(): ChainName;
address(): string;
// Accept an array of unsigned transactions and return
// an array of signed and serialized transactions.
// The transactions may be inspected or altered before
// signing.
// Note: The serialization is chain specific, if in doubt,
// see the example implementations linked below
sign(tx: UnsignedTransaction[]): Promise<SignedTx[]>;
}

// A SignAndSendSigner is for situations where the signer is
// connected to the network and wishes to broadcast the
// transactions themselves
export interface SignAndSendSigner {
chain(): ChainName;
address(): string;
// Accept an array of unsigned transactions and return
// an array of transaction ids in the same order as the
// UnsignedTransactions array.
signAndSend(tx: UnsignedTransaction[]): Promise<TxHash[]>;
}
-

See the testing signers (Evm, Solana, ...) for an example of how to implement a signer for a specific chain or platform.

+

See the testing signers (Evm, Solana, ...) for an example of how to implement a signer for a specific chain or platform.

Protocols

While Wormhole itself is a Generic Message Passing protocol, a number of protocols have been built on top of it to provide specific functionality.

Each Protocol, if available, will have a Platform specific implementation. These implementations provide methods to generate transactions or read state from the contract on-chain.

Wormhole Core

The protocol that underlies all Wormhole activity is the Core protocol. This protocol is responsible for emitting the message containing the information necessary to perform bridging including Emitter address, the Sequence number for the message and the Payload of the message itself.

@@ -75,7 +75,7 @@

Using the WormholeTransfer abstractions is the recommended way to interact with these protocols but it is possible to use them directly

import { signSendWait } from "@wormhole-foundation/sdk";

// ...

const tb = await srcChain.getTokenBridge(); // => TokenBridge<'Evm'>

const token = "0xdeadbeef...";
const txGenerator = tb.createAttestation(token); // => AsyncGenerator<UnsignedTransaction, ...>
const txids = await signSendWait(srcChain, txGenerator, src.signer); // => TxHash[]
-

Supported protocols are defined in the definitions module.

+

Supported protocols are defined in the definitions module.

Transfers

While using the ChainContext and Protocol clients directly is possible, to do things like transfer tokens, the SDK provides some helpful abstractions.

The WormholeTransfer interface provides a convenient abstraction to encapsulate the steps involved in a cross-chain transfer.

Token Transfers

Performing a Token Transfer is trivial for any source and destination chains.

diff --git a/examples/README.md b/examples/README.md index 6a1cf041f..61a0443c4 100644 --- a/examples/README.md +++ b/examples/README.md @@ -1,4 +1,4 @@ -# Connect SDK Examples +# Wormhole Typescript SDK Examples ## Usage diff --git a/examples/package.json b/examples/package.json index 7893d0773..365097320 100644 --- a/examples/package.json +++ b/examples/package.json @@ -3,12 +3,12 @@ "version": "1.0.3", "repository": { "type": "git", - "url": "git+https://github.com/wormhole-foundation/connect-sdk.git" + "url": "git+https://github.com/wormhole-foundation/wormhole-sdk-ts.git" }, "bugs": { - "url": "https://github.com/wormhole-foundation/connect-sdk/issues" + "url": "https://github.com/wormhole-foundation/wormhole-sdk-ts/issues" }, - "homepage": "https://github.com/wormhole-foundation/connect-sdk#readme", + "homepage": "https://github.com/wormhole-foundation/wormhole-sdk-ts#readme", "directories": { "test": "__tests__" }, @@ -17,7 +17,7 @@ "module": "./dist/esm/index.js", "type": "module", "author": "", - "description": "The core package for the Connect SDK, used in conjunction with 1 or more of the chain packages", + "description": "The core package for the Typescript SDK, used in conjunction with 1 or more of the chain packages", "files": [ "dist/esm", "dist/cjs" diff --git a/platforms/algorand/package.json b/platforms/algorand/package.json index 37a95deee..dbb628d18 100644 --- a/platforms/algorand/package.json +++ b/platforms/algorand/package.json @@ -3,12 +3,12 @@ "version": "1.0.3", "repository": { "type": "git", - "url": "git+https://github.com/wormhole-foundation/connect-sdk.git" + "url": "git+https://github.com/wormhole-foundation/wormhole-sdk-ts.git" }, "bugs": { - "url": "https://github.com/wormhole-foundation/connect-sdk/issues" + "url": "https://github.com/wormhole-foundation/wormhole-sdk-ts/issues" }, - "homepage": "https://github.com/wormhole-foundation/connect-sdk#readme", + "homepage": "https://github.com/wormhole-foundation/wormhole-sdk-ts#readme", "directories": { "test": "tests" }, diff --git a/platforms/algorand/protocols/core/package.json b/platforms/algorand/protocols/core/package.json index b31eaf72a..abca54955 100644 --- a/platforms/algorand/protocols/core/package.json +++ b/platforms/algorand/protocols/core/package.json @@ -3,12 +3,12 @@ "version": "1.0.3", "repository": { "type": "git", - "url": "git+https://github.com/wormhole-foundation/connect-sdk.git" + "url": "git+https://github.com/wormhole-foundation/wormhole-sdk-ts.git" }, "bugs": { - "url": "https://github.com/wormhole-foundation/connect-sdk/issues" + "url": "https://github.com/wormhole-foundation/wormhole-sdk-ts/issues" }, - "homepage": "https://github.com/wormhole-foundation/connect-sdk#readme", + "homepage": "https://github.com/wormhole-foundation/wormhole-sdk-ts#readme", "directories": { "test": "tests" }, diff --git a/platforms/algorand/protocols/tokenBridge/package.json b/platforms/algorand/protocols/tokenBridge/package.json index 91b79f489..3f0b17b3b 100644 --- a/platforms/algorand/protocols/tokenBridge/package.json +++ b/platforms/algorand/protocols/tokenBridge/package.json @@ -3,12 +3,12 @@ "version": "1.0.3", "repository": { "type": "git", - "url": "git+https://github.com/wormhole-foundation/connect-sdk.git" + "url": "git+https://github.com/wormhole-foundation/wormhole-sdk-ts.git" }, "bugs": { - "url": "https://github.com/wormhole-foundation/connect-sdk/issues" + "url": "https://github.com/wormhole-foundation/wormhole-sdk-ts/issues" }, - "homepage": "https://github.com/wormhole-foundation/connect-sdk#readme", + "homepage": "https://github.com/wormhole-foundation/wormhole-sdk-ts#readme", "directories": { "test": "tests" }, diff --git a/platforms/aptos/package.json b/platforms/aptos/package.json index 40b38c370..c8107e34e 100644 --- a/platforms/aptos/package.json +++ b/platforms/aptos/package.json @@ -3,12 +3,12 @@ "version": "1.0.3", "repository": { "type": "git", - "url": "git+https://github.com/wormhole-foundation/connect-sdk.git" + "url": "git+https://github.com/wormhole-foundation/wormhole-sdk-ts.git" }, "bugs": { - "url": "https://github.com/wormhole-foundation/connect-sdk/issues" + "url": "https://github.com/wormhole-foundation/wormhole-sdk-ts/issues" }, - "homepage": "https://github.com/wormhole-foundation/connect-sdk#readme", + "homepage": "https://github.com/wormhole-foundation/wormhole-sdk-ts#readme", "directories": { "test": "__tests__" }, diff --git a/platforms/aptos/protocols/core/package.json b/platforms/aptos/protocols/core/package.json index 542b0a7d3..5db40b990 100644 --- a/platforms/aptos/protocols/core/package.json +++ b/platforms/aptos/protocols/core/package.json @@ -3,12 +3,12 @@ "version": "1.0.3", "repository": { "type": "git", - "url": "git+https://github.com/wormhole-foundation/connect-sdk.git" + "url": "git+https://github.com/wormhole-foundation/wormhole-sdk-ts.git" }, "bugs": { - "url": "https://github.com/wormhole-foundation/connect-sdk/issues" + "url": "https://github.com/wormhole-foundation/wormhole-sdk-ts/issues" }, - "homepage": "https://github.com/wormhole-foundation/connect-sdk#readme", + "homepage": "https://github.com/wormhole-foundation/wormhole-sdk-ts#readme", "directories": { "test": "__tests__" }, diff --git a/platforms/aptos/protocols/tokenBridge/package.json b/platforms/aptos/protocols/tokenBridge/package.json index c31c42bd7..a7a69a76d 100644 --- a/platforms/aptos/protocols/tokenBridge/package.json +++ b/platforms/aptos/protocols/tokenBridge/package.json @@ -3,12 +3,12 @@ "version": "1.0.3", "repository": { "type": "git", - "url": "git+https://github.com/wormhole-foundation/connect-sdk.git" + "url": "git+https://github.com/wormhole-foundation/wormhole-sdk-ts.git" }, "bugs": { - "url": "https://github.com/wormhole-foundation/connect-sdk/issues" + "url": "https://github.com/wormhole-foundation/wormhole-sdk-ts/issues" }, - "homepage": "https://github.com/wormhole-foundation/connect-sdk#readme", + "homepage": "https://github.com/wormhole-foundation/wormhole-sdk-ts#readme", "directories": { "test": "__tests__" }, diff --git a/platforms/cosmwasm/package.json b/platforms/cosmwasm/package.json index 4de33271b..2e1b8bf13 100644 --- a/platforms/cosmwasm/package.json +++ b/platforms/cosmwasm/package.json @@ -3,12 +3,12 @@ "version": "1.0.3", "repository": { "type": "git", - "url": "git+https://github.com/wormhole-foundation/connect-sdk.git" + "url": "git+https://github.com/wormhole-foundation/wormhole-sdk-ts.git" }, "bugs": { - "url": "https://github.com/wormhole-foundation/connect-sdk/issues" + "url": "https://github.com/wormhole-foundation/wormhole-sdk-ts/issues" }, - "homepage": "https://github.com/wormhole-foundation/connect-sdk#readme", + "homepage": "https://github.com/wormhole-foundation/wormhole-sdk-ts#readme", "directories": { "test": "__tests__" }, diff --git a/platforms/cosmwasm/protocols/core/package.json b/platforms/cosmwasm/protocols/core/package.json index c26548a35..58d843cba 100644 --- a/platforms/cosmwasm/protocols/core/package.json +++ b/platforms/cosmwasm/protocols/core/package.json @@ -3,12 +3,12 @@ "version": "1.0.3", "repository": { "type": "git", - "url": "git+https://github.com/wormhole-foundation/connect-sdk.git" + "url": "git+https://github.com/wormhole-foundation/wormhole-sdk-ts.git" }, "bugs": { - "url": "https://github.com/wormhole-foundation/connect-sdk/issues" + "url": "https://github.com/wormhole-foundation/wormhole-sdk-ts/issues" }, - "homepage": "https://github.com/wormhole-foundation/connect-sdk#readme", + "homepage": "https://github.com/wormhole-foundation/wormhole-sdk-ts#readme", "directories": { "test": "tests" }, diff --git a/platforms/cosmwasm/protocols/ibc/package.json b/platforms/cosmwasm/protocols/ibc/package.json index 7ea0fdf1b..ec60d9367 100644 --- a/platforms/cosmwasm/protocols/ibc/package.json +++ b/platforms/cosmwasm/protocols/ibc/package.json @@ -3,12 +3,12 @@ "version": "1.0.3", "repository": { "type": "git", - "url": "git+https://github.com/wormhole-foundation/connect-sdk.git" + "url": "git+https://github.com/wormhole-foundation/wormhole-sdk-ts.git" }, "bugs": { - "url": "https://github.com/wormhole-foundation/connect-sdk/issues" + "url": "https://github.com/wormhole-foundation/wormhole-sdk-ts/issues" }, - "homepage": "https://github.com/wormhole-foundation/connect-sdk#readme", + "homepage": "https://github.com/wormhole-foundation/wormhole-sdk-ts#readme", "directories": { "test": "tests" }, diff --git a/platforms/cosmwasm/protocols/tokenBridge/package.json b/platforms/cosmwasm/protocols/tokenBridge/package.json index f6d69b200..5f43f85ff 100644 --- a/platforms/cosmwasm/protocols/tokenBridge/package.json +++ b/platforms/cosmwasm/protocols/tokenBridge/package.json @@ -3,12 +3,12 @@ "version": "1.0.3", "repository": { "type": "git", - "url": "git+https://github.com/wormhole-foundation/connect-sdk.git" + "url": "git+https://github.com/wormhole-foundation/wormhole-sdk-ts.git" }, "bugs": { - "url": "https://github.com/wormhole-foundation/connect-sdk/issues" + "url": "https://github.com/wormhole-foundation/wormhole-sdk-ts/issues" }, - "homepage": "https://github.com/wormhole-foundation/connect-sdk#readme", + "homepage": "https://github.com/wormhole-foundation/wormhole-sdk-ts#readme", "directories": { "test": "tests" }, diff --git a/platforms/evm/package.json b/platforms/evm/package.json index 64a981a1e..0d0d64567 100644 --- a/platforms/evm/package.json +++ b/platforms/evm/package.json @@ -3,12 +3,12 @@ "version": "1.0.3", "repository": { "type": "git", - "url": "git+https://github.com/wormhole-foundation/connect-sdk.git" + "url": "git+https://github.com/wormhole-foundation/wormhole-sdk-ts.git" }, "bugs": { - "url": "https://github.com/wormhole-foundation/connect-sdk/issues" + "url": "https://github.com/wormhole-foundation/wormhole-sdk-ts/issues" }, - "homepage": "https://github.com/wormhole-foundation/connect-sdk#readme", + "homepage": "https://github.com/wormhole-foundation/wormhole-sdk-ts#readme", "directories": { "test": "tests" }, diff --git a/platforms/evm/protocols/cctp/package.json b/platforms/evm/protocols/cctp/package.json index 06e76c352..ccf6f978f 100644 --- a/platforms/evm/protocols/cctp/package.json +++ b/platforms/evm/protocols/cctp/package.json @@ -3,12 +3,12 @@ "version": "1.0.3", "repository": { "type": "git", - "url": "git+https://github.com/wormhole-foundation/connect-sdk.git" + "url": "git+https://github.com/wormhole-foundation/wormhole-sdk-ts.git" }, "bugs": { - "url": "https://github.com/wormhole-foundation/connect-sdk/issues" + "url": "https://github.com/wormhole-foundation/wormhole-sdk-ts/issues" }, - "homepage": "https://github.com/wormhole-foundation/connect-sdk#readme", + "homepage": "https://github.com/wormhole-foundation/wormhole-sdk-ts#readme", "directories": { "test": "tests" }, diff --git a/platforms/evm/protocols/core/package.json b/platforms/evm/protocols/core/package.json index af98e064a..8d394865f 100644 --- a/platforms/evm/protocols/core/package.json +++ b/platforms/evm/protocols/core/package.json @@ -3,12 +3,12 @@ "version": "1.0.3", "repository": { "type": "git", - "url": "git+https://github.com/wormhole-foundation/connect-sdk.git" + "url": "git+https://github.com/wormhole-foundation/wormhole-sdk-ts.git" }, "bugs": { - "url": "https://github.com/wormhole-foundation/connect-sdk/issues" + "url": "https://github.com/wormhole-foundation/wormhole-sdk-ts/issues" }, - "homepage": "https://github.com/wormhole-foundation/connect-sdk#readme", + "homepage": "https://github.com/wormhole-foundation/wormhole-sdk-ts#readme", "directories": { "test": "tests" }, diff --git a/platforms/evm/protocols/portico/package.json b/platforms/evm/protocols/portico/package.json index c6c7e9126..d94f66f92 100644 --- a/platforms/evm/protocols/portico/package.json +++ b/platforms/evm/protocols/portico/package.json @@ -3,12 +3,12 @@ "version": "1.0.3", "repository": { "type": "git", - "url": "git+https://github.com/wormhole-foundation/connect-sdk.git" + "url": "git+https://github.com/wormhole-foundation/wormhole-sdk-ts.git" }, "bugs": { - "url": "https://github.com/wormhole-foundation/connect-sdk/issues" + "url": "https://github.com/wormhole-foundation/wormhole-sdk-ts/issues" }, - "homepage": "https://github.com/wormhole-foundation/connect-sdk#readme", + "homepage": "https://github.com/wormhole-foundation/wormhole-sdk-ts#readme", "directories": { "test": "tests" }, diff --git a/platforms/evm/protocols/tokenBridge/package.json b/platforms/evm/protocols/tokenBridge/package.json index b07fe30f3..898e0dc74 100644 --- a/platforms/evm/protocols/tokenBridge/package.json +++ b/platforms/evm/protocols/tokenBridge/package.json @@ -3,12 +3,12 @@ "version": "1.0.3", "repository": { "type": "git", - "url": "git+https://github.com/wormhole-foundation/connect-sdk.git" + "url": "git+https://github.com/wormhole-foundation/wormhole-sdk-ts.git" }, "bugs": { - "url": "https://github.com/wormhole-foundation/connect-sdk/issues" + "url": "https://github.com/wormhole-foundation/wormhole-sdk-ts/issues" }, - "homepage": "https://github.com/wormhole-foundation/connect-sdk#readme", + "homepage": "https://github.com/wormhole-foundation/wormhole-sdk-ts#readme", "directories": { "test": "tests" }, diff --git a/platforms/solana/package.json b/platforms/solana/package.json index e1ccc0b11..f1aa1e3cd 100644 --- a/platforms/solana/package.json +++ b/platforms/solana/package.json @@ -3,12 +3,12 @@ "version": "1.0.3", "repository": { "type": "git", - "url": "git+https://github.com/wormhole-foundation/connect-sdk.git" + "url": "git+https://github.com/wormhole-foundation/wormhole-sdk-ts.git" }, "bugs": { - "url": "https://github.com/wormhole-foundation/connect-sdk/issues" + "url": "https://github.com/wormhole-foundation/wormhole-sdk-ts/issues" }, - "homepage": "https://github.com/wormhole-foundation/connect-sdk#readme", + "homepage": "https://github.com/wormhole-foundation/wormhole-sdk-ts#readme", "directories": { "test": "__tests__" }, diff --git a/platforms/solana/protocols/cctp/package.json b/platforms/solana/protocols/cctp/package.json index 4ca320a1f..25aa86733 100644 --- a/platforms/solana/protocols/cctp/package.json +++ b/platforms/solana/protocols/cctp/package.json @@ -3,12 +3,12 @@ "version": "1.0.3", "repository": { "type": "git", - "url": "git+https://github.com/wormhole-foundation/connect-sdk.git" + "url": "git+https://github.com/wormhole-foundation/wormhole-sdk-ts.git" }, "bugs": { - "url": "https://github.com/wormhole-foundation/connect-sdk/issues" + "url": "https://github.com/wormhole-foundation/wormhole-sdk-ts/issues" }, - "homepage": "https://github.com/wormhole-foundation/connect-sdk#readme", + "homepage": "https://github.com/wormhole-foundation/wormhole-sdk-ts#readme", "directories": { "test": "__tests__" }, diff --git a/platforms/solana/protocols/core/package.json b/platforms/solana/protocols/core/package.json index 2af98b20a..14439d211 100644 --- a/platforms/solana/protocols/core/package.json +++ b/platforms/solana/protocols/core/package.json @@ -3,12 +3,12 @@ "version": "1.0.3", "repository": { "type": "git", - "url": "git+https://github.com/wormhole-foundation/connect-sdk.git" + "url": "git+https://github.com/wormhole-foundation/wormhole-sdk-ts.git" }, "bugs": { - "url": "https://github.com/wormhole-foundation/connect-sdk/issues" + "url": "https://github.com/wormhole-foundation/wormhole-sdk-ts/issues" }, - "homepage": "https://github.com/wormhole-foundation/connect-sdk#readme", + "homepage": "https://github.com/wormhole-foundation/wormhole-sdk-ts#readme", "directories": { "test": "__tests__" }, diff --git a/platforms/solana/protocols/tokenBridge/package.json b/platforms/solana/protocols/tokenBridge/package.json index c4c9a61d8..9d8e8be58 100644 --- a/platforms/solana/protocols/tokenBridge/package.json +++ b/platforms/solana/protocols/tokenBridge/package.json @@ -3,12 +3,12 @@ "version": "1.0.3", "repository": { "type": "git", - "url": "git+https://github.com/wormhole-foundation/connect-sdk.git" + "url": "git+https://github.com/wormhole-foundation/wormhole-sdk-ts.git" }, "bugs": { - "url": "https://github.com/wormhole-foundation/connect-sdk/issues" + "url": "https://github.com/wormhole-foundation/wormhole-sdk-ts/issues" }, - "homepage": "https://github.com/wormhole-foundation/connect-sdk#readme", + "homepage": "https://github.com/wormhole-foundation/wormhole-sdk-ts#readme", "directories": { "test": "__tests__" }, diff --git a/platforms/sui/package.json b/platforms/sui/package.json index cd41b771c..8976404f6 100644 --- a/platforms/sui/package.json +++ b/platforms/sui/package.json @@ -3,12 +3,12 @@ "version": "1.0.3", "repository": { "type": "git", - "url": "git+https://github.com/wormhole-foundation/connect-sdk.git" + "url": "git+https://github.com/wormhole-foundation/wormhole-sdk-ts.git" }, "bugs": { - "url": "https://github.com/wormhole-foundation/connect-sdk/issues" + "url": "https://github.com/wormhole-foundation/wormhole-sdk-ts/issues" }, - "homepage": "https://github.com/wormhole-foundation/connect-sdk#readme", + "homepage": "https://github.com/wormhole-foundation/wormhole-sdk-ts#readme", "directories": { "test": "tests" }, diff --git a/platforms/sui/protocols/core/package.json b/platforms/sui/protocols/core/package.json index 123c9bfc5..0511506cf 100644 --- a/platforms/sui/protocols/core/package.json +++ b/platforms/sui/protocols/core/package.json @@ -3,12 +3,12 @@ "version": "1.0.3", "repository": { "type": "git", - "url": "git+https://github.com/wormhole-foundation/connect-sdk.git" + "url": "git+https://github.com/wormhole-foundation/wormhole-sdk-ts.git" }, "bugs": { - "url": "https://github.com/wormhole-foundation/connect-sdk/issues" + "url": "https://github.com/wormhole-foundation/wormhole-sdk-ts/issues" }, - "homepage": "https://github.com/wormhole-foundation/connect-sdk#readme", + "homepage": "https://github.com/wormhole-foundation/wormhole-sdk-ts#readme", "directories": { "test": "tests" }, diff --git a/platforms/sui/protocols/tokenBridge/package.json b/platforms/sui/protocols/tokenBridge/package.json index d91a9c389..7b756529f 100644 --- a/platforms/sui/protocols/tokenBridge/package.json +++ b/platforms/sui/protocols/tokenBridge/package.json @@ -3,12 +3,12 @@ "version": "1.0.3", "repository": { "type": "git", - "url": "git+https://github.com/wormhole-foundation/connect-sdk.git" + "url": "git+https://github.com/wormhole-foundation/wormhole-sdk-ts.git" }, "bugs": { - "url": "https://github.com/wormhole-foundation/connect-sdk/issues" + "url": "https://github.com/wormhole-foundation/wormhole-sdk-ts/issues" }, - "homepage": "https://github.com/wormhole-foundation/connect-sdk#readme", + "homepage": "https://github.com/wormhole-foundation/wormhole-sdk-ts#readme", "directories": { "test": "tests" }, diff --git a/sdk/README.md b/sdk/README.md index 4e5271cab..74cb7c932 100644 --- a/sdk/README.md +++ b/sdk/README.md @@ -4,7 +4,7 @@ The Wormhole Typescript SDK is useful for interacting with the chains Wormhole s ## Warning -:warning: This package is a Work in Progress so the interface may change and there are likely bugs. Please [report](https://github.com/wormhole-foundation/connect-sdk/issues) any issues you find. :warning: +:warning: This package is a Work in Progress so the interface may change and there are likely bugs. Please [report](https://github.com/wormhole-foundation/wormhole-sdk-ts/issues) any issues you find. :warning: ## Installation @@ -211,7 +211,7 @@ export interface SignAndSendSigner { } ``` -See the testing signers ([Evm](https://github.com/wormhole-foundation/connect-sdk/blob/main/platforms/evm/src/signer.ts), [Solana](https://github.com/wormhole-foundation/connect-sdk/blob/main/platforms/solana/src/signer.ts), ...) for an example of how to implement a signer for a specific chain or platform. +See the testing signers ([Evm](https://github.com/wormhole-foundation/wormhole-sdk-ts/blob/main/platforms/evm/src/signer.ts), [Solana](https://github.com/wormhole-foundation/wormhole-sdk-ts/blob/main/platforms/solana/src/signer.ts), ...) for an example of how to implement a signer for a specific chain or platform. ### Protocols @@ -293,7 +293,7 @@ const txGenerator = tb.createAttestation(token); // => AsyncGenerator TxHash[] ``` -Supported protocols are defined in the [definitions module](https://github.com/wormhole-foundation/connect-sdk/tree/main/core/definitions/src/protocols). +Supported protocols are defined in the [definitions module](https://github.com/wormhole-foundation/wormhole-sdk-ts/tree/main/core/definitions/src/protocols). ## Transfers diff --git a/sdk/package.json b/sdk/package.json index 95c7d4a86..ed8471d5d 100644 --- a/sdk/package.json +++ b/sdk/package.json @@ -3,12 +3,12 @@ "version": "1.0.3", "repository": { "type": "git", - "url": "git+https://github.com/wormhole-foundation/connect-sdk.git" + "url": "git+https://github.com/wormhole-foundation/wormhole-sdk-ts.git" }, "bugs": { - "url": "https://github.com/wormhole-foundation/connect-sdk/issues" + "url": "https://github.com/wormhole-foundation/wormhole-sdk-ts/issues" }, - "homepage": "https://github.com/wormhole-foundation/connect-sdk#readme", + "homepage": "https://github.com/wormhole-foundation/wormhole-sdk-ts#readme", "directories": { "test": "__tests__" }, @@ -16,7 +16,7 @@ "main": "./dist/cjs/index.js", "types": "./dist/cjs/index.d.ts", "module": "./dist/esm/index.js", - "description": "The core package for the Connect SDK, used in conjunction with 1 or more of the chain packages", + "description": "The core package for the Typescript SDK, used in conjunction with 1 or more of the chain packages", "files": [ "dist/esm", "dist/cjs" diff --git a/tokenRegistry/package.json b/tokenRegistry/package.json index 1e5f19fdb..3161e0347 100644 --- a/tokenRegistry/package.json +++ b/tokenRegistry/package.json @@ -4,12 +4,12 @@ "repository": { "type": "git", - "url": "git+https://github.com/wormhole-foundation/connect-sdk.git" + "url": "git+https://github.com/wormhole-foundation/wormhole-sdk-ts.git" }, "bugs": { - "url": "https://github.com/wormhole-foundation/connect-sdk/issues" + "url": "https://github.com/wormhole-foundation/wormhole-sdk-ts/issues" }, - "homepage": "https://github.com/wormhole-foundation/connect-sdk#readme", + "homepage": "https://github.com/wormhole-foundation/wormhole-sdk-ts#readme", "directories": { "test": "__tests__" },