# xrpl-hooks-api-assembly-script

> XRPL hooks API exports that you can import into your XRPL hooks project written in AssemblyScript.

Latest version **0.2.9** (published 2021-09-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install xrpl-hooks-api-assembly-script
pnpm add xrpl-hooks-api-assembly-script
yarn add xrpl-hooks-api-assembly-script
bun add xrpl-hooks-api-assembly-script
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.9 |
| Published | 2021-09-29 |
| First published | 2021-09-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 24 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Jay Grissom |
| Maintainers | jfgrissom |
| Keywords | xrpl, hooks, assemblyscript |

## Links

- npm: https://www.npmjs.com/package/xrpl-hooks-api-assembly-script
- Repository: https://github.com/jfgrissom/xrpl-hooks-api-assembly-script
- Homepage: https://github.com/jfgrissom/xrpl-hooks-api-assembly-script#readme
- Issues: https://github.com/jfgrissom/xrpl-hooks-api-assembly-script/issues
- npm.io page: https://npm.io/package/xrpl-hooks-api-assembly-script

## Recent versions

- 0.2.9 (latest) — 2021-09-29
- 0.2.8 — 2021-09-29
- 0.2.7 — 2021-09-29
- 0.2.6 — 2021-09-29
- 0.2.5 — 2021-09-27
- 0.2.4 — 2021-09-26
- 0.2.3 — 2021-09-26
- 0.2.2-dev — 2021-09-26
- 0.2.1-dev — 2021-09-26
- 0.2.0 — 2021-09-26
- 0.1.15 — 2021-09-25
- 0.1.13-dev — 2021-09-25
- 0.1.12-dev — 2021-09-25
- 0.1.11-dev — 2021-09-25
- 0.1.10-dev — 2021-09-25
- … 8 more at https://npm.io/package/xrpl-hooks-api-assembly-script/versions

## README

# XRPL Hooks API for AssemblyScript

XRPL hooks API exports that you can import into your hooks project written in AssemblyScript.

While this is currently working, please understand this repo is currently a work in progress. It's likely to be broken for versions prior to 1.0.0. Thanks for your patience. Contact info below if you're having trouble.

## Background

This was created based on the work done by <a href="https://github.com/XRPL-Labs/xrpld-hooks/commits?author=RichardAH" target="_blank">RichardAH</a>. He has done some great work for XRPL hooks in C and I wanted to try writing my XRPL Hooks in AssemblyScript.

The contents of this lib are based on the headers he created that represent the <a href="https://github.com/XRPL-Labs/xrpld-hooks/blob/hooks-chaining/hook-api-examples/hookapi.h" target="_blank">XRPL Hooks API</a>.

Of course the folks at <a href="https://xrpl-labs.com/" target="_blank">XRPL-Labs</a> an many other developers in the #XrpCommunity were a super help too!

## XRPL Hooks Docs

- <a href="https://github.com/XRPL-Hackathon-2021/hooks-liquidity-pool/blob/master/README.md" target="_blank">Getting setup to use hooks in your local development environment</a>.
- <a href="https://xrpl-hooks.readme.io/" target="_blank">Learn more about XRPL hooks</a>.
- <a href="https://xrpl-hooks.readme.io/reference/hook-api-conventions" target="_blank">Learn more about the API that these declarations provide access to</a>.
- <a href="https://xrpl-hooks.readme.io/docs/loops-and-guarding" target="_blank">Learn more about the GUARD (\_g) function passed from the XRPL to your compiled binary here</a>.

## Usage

1. Pull the library into your project.

   ```
   # From a terminal in the root of your project
   npm i xrpl-hooks-api-assembly-script -D
   ```

1. import the declarations you want to use into your source code.

   ```
   # assembly/index.ts
   import { _g as GUARD } from '../node_modules/xrpl-hooks-api-assembly-script/dist'
   ```

1. Use the new declaration in your hook or cback functions.

   ```
   # assembly/index.ts
   export function hook(reserved: i64): i64 {
      GUARD(1,1)
      // Unreached code.
      return 42
   }
   ```

## Compiler Options

In the scripts section of your `package.json` using these compiler options are currently working when importing these declarations.

```
"scripts": {
    ...
    "asbuild:untouched": "asc assembly/index.ts --target debug -O3 --noAssert --runtime minimal -b build/untouched.wasm -t build/untouched.wat -d build/untouched.d.ts",
    "asbuild:optimized": "asc assembly/index.ts --target release  -O3 --noAssert --runtime minimal -b build/optimized.wasm -t build/optimized.wat -d build/optimized.d.ts",
    "asbuild": "npm run asbuild:untouched && npm run asbuild:optimized",
    ...
  }
```

## Contribute

If you want to help out simply fork this repo, make your changes, and submit a PR.

Once your branch is merged to master a new release will be cut and a distribution will be pushed to npmjs.com.

If you just want to share what you found without a PR hit me up on Twitter.

## Contact

- https://twitter.com/jfgrissom

---
_Source: https://npm.io/package/xrpl-hooks-api-assembly-script · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._