Skip to content

Commit

Permalink
doc
Browse files Browse the repository at this point in the history
  • Loading branch information
ty-everett committed Feb 22, 2025
1 parent 769ed84 commit 8bd88ba
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 6 deletions.
12 changes: 11 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ All notable changes to this project will be documented in this file. The format
## Table of Contents

- [Unreleased](#unreleased)
- [1.3.23 - 2025-02-19](#1323---2025-02-21)
- [1.3.24 - 2025-02-22](#1324---2025-02-22)
- [1.3.23 - 2025-02-21](#1323---2025-02-21)
- [1.3.22 - 2025-02-19](#1322---2025-02-19)
- [1.3.21 - 2025-02-17](#1321---2025-02-17)
- [1.3.20- 2025-02-11](#1320---2025-02-17)
Expand Down Expand Up @@ -89,12 +90,21 @@ All notable changes to this project will be documented in this file. The format

---

## [1.3.24] - 2025-02-22

### Added

- Originator support to PushDrop template

---

## [1.3.23] - 2025-02-21

### Fixed

- Fixed a bug with SHIPCast's default configuration.

---

## [1.3.22] - 2025-02-19

Expand Down
6 changes: 3 additions & 3 deletions docs/overlay-tools.md
Original file line number Diff line number Diff line change
Expand Up @@ -262,7 +262,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
| [HTTPSOverlayLookupFacilitator](#class-httpsoverlaylookupfacilitator) |
| [LookupResolver](#class-lookupresolver) |
| [OverlayAdminTokenTemplate](#class-overlayadmintokentemplate) |
| [SHIPCast](#class-shipcast) |
| [SHIPBroadcaster](#class-shipbroadcaster) |

Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)

Expand Down Expand Up @@ -430,12 +430,12 @@ Argument Details
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)

---
### Class: SHIPCast
### Class: SHIPBroadcaster

Represents a SHIP transaction broadcaster.

```ts
export default class SHIPCast implements Broadcaster {
export default class SHIPBroadcaster implements Broadcaster {
constructor(topics: string[], config?: SHIPBroadcasterConfig)
async broadcast(tx: Transaction): Promise<BroadcastResponse | BroadcastFailure>
}
Expand Down
7 changes: 5 additions & 2 deletions docs/script.md
Original file line number Diff line number Diff line change
Expand Up @@ -211,11 +211,12 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
```ts
export default class PushDrop implements ScriptTemplate {
wallet: WalletInterface;
originator?: string;
static decode(script: LockingScript): {
lockingPublicKey: PublicKey;
fields: number[][];
}
constructor(wallet: WalletInterface)
constructor(wallet: WalletInterface, originator?: string)
async lock(fields: number[][], protocolID: [
SecurityLevel,
string
Expand All @@ -237,14 +238,16 @@ See also: [LockingScript](./script.md#class-lockingscript), [PublicKey](./primit
Constructs a new instance of the PushDrop class.

```ts
constructor(wallet: WalletInterface)
constructor(wallet: WalletInterface, originator?: string)
```
See also: [WalletInterface](./wallet.md#interface-walletinterface)

Argument Details

+ **wallet**
+ The wallet interface used for creating signatures and accessing public keys.
+ **originator**
+ — The originator to use with Wallet requests

#### Method decode

Expand Down

0 comments on commit 8bd88ba

Please sign in to comment.