Merging with master

FuelLabs · May 26, 2023 · 6623a50 · 6623a50
2 parents 7ef1364 + 0b3c342
commit 6623a50
Show file tree

Hide file tree

Showing 37 changed files with 1,137 additions and 184 deletions.
diff --git a/.changeset/flat-coats-swim.md b/.changeset/flat-coats-swim.md
@@ -0,0 +1,5 @@
+---
+"@fuel-ts/providers": patch
+---
+
+fix: inputify should accept string for data prop (0x for instance)
diff --git a/.changeset/two-terms-type.md b/.changeset/two-terms-type.md
@@ -0,0 +1,2 @@
+---
+---
diff --git a/.github/workflows/md-lint.yaml b/.github/workflows/md-lint.yaml
@@ -0,0 +1,26 @@
+name: "Lint markdown files"
+
+on:
+  pull_request:
+    types:
+      - opened
+      - edited
+      - synchronize
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  markdown-link-check:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: CI Setup
+        uses: ./.github/actions/ci-setup
+
+      - name: Lint markdown files
+        run: pnpm lint:md-links
diff --git a/.textlintrc.json b/.textlintrc.json
@@ -0,0 +1,10 @@
+{
+  "plugins": {},
+  "filters": {},
+  "rules": {
+    "no-dead-link": {
+      "ignoreRedirects": true,
+      "checkRelative": false
+    }
+  }
+}
diff --git a/package.json b/package.json
@@ -19,6 +19,7 @@
     "lint": "run-s lint:check prettier:check",
     "lint:check": "eslint . --ext .ts --cache --cache-location=./.husky/.lintcache/eslint",
     "lint:fix": "pnpm lint:check -- --fix",
+    "lint:md-links": "tsx ./scripts/lint-md-links",
     "prettier:check": "prettier --check --cache --cache-location=./.husky/.lintcache/prettier packages",
     "prettier:format": "prettier --write packages",
     "services:run": "pnpm docker:run:bg",
@@ -76,16 +77,16 @@
     "eslint-plugin-tsdoc": "^0.2.17",
     "ethers": "^5.7.2",
     "forc-bin": "workspace:*",
+    "glob": "^10.2.6",
     "husky": "^8.0.3",
     "jest": "^29.5.0",
     "jest-text-transformer": "^1.0.4",
-    "markdownlint": "^0.23.1",
-    "markdownlint-cli": "^0.27.1",
-    "nodemon": "^2.0.22",
     "npm-run-all": "^4.1.5",
     "open": "^8.4.0",
     "prettier": "^2.7.1",
     "shelljs": "^0.8.5",
+    "textlint": "^13.3.2",
+    "textlint-rule-no-dead-link": "^5.1.2",
     "ts-generator": "^0.1.1",
     "ts-jest": "^29.0.3",
     "tsup": "^5.12.9",

diff --git a/packages/abi-coder/README.md b/packages/abi-coder/README.md
@@ -2,7 +2,7 @@
 
 **@fuel-ts/abi-coder** is a sub-module for interacting with **Fuel**.
 
