Skip to content

Commit

Permalink
* restructured lang user-defined-types
Browse files Browse the repository at this point in the history
* fixed broken links
  • Loading branch information
christianschmitz committed Oct 6, 2023
1 parent 8c24417 commit abb1bca
Show file tree
Hide file tree
Showing 124 changed files with 241 additions and 3,454 deletions.
2 changes: 1 addition & 1 deletion book.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ authors = ["Daniel Onyesoh", "Christian Schmitz"]
language = "en"
multilingual = false
src = "src"
title = "The Helios Smart Contract Language"
title = "Helios"

[build]
build-dir = "book"
Expand Down
8 changes: 4 additions & 4 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
"author": "",
"license": "ISC",
"dependencies": {
"@hyperionbt/helios": "^0.15.10",
"@hyperionbt/helios": "^0.15.12",
"@jsdoc/ast": "^0.2.1",
"@jsdoc/parse": "^0.3.1",
"typedoc": "^0.24.8",
Expand Down
67 changes: 33 additions & 34 deletions src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,17 +21,18 @@
- [Function values](./lang/functions/values.md)
- [Example: Collatz sequence](./lang/functions/example.md)
- [Operators](./lang/operators.md)
- [Structs](./lang/structs.md)
- [Enums](./lang/enums.md)
- [Destructuring](./lang/destructuring.md)
- [Methods](./lang/methods.md)
- [Associated functions and constants](./lang/associated-functions-and-constants.md)
- [Automatic methods](./lang/automatic-methods.md)
- [Example: Rational](./lang/example-rational.md)
- [User-defined types](./lang/user-defined-types/index.md)
- [Structs](./lang/user-defined-types/structs.md)
- [Enums](./lang/user-defined-types/enums.md)
- [Destructuring](./lang/user-defined-types/destructuring.md)
- [Methods](./lang/user-defined-types/methods/index.md)
- [Associated functions and constants](./lang/user-defined-types/methods/associated-functions-and-constants.md)
- [Automatic methods](./lang/user-defined-types/methods/automatic-methods.md)
- [Example: Rational](./lang/user-defined-types/methods/example-rational.md)
- [Generics](./lang/generics.md)
- [Structure of a script](./lang/script-structure.md)
- [Example: `always_succeeds`](./lang/example-script.md)
- [Contract Parameters](./lang/parameterized.md)
- [Structure of a script](./lang/script-structure/index.md)
- [Example: `always_succeeds`](./lang/script-structure/example-script.md)
- [Contract Parameters](./lang/script-structure/parameterized.md)
- [Modules](./lang/modules.md)
- [Builtins](./lang/builtins/index.md)
- [Address](./lang/builtins/address.md)
Expand All @@ -56,7 +57,6 @@
- [ScriptContext](./lang/builtins/scriptcontext.md)
- [ScriptHash](./lang/builtins/scripthash.md)
- [ScriptPurpose](./lang/builtins/scriptpurpose.md)
- [StakeKeyHash](./lang/builtins/stakekeyhash.md)
- [StakingCredential](./lang/builtins/stakingcredential.md)
- [StakingHash](./lang/builtins/stakinghash.md)
- [StakingPurpose](./lang/builtins/stakingpurpose.md)
Expand All @@ -74,8 +74,8 @@
- [Value](./lang/builtins/value.md)

- [Helios API](./api/index.md)
- [Setup](./api/setup.md)
- [Deno](./api/deno.md)
- [Setup](./api/setup/index.md)
- [Deno](./api/setup/deno.md)
- [Compiling Helios sources](./api/compiling.md)
- [Generating datums and redeemers](./api/generating.md)
- [Building transactions](./api/building/index.md)
Expand All @@ -95,28 +95,27 @@
- [Buying for-sale assets](./api/picoswap/buying.md)

- [Helios CLI](./cli/index.md)
- [Setup](./cli/setup.md)
- [Install helios-cli](./cli/install.md)
- [Setup cardano-node](./cli/cardano-node.md)
- [Wallet setup](./cli/wallet.md)
- [Setup](./cli/setup/index.md)
- [Install helios-cli](./cli/setup/install.md)
- [Setup cardano-node](./cli/setup/cardano-node.md)
- [Wallet setup](./cli/setup/wallet.md)
- [Using helios-cli](./cli/usage.md)
- [Example: Always succeeds](./cli/example-always-succeeds.md)
- [Example: Time lock](./cli/example-time-lock.md)

- [Integrations](./integrations/index.md)
- [Different versions of Helios](./integrations/different-versions.md)
- [VSCode](./integrations/vscode.md)
- [Webpack](./integrations/webpack.md)

- [Advanced concepts](./advanced-concepts/index.md)
- [Exploits](./advanced-concepts/exploits.md)
- [Intermediate representation](./advanced-concepts/ir/index.md)
- [Simplification](./advanced-concepts/ir/simplification.md)
- [Minting native assets](./advanced-concepts/minting/index.md)
- [Signature based minting](./advanced-concepts/minting/signature.md)
- [Unique minting](./advanced-concepts/minting/unique.md)
- [Vesting contract](./advanced-concepts/vesting-contract.md)
- [English auction](./advanced-concepts/english-auction.md)
- [Oracle pools](./advanced-concepts/oracle-pools.md)
- [dApp recommendations](./advanced-concepts/dapps.md)
- [Tx finalization](./advanced-concepts/tx-finalization.md)
- [Further reading](./further-reading/index.md)
- [Integrations](./further-reading/integrations/index.md)
- [Different versions of Helios](./further-reading/integrations/different-versions.md)
- [VSCode](./further-reading/integrations/vscode.md)
- [Webpack](./further-reading/integrations/webpack.md)
- [Exploits](./further-reading/exploits.md)
- [Intermediate representation](./further-reading/ir/index.md)
- [Simplification](./further-reading/ir/simplification.md)
- [Minting native assets](./further-reading/minting/index.md)
- [Signature based minting](./further-reading/minting/signature.md)
- [Unique minting](./further-reading/minting/unique.md)
- [Vesting contract](./further-reading/vesting-contract.md)
- [English auction](./further-reading/english-auction.md)
- [Oracle pools](./further-reading/oracle-pools.md)
- [dApp recommendations](./further-reading/dapps.md)
- [Tx finalization](./further-reading/tx-finalization.md)
5 changes: 0 additions & 5 deletions src/advanced-concepts/index.md

This file was deleted.

2 changes: 1 addition & 1 deletion src/api/building/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import * as helios from "helios"

## `Tx`

A new [`Tx`](../reference/tx.md) instance acts as a transaction builder, using builder pattern methods.
A new [`Tx`](../reference/classes/Tx.md) instance acts as a transaction builder, using builder pattern methods.

```js
const tx = new helios.Tx()
Expand Down
2 changes: 1 addition & 1 deletion src/api/generating.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ const MY_DATUM = Datum {
}`
```

Remember that after the `main` function you can define data generators and test functions (see [script structure](../lang/script-structure.md)).
Remember that after the `main` function you can define data generators and test functions (see [script structure](../lang/script-structure/index.md)).

`MY_DATUM` in this example can be evaluated using the API:

Expand Down
115 changes: 0 additions & 115 deletions src/api/reference/address.md

This file was deleted.

35 changes: 0 additions & 35 deletions src/api/reference/assetclass.md

This file was deleted.

26 changes: 0 additions & 26 deletions src/api/reference/assets.md

This file was deleted.

48 changes: 0 additions & 48 deletions src/api/reference/blockfrostv0.md

This file was deleted.

Loading

0 comments on commit abb1bca

Please sign in to comment.