Skip to content

Commit

Permalink
update links to documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
woodser committed Jan 20, 2024
1 parent f62e36a commit 0c875ea
Show file tree
Hide file tree
Showing 7 changed files with 18 additions and 18 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -28,7 +28,7 @@ A TypeScript library for creating Monero applications using RPC and WebAssembly

<p align="center">
<img width="85%" height="auto" src="https://raw.githubusercontent.com/monero-ecosystem/monero-ts/master/docs/img/architecture.png"/><br>
<i>Build browser or Node.js applications using RPC or WebAssembly bindings to <a href="https://github.com/monero-project/monero">monero-project/monero</a>. Wallet implementations are interchangeable by conforming to a common interface, <a href="https://moneroecosystem.org/monero-ts/typedocs/classes/MoneroWallet.html">MoneroWallet.ts</a>.</i>
<i>Build browser or Node.js applications using RPC or WebAssembly bindings to <a href="https://github.com/monero-project/monero">monero-project/monero</a>. Wallet implementations are interchangeable by conforming to a common interface, <a href="https://woodser.github.io/monero-ts/typedocs/classes/MoneroWallet.html">MoneroWallet.ts</a>.</i>
</p>

## Sample code
Expand Down Expand Up @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion docs/developer_guide/connection_manager.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
6 changes: 3 additions & 3 deletions docs/developer_guide/creating_wallets.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/developer_guide/data_model.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<p align="center">
<img width="65%" height="auto" src="../img/data_model.png"/><br>
<i><a href="https://moneroecosystem.org/monero-ts/typedocs/classes/MoneroBlock.html">Blocks</a> have <a href="https://moneroecosystem.org/monero-ts/typedocs/classes/MoneroTxWallet.html">transactions</a> which can have <a href="https://moneroecosystem.org/monero-ts/typedocs/classes/MoneroIncomingTransfer.html">incoming transfers</a>, an <a href="https://moneroecosystem.org/monero-ts/typedocs/classes/MoneroOutgoingTransfer.html">outgoing transfer</a>, and <a href="https://moneroecosystem.org/monero-ts/typedocs/classes/MoneroOutputWallet.html">outputs</a>.</i>
<i><a href="https://woodser.github.io/monero-ts/typedocs/classes/MoneroBlock.html">Blocks</a> have <a href="https://woodser.github.io/monero-ts/typedocs/classes/MoneroTxWallet.html">transactions</a> which can have <a href="https://woodser.github.io/monero-ts/typedocs/classes/MoneroIncomingTransfer.html">incoming transfers</a>, an <a href="https://woodser.github.io/monero-ts/typedocs/classes/MoneroOutgoingTransfer.html">outgoing transfer</a>, and <a href="https://woodser.github.io/monero-ts/typedocs/classes/MoneroOutputWallet.html">outputs</a>.</i>
</p>

## JSON
Expand Down
6 changes: 3 additions & 3 deletions docs/developer_guide/getting_started_p1.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions docs/developer_guide/query_data_model.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/developer_guide/sending_funds.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down

0 comments on commit 0c875ea

Please sign in to comment.