-This module is responsible for encoding and decoding the Application Binary Interface (ABI) used by most smart contracts to interoperate between other smart contracts and clients. The ABI being encoded and decoded is specified [here](https://github.com/FuelLabs/fuel-specs/blob/master/specs/protocol/abi.md).
+This module is responsible for encoding and decoding the Application Binary Interface (ABI) used by most smart contracts to interoperate between other smart contracts and clients. The ABI being encoded and decoded is specified [here](https://github.com/FuelLabs/fuel-specs/blob/master/src/protocol/abi/index.md).
 
 # Table of contents
 
@@ -16,7 +16,9 @@ This module is responsible for encoding and decoding the Application Binary Inte
 
 ## Documentation
 
-See [Fuel-ts Documentation](https://fuellabs.github.io/fuels-ts/packages/fuel-ts-abi-coder/)
+<!-- TODO: Replace this link with specific docs for this package if and when we re-introduce a API reference section to our docs -->
+
+See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/)
 
 ## Usage
 

diff --git a/packages/abi-typegen/README.md b/packages/abi-typegen/README.md
@@ -17,7 +17,7 @@ See the full ABI-spec [here](https://github.com/FuelLabs/fuel-specs/blob/master/
 
 ## Documentation
 
-See [Fuel-ts Documentation](https://fuellabs.github.io/fuels-ts/packages/fuel-ts-abi-typegen/)
+See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/guide/abi-typegen/)
 
 ## Installation
 

diff --git a/packages/abi-typegen/package.json b/packages/abi-typegen/package.json
@@ -65,15 +65,14 @@
     "@fuel-ts/utils": "workspace:*",
     "@fuel-ts/versions": "workspace:*",
     "commander": "^9.4.1",
-    "glob": "^8.0.3",
+    "glob": "^10.2.6",
     "handlebars": "^4.7.7",
     "lodash.uniq": "^4.5.0",
     "lodash.upperfirst": "^4.3.1",
     "mkdirp": "^1.0.4",
     "rimraf": "^3.0.2"
   },
   "devDependencies": {
-    "@types/glob": "^8.0.0",
     "@types/lodash.uniq": "^4.5.7",
     "@types/lodash.upperfirst": "^4.3.7",
     "@types/mkdirp": "^1.0.2",

diff --git a/packages/abi-typegen/src/runTypegen.test.ts b/packages/abi-typegen/src/runTypegen.test.ts
@@ -1,6 +1,6 @@
 import { safeExec } from '@fuel-ts/utils/test';
 import { existsSync } from 'fs';
-import { sync as globSync } from 'glob';
+import { globSync } from 'glob';
 import { join } from 'path';
 // eslint-disable-next-line import/no-extraneous-dependencies
 import shelljs from 'shelljs';

diff --git a/packages/abi-typegen/src/runTypegen.ts b/packages/abi-typegen/src/runTypegen.ts
@@ -1,5 +1,5 @@
 import { readFileSync, writeFileSync } from 'fs';
-import { sync as globSync } from 'glob';
+import { globSync } from 'glob';
 import mkdirp from 'mkdirp';
 import { basename } from 'path';
 import rimraf from 'rimraf';

diff --git a/packages/address/README.md b/packages/address/README.md
@@ -16,7 +16,7 @@ This module contains the utilities for encoding and decoding address and contrac
 
 ## Documentation
 
-See [Fuel-ts Documentation](https://fuellabs.github.io/fuels-ts/packages/fuel-ts-address/)
+See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/guide/types/address.html)
 
 ## Usage
 

diff --git a/packages/asm/README.md b/packages/asm/README.md
@@ -16,7 +16,9 @@ This module is responsible for tools to generate an instruction set for the Fuel
 
 ## Documentation
 
-See [Fuel-ts Documentation](https://fuellabs.github.io/fuels-ts/packages/fuel-ts-asm/)
+<!-- TODO: Replace this link with specific docs for this package if and when we re-introduce a API reference section to our docs -->
+
+See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/)
 
 ## Usage
 

diff --git a/packages/contract/README.md b/packages/contract/README.md
@@ -16,7 +16,7 @@ This module allows for a simple way to serialize calls and transactions to an on
 
 ## Documentation
 
-See [Fuel-ts Documentation](https://fuellabs.github.io/fuels-ts/packages/fuel-ts-contract/)
+See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/guide/contracts/)
 
 ## Usage
 

diff --git a/packages/hasher/README.md b/packages/hasher/README.md
@@ -16,7 +16,9 @@ This module contains several common hashing utilities.
 
 ## Documentation
 
-See [Fuel-ts Documentation](https://fuellabs.github.io/fuels-ts/packages/fuel-ts-hasher/)
+<!-- TODO: Replace this link with specific docs for this package if and when we re-introduce a API reference section to our docs -->
+
+See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/)
 
 ## Usage
 

diff --git a/packages/hdwallet/README.md b/packages/hdwallet/README.md
@@ -16,7 +16,9 @@ This module is an implementation of the BIP-0044 and BIP-0032, Multi-Account Hie
 
 ## Documentation
 
-See [Fuel-ts Documentation](https://fuellabs.github.io/fuels-ts/packages/fuel-ts-hdwallet/)
+<!-- TODO: Replace this link with specific docs for this package if and when we re-introduce a API reference section to our docs -->
+
+See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/)
 
 ## Usage
 

diff --git a/packages/interfaces/README.md b/packages/interfaces/README.md
@@ -16,7 +16,9 @@ This module contains utilities to manipulate binary data and can be used to help
 
 ## Documentation
 
-See [Fuel-ts Documentation](https://fuellabs.github.io/fuels-ts/packages/fuel-ts-interfaces/)
+<!-- TODO: Replace this link with specific docs for this package if and when we re-introduce a API reference section to our docs -->
+
+See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/)
 
 ## Usage
 

diff --git a/packages/keystore/README.md b/packages/keystore/README.md
@@ -16,7 +16,9 @@ This module contains the utilities for encrypting and decrypting data objects us
 
 ## Documentation
 
-See [Fuel-ts Documentation](https://fuellabs.github.io/fuels-ts/packages/fuel-ts-keystore/)
+<!-- TODO: Replace this link with specific docs for this package if and when we re-introduce a API reference section to our docs -->
+
+See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/)
 
 ## Usage
 

diff --git a/packages/math/README.md b/packages/math/README.md
@@ -18,7 +18,9 @@ Math is based in [bn.js](https://www.npmjs.com/package/bn.js) library, which hel
 
 ## Documentation
 
-See [Fuel-ts Documentation](https://fuellabs.github.io/fuels-ts/packages/fuel-ts-math/)
+<!-- TODO: Replace this link with specific docs for this package if and when we re-introduce a API reference section to our docs -->
+
+See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/)
 
 ## Usage
 

diff --git a/packages/merkle-shared/README.md b/packages/merkle-shared/README.md
@@ -16,7 +16,9 @@ This module contains shared utilities for testing and deploying merkle trees.
 
 ## Documentation
 
-See [Fuel-ts Documentation](https://fuellabs.github.io/fuels-ts/packages/fuel-ts-merkle-shared/)
+<!-- TODO: Replace this link with specific docs for this package if and when we re-introduce a API reference section to our docs -->
+
+See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/)
 
 ## Usage
 

diff --git a/packages/merkle/README.md b/packages/merkle/README.md
@@ -16,7 +16,9 @@ This module contains the utilities for working with binary merkle trees.
 
 ## Documentation
 
-See [Fuel-ts Documentation](https://fuellabs.github.io/fuels-ts/packages/fuel-ts-merkle/)
+<!-- TODO: Replace this link with specific docs for this package if and when we re-introduce a API reference section to our docs -->
+
+See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/)
 
 ## Usage
 

diff --git a/packages/merklesum/README.md b/packages/merklesum/README.md
@@ -16,7 +16,9 @@ This module contains the utilities for computing merkle tree roots.
 
 ## Documentation
 
-See [Fuel-ts Documentation](https://fuellabs.github.io/fuels-ts/packages/fuel-ts-merklesum/)
+<!-- TODO: Replace this link with specific docs for this package if and when we re-introduce a API reference section to our docs -->
+
+See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/)
 
 ## Usage
 

diff --git a/packages/mnemonic/README.md b/packages/mnemonic/README.md
@@ -16,7 +16,9 @@ This module contains utilities to import and export BIP 39 mnemonic phrases in c
 
 ## Documentation
 
-See [Fuel-ts Documentation](https://fuellabs.github.io/fuels-ts/packages/fuel-ts-mnemonic/)
+<!-- TODO: Replace this link with specific docs for this package if and when we re-introduce a API reference section to our docs -->
+
+See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/)
 
 ## Usage
 

diff --git a/packages/predicate/README.md b/packages/predicate/README.md
@@ -16,7 +16,7 @@ This module allows for a simple way to serialize calls to an on-chain predicate
 
 ## Documentation
 
-See [Fuel-ts Documentation](https://fuellabs.github.io/fuels-ts/packages/fuel-ts-predicate/)
+See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/guide/predicates/)
 
 ## Usage
 

diff --git a/packages/program/README.md b/packages/program/README.md
@@ -16,7 +16,9 @@ This module allows for a simple way to serialize calls and transactions to Sway
 
 ## Documentation
 
-See [Fuel-ts Documentation](https://fuellabs.github.io/fuels-ts/packages/fuel-ts-program/)
+<!-- TODO: Replace this link with specific docs for this package if and when we re-introduce a API reference section to our docs -->
+
+See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/)
 
 ## Usage
 

diff --git a/packages/providers/README.md b/packages/providers/README.md
@@ -16,7 +16,7 @@ This module contains common Provider classes and utility functions for connectin
 
 ## Documentation
 
-See [Fuel-ts Documentation](https://fuellabs.github.io/fuels-ts/packages/fuel-ts-providers/)
+See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/guide/providers/)
 
 ## Usage
 

diff --git a/packages/providers/src/transaction-request/input.ts b/packages/providers/src/transaction-request/input.ts
@@ -122,17 +122,18 @@ export const inputify = (value: TransactionRequestInput): Input => {
     case InputType.Message: {
       const predicate = arrayify(value.predicate ?? '0x');
       const predicateData = arrayify(value.predicateData ?? '0x');
+      const data = arrayify(value.data ?? '0x');
       return {
         type: InputType.Message,
         sender: hexlify(value.sender),
         recipient: hexlify(value.recipient),
         amount: bn(value.amount),
         nonce: bn(value.nonce),
         witnessIndex: value.witnessIndex,
-        dataLength: value.data.length,
+        dataLength: data.length,
         predicateLength: predicate.length,
         predicateDataLength: predicateData.length,
-        data: hexlify(value.data),
+        data: hexlify(data),
         predicate: hexlify(predicate),
         predicateData: hexlify(predicateData),
       };

diff --git a/packages/signer/README.md b/packages/signer/README.md
@@ -16,7 +16,9 @@ This module containts utilities for secp256-k1 signing, verifying and recovery o
 
 ## Documentation
 
-See [Fuel-ts Documentation](https://fuellabs.github.io/fuels-ts/packages/fuel-ts-signer/)
+<!-- TODO: Replace this link with specific docs for this package if and when we re-introduce a API reference section to our docs -->
+
+See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/)
 
 ## Usage
 

diff --git a/packages/sparsemerkle/README.md b/packages/sparsemerkle/README.md
@@ -16,7 +16,9 @@ This module contains utilities for working with sparse merkle trees to help prov
 
 ## Documentation
 
-See [Fuel-ts Documentation](https://fuellabs.github.io/fuels-ts/packages/fuel-ts-sparsemerkle/)
+<!-- TODO: Replace this link with specific docs for this package if and when we re-introduce a API reference section to our docs -->
+
+See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/)
 
 ## Usage
 

diff --git a/packages/testcases/README.md b/packages/testcases/README.md
@@ -16,7 +16,9 @@ This module contains the testcases used to verify various Fuel operations and SD
 
 ## Documentation
 
-See [Fuel-ts Documentation](https://fuellabs.github.io/fuels-ts/packages/fuel-ts-testcases/)
+<!-- TODO: Replace this link with specific docs for this package if and when we re-introduce a API reference section to our docs -->
+
+See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/)
 
 ## Usage
 

diff --git a/packages/transactions/README.md b/packages/transactions/README.md
@@ -16,7 +16,9 @@ This module contains various constants and functions for encoding and decoding s
 
 ## Documentation
 
-See [Fuel-ts Documentation](https://fuellabs.github.io/fuels-ts/packages/fuel-ts-transactions/)
+<!-- TODO: Replace this link with specific docs for this package if and when we re-introduce a API reference section to our docs -->
+
+See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/)
 
 ## Usage
 

diff --git a/packages/utils/README.md b/packages/utils/README.md
@@ -16,7 +16,9 @@ It's a collection of utilities and test utilities that may be useful in other pl
 
 ## Documentation
 
-See [Fuel-ts Documentation](https://fuellabs.github.io/fuels-ts/packages/fuel-ts-utils/)
+<!-- TODO: Replace this link with specific docs for this package if and when we re-introduce a API reference section to our docs -->
+
+See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/)
 
 ## Installation
 

diff --git a/packages/versions/README.md b/packages/versions/README.md
@@ -24,7 +24,9 @@ Aditionally, the library can be used as a CLI tool to help checking/validating u
 
 ## Documentation
 
-See [Fuel-ts Documentation](https://fuellabs.github.io/fuels-ts/packages/fuel-ts-versions/)
+<!-- TODO: Replace this link with specific docs for this package if and when we re-introduce a API reference section to our docs -->
+
+See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/)
 
 ## Installation
 

diff --git a/packages/wallet-manager/README.md b/packages/wallet-manager/README.md
@@ -16,7 +16,9 @@ This module is a coordination wrapper to manage multiple wallet `Vaults` and sto
 
 ## Documentation
 
-See [Fuel-ts Documentation](https://fuellabs.github.io/fuels-ts/packages/fuel-ts-wallet-manager/)
+<!-- TODO: Replace this link with specific docs for this package if and when we re-introduce a API reference section to our docs -->
+
+See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/)
 
 ## Usage
 

diff --git a/packages/wallet/README.md b/packages/wallet/README.md
@@ -16,7 +16,7 @@ This module contains the class to manage a private key and signing for a standar
 
 ## Documentation
 
-See [Fuel-ts Documentation](https://fuellabs.github.io/fuels-ts/packages/fuel-ts-wallet/)
+See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/guide/wallets/)
 
 ## Usage