diff --git a/README.md b/README.md index a811caad6..d3ddf1064 100644 --- a/README.md +++ b/README.md @@ -5,8 +5,8 @@ A TypeScript library for creating Monero applications using RPC and WebAssembly * Supports client-side wallets in Node.js and the browser using WebAssembly. * Supports wallet and daemon RPC clients. * Supports multisig, view-only, and offline wallets. -* Wallet types are interchangeable by conforming to a [common interface](https://moneroecosystem.org/monero-ts/typedocs/classes/MoneroWallet.html). -* Uses a clearly defined [data model and API specification](https://moneroecosystem.org/monero-java/monero-spec.pdf) intended to be intuitive and robust. +* Wallet types are interchangeable by conforming to a [common interface](https://woodser.github.io/monero-ts/typedocs/classes/MoneroWallet.html). +* Uses a clearly defined [data model and API specification](https://woodser.github.io/monero-java/monero-spec.pdf) intended to be intuitive and robust. * [Query wallet transactions, transfers, and outputs](docs/developer_guide/query_data_model.md) by their properties. * Fetch and process binary data from the daemon (e.g. raw blocks). * Receive notifications when blocks are added to the chain or when wallets sync, send, or receive. @@ -28,7 +28,7 @@ A TypeScript library for creating Monero applications using RPC and WebAssembly


- Build browser or Node.js applications using RPC or WebAssembly bindings to monero-project/monero. Wallet implementations are interchangeable by conforming to a common interface, MoneroWallet.ts. + Build browser or Node.js applications using RPC or WebAssembly bindings to monero-project/monero. Wallet implementations are interchangeable by conforming to a common interface, MoneroWallet.ts.

## Sample code @@ -105,8 +105,8 @@ await walletFull.close(true); ## Documentation -* [TypeDocs](https://moneroecosystem.org/monero-ts/typedocs/) -* [API and model overview with visual diagrams](https://moneroecosystem.org/monero-java/monero-spec.pdf) +* [TypeDocs](https://woodser.github.io/monero-ts/typedocs/) +* [API and model overview with visual diagrams](https://woodser.github.io/monero-java/monero-spec.pdf) * [Creating wallets](docs/developer_guide/creating_wallets.md) * [The data model: blocks, transactions, transfers, and outputs](docs/developer_guide/data_model.md) * [Getting transactions, transfers, and outputs](docs/developer_guide/query_data_model.md) diff --git a/docs/developer_guide/connection_manager.md b/docs/developer_guide/connection_manager.md index 41e974d34..23082298f 100644 --- a/docs/developer_guide/connection_manager.md +++ b/docs/developer_guide/connection_manager.md @@ -2,7 +2,7 @@ The following code demonstrates how to use monero-ts's connection manager to manage daemon or wallet RPC endpoints. -See [MoneroConnectionManager](https://moneroecosystem.org/monero-ts/typedocs/classes/MoneroConnectionManager.html) or [TestMoneroConnectionManager.ts](https://github.com/monero-ecosystem/monero-ts/blob/master/src/test/TestMoneroConnectionManager.ts) for more detail. +See [MoneroConnectionManager](https://woodser.github.io/monero-ts/typedocs/classes/MoneroConnectionManager.html) or [TestMoneroConnectionManager.ts](https://github.com/monero-ecosystem/monero-ts/blob/master/src/test/TestMoneroConnectionManager.ts) for more detail. ```typescript // import monero-ts (or import types individually) diff --git a/docs/developer_guide/creating_wallets.md b/docs/developer_guide/creating_wallets.md index df9a17452..68cf026e0 100644 --- a/docs/developer_guide/creating_wallets.md +++ b/docs/developer_guide/creating_wallets.md @@ -10,7 +10,7 @@ Three types of wallets can be created: This example creates a client connected to monero-wallet-rpc then creates a wallet. -See [MoneroWalletRpc.createWallet()](https://moneroecosystem.org/monero-ts/typedocs/classes/MoneroWalletRpc.html#createWallet) for all options. +See [MoneroWalletRpc.createWallet()](https://woodser.github.io/monero-ts/typedocs/classes/MoneroWalletRpc.html#createWallet) for all options. ```typescript // create a client connected to monero-wallet-rpc @@ -29,7 +29,7 @@ await walletRpc.createWallet({ This example creates a wallet using WebAssembly bindings to [wallet2.h](https://github.com/monero-project/monero/blob/master/src/wallet/wallet2.h). -See [MoneroWalletFull.createWallet()](https://moneroecosystem.org/monero-ts/typedocs/classes/MoneroWalletFull.html#createWallet) for all options. +See [MoneroWalletFull.createWallet()](https://woodser.github.io/monero-ts/typedocs/classes/MoneroWalletFull.html#createWallet) for all options. ```typescript // create wallet using WebAssembly @@ -51,7 +51,7 @@ let wallet = await moneroTs.createWalletFull({ This example creates a keys-only wallet using WebAssembly bindings to monero-project/monero. -See [MoneroWalletKeys.createWallet()](https://moneroecosystem.org/monero-ts/typedocs/classes/MoneroWalletKeys.html#createWallet) for all options. +See [MoneroWalletKeys.createWallet()](https://woodser.github.io/monero-ts/typedocs/classes/MoneroWalletKeys.html#createWallet) for all options. ```typescript // create keys-only wallet diff --git a/docs/developer_guide/data_model.md b/docs/developer_guide/data_model.md index 67e45c25c..cbcab3731 100644 --- a/docs/developer_guide/data_model.md +++ b/docs/developer_guide/data_model.md @@ -2,11 +2,11 @@ ## Overview -This section introduces the data model used in monero-ts. Refer to the [API specification](https://moneroecosystem.org/monero-java/monero-spec.pdf) or [JSDocs](https://moneroecosystem.org/monero-ts/typedocs/classes/MoneroTxWallet.html) for more information. +This section introduces the data model used in monero-ts. Refer to the [API specification](https://woodser.github.io/monero-java/monero-spec.pdf) or [JSDocs](https://woodser.github.io/monero-ts/typedocs/classes/MoneroTxWallet.html) for more information.


- Blocks have transactions which can have incoming transfers, an outgoing transfer, and outputs. + Blocks have transactions which can have incoming transfers, an outgoing transfer, and outputs.

## JSON diff --git a/docs/developer_guide/getting_started_p1.md b/docs/developer_guide/getting_started_p1.md index 02d154ece..40c2cf409 100644 --- a/docs/developer_guide/getting_started_p1.md +++ b/docs/developer_guide/getting_started_p1.md @@ -2,7 +2,7 @@ ## What is monero-ts? -monero-ts is a TypeScript library for producing Monero applications. The library conforms to a [model and API specification](https://moneroecosystem.org/monero-java/monero-spec.pdf) which aims to be an intuitive and robust interface to [monero-project/monero](https://github.com/monero-project/monero). +monero-ts is a TypeScript library for producing Monero applications. The library conforms to a [model and API specification](https://woodser.github.io/monero-java/monero-spec.pdf) which aims to be an intuitive and robust interface to [monero-project/monero](https://github.com/monero-project/monero). In addition to RPC wallet and daemon server queries, monero-ts can perform native wallet operations through WebAssembly (Wasm). The Wasm wallet enables developers to build trustless, client-side applications by eliminating the need to communicate with a RPC wallet server intermediary. @@ -54,14 +54,14 @@ Note the program's two components: ### Building a keys-only wallet -monero-javscript implements keys-only wallets in the [MoneroWalletKeys](https://moneroecosystem.org/monero-ts/typedocs/classes/MoneroWalletKeys.html) class. You can create a random keys-only wallet as follows: +monero-javscript implements keys-only wallets in the [MoneroWalletKeys](https://woodser.github.io/monero-ts/typedocs/classes/MoneroWalletKeys.html) class. You can create a random keys-only wallet as follows: ```typescript // create a random keys-only (offline) stagenet wallet import * as moneroTs from "monero-ts"; let keysOnlyWallet = await moneroTs.createWalletKeys({networkType: moneroTs.MoneroNetworkType.STAGENET, language: "English"}); ``` -Wallets are created with a [MoneroWalletConfig](https://moneroecosystem.org/monero-ts/typedocs/classes/MoneroWalletConfig) or equivalent JSON object. The monero-ts library will create or restore a wallet based on attributes defined in the configuration or throw an error if any attributes are invalid. For example, a configuration that defines a view key but not a spend key will prompt the library to create a view-only wallet. The configuration object in the offline wallet generator code above contains no keys, so monero-ts generates a new, random wallet rather than restoring an existing wallet. +Wallets are created with a [MoneroWalletConfig](https://woodser.github.io/monero-ts/typedocs/classes/MoneroWalletConfig) or equivalent JSON object. The monero-ts library will create or restore a wallet based on attributes defined in the configuration or throw an error if any attributes are invalid. For example, a configuration that defines a view key but not a spend key will prompt the library to create a view-only wallet. The configuration object in the offline wallet generator code above contains no keys, so monero-ts generates a new, random wallet rather than restoring an existing wallet. The offline wallet generator displays four basic wallet attributes: * The seed phrase diff --git a/docs/developer_guide/query_data_model.md b/docs/developer_guide/query_data_model.md index 0a021b165..edc3b8f22 100644 --- a/docs/developer_guide/query_data_model.md +++ b/docs/developer_guide/query_data_model.md @@ -4,7 +4,7 @@ Wallet [transactions, transfers, and outputs](data_model.md) can be queried by t ## Getting transactions with queries -See [MoneroWallet.getTxs()](https://moneroecosystem.org/monero-ts/typedocs/classes/MoneroWallet.html#getTxs) for all query options. +See [MoneroWallet.getTxs()](https://woodser.github.io/monero-ts/typedocs/classes/MoneroWallet.html#getTxs) for all query options. ```typescript // get a transaction by hash @@ -43,7 +43,7 @@ let txs = await wallet.getTxs({ ## Getting transfers with queries -See [MoneroWallet.getTransfers()](https://moneroecosystem.org/monero-ts/typedocs/classes/MoneroWallet.html#getTransfers) for all query options. +See [MoneroWallet.getTransfers()](https://woodser.github.io/monero-ts/typedocs/classes/MoneroWallet.html#getTransfers) for all query options. ```typescript // get all transfers @@ -81,7 +81,7 @@ let transfers = await wallet.getTransfers({ ## Getting outputs with queries -See [MoneroWallet.getOutputs()](https://moneroecosystem.org/monero-ts/typedocs/classes/MoneroWallet.html#getOutputs) for all query options. +See [MoneroWallet.getOutputs()](https://woodser.github.io/monero-ts/typedocs/classes/MoneroWallet.html#getOutputs) for all query options. ```typescript // get all outputs diff --git a/docs/developer_guide/sending_funds.md b/docs/developer_guide/sending_funds.md index a820e1c44..fa21320b4 100644 --- a/docs/developer_guide/sending_funds.md +++ b/docs/developer_guide/sending_funds.md @@ -1,6 +1,6 @@ # Sending funds -The following are examples of sending funds using monero-ts. See [MoneroTxConfig](https://moneroecosystem.org/monero-ts/typedocs/classes/MoneroTxConfig.html) for all options. +The following are examples of sending funds using monero-ts. See [MoneroTxConfig](https://woodser.github.io/monero-ts/typedocs/classes/MoneroTxConfig.html) for all options. ```typescript // create a transaction to send funds to an address, but do not relay