diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml new file mode 100644 index 00000000..f4d9a530 --- /dev/null +++ b/.github/workflows/docs.yaml @@ -0,0 +1,48 @@ +name: Build documentation + +on: [push] + +env: + # Name of module and id separated by a slash + INSTANCE: Writerside/in + # Replace HI with the ID of the instance in capital letters + ARTIFACT: webHelpIN2-all.zip + # Docker image version + DOCKER_VERSION: "242.21870" + +jobs: + build: + runs-on: ubuntu-latest + steps: + - name: Checkout repository + uses: actions/checkout@v4 + with: + fetch-depth: 0 + - uses: actions/setup-go@v5 + with: + go-version: '^1.23.2' + - uses: hecrj/setup-rust-action@v2 + with: + rust-version: stable + - name: Update image + run: cd docs && ./update_screenshot.sh + - name: Build Writerside docs using Docker + uses: JetBrains/writerside-github-action@v4 + with: + location: "docs" + instance: ${{ env.INSTANCE }} + artifact: ${{ env.ARTIFACT }} + docker-version: ${{ env.DOCKER_VERSION }} + + - name: Upload artifact + uses: actions/upload-artifact@v4 + with: + name: artifact + path: artifacts/${{ env.ARTIFACT }} + + - name: Release + uses: softprops/action-gh-release@v2 + if: startsWith(github.ref, 'refs/tags/') + with: + files: artifacts/${{ env.ARTIFACT }} + token: ${{ secrets.CUSTOM_GITHUB_TOKEN }} diff --git a/.github/workflows/full_check.yaml b/.github/workflows/full_check.yaml index ddd5c556..19f2786b 100644 --- a/.github/workflows/full_check.yaml +++ b/.github/workflows/full_check.yaml @@ -63,7 +63,7 @@ jobs: strategy: matrix: coin: [monero, wownero] - runs-on: ubuntu-latest + runs-on: ubuntu-22.04 # container: # image: debian:bookworm steps: @@ -391,7 +391,7 @@ jobs: key: depends-${{ github.job }}-${{ matrix.coin }}-${{ hashFiles('*/contrib/depends/packages/*.mk') }} - name: build run: | - ./build_single.sh ${{ matrix.coin }} aarch64-host-apple-darwin -j$(sysctl -n hw.logicalcpu) + ./build_single.sh ${{ matrix.coin }} aarch64-host-apple-darwin -j$(sysctl -n hw.logicalcpu) - name: rename artifacts run: | mkdir release/gh/ @@ -448,7 +448,7 @@ jobs: key: depends-${{ github.job }}-${{ matrix.coin }}-${{ hashFiles('*/contrib/depends/packages/*.mk') }} - name: build run: | - ./build_single.sh ${{ matrix.coin }} host-apple-ios -j$(sysctl -n hw.logicalcpu) + ./build_single.sh ${{ matrix.coin }} host-apple-ios -j$(sysctl -n hw.logicalcpu) - name: rename artifacts run: | mkdir release/gh/ @@ -585,6 +585,32 @@ jobs: cd impls/monero.ts deno run --unstable-ffi --allow-ffi checksum.ts + regression_check: + strategy: + matrix: + coin: [monero, wownero] + needs: [ + lib_linux + ] + runs-on: ubuntu-24.04 + steps: + - uses: denoland/setup-deno@v2 + with: + deno-version: v2.x + + - uses: actions/checkout@v4 + with: + fetch-depth: 0 + submodules: recursive + + - uses: actions/download-artifact@v4 + with: + name: linux ${{ matrix.coin }} + path: release/${{ matrix.coin }} + + - name: Run regression tests + run: COIN="${{ matrix.coin }}" deno test -A tests/ + comment_pr: name: comment on pr runs-on: ubuntu-latest diff --git a/.gitignore b/.gitignore index 4d94944d..2dbc30ee 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,5 @@ release/ -build/ \ No newline at end of file +build/ +tests/monero-cli +tests/libs +tests/wallets diff --git a/README.md b/README.md index 3a9b1a5b..63f3fce2 100644 --- a/README.md +++ b/README.md @@ -2,94 +2,15 @@ > Wrapper around wallet2_api.h that can be called using C api. -[![status-badge](https://ci.mrcyjanek.net/api/badges/5/status.svg?branch=rewrite-wip)](https://ci.mrcyjanek.net/repos/5/branches/rewrite-wip) - ## Building -to "clean" everything: +TL;DR: ```bash $ rm -rf monero wownero release $ git submodule update --init --recursive --force +$ for coin in monero wownero; do ./apply_patches $coin; done +$ ./build_single monero $(gcc -dumpmachine) -j$(nproc) ``` -fix ownership (if you build in docker but clone as a local user) - -```bash -$ sudo chown $(whoami) . -R -``` - -patch codebase - -```bash -$ ./apply_patches.sh monero -$ ./apply_patches.sh wownero -``` - -build monero_c - -```bash -$ ./build_single.sh monero x86_64-linux-gnu -j$(nproc) - wownero i686-linux-gnu - aarch64-linux-gnu - x86_64-linux-android - i686-linux-android - aarch64-linux-android - arm-linux-androideabi - i686-w64-mingw32 - x86_64-w64-mingw32 - host-apple-darwin - host-apple-ios -``` - -While building I aim to compile the code at oldest supported release of debian, using default toolchain to ensure that all linux distributions are able to run monero_c libraries, below I present a supported builders for given targets - -| x | builder | notes | -| ---------------------- | -------------------- | ----- | -| x86_64-linux-gnu | debian:buster | | -| i686-linux-gnu | debian:buster | | -| aarch64-linux-gnu | debian:buster | | -| x86_64-linux-android | debian:buster | | -| i686-linux-android | debian:buster | | -| aarch64-linux-android | debian:buster | | -| arm-linux-androideabi | debian:buster | | -| i686-w64-mingw32 | debian:buster | hardcoded DLL paths in build_single.sh | -| x86_64-w64-mingw32 | debian:buster | -"- | -| x86_64-apple-darwin11 | debian:bookworm | extra build step: `${HOST_ABI}-ranlib $PWD/$repo/contrib/depends/${HOST_ABI}/lib/libpolyseed.a` | -| aarch64-apple-darwin11 | debian:bookworm | -"- | -| host-apple-darwin | arm64-apple-darwin23 | dependencies: `brew install unbound boost@1.76 zmq cmake ccache autoconf automake libtool && brew link boost@1.76` | -| host-apple-ios | arm64-apple-darwin23 | | - -## Design - -Functions are as simple as reasonably possible as few steps should be performed to get from the exposed C api to actual wallet2 (or wallet3 in future) api calls. - -The only things passed in and out are: - -- void -- bool -- int -- uint64_t -- void* -- const char* - -All more complex structures are serialized into `const char*`, take look at MONERO_Wallet_createTransaction which uses `splitString(std::string(preferredInputs), std::string(separator));` to convert string into a std::set, so no implementation will need to worry about that. - -Is there more effective way to do that? Probably. Is there more universal way to pass that (JSON, or others?)? Most likely. That being said, I'm against doing that. You can easily join a string in any language, and I like to keep dependency count as low as possible. - -As for function naming `${COIN}_namespaceOrClass_functionName` is being used, currently these cryptocurrencies are supported - -- monero -- wownero - -both using wallet2 api, and both being patched with our secret ingredient(tm) (check patches directory). - -Since monero_c aims to be one-fits-all solution for monero wallets, there are some special things inside, like functions prefixed with `DEBUG_*`, these are not quarenteed to stay in the code, and can be changed, the only reason they are in is because I needed some testing early in the development when bringing support for variety of platforms. - -If you are a wallet developer and you **really** need this one function that doesn't exist, feel free to let me know I'll be happy to implement that. - -Currently there are enterprise resitents in our library: `${COIN}_cw_*` these functions are not guaranteed to stay stable, and are made for cake wallet to implement features that are not used in xmruw nor in stack_wallet (which I need to double-check later?). - -## Contributing - -To contribute you can visit git.mrcyjanek.net/mrcyjanek/monero_c and open a PR, alternatively use any other code mirror or send patches directly. \ No newline at end of file +Broken? Not working? Need help? https://moneroc.mrcyjanek.net/ diff --git a/docs/.idea/.gitignore b/docs/.idea/.gitignore new file mode 100644 index 00000000..26d33521 --- /dev/null +++ b/docs/.idea/.gitignore @@ -0,0 +1,3 @@ +# Default ignored files +/shelf/ +/workspace.xml diff --git a/docs/.idea/docs.iml b/docs/.idea/docs.iml new file mode 100644 index 00000000..61021940 --- /dev/null +++ b/docs/.idea/docs.iml @@ -0,0 +1,8 @@ + + + + + + + + \ No newline at end of file diff --git a/docs/.idea/modules.xml b/docs/.idea/modules.xml new file mode 100644 index 00000000..6049cfe0 --- /dev/null +++ b/docs/.idea/modules.xml @@ -0,0 +1,8 @@ + + + + + + + + \ No newline at end of file diff --git a/docs/.idea/vcs.xml b/docs/.idea/vcs.xml new file mode 100644 index 00000000..6c0b8635 --- /dev/null +++ b/docs/.idea/vcs.xml @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/docs/Writerside/assets/onefetch.png b/docs/Writerside/assets/onefetch.png new file mode 100644 index 00000000..4cf1288c Binary files /dev/null and b/docs/Writerside/assets/onefetch.png differ diff --git a/docs/Writerside/c.list b/docs/Writerside/c.list new file mode 100644 index 00000000..c4c77a29 --- /dev/null +++ b/docs/Writerside/c.list @@ -0,0 +1,6 @@ + + + + + \ No newline at end of file diff --git a/docs/Writerside/cfg/buildprofiles.xml b/docs/Writerside/cfg/buildprofiles.xml new file mode 100644 index 00000000..332e47bb --- /dev/null +++ b/docs/Writerside/cfg/buildprofiles.xml @@ -0,0 +1,13 @@ + + + + + + + + true + + + + diff --git a/docs/Writerside/cfg/glossary.xml b/docs/Writerside/cfg/glossary.xml new file mode 100644 index 00000000..22bec6b4 --- /dev/null +++ b/docs/Writerside/cfg/glossary.xml @@ -0,0 +1,7 @@ + + + + + Description of what "foo" is. + + \ No newline at end of file diff --git a/docs/Writerside/in.tree b/docs/Writerside/in.tree new file mode 100644 index 00000000..b803dbb4 --- /dev/null +++ b/docs/Writerside/in.tree @@ -0,0 +1,17 @@ + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/Writerside/topics/Android.md b/docs/Writerside/topics/Android.md new file mode 100644 index 00000000..c02b14f9 --- /dev/null +++ b/docs/Writerside/topics/Android.md @@ -0,0 +1,52 @@ +# Android + +Building on linux has been tested on +- `ubuntu:22.04` (docker tag) + +## Install dependencies + +```bash +$ apt update +$ apt install -y build-essential pkg-config autoconf libtool \ + ccache make cmake gcc g++ git curl lbzip2 libtinfo5 gperf \ + unzip python-is-python3 +``` + +## Prepare source + +> If you are running in docker or have not configured git you may need to do the following: +> ```bash +> git config --global --add safe.directory '*' +> git config --global user.email "ci@mrcyjanek.net" +> git config --global user.name "CI mrcyjanek.net" +> ``` + +```bash +$ git clone https://github.com/mrcyjanek/monero_c --recursive +$ cd monero_c +$ ./apply_patches.sh monero +``` + +## Building + + + + +$ ./build_single.sh monero x86_64-linux-android -j$(nproc) + + + + +$ ./build_single.sh monero aarch64-linux-android -j$(nproc) + + + + +$ ./build_single.sh monero armv7a-linux-androideabi -j$(nproc) + + + + +## Known issues + +None. Open an issue if you find something not working. \ No newline at end of file diff --git a/docs/Writerside/topics/Building.md b/docs/Writerside/topics/Building.md new file mode 100644 index 00000000..f44f1f37 --- /dev/null +++ b/docs/Writerside/topics/Building.md @@ -0,0 +1,99 @@ +# Building + +Building monero_c comes down to these simple steps: +```bash +$ git clone https://github.com/mrcyjanek/monero_c --recursive +$ ./apply_patches.sh monero # patch the libraries +$ ./build_single x86_64-linux-gnu -j$(nproc) +``` + +To get detailed information about building please select your host platform (the one that you will use to build the +monero wallet) + +- [I'm scared. How can I use prebuilds?](Using-prebuilds.md) +- [Linux](#linux) +- [macOS](#macos) +- [Windows](#windows) + +## Supported systems + +| Target | Builder | Notes | +|------------------|-----------------------------|----------------------------------------------------------------------------------| +| Windows | Linux, Docker, WSL2 | msys2 builds are not supported, there are hardcoded DLL paths in build_single.sh | +| macOS | Native, Linux, Docker, WSL2 | Native builds are being widely used, but are not endorsed by me personally. | +| iOS | macOS | | +| Android | Linux, Docker, WSL2 | | +| Linux | Native, Docker, WSL2 | | +| Linux/SailfishOS | Native, Docker | Required meego toolchain. | + +All supported systems are built on CI, so for the most up-to-date list of all supported systems, together with proper +dependencies please take a look at [full_check.yml](https://github.com/MrCyjaneK/monero_c/blob/master/.github/workflows/full_check.yaml) +file. + +### Linux + +Linux builds should be built on as old of a distro as possible - targeting `debian:oldoldstable`, main reason for that +is GLIBC compatibility (or lack of it). For some reason software compiled with newer GLIBC won't work on devices with +older GLIBC, so the solution is to simply build on the oldest possible os (or abandon GLIBC and use musl). + +- x86-64-linux-gnu +- i686-linux-gnu - deprecated by monero +- aarch64-linux-gnu + +[More details](Linux.md) + +#### SailfishOS + +Fully supported (except for armv7l devices). + +- i686-meego-linux-gnu +- aarch64-meego-linux-gnu + +More details: TBD + +#### Alpine Linux + +Requires dependency removed by upstream - it is preserved in `external/alpine/libexecinfo`. It could easily +be brought back - but since nobody uses it and nobody complained about it missing it kind of never landed in monero_c +after rewrite fully. That being said it should mostly work. + +- ~~x86_64-alpine-linux-musl~~ +- ~~aarch64-alpine-linux-musl~~ + +More details: TBD + +### Android + +Includes bumped NDK version + +- x86_64-linux-android +- ~~i686-linux-android~~ - unsupported, fails to build +- aarch64-linux-android +- armv7a-linux-androideabi + +[More details](Android.md) + +### Windows + +Msys2 shell is not supported, docker or WSL2 is requried to build + +- i686-w64-mingw32 - deprecated by monero +- x86_64-w64-mingw32 +- aarch64-w64-unknown - unsupported. + Though - if somebody can grab and send me a decent CopilotPC I'll be happy to work on that. As for now using x86_64 + build should be fine (but slower in runtime) solution. + +[More details](Windows.md) + +### macOS + +- x86_64-apple-darwin11 +- aarch64-apple-darwin11 +- host-apple-darwin +- x86_64-host-apple-darwin - alias for host-apple-darwin +- aarch64-host-apple-darwin alias for host-apple-darwin + +[More details](macOS.md) + +### iOS +- host-apple-ios - probably will be renamed to `aarch64-apple-ios` \ No newline at end of file diff --git a/docs/Writerside/topics/Linux.md b/docs/Writerside/topics/Linux.md new file mode 100644 index 00000000..7d3a2f14 --- /dev/null +++ b/docs/Writerside/topics/Linux.md @@ -0,0 +1,71 @@ +# Linux + +Building on linux has been tested on +- `debian:bullseye` (docker tag) + +## Install dependencies + + + + +$ apt update +$ apt install -y build-essential pkg-config autoconf libtool \ + ccache make cmake gcc g++ git curl lbzip2 libtinfo5 gperf + + + + +$ apt update +$ apt install -y build-essential pkg-config autoconf libtool \ + ccache make cmake gcc g++ git curl lbzip2 libtinfo5 gperf \ + gcc-aarch64-linux-gnu g++-aarch64-linux-gnu + + + + +$ apt update +$ apt install -y build-essential pkg-config autoconf libtool \ + ccache make cmake gcc g++ git curl lbzip2 libtinfo5 gperf \ + gcc-i686-linux-gnu g++-i686-linux-gnu + + + + +## Prepare source + +> If you are running in docker or have not configured git you may need to do the following: +> ```bash +> git config --global --add safe.directory '*' +> git config --global user.email "ci@mrcyjanek.net" +> git config --global user.name "CI mrcyjanek.net" +> ``` + +```bash +$ git clone https://github.com/mrcyjanek/monero_c --recursive +$ cd monero_c +$ ./apply_patches.sh monero +``` + +## Building + + + + +$ ./build_single.sh monero x86_64-linux-gnu -j$(nproc) + + + + +$ ./build_single.sh monero aarch64-linux-gnu -j$(nproc) + + + + +$ ./build_single.sh monero i686-linux-gnu -j$(nproc) + + + + +## Known issues + +None. Open an issue if you find something not working. \ No newline at end of file diff --git a/docs/Writerside/topics/Using-prebuilds.md b/docs/Writerside/topics/Using-prebuilds.md new file mode 100644 index 00000000..f4ff35e1 --- /dev/null +++ b/docs/Writerside/topics/Using-prebuilds.md @@ -0,0 +1,48 @@ +# Using prebuilds + +Prebuilds are more convenient way of using monero_c in your code (although these builds should **NOT** be used in +production). There are several ways in which you can use prebuilds + +## The monero_c way + +1. Go to https://github.com/MrCyjaneK/monero_c/releases +2. Click on the release that you are interested in +3. Download release-bundle.zip +4. Unzip it in monero_c directory + +That zip file contains all builds that monero_c supports prepared in the exactly same way as you would prepare them if +building on your own. This is the easiest way to get started. + +> Keep in mind that release-bundle.zip contains .xz files inside, so if you want to actually use them you need to use +> them you need to unxz them first +> ```bash +> $ unxz -f -k release/*/*.xz +> ``` + +## The monero_c way (different) + +Alternatively you can go to releases tab and grab whatever you need, there are over 40 libraries. Surely one will fit +your use case. + +## The build_moneroc.sh way + +This method is used by [xmruw](https://github.com/mrcyjanek/unnamed_monero_wallet) and +[monero-tui](https://github.com/Im-Beast/monero-tui). + +It supports both building and downloading prebuilds and putting them in correct location, [have a look at the code +yourself](https://github.com/MrCyjaneK/unnamed_monero_wallet/blob/master-rewrite/build_moneroc.sh) + +```bash +$ ./build_moneroc.sh + --prebuild # allow downloads of prebuilds + --coin # monero/wownero + --tag v0.18.3.3-RC45 # which tag to build / download + --triplet x86_64-linux-android # which triplet to build / download + --location android/.../jniLibs/x86_64 # where to but the libraries +``` + +## The cake wallet way + +There is a simple script in cake_wallet written in `dart` that runs on all platform (including windows) which downloads +all required libraries for selected platforms in one go. +[You can take look at it here](https://github.com/cake-tech/cake_wallet/blob/main/tool/download_moneroc_prebuilds.dart) \ No newline at end of file diff --git a/docs/Writerside/topics/Windows.md b/docs/Writerside/topics/Windows.md new file mode 100644 index 00000000..1cb931c2 --- /dev/null +++ b/docs/Writerside/topics/Windows.md @@ -0,0 +1,63 @@ +# Windows + +Building on windows has been tested on +- `debian:bullseye` (docker tag) +- `Ubuntu 22.04 WSL` + +## Install dependencies + + + + +$ apt update +$ apt install -y build-essential pkg-config autoconf libtool \ + ccache make cmake gcc g++ git curl lbzip2 libtinfo5 gperf \ + gcc-mingw-w64-x86-64 g++-mingw-w64-x86-64 + + + + +$ apt update +$ apt install -y build-essential pkg-config autoconf libtool \ + ccache make cmake gcc g++ git curl lbzip2 libtinfo5 gperf \ + gcc-mingw-w64-i686 g++-mingw-w64-i686 + + + + +## Prepare source + +> If you are running in docker or have not configured git you may need to do the following: +> ```bash +> git config --global --add safe.directory '*' +> git config --global user.email "ci@mrcyjanek.net" +> git config --global user.name "CI mrcyjanek.net" +> ``` + +```bash +$ git clone https://github.com/mrcyjanek/monero_c --recursive +$ cd monero_c +$ ./apply_patches.sh monero +``` + +## Building + + + + +$ ./build_single.sh monero x86_64-w64-mingw32 -j$(nproc) + + + + +$ ./build_single.sh monero i686-w64-mingw32 -j$(nproc) + + + + +## Known issues + +### Dynamically loaded dependencies + +There are some dynamically loaded dependencies which are copied over from the OS package repository. All of them are +available in `release/` directory. \ No newline at end of file diff --git a/docs/Writerside/topics/about.md b/docs/Writerside/topics/about.md new file mode 100644 index 00000000..448e70f2 --- /dev/null +++ b/docs/Writerside/topics/about.md @@ -0,0 +1,59 @@ +# About + +![monero_c onefetch](../assets/onefetch.png) + +## Goal + +The goal of monero_c is simple, at least on the surface +- Build monero for all platforms +- Access monero functions from all languages +- Bring in new features used by wallets but still not merged upstream + +To achieve these tasks some major changes had to happen to monero. + +## Building + +For the most part `contrib/depends` directory of `monero` was used, as it is in perfect shape (that being said it's +terrible to debug when something goes wrong). But it doesn't work with iOS, and it doesn't work on macOS, so some +dependencies had to be pulled as a submodules. But that being said, linux can be used to build for all platforms (except +for iOS - you need macOS for that, and you also need that 100EUR/year license to actually be able to do something with +said library). + +This is especially good because any device can run linux, on WSL2 or under docker. + +## Accessing monero functions + +Though just building the library is not enough, if you just `make wallet_api` in the upstream code you end up in a +place where you technically have the functions in a dynamic library, but you can only use C++ ABI to interact with it. +Which is not ideal. Of course, it is doable, if you want to deal with `__ZNK6Monero10WalletImpl7addressEjj` instead of +`MONERO_Wallet_address`, and make sure that the way you pass in variables is what C++ expects. +I went with the simplest and most standard way of doing that - C ABI (which is what monero should offer in the first +place). Now with any language that supports C interop you can just go ahead and use monero wallet. + +All functionality is simplified to use only the following types: + +- bool +- int +- uint64_t +- void* +- const char* +- void + +## Bring in new features + +There are some extra features inside of the code like +- Polyseed support +- Background sync +- Airgap functions +- Coin control +- UR support +- Ledger support (on android and iSO) +- many fixes + +These features land in the `patches` directory, and are applied to the upstream monero code. + +## Summary + +monero_c extends monero functionality and also simplifies it by a huge extent, if you want to use monero - monero_c is +probably the way to go. +Are you ready to start? Let's see how to build the binary. \ No newline at end of file diff --git a/docs/Writerside/topics/macOS.md b/docs/Writerside/topics/macOS.md new file mode 100644 index 00000000..367893b8 --- /dev/null +++ b/docs/Writerside/topics/macOS.md @@ -0,0 +1,86 @@ +# macOS + +Building on linux has been tested on +- `macos-14` (github runner) +- `MacOS 15.0.1 Sequoia` (Native) +- `debian:bookworm` (docker tag) + +## Install dependencies + + + + +$ # install xcode 15.4 (or current latest) +$ brew install ccache unbound boost@1.76 zmq autoconf automake libtool +$ brew link boost@1.76 + + + + +$ # install xcode 15.4 (or current latest) +$ brew install ccache unbound boost@1.76 zmq autoconf automake libtool +$ brew link boost@1.76 +$ arch -x86_64 brew install ccache unbound boost@1.76 zmq autoconf automake libtool +$ arch -x86_64 brew link boost@1.76 + + + + +$ apt update +$ apt install -y build-essential pkg-config autoconf libtool \ + ccache make cmake gcc g++ git curl lbzip2 libtinfo5 gperf \ + python-is-python3 + + + + +## Prepare source + +> If you are running in docker or have not configured git you may need to do the following: +> ```bash +> git config --global --add safe.directory '*' +> git config --global user.email "ci@mrcyjanek.net" +> git config --global user.name "CI mrcyjanek.net" +> ``` + +```bash +$ git clone https://github.com/mrcyjanek/monero_c --recursive +$ cd monero_c +$ ./apply_patches.sh monero +``` + +## Building + + + + +$ ./build_single.sh monero x86_64-host-apple-darwin -j$(nproc) + + + + +$ ./build_single.sh monero aarch64-host-apple-darwin -j$(nproc) + + + + +$ arch -x86_64 ./build_single.sh monero x86_64-host-apple-darwin -j$(nproc) + + + + +$ ./build_single.sh monero x86_64-apple-darwin11 -j$(nproc) + + + + +$ ./build_single.sh monero aarch64-apple-darwin-11 -j$(nproc) + + + + +## Known issues + +### Creating fat library + +[Check cake_wallet solution](https://github.com/cake-tech/cake_wallet/blob/main/scripts/macos/build_monero_all.sh) \ No newline at end of file diff --git a/docs/Writerside/writerside.cfg b/docs/Writerside/writerside.cfg new file mode 100644 index 00000000..98e14351 --- /dev/null +++ b/docs/Writerside/writerside.cfg @@ -0,0 +1,11 @@ + + + + + + + + + + \ No newline at end of file diff --git a/docs/update_screenshot.sh b/docs/update_screenshot.sh new file mode 100755 index 00000000..a404047f --- /dev/null +++ b/docs/update_screenshot.sh @@ -0,0 +1,14 @@ +#!/bin/bash +set -x -e +go install github.com/homeport/termshot/cmd/termshot@main +cargo install onefetch +COMMIT_COUNT=$(git log --pretty=format:'' | wc -l | xargs) +echo Commit count: $COMMIT_COUNT +if (( $COMMIT_COUNT % 69 == 0 )) +then + echo "easter egg, yay!" + termshot --show-cmd --filename Writerside/assets/onefetch.png -- "onefetch --number-of-authors 0 -a html | lolcat" +else + echo "normal. Yay." + termshot --show-cmd --filename Writerside/assets/onefetch.png -- "onefetch --number-of-authors 0 -a c++" +fi \ No newline at end of file diff --git a/impls/monero.dart/LICENSE b/impls/monero.dart/LICENSE deleted file mode 100644 index f288702d..00000000 --- a/impls/monero.dart/LICENSE +++ /dev/null @@ -1,674 +0,0 @@ - GNU GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The GNU General Public License is a free, copyleft license for -software and other kinds of works. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -the GNU General Public License is intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains free -software for all its users. We, the Free Software Foundation, use the -GNU General Public License for most of our software; it applies also to -any other work released this way by its authors. You can apply it to -your programs, too. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - - To protect your rights, we need to prevent others from denying you -these rights or asking you to surrender the rights. Therefore, you have -certain responsibilities if you distribute copies of the software, or if -you modify it: responsibilities to respect the freedom of others. - - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must pass on to the recipients the same -freedoms that you received. You must make sure that they, too, receive -or can get the source code. And you must show them these terms so they -know their rights. - - Developers that use the GNU GPL protect your rights with two steps: -(1) assert copyright on the software, and (2) offer you this License -giving you legal permission to copy, distribute and/or modify it. - - For the developers' and authors' protection, the GPL clearly explains -that there is no warranty for this free software. For both users' and -authors' sake, the GPL requires that modified versions be marked as -changed, so that their problems will not be attributed erroneously to -authors of previous versions. - - Some devices are designed to deny users access to install or run -modified versions of the software inside them, although the manufacturer -can do so. This is fundamentally incompatible with the aim of -protecting users' freedom to change the software. The systematic -pattern of such abuse occurs in the area of products for individuals to -use, which is precisely where it is most unacceptable. Therefore, we -have designed this version of the GPL to prohibit the practice for those -products. If such problems arise substantially in other domains, we -stand ready to extend this provision to those domains in future versions -of the GPL, as needed to protect the freedom of users. - - Finally, every program is threatened constantly by software patents. -States should not allow patents to restrict development and use of -software on general-purpose computers, but in those that do, we wish to -avoid the special danger that patents applied to a free program could -make it effectively proprietary. To prevent this, the GPL assures that -patents cannot be used to render the program non-free. - - The precise terms and conditions for copying, distribution and -modification follow. - - TERMS AND CONDITIONS - - 0. Definitions. - - "This License" refers to version 3 of the GNU General Public License. - - "Copyright" also means copyright-like laws that apply to other kinds of -works, such as semiconductor masks. - - "The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - - To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of an -exact copy. The resulting work is called a "modified version" of the -earlier work or a work "based on" the earlier work. - - A "covered work" means either the unmodified Program or a work based -on the Program. - - To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - - To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user through -a computer network, with no transfer of a copy, is not conveying. - - An interactive user interface displays "Appropriate Legal Notices" -to the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - - 1. Source Code. - - The "source code" for a work means the preferred form of the work -for making modifications to it. "Object code" means any non-source -form of a work. - - A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - - The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - - The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - - The Corresponding Source need not include anything that users -can regenerate automatically from other parts of the Corresponding -Source. - - The Corresponding Source for a work in source code form is that -same work. - - 2. Basic Permissions. - - All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - - You may make, run and propagate covered works that you do not -convey, without conditions so long as your license otherwise remains -in force. You may convey covered works to others for the sole purpose -of having them make modifications exclusively for you, or provide you -with facilities for running those works, provided that you comply with -the terms of this License in conveying all material for which you do -not control copyright. Those thus making or running the covered works -for you must do so exclusively on your behalf, under your direction -and control, on terms that prohibit them from making any copies of -your copyrighted material outside their relationship with you. - - Conveying under any other circumstances is permitted solely under -the conditions stated below. Sublicensing is not allowed; section 10 -makes it unnecessary. - - 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - - No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - - When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such circumvention -is effected by exercising rights under this License with respect to -the covered work, and you disclaim any intention to limit operation or -modification of the work as a means of enforcing, against the work's -users, your or third parties' legal rights to forbid circumvention of -technological measures. - - 4. Conveying Verbatim Copies. - - You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - - You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - - 5. Conveying Modified Source Versions. - - You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these conditions: - - a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. - - b) The work must carry prominent notices stating that it is - released under this License and any conditions added under section - 7. This requirement modifies the requirement in section 4 to - "keep intact all notices". - - c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. - - d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - - A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - - 6. Conveying Non-Source Forms. - - You may convey a covered work in object code form under the terms -of sections 4 and 5, provided that you also convey the -machine-readable Corresponding Source under the terms of this License, -in one of these ways: - - a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. - - b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the - Corresponding Source from a network server at no charge. - - c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. - - d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. - - e) Convey the object code using peer-to-peer transmission, provided - you inform other peers where the object code and Corresponding - Source of the work are being offered to the general public at no - charge under subsection 6d. - - A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - - A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, family, -or household purposes, or (2) anything designed or sold for incorporation -into a dwelling. In determining whether a product is a consumer product, -doubtful cases shall be resolved in favor of coverage. For a particular -product received by a particular user, "normally used" refers to a -typical or common use of that class of product, regardless of the status -of the particular user or of the way in which the particular user -actually uses, or expects or is expected to use, the product. A product -is a consumer product regardless of whether the product has substantial -commercial, industrial or non-consumer uses, unless such uses represent -the only significant mode of use of the product. - - "Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to install -and execute modified versions of a covered work in that User Product from -a modified version of its Corresponding Source. The information must -suffice to ensure that the continued functioning of the modified object -code is in no case prevented or interfered with solely because -modification has been made. - - If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - - The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or updates -for a work that has been modified or installed by the recipient, or for -the User Product in which it has been modified or installed. Access to a -network may be denied when the modification itself materially and -adversely affects the operation of the network or violates the rules and -protocols for communication across the network. - - Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - - 7. Additional Terms. - - "Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - - When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - - Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders of -that material) supplement the terms of this License with terms: - - a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or - - b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or - - c) Prohibiting misrepresentation of the origin of that material, or - requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or - - d) Limiting the use for publicity purposes of names of licensors or - authors of the material; or - - e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or - - f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions of - it) with contractual assumptions of liability to the recipient, for - any liability that these contractual assumptions directly impose on - those licensors and authors. - - All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - - If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - - Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; -the above requirements apply either way. - - 8. Termination. - - You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - - However, if you cease all violation of this License, then your -license from a particular copyright holder is reinstated (a) -provisionally, unless and until the copyright holder explicitly and -finally terminates your license, and (b) permanently, if the copyright -holder fails to notify you of the violation by some reasonable means -prior to 60 days after the cessation. - - Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - - Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - - 9. Acceptance Not Required for Having Copies. - - You are not required to accept this License in order to receive or -run a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - - 10. Automatic Licensing of Downstream Recipients. - - Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - - An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - - You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - - 11. Patents. - - A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - - A contributor's "essential patent claims" are all patent claims -owned or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - - Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - - In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - - If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - - If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - - A patent license is "discriminatory" if it does not include within -the scope of its coverage, prohibits the exercise of, or is -conditioned on the non-exercise of one or more of the rights that are -specifically granted under this License. You may not convey a covered -work if you are a party to an arrangement with a third party that is -in the business of distributing software, under which you make payment -to the third party based on the extent of your activity of conveying -the work, and under which the third party grants, to any of the -parties who would receive the covered work from you, a discriminatory -patent license (a) in connection with copies of the covered work -conveyed by you (or copies made from those copies), or (b) primarily -for and in connection with specific products or compilations that -contain the covered work, unless you entered into that arrangement, -or that patent license was granted, prior to 28 March 2007. - - Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - - 12. No Surrender of Others' Freedom. - - If conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot convey a -covered work so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you may -not convey it at all. For example, if you agree to terms that obligate you -to collect a royalty for further conveying from those to whom you convey -the Program, the only way you could satisfy both those terms and this -License would be to refrain entirely from conveying the Program. - - 13. Use with the GNU Affero General Public License. - - Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU Affero General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the special requirements of the GNU Affero General Public License, -section 13, concerning interaction through a network will apply to the -combination as such. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of -the GNU General Public License from time to time. Such new versions will -be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - - Each version is given a distinguishing version number. If the -Program specifies that a certain numbered version of the GNU General -Public License "or any later version" applies to it, you have the -option of following the terms and conditions either of that numbered -version or of any later version published by the Free Software -Foundation. If the Program does not specify a version number of the -GNU General Public License, you may choose any version ever published -by the Free Software Foundation. - - If the Program specifies that a proxy can decide which future -versions of the GNU General Public License can be used, that proxy's -public statement of acceptance of a version permanently authorizes you -to choose that version for the Program. - - Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. - - 15. Disclaimer of Warranty. - - THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY -OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, -THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM -IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF -ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. Limitation of Liability. - - IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS -THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY -GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE -USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF -DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD -PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), -EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF -SUCH DAMAGES. - - 17. Interpretation of Sections 15 and 16. - - If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -state the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - - Copyright (C) - - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . - -Also add information on how to contact you by electronic and paper mail. - - If the program does terminal interaction, make it output a short -notice like this when it starts in an interactive mode: - - Copyright (C) - This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. - This is free software, and you are welcome to redistribute it - under certain conditions; type `show c' for details. - -The hypothetical commands `show w' and `show c' should show the appropriate -parts of the General Public License. Of course, your program's commands -might be different; for a GUI interface, you would use an "about box". - - You should also get your employer (if you work as a programmer) or school, -if any, to sign a "copyright disclaimer" for the program, if necessary. -For more information on this, and how to apply and follow the GNU GPL, see -. - - The GNU General Public License does not permit incorporating your program -into proprietary programs. If your program is a subroutine library, you -may consider it more useful to permit linking proprietary applications with -the library. If this is what you want to do, use the GNU Lesser General -Public License instead of this License. But first, please read -. diff --git a/impls/monero.ts/README.md b/impls/monero.ts/README.md index e3b20f6b..fe064670 100644 --- a/impls/monero.ts/README.md +++ b/impls/monero.ts/README.md @@ -7,13 +7,20 @@ This library does not ship with `monero_c` libraries.\ To use these bindings you have to bring your own `monero_c` libraries.\ There are at least two ways to do so: + - Ahead-of-time, during builds where you only ship necessary library for a given platform.\ - See [monero-tui](https://github.com/Im-Beast/monero-tui/blob/main/.github/workflows/dev-build.yml) build workflow as an example of doing so. + See [monero-tui](https://github.com/Im-Beast/monero-tui/blob/main/.github/workflows/dev-build.yml) build workflow as + an example of doing so. ```ts - import { loadDylib, Wallet, WalletManager } from "https://raw.githubusercontent.com/MrCyjaneK/monero_c/master/impls/monero.ts/mod.ts"; + import { + loadMoneroDylib, + Wallet, + WalletManager, + } from "https://raw.githubusercontent.com/MrCyjaneK/monero_c/master/impls/monero.ts/mod.ts"; // Try to load dylib from the default lib/* path - loadDylib(); + // You can also use loadWowneroDylib for Wownero + loadMoneroDylib(); const wm = await WalletManager.new(); const wallet = await Wallet.create(wm, "./my_wallet", "password"); @@ -27,11 +34,11 @@ There are at least two ways to do so: ```ts import { dlopen } from "jsr:@denosaurs/plug"; // It's recommened to put the monero.ts github link into your import_map to reduce the url clutter - import { loadDylib, symbols, Wallet, WalletManager } from "https://raw.githubusercontent.com/MrCyjaneK/monero_c/master/impls/monero.ts/mod.ts"; + import { loadMoneroDylib, symbols, Wallet, WalletManager } from "https://raw.githubusercontent.com/MrCyjaneK/monero_c/master/impls/monero.ts/mod.ts"; // Load dylib loaded by plug const lib = await dlopen(..., symbols); - loadDylib(lib); + loadMoneroDylib(lib); const wm = await WalletManager.new(); const wallet = await Wallet.create(wm, "./my_wallet", "password"); diff --git a/impls/monero.ts/checksum.ts b/impls/monero.ts/checksum.ts index 22d30383..b0d12b02 100644 --- a/impls/monero.ts/checksum.ts +++ b/impls/monero.ts/checksum.ts @@ -1,8 +1,8 @@ import { moneroChecksum } from "./checksum_monero.ts"; -import { readCString } from "./src/utils.ts"; -import { dylib, loadDylib } from "./src/bindings.ts"; +import { getSymbol, readCString } from "./src/utils.ts"; +import { dylib, loadMoneroDylib } from "./src/bindings.ts"; -loadDylib(); +loadMoneroDylib(); export class ChecksumError extends Error { readonly code: number; @@ -21,7 +21,7 @@ export class ChecksumError extends Error { * @returns {ChecksumError} which contains information about why checksum failed */ export async function validateChecksum(): Promise { - const cppHeaderHash = await readCString(await dylib.symbols.MONERO_checksum_wallet2_api_c_h(), false); + const cppHeaderHash = await readCString(await getSymbol("checksum_wallet2_api_c_h")!(), false); const tsHeaderHash = moneroChecksum.wallet2_api_c_h_sha256; const errors: string[] = []; @@ -32,14 +32,14 @@ export async function validateChecksum(): Promise { errorCode++; } - const cppSourceHash = await readCString(await dylib.symbols.MONERO_checksum_wallet2_api_c_cpp(), false); + const cppSourceHash = await readCString(await getSymbol("checksum_wallet2_api_c_cpp")!(), false); const tsSourceHash = moneroChecksum.wallet2_api_c_cpp_sha256; if (cppSourceHash !== tsSourceHash) { errors.push(`ERR: CPP source file check mismatch ${cppSourceHash} == ${tsSourceHash}`); errorCode++; } - const cppExportHash = await readCString(await dylib.symbols.MONERO_checksum_wallet2_api_c_exp(), false); + const cppExportHash = await readCString(await getSymbol("checksum_wallet2_api_c_exp")!(), false); const tsExportHash = moneroChecksum.wallet2_api_c_exp_sha256; if (cppExportHash !== tsExportHash) { if (Deno.build.os !== "darwin") { diff --git a/impls/monero.ts/src/bindings.ts b/impls/monero.ts/src/bindings.ts index b854f7d3..93ce8f9e 100644 --- a/impls/monero.ts/src/bindings.ts +++ b/impls/monero.ts/src/bindings.ts @@ -1,542 +1,8 @@ -export const symbols = { - "MONERO_WalletManagerFactory_getWalletManager": { - nonblocking: true, - parameters: [], - // void* - result: "pointer", - }, +import { type Dylib, moneroSymbols, type MoneroTsDylib, wowneroSymbols, type WowneroTsDylib } from "./symbols.ts"; - //#region WalletManager - "MONERO_WalletManager_createWallet": { - nonblocking: true, - // void* wm_ptr, const char* path, const char* password, const char* language, int networkType - parameters: ["pointer", "pointer", "pointer", "pointer", "i32"], - // void* - result: "pointer", - }, - "MONERO_WalletManager_openWallet": { - nonblocking: true, - // void* wm_ptr, const char* path, const char* password, int networkType - "parameters": ["pointer", "pointer", "pointer", "i32"], - // void* - result: "pointer", - }, - "MONERO_WalletManager_recoveryWallet": { - nonblocking: true, - // void* wm_ptr, const char* path, const char* password, const char* mnemonic, - // int networkType, uint64_t restoreHeight, uint64_t kdfRounds, const char* seedOffset - parameters: ["pointer", "pointer", "pointer", "pointer", "i32", "u64", "u64", "pointer"], - // void* - result: "pointer", - }, - "MONERO_WalletManager_blockchainHeight": { - nonblocking: true, - // void* wm_ptr - parameters: ["pointer"], - // uint64_t - result: "u64", - }, - "MONERO_WalletManager_blockchainTargetHeight": { - nonblocking: true, - // void* wm_ptr - parameters: ["pointer"], - // uint64_t - result: "u64", - }, - "MONERO_WalletManager_setDaemonAddress": { - nonblocking: true, - // void* wm_ptr, const char* address - parameters: ["pointer", "pointer"], - // void - result: "void", - }, - //#endregion +export let dylib: Dylib; - //#region Wallet - "MONERO_Wallet_init": { - nonblocking: true, - // void* wallet_ptr, const char* daemon_address, uint64_t upper_transaction_size_limit, - // const char* daemon_username, const char* daemon_password, bool use_ssl, bool lightWallet, - // const char* proxy_address - parameters: ["pointer", "pointer", "u64", "pointer", "pointer", "bool", "bool", "pointer"], - // bool - result: "bool", - }, - "MONERO_Wallet_init3": { - nonblocking: true, - // void* wallet_ptr, const char* argv0, const char* default_log_base_name, - // const char* log_path, bool console - parameters: ["pointer", "pointer", "pointer", "pointer", "bool"], - // void - result: "void", - }, - "MONERO_Wallet_setTrustedDaemon": { - nonblocking: true, - // void* wallet_ptr, bool arg - parameters: ["pointer", "bool"], - // void - result: "void", - }, - "MONERO_Wallet_startRefresh": { - nonblocking: true, - // void* wallet_ptr - parameters: ["pointer"], - // void - result: "void", - }, - "MONERO_Wallet_refreshAsync": { - nonblocking: true, - // void* wallet_ptr - parameters: ["pointer"], - // void - result: "void", - }, - "MONERO_Wallet_blockChainHeight": { - nonblocking: true, - // void* wallet_ptr - parameters: ["pointer"], - // uint64_t - result: "u64", - }, - "MONERO_Wallet_daemonBlockChainHeight": { - nonblocking: true, - // void* wallet_ptr - parameters: ["pointer"], - // uint64_t - result: "u64", - }, - "MONERO_Wallet_synchronized": { - nonblocking: true, - // void* wallet_ptr - parameters: ["pointer"], - // bool - result: "bool", - }, - "MONERO_Wallet_store": { - nonblocking: true, - // void* wallet_ptr, const char* path - parameters: ["pointer", "pointer"], - // bool - result: "bool", - }, - "MONERO_Wallet_address": { - nonblocking: true, - // void* wallet_ptr, uint64_t accountIndex, uint64_t addressIndex - parameters: ["pointer", "u64", "u64"], - // char* - result: "pointer", - }, - "MONERO_Wallet_balance": { - nonblocking: true, - // void* wallet_ptr, uint32_t accountIndex - parameters: ["pointer", "u32"], - // uint64_t - result: "u64", - }, - "MONERO_Wallet_unlockedBalance": { - nonblocking: true, - // void* wallet_ptr, uint32_t accountIndex - parameters: ["pointer", "u32"], - // uint64_t - result: "u64", - }, - "MONERO_Wallet_addSubaddressAccount": { - nonblocking: true, - // void* wallet_ptr, const char* label - parameters: ["pointer", "pointer"], - // void - result: "void", - }, - "MONERO_Wallet_numSubaddressAccounts": { - nonblocking: true, - // void* wallet_ptr - parameters: ["pointer"], - // size_t - result: "usize", - }, - "MONERO_Wallet_addSubaddress": { - nonblocking: true, - // void* wallet_ptr, uint32_t accountIndex, const char* label - parameters: ["pointer", "u32", "pointer"], - // void - result: "void", - }, - "MONERO_Wallet_numSubaddresses": { - nonblocking: true, - // void* wallet_ptr, uint32_t accountIndex - parameters: ["pointer", "u32"], - // size_t - result: "usize", - }, - "MONERO_Wallet_getSubaddressLabel": { - nonblocking: true, - // void* wallet_ptr, uint32_t accountIndex, uint32_t addressIndex - parameters: ["pointer", "u32", "u32"], - // const char* - result: "pointer", - }, - "MONERO_Wallet_setSubaddressLabel": { - nonblocking: true, - // void* wallet_ptr, uint32_t accountIndex, uint32_t addressIndex, const char* label - parameters: ["pointer", "u32", "u32", "pointer"], - // void - result: "void", - }, - "MONERO_Wallet_status": { - nonblocking: true, - // void* wallet_ptr - parameters: ["pointer"], - // int - result: "i32", - }, - "MONERO_Wallet_errorString": { - nonblocking: true, - // void* wallet_ptr - parameters: ["pointer"], - // char* - result: "pointer", - }, - "MONERO_Wallet_history": { - nonblocking: true, - // void* wallet_ptr - parameters: ["pointer"], - // void* - result: "pointer", - }, - "MONERO_Wallet_createTransaction": { - nonblocking: true, - // void* wallet_ptr, const char* dst_addr, const char* payment_id - // uint64_t amount, uint32_t mixin_count, int pendingTransactionPriority, - // uint32_t subaddr_account, const char* preferredInputs, const char* separator - parameters: ["pointer", "pointer", "pointer", "u64", "u32", "i32", "u32", "pointer", "pointer"], - // void* - result: "pointer", - }, - "MONERO_Wallet_amountFromString": { - nonblocking: true, - // const char* amount - parameters: ["pointer"], - // uint64_t - result: "u64", - }, - //#endregion - - //#region TransactionHistory - "MONERO_TransactionHistory_count": { - nonblocking: true, - // void* txHistory_ptr - parameters: ["pointer"], - // int - result: "i32", - }, - "MONERO_TransactionHistory_transaction": { - nonblocking: true, - // void* txHistory_ptr, int index - parameters: ["pointer", "i32"], - // void* - result: "pointer", - }, - "MONERO_TransactionHistory_transactionById": { - nonblocking: true, - // void* txHistory_ptr, const char* id - parameters: ["pointer", "pointer"], - // void* - result: "pointer", - }, - "MONERO_TransactionHistory_refresh": { - nonblocking: true, - // void* txHistory_ptr - parameters: ["pointer"], - // void - result: "void", - }, - "MONERO_TransactionHistory_setTxNote": { - nonblocking: true, - // void* txHistory_ptr, const char* txid, const char* note - parameters: ["pointer", "pointer", "pointer"], - // void - result: "void", - }, - //#endregion - - //#region TransactionInfo - "MONERO_TransactionInfo_direction": { - nonblocking: true, - // void* txInfo_ptr - parameters: ["pointer"], - // int - result: "i32", - }, - "MONERO_TransactionInfo_isPending": { - nonblocking: true, - // void* txInfo_ptr - parameters: ["pointer"], - // bool - result: "bool", - }, - "MONERO_TransactionInfo_isFailed": { - nonblocking: true, - // void* txInfo_ptr - parameters: ["pointer"], - // bool - result: "bool", - }, - "MONERO_TransactionInfo_isCoinbase": { - nonblocking: true, - // void* txInfo_ptr - parameters: ["pointer"], - // bool - result: "bool", - }, - "MONERO_TransactionInfo_amount": { - nonblocking: true, - // void* txInfo_ptr - parameters: ["pointer"], - // uint64_t - result: "u64", - }, - "MONERO_TransactionInfo_fee": { - nonblocking: true, - // void* txInfo_ptr - parameters: ["pointer"], - // uint64_t - result: "u64", - }, - "MONERO_TransactionInfo_blockHeight": { - nonblocking: true, - // void* txInfo_ptr - parameters: ["pointer"], - // uint64_t - result: "u64", - }, - "MONERO_TransactionInfo_description": { - nonblocking: true, - // void* txInfo_ptr - parameters: ["pointer"], - // const char* - result: "pointer", - }, - "MONERO_TransactionInfo_subaddrIndex": { - nonblocking: true, - // void* txInfo_ptr - parameters: ["pointer"], - // const char* - result: "pointer", - }, - "MONERO_TransactionInfo_subaddrAccount": { - nonblocking: true, - // void* txInfo_ptr - parameters: ["pointer"], - // uint32_t - result: "u32", - }, - "MONERO_TransactionInfo_label": { - nonblocking: true, - // void* txInfo_ptr - parameters: ["pointer"], - // const char* - result: "pointer", - }, - "MONERO_TransactionInfo_confirmations": { - nonblocking: true, - // void* txInfo_ptr - parameters: ["pointer"], - // uint64_t - result: "u64", - }, - "MONERO_TransactionInfo_unlockTime": { - nonblocking: true, - // void* txInfo_ptr - parameters: ["pointer"], - // uint64_t - result: "u64", - }, - "MONERO_TransactionInfo_hash": { - nonblocking: true, - // void* txInfo_ptr - parameters: ["pointer"], - // const char* - result: "pointer", - }, - "MONERO_TransactionInfo_timestamp": { - nonblocking: true, - // void* txInfo_ptr - parameters: ["pointer"], - // uint64_t - result: "u64", - }, - "MONERO_TransactionInfo_paymentId": { - nonblocking: true, - // void* txInfo_ptr - parameters: ["pointer"], - // const char* - result: "pointer", - }, - "MONERO_TransactionInfo_transfers_count": { - nonblocking: true, - // void* txInfo_ptr - parameters: ["pointer"], - // int - result: "i32", - }, - "MONERO_TransactionInfo_transfers_amount": { - nonblocking: true, - // void* txInfo_ptr, int index - parameters: ["pointer", "i32"], - // uint64_t - result: "u64", - }, - "MONERO_TransactionInfo_transfers_address": { - nonblocking: true, - // void* txInfo_ptr, int index - parameters: ["pointer", "i32"], - // const char* - result: "pointer", - }, - //#endregion - - //#region PendingTransaction - "MONERO_PendingTransaction_status": { - nonblocking: true, - // void* pendingTx_ptr - parameters: ["pointer"], - // int - result: "i32", - }, - "MONERO_PendingTransaction_errorString": { - nonblocking: true, - // void* pendingTx_ptr - parameters: ["pointer"], - // const char* - result: "pointer", - }, - "MONERO_PendingTransaction_commit": { - nonblocking: true, - // void* pendingTx_ptr, const char* filename, bool overwrite - parameters: ["pointer", "pointer", "bool"], - // bool - result: "bool", - }, - "MONERO_PendingTransaction_commitUR": { - nonblocking: true, - // void* pendingTx_ptr, int max_fragment_length - parameters: ["pointer", "i32"], - // const char* - result: "pointer", - }, - "MONERO_PendingTransaction_amount": { - nonblocking: true, - // void* pendingTx_ptr - parameters: ["pointer"], - // uint64_t - result: "u64", - }, - "MONERO_PendingTransaction_dust": { - nonblocking: true, - // void* pendingTx_ptr - parameters: ["pointer"], - // uint64_t - result: "u64", - }, - "MONERO_PendingTransaction_fee": { - nonblocking: true, - // void* pendingTx_ptr - parameters: ["pointer"], - // uint64_t - result: "u64", - }, - "MONERO_PendingTransaction_txid": { - nonblocking: true, - // void* pendingTx_ptr, const char* separator - parameters: ["pointer", "pointer"], - // const char* - result: "pointer", - }, - "MONERO_PendingTransaction_txCount": { - nonblocking: true, - // void* pendingTx_ptr - parameters: ["pointer"], - // uint64_t - result: "u64", - }, - "MONERO_PendingTransaction_subaddrAccount": { - nonblocking: true, - // void* pendingTx_ptr, const char* separator - parameters: ["pointer", "pointer"], - // const char* - result: "pointer", - }, - "MONERO_PendingTransaction_subaddrIndices": { - nonblocking: true, - // void* pendingTx_ptr, const char* separator - parameters: ["pointer", "pointer"], - // const char* - result: "pointer", - }, - "MONERO_PendingTransaction_multisigSignData": { - nonblocking: true, - // void* pendingTx_ptr - parameters: ["pointer"], - // const char* - result: "pointer", - }, - "MONERO_PendingTransaction_signMultisigTx": { - nonblocking: true, - // void* pendingTx_ptr - parameters: ["pointer"], - // void - result: "void", - }, - "MONERO_PendingTransaction_signersKeys": { - nonblocking: true, - // void* pendingTx_ptr - parameters: ["pointer"], - // const char* - result: "pointer", - }, - "MONERO_PendingTransaction_hex": { - nonblocking: true, - // void* pendingTx_ptr, const char* separator - parameters: ["pointer", "pointer"], - // const char* - result: "pointer", - }, - //#endregion - - //#region Checksum - "MONERO_checksum_wallet2_api_c_h": { - nonblocking: true, - parameters: [], - // const char* - result: "pointer", - }, - "MONERO_checksum_wallet2_api_c_cpp": { - nonblocking: true, - parameters: [], - // const char* - result: "pointer", - }, - "MONERO_checksum_wallet2_api_c_exp": { - nonblocking: true, - parameters: [], - // const char* - result: "pointer", - }, - //#endregion - - "MONERO_free": { - nonblocking: true, - // void* ptr - parameters: ["pointer"], - // void - result: "void", - }, -} as const; - -type MoneroTsDylib = Deno.DynamicLibrary; - -export let dylib: MoneroTsDylib; -export function loadDylib(newDylib?: MoneroTsDylib) { +export function loadMoneroDylib(newDylib?: MoneroTsDylib) { if (newDylib) { dylib = newDylib; return; @@ -558,5 +24,30 @@ export function loadDylib(newDylib?: MoneroTsDylib) { break; } - dylib = Deno.dlopen(libPath, symbols); + dylib = Deno.dlopen(libPath, moneroSymbols); +} + +export function loadWowneroDylib(newDylib?: WowneroTsDylib) { + if (newDylib) { + dylib = newDylib; + return; + } + + let libPath: string; + switch (Deno.build.os) { + case "darwin": + libPath = "./lib/wownero_libwallet2_api_c.dylib"; + break; + case "android": + libPath = "./lib/libwownero_libwallet2_api_c.so"; + break; + case "windows": + libPath = "./lib/wownero_libwallet2_api_c.dll"; + break; + default: + libPath = "./lib/wownero_libwallet2_api_c.so"; + break; + } + + dylib = Deno.dlopen(libPath, wowneroSymbols); } diff --git a/impls/monero.ts/src/pending_transaction.ts b/impls/monero.ts/src/pending_transaction.ts index cf487218..169332fd 100644 --- a/impls/monero.ts/src/pending_transaction.ts +++ b/impls/monero.ts/src/pending_transaction.ts @@ -1,5 +1,4 @@ -import { dylib } from "./bindings.ts"; -import { CString, readCString, type Sanitizer } from "./utils.ts"; +import { CString, getSymbol, readCString, type Sanitizer } from "./utils.ts"; export type PendingTransactionPtr = Deno.PointerObject<"transactionInfo">; @@ -13,13 +12,13 @@ export class PendingTransaction { } async status(): Promise { - return await dylib.symbols.MONERO_PendingTransaction_status(this.#pendingTxPtr); + return await getSymbol("PendingTransaction_status")(this.#pendingTxPtr); } async errorString(): Promise { if (!await this.status()) return null; - const error = await dylib.symbols.MONERO_PendingTransaction_errorString(this.#pendingTxPtr); + const error = await getSymbol("PendingTransaction_errorString")(this.#pendingTxPtr); if (!error) return null; return await readCString(error) || null; @@ -34,7 +33,7 @@ export class PendingTransaction { } async commit(fileName: string, overwrite: boolean, sanitize = true): Promise { - const bool = await dylib.symbols.MONERO_PendingTransaction_commit( + const bool = await getSymbol("PendingTransaction_commit")( this.#pendingTxPtr, CString(fileName), overwrite, @@ -44,29 +43,36 @@ export class PendingTransaction { } async commitUR(maxFragmentLength: number): Promise { - const result = await dylib.symbols.MONERO_PendingTransaction_commitUR( + const commitUR = getSymbol("PendingTransaction_commitUR"); + + if (!commitUR) { + return null; + } + + const result = await commitUR( this.#pendingTxPtr, maxFragmentLength, ); + if (!result) return null; await this.throwIfError(); return await readCString(result) || null; } async amount(): Promise { - return await dylib.symbols.MONERO_PendingTransaction_amount(this.#pendingTxPtr); + return await getSymbol("PendingTransaction_amount")(this.#pendingTxPtr); } async dust(): Promise { - return await dylib.symbols.MONERO_PendingTransaction_dust(this.#pendingTxPtr); + return await getSymbol("PendingTransaction_dust")(this.#pendingTxPtr); } async fee(): Promise { - return await dylib.symbols.MONERO_PendingTransaction_fee(this.#pendingTxPtr); + return await getSymbol("PendingTransaction_fee")(this.#pendingTxPtr); } async txid(separator: string, sanitize = true): Promise { - const result = await dylib.symbols.MONERO_PendingTransaction_txid( + const result = await getSymbol("PendingTransaction_txid")( this.#pendingTxPtr, CString(separator), ); @@ -76,6 +82,6 @@ export class PendingTransaction { } async txCount(): Promise { - return await dylib.symbols.MONERO_PendingTransaction_txCount(this.#pendingTxPtr); + return await getSymbol("PendingTransaction_txCount")(this.#pendingTxPtr); } } diff --git a/impls/monero.ts/src/symbols.ts b/impls/monero.ts/src/symbols.ts new file mode 100644 index 00000000..38707b8f --- /dev/null +++ b/impls/monero.ts/src/symbols.ts @@ -0,0 +1,553 @@ +export const moneroSymbols = { + "MONERO_WalletManagerFactory_getWalletManager": { + nonblocking: true, + parameters: [], + // void* + result: "pointer", + }, + + //#region WalletManager + "MONERO_WalletManager_createWallet": { + nonblocking: true, + // void* wm_ptr, const char* path, const char* password, const char* language, int networkType + parameters: ["pointer", "pointer", "pointer", "pointer", "i32"], + // void* + result: "pointer", + }, + "MONERO_WalletManager_openWallet": { + nonblocking: true, + // void* wm_ptr, const char* path, const char* password, int networkType + "parameters": ["pointer", "pointer", "pointer", "i32"], + // void* + result: "pointer", + }, + "MONERO_WalletManager_recoveryWallet": { + nonblocking: true, + // void* wm_ptr, const char* path, const char* password, const char* mnemonic, + // int networkType, uint64_t restoreHeight, uint64_t kdfRounds, const char* seedOffset + parameters: ["pointer", "pointer", "pointer", "pointer", "i32", "u64", "u64", "pointer"], + // void* + result: "pointer", + }, + "MONERO_WalletManager_blockchainHeight": { + nonblocking: true, + // void* wm_ptr + parameters: ["pointer"], + // uint64_t + result: "u64", + }, + "MONERO_WalletManager_blockchainTargetHeight": { + nonblocking: true, + // void* wm_ptr + parameters: ["pointer"], + // uint64_t + result: "u64", + }, + "MONERO_WalletManager_setDaemonAddress": { + nonblocking: true, + // void* wm_ptr, const char* address + parameters: ["pointer", "pointer"], + // void + result: "void", + }, + //#endregion + + //#region Wallet + "MONERO_Wallet_init": { + nonblocking: true, + // void* wallet_ptr, const char* daemon_address, uint64_t upper_transaction_size_limit, + // const char* daemon_username, const char* daemon_password, bool use_ssl, bool lightWallet, + // const char* proxy_address + parameters: ["pointer", "pointer", "u64", "pointer", "pointer", "bool", "bool", "pointer"], + // bool + result: "bool", + }, + "MONERO_Wallet_init3": { + nonblocking: true, + // void* wallet_ptr, const char* argv0, const char* default_log_base_name, + // const char* log_path, bool console + parameters: ["pointer", "pointer", "pointer", "pointer", "bool"], + // void + result: "void", + }, + "MONERO_Wallet_setTrustedDaemon": { + nonblocking: true, + // void* wallet_ptr, bool arg + parameters: ["pointer", "bool"], + // void + result: "void", + }, + "MONERO_Wallet_startRefresh": { + nonblocking: true, + // void* wallet_ptr + parameters: ["pointer"], + // void + result: "void", + }, + "MONERO_Wallet_refreshAsync": { + nonblocking: true, + // void* wallet_ptr + parameters: ["pointer"], + // void + result: "void", + }, + "MONERO_Wallet_blockChainHeight": { + nonblocking: true, + // void* wallet_ptr + parameters: ["pointer"], + // uint64_t + result: "u64", + }, + "MONERO_Wallet_daemonBlockChainHeight": { + nonblocking: true, + // void* wallet_ptr + parameters: ["pointer"], + // uint64_t + result: "u64", + }, + "MONERO_Wallet_synchronized": { + nonblocking: true, + // void* wallet_ptr + parameters: ["pointer"], + // bool + result: "bool", + }, + "MONERO_Wallet_store": { + nonblocking: true, + // void* wallet_ptr, const char* path + parameters: ["pointer", "pointer"], + // bool + result: "bool", + }, + "MONERO_Wallet_address": { + nonblocking: true, + // void* wallet_ptr, uint64_t accountIndex, uint64_t addressIndex + parameters: ["pointer", "u64", "u64"], + // char* + result: "pointer", + }, + "MONERO_Wallet_balance": { + nonblocking: true, + // void* wallet_ptr, uint32_t accountIndex + parameters: ["pointer", "u32"], + // uint64_t + result: "u64", + }, + "MONERO_Wallet_unlockedBalance": { + nonblocking: true, + // void* wallet_ptr, uint32_t accountIndex + parameters: ["pointer", "u32"], + // uint64_t + result: "u64", + }, + "MONERO_Wallet_addSubaddressAccount": { + nonblocking: true, + // void* wallet_ptr, const char* label + parameters: ["pointer", "pointer"], + // void + result: "void", + }, + "MONERO_Wallet_numSubaddressAccounts": { + nonblocking: true, + // void* wallet_ptr + parameters: ["pointer"], + // size_t + result: "usize", + }, + "MONERO_Wallet_addSubaddress": { + nonblocking: true, + // void* wallet_ptr, uint32_t accountIndex, const char* label + parameters: ["pointer", "u32", "pointer"], + // void + result: "void", + }, + "MONERO_Wallet_numSubaddresses": { + nonblocking: true, + // void* wallet_ptr, uint32_t accountIndex + parameters: ["pointer", "u32"], + // size_t + result: "usize", + }, + "MONERO_Wallet_getSubaddressLabel": { + nonblocking: true, + // void* wallet_ptr, uint32_t accountIndex, uint32_t addressIndex + parameters: ["pointer", "u32", "u32"], + // const char* + result: "pointer", + }, + "MONERO_Wallet_setSubaddressLabel": { + nonblocking: true, + // void* wallet_ptr, uint32_t accountIndex, uint32_t addressIndex, const char* label + parameters: ["pointer", "u32", "u32", "pointer"], + // void + result: "void", + }, + "MONERO_Wallet_status": { + nonblocking: true, + // void* wallet_ptr + parameters: ["pointer"], + // int + result: "i32", + }, + "MONERO_Wallet_errorString": { + nonblocking: true, + // void* wallet_ptr + parameters: ["pointer"], + // char* + result: "pointer", + }, + "MONERO_Wallet_history": { + nonblocking: true, + // void* wallet_ptr + parameters: ["pointer"], + // void* + result: "pointer", + }, + "MONERO_Wallet_createTransaction": { + nonblocking: true, + // void* wallet_ptr, const char* dst_addr, const char* payment_id + // uint64_t amount, uint32_t mixin_count, int pendingTransactionPriority, + // uint32_t subaddr_account, const char* preferredInputs, const char* separator + parameters: ["pointer", "pointer", "pointer", "u64", "u32", "i32", "u32", "pointer", "pointer"], + // void* + result: "pointer", + }, + "MONERO_Wallet_amountFromString": { + nonblocking: true, + // const char* amount + parameters: ["pointer"], + // uint64_t + result: "u64", + }, + //#endregion + + //#region TransactionHistory + "MONERO_TransactionHistory_count": { + nonblocking: true, + // void* txHistory_ptr + parameters: ["pointer"], + // int + result: "i32", + }, + "MONERO_TransactionHistory_transaction": { + nonblocking: true, + // void* txHistory_ptr, int index + parameters: ["pointer", "i32"], + // void* + result: "pointer", + }, + "MONERO_TransactionHistory_transactionById": { + nonblocking: true, + // void* txHistory_ptr, const char* id + parameters: ["pointer", "pointer"], + // void* + result: "pointer", + }, + "MONERO_TransactionHistory_refresh": { + nonblocking: true, + // void* txHistory_ptr + parameters: ["pointer"], + // void + result: "void", + }, + "MONERO_TransactionHistory_setTxNote": { + nonblocking: true, + // void* txHistory_ptr, const char* txid, const char* note + parameters: ["pointer", "pointer", "pointer"], + // void + result: "void", + }, + //#endregion + + //#region TransactionInfo + "MONERO_TransactionInfo_direction": { + nonblocking: true, + // void* txInfo_ptr + parameters: ["pointer"], + // int + result: "i32", + }, + "MONERO_TransactionInfo_isPending": { + nonblocking: true, + // void* txInfo_ptr + parameters: ["pointer"], + // bool + result: "bool", + }, + "MONERO_TransactionInfo_isFailed": { + nonblocking: true, + // void* txInfo_ptr + parameters: ["pointer"], + // bool + result: "bool", + }, + "MONERO_TransactionInfo_isCoinbase": { + nonblocking: true, + // void* txInfo_ptr + parameters: ["pointer"], + // bool + result: "bool", + }, + "MONERO_TransactionInfo_amount": { + nonblocking: true, + // void* txInfo_ptr + parameters: ["pointer"], + // uint64_t + result: "u64", + }, + "MONERO_TransactionInfo_fee": { + nonblocking: true, + // void* txInfo_ptr + parameters: ["pointer"], + // uint64_t + result: "u64", + }, + "MONERO_TransactionInfo_blockHeight": { + nonblocking: true, + // void* txInfo_ptr + parameters: ["pointer"], + // uint64_t + result: "u64", + }, + "MONERO_TransactionInfo_description": { + nonblocking: true, + // void* txInfo_ptr + parameters: ["pointer"], + // const char* + result: "pointer", + }, + "MONERO_TransactionInfo_subaddrIndex": { + nonblocking: true, + // void* txInfo_ptr + parameters: ["pointer"], + // const char* + result: "pointer", + }, + "MONERO_TransactionInfo_subaddrAccount": { + nonblocking: true, + // void* txInfo_ptr + parameters: ["pointer"], + // uint32_t + result: "u32", + }, + "MONERO_TransactionInfo_label": { + nonblocking: true, + // void* txInfo_ptr + parameters: ["pointer"], + // const char* + result: "pointer", + }, + "MONERO_TransactionInfo_confirmations": { + nonblocking: true, + // void* txInfo_ptr + parameters: ["pointer"], + // uint64_t + result: "u64", + }, + "MONERO_TransactionInfo_unlockTime": { + nonblocking: true, + // void* txInfo_ptr + parameters: ["pointer"], + // uint64_t + result: "u64", + }, + "MONERO_TransactionInfo_hash": { + nonblocking: true, + // void* txInfo_ptr + parameters: ["pointer"], + // const char* + result: "pointer", + }, + "MONERO_TransactionInfo_timestamp": { + nonblocking: true, + // void* txInfo_ptr + parameters: ["pointer"], + // uint64_t + result: "u64", + }, + "MONERO_TransactionInfo_paymentId": { + nonblocking: true, + // void* txInfo_ptr + parameters: ["pointer"], + // const char* + result: "pointer", + }, + "MONERO_TransactionInfo_transfers_count": { + nonblocking: true, + // void* txInfo_ptr + parameters: ["pointer"], + // int + result: "i32", + }, + "MONERO_TransactionInfo_transfers_amount": { + nonblocking: true, + // void* txInfo_ptr, int index + parameters: ["pointer", "i32"], + // uint64_t + result: "u64", + }, + "MONERO_TransactionInfo_transfers_address": { + nonblocking: true, + // void* txInfo_ptr, int index + parameters: ["pointer", "i32"], + // const char* + result: "pointer", + }, + //#endregion + + //#region PendingTransaction + "MONERO_PendingTransaction_status": { + nonblocking: true, + // void* pendingTx_ptr + parameters: ["pointer"], + // int + result: "i32", + }, + "MONERO_PendingTransaction_errorString": { + nonblocking: true, + // void* pendingTx_ptr + parameters: ["pointer"], + // const char* + result: "pointer", + }, + "MONERO_PendingTransaction_commit": { + nonblocking: true, + // void* pendingTx_ptr, const char* filename, bool overwrite + parameters: ["pointer", "pointer", "bool"], + // bool + result: "bool", + }, + "MONERO_PendingTransaction_commitUR": { + optional: true, + nonblocking: true, + // void* pendingTx_ptr, int max_fragment_length + parameters: ["pointer", "i32"], + // const char* + result: "pointer", + }, + "MONERO_PendingTransaction_amount": { + nonblocking: true, + // void* pendingTx_ptr + parameters: ["pointer"], + // uint64_t + result: "u64", + }, + "MONERO_PendingTransaction_dust": { + nonblocking: true, + // void* pendingTx_ptr + parameters: ["pointer"], + // uint64_t + result: "u64", + }, + "MONERO_PendingTransaction_fee": { + nonblocking: true, + // void* pendingTx_ptr + parameters: ["pointer"], + // uint64_t + result: "u64", + }, + "MONERO_PendingTransaction_txid": { + nonblocking: true, + // void* pendingTx_ptr, const char* separator + parameters: ["pointer", "pointer"], + // const char* + result: "pointer", + }, + "MONERO_PendingTransaction_txCount": { + nonblocking: true, + // void* pendingTx_ptr + parameters: ["pointer"], + // uint64_t + result: "u64", + }, + "MONERO_PendingTransaction_subaddrAccount": { + nonblocking: true, + // void* pendingTx_ptr, const char* separator + parameters: ["pointer", "pointer"], + // const char* + result: "pointer", + }, + "MONERO_PendingTransaction_subaddrIndices": { + nonblocking: true, + // void* pendingTx_ptr, const char* separator + parameters: ["pointer", "pointer"], + // const char* + result: "pointer", + }, + "MONERO_PendingTransaction_multisigSignData": { + nonblocking: true, + // void* pendingTx_ptr + parameters: ["pointer"], + // const char* + result: "pointer", + }, + "MONERO_PendingTransaction_signMultisigTx": { + nonblocking: true, + // void* pendingTx_ptr + parameters: ["pointer"], + // void + result: "void", + }, + "MONERO_PendingTransaction_signersKeys": { + nonblocking: true, + // void* pendingTx_ptr + parameters: ["pointer"], + // const char* + result: "pointer", + }, + "MONERO_PendingTransaction_hex": { + nonblocking: true, + // void* pendingTx_ptr, const char* separator + parameters: ["pointer", "pointer"], + // const char* + result: "pointer", + }, + //#endregion + + //#region Checksum + "MONERO_checksum_wallet2_api_c_h": { + optional: true, + nonblocking: true, + parameters: [], + // const char* + result: "pointer", + }, + "MONERO_checksum_wallet2_api_c_cpp": { + optional: true, + nonblocking: true, + parameters: [], + // const char* + result: "pointer", + }, + "MONERO_checksum_wallet2_api_c_exp": { + optional: true, + nonblocking: true, + parameters: [], + // const char* + result: "pointer", + }, + //#endregion + + "MONERO_free": { + nonblocking: true, + // void* ptr + parameters: ["pointer"], + // void + result: "void", + }, +} as const; + +type MoneroSymbols = typeof moneroSymbols; +export type MoneroTsDylib = Deno.DynamicLibrary; + +type ReplaceMonero = T extends `MONERO${infer Y}` ? `WOWNERO${Y}` : never; + +type WowneroSymbols = { [Key in keyof MoneroSymbols as ReplaceMonero]: MoneroSymbols[Key] }; + +export const wowneroSymbols = Object.fromEntries( + Object.entries(moneroSymbols).map(([key, value]) => [key.replace("MONERO", "WOWNERO"), value]), +) as WowneroSymbols; + +export type WowneroTsDylib = Deno.DynamicLibrary; + +export type Dylib = MoneroTsDylib | WowneroTsDylib; diff --git a/impls/monero.ts/src/transaction_history.ts b/impls/monero.ts/src/transaction_history.ts index cc76fc25..aab64da7 100644 --- a/impls/monero.ts/src/transaction_history.ts +++ b/impls/monero.ts/src/transaction_history.ts @@ -1,6 +1,5 @@ -import { dylib } from "./bindings.ts"; import { TransactionInfo, TransactionInfoPtr } from "./transaction_info.ts"; -import { CString } from "./utils.ts"; +import { CString, getSymbol } from "./utils.ts"; export type TransactionHistoryPtr = Deno.PointerObject<"transactionHistory">; @@ -12,24 +11,23 @@ export class TransactionHistory { } async count(): Promise { - return await dylib.symbols.MONERO_TransactionHistory_count(this.#txHistoryPtr); + return await getSymbol("TransactionHistory_count")(this.#txHistoryPtr); } async transaction(index: number): Promise { return new TransactionInfo( - (await dylib.symbols.MONERO_TransactionHistory_transaction( - this.#txHistoryPtr, - index, - )) as TransactionInfoPtr, + ( + await getSymbol("TransactionHistory_transaction")(this.#txHistoryPtr, index) + ) as TransactionInfoPtr, ); } async refresh(): Promise { - await dylib.symbols.MONERO_TransactionHistory_refresh(this.#txHistoryPtr); + await getSymbol("TransactionHistory_refresh")(this.#txHistoryPtr); } async setTxNote(transactionId: string, note: string): Promise { - await dylib.symbols.MONERO_TransactionHistory_setTxNote( + await getSymbol("TransactionHistory_setTxNote")( this.#txHistoryPtr, CString(transactionId), CString(note), diff --git a/impls/monero.ts/src/transaction_info.ts b/impls/monero.ts/src/transaction_info.ts index 7db45f5d..22ea0e78 100644 --- a/impls/monero.ts/src/transaction_info.ts +++ b/impls/monero.ts/src/transaction_info.ts @@ -1,5 +1,5 @@ import { dylib } from "./bindings.ts"; -import { readCString, Sanitizer } from "./utils.ts"; +import { getSymbol, readCString, Sanitizer } from "./utils.ts"; export type TransactionInfoPtr = Deno.PointerObject<"transactionInfo">; @@ -13,7 +13,7 @@ export class TransactionInfo { } async direction(): Promise<"in" | "out"> { - switch (await dylib.symbols.MONERO_TransactionInfo_direction(this.#txInfoPtr)) { + switch (await getSymbol("TransactionInfo_direction")(this.#txInfoPtr)) { case 0: return "in"; case 1: @@ -25,80 +25,80 @@ export class TransactionInfo { } async isPending(): Promise { - return await dylib.symbols.MONERO_TransactionInfo_isPending(this.#txInfoPtr); + return await getSymbol("TransactionInfo_isPending")(this.#txInfoPtr); } async isFailed(): Promise { - return await dylib.symbols.MONERO_TransactionInfo_isFailed(this.#txInfoPtr); + return await getSymbol("TransactionInfo_isFailed")(this.#txInfoPtr); } async isCoinbase(): Promise { - return await dylib.symbols.MONERO_TransactionInfo_isCoinbase(this.#txInfoPtr); + return await getSymbol("TransactionInfo_isCoinbase")(this.#txInfoPtr); } async amount(): Promise { - return await dylib.symbols.MONERO_TransactionInfo_amount(this.#txInfoPtr); + return await getSymbol("TransactionInfo_amount")(this.#txInfoPtr); } async fee(): Promise { - return await dylib.symbols.MONERO_TransactionInfo_fee(this.#txInfoPtr); + return await getSymbol("TransactionInfo_fee")(this.#txInfoPtr); } async blockHeight(): Promise { - return await dylib.symbols.MONERO_TransactionInfo_blockHeight(this.#txInfoPtr); + return await getSymbol("TransactionInfo_blockHeight")(this.#txInfoPtr); } async description(): Promise { - const description = await dylib.symbols.MONERO_TransactionInfo_description(this.#txInfoPtr); + const description = await getSymbol("TransactionInfo_description")(this.#txInfoPtr); return await readCString(description) || ""; } async subaddrIndex(): Promise { - const subaddrIndex = await dylib.symbols.MONERO_TransactionInfo_subaddrIndex(this.#txInfoPtr); + const subaddrIndex = await getSymbol("TransactionInfo_subaddrIndex")(this.#txInfoPtr); return await readCString(subaddrIndex) || ""; } async subaddrAccount(): Promise { - return await dylib.symbols.MONERO_TransactionInfo_subaddrAccount(this.#txInfoPtr); + return await getSymbol("TransactionInfo_subaddrAccount")(this.#txInfoPtr); } async label(): Promise { - const label = await dylib.symbols.MONERO_TransactionInfo_label(this.#txInfoPtr); + const label = await getSymbol("TransactionInfo_label")(this.#txInfoPtr); return await readCString(label) || ""; } async confirmations(): Promise { - return await dylib.symbols.MONERO_TransactionInfo_confirmations(this.#txInfoPtr); + return await getSymbol("TransactionInfo_confirmations")(this.#txInfoPtr); } async unlockTime(): Promise { - return await dylib.symbols.MONERO_TransactionInfo_unlockTime(this.#txInfoPtr); + return await getSymbol("TransactionInfo_unlockTime")(this.#txInfoPtr); } async hash(): Promise { - const hash = await dylib.symbols.MONERO_TransactionInfo_hash(this.#txInfoPtr); + const hash = await getSymbol("TransactionInfo_hash")(this.#txInfoPtr); return await readCString(hash) || ""; } async timestamp(): Promise { - return await dylib.symbols.MONERO_TransactionInfo_timestamp(this.#txInfoPtr); + return await getSymbol("TransactionInfo_timestamp")(this.#txInfoPtr); } async paymentId(): Promise { - const paymentId = await dylib.symbols.MONERO_TransactionInfo_paymentId(this.#txInfoPtr); + const paymentId = await getSymbol("TransactionInfo_paymentId")(this.#txInfoPtr); return await readCString(paymentId) || ""; } async transfersCount(): Promise { - return await dylib.symbols.MONERO_TransactionInfo_transfers_count(this.#txInfoPtr); + return await getSymbol("TransactionInfo_transfers_count")(this.#txInfoPtr); } async transfersAmount(index: number): Promise { - return await dylib.symbols.MONERO_TransactionInfo_transfers_amount(this.#txInfoPtr, index); + return await getSymbol("TransactionInfo_transfers_amount")(this.#txInfoPtr, index); } async transfersAddress(index: number): Promise { - const transfersAddress = await dylib.symbols.MONERO_TransactionInfo_transfers_address(this.#txInfoPtr, index); + const transfersAddress = await getSymbol("TransactionInfo_transfers_address")(this.#txInfoPtr, index); return await readCString(transfersAddress) || ""; } } diff --git a/impls/monero.ts/src/utils.ts b/impls/monero.ts/src/utils.ts index 6fa640f6..e88ddcd1 100644 --- a/impls/monero.ts/src/utils.ts +++ b/impls/monero.ts/src/utils.ts @@ -1,4 +1,5 @@ import { dylib } from "../mod.ts"; +import type { moneroSymbols, MoneroTsDylib, WowneroTsDylib } from "./symbols.ts"; export type Sanitizer = () => void | PromiseLike; @@ -7,6 +8,17 @@ export function CString(string: string): Deno.PointerValue { return Deno.UnsafePointer.of(textEncoder.encode(`${string}\x00`)); } +type SymbolWithoutPrefix = keyof typeof moneroSymbols extends `MONERO_${infer DylibSymbol}` ? DylibSymbol : never; +export function getSymbol( + symbol: S, +): MoneroTsDylib["symbols"][`MONERO_${S}`] | WowneroTsDylib["symbols"][`WOWNERO_${S}`] { + if ("MONERO_free" in dylib.symbols) { + return dylib.symbols[`MONERO_${symbol}` as const]; + } else { + return dylib.symbols[`WOWNERO_${symbol}` as const]; + } +} + /** * This method reads string from the given pointer and frees the string. * @@ -19,7 +31,7 @@ export async function readCString(pointer: Deno.PointerValue, free = true): Prom if (!pointer) return null; const string = new Deno.UnsafePointerView(pointer).getCString(); if (free) { - await dylib.symbols.MONERO_free(pointer); + await getSymbol("free")(pointer); } return string; } diff --git a/impls/monero.ts/src/wallet.ts b/impls/monero.ts/src/wallet.ts index 07c40ceb..ea25f21f 100644 --- a/impls/monero.ts/src/wallet.ts +++ b/impls/monero.ts/src/wallet.ts @@ -1,8 +1,8 @@ import { dylib } from "./bindings.ts"; -import { CString, readCString, Sanitizer } from "./utils.ts"; +import { CString, getSymbol, readCString, Sanitizer } from "./utils.ts"; + import { WalletManager, type WalletManagerPtr } from "./wallet_manager.ts"; import { TransactionHistory, TransactionHistoryPtr } from "./transaction_history.ts"; - import { PendingTransaction } from "./pending_transaction.ts"; import { PendingTransactionPtr } from "./pending_transaction.ts"; @@ -19,40 +19,44 @@ export class Wallet { this.sanitizer = sanitizer; } + getPointer(): WalletPtr { + return this.#walletPtr; + } + async store(path = ""): Promise { - const bool = await dylib.symbols.MONERO_Wallet_store(this.#walletPtr, CString(path)); + const bool = await getSymbol("Wallet_store")(this.#walletPtr, CString(path)); await this.throwIfError(); return bool; } - async initWallet(): Promise { + async initWallet(daemonAddress = "http://nodex.monerujo.io:18081"): Promise { await this.init(); await this.setTrustedDaemon(true); - await this.setDaemonAddress("http://nodex.monerujo.io:18081"); + await this.setDaemonAddress(daemonAddress); await this.startRefresh(); await this.refreshAsync(); await this.throwIfError(); } async setDaemonAddress(address: string): Promise { - await dylib.symbols.MONERO_WalletManager_setDaemonAddress( + await getSymbol("WalletManager_setDaemonAddress")( this.#walletManagerPtr, CString(address), ); } async startRefresh(): Promise { - await dylib.symbols.MONERO_Wallet_startRefresh(this.#walletPtr); + await getSymbol("Wallet_startRefresh")(this.#walletPtr); await this.throwIfError(); } async refreshAsync(): Promise { - await dylib.symbols.MONERO_Wallet_refreshAsync(this.#walletPtr); + await getSymbol("Wallet_refreshAsync")(this.#walletPtr); await this.throwIfError(); } async init(): Promise { - const bool = await dylib.symbols.MONERO_Wallet_init( + const bool = await getSymbol("Wallet_init")( this.#walletPtr, CString("http://nodex.monerujo.io:18081"), 0n, @@ -67,7 +71,7 @@ export class Wallet { } async setTrustedDaemon(value: boolean): Promise { - await dylib.symbols.MONERO_Wallet_setTrustedDaemon(this.#walletPtr, value); + await getSymbol("Wallet_setTrustedDaemon")(this.#walletPtr, value); } static async create( @@ -79,7 +83,7 @@ export class Wallet { // We assign holder of the pointer in Wallet constructor const walletManagerPtr = walletManager.getPointer(); - const walletPtr = await dylib.symbols.MONERO_WalletManager_createWallet( + const walletPtr = await getSymbol("WalletManager_createWallet")( walletManagerPtr, CString(path), CString(password), @@ -103,7 +107,7 @@ export class Wallet { // We assign holder of the pointer in Wallet constructor const walletManagerPtr = walletManager.getPointer(); - const walletPtr = await dylib.symbols.MONERO_WalletManager_openWallet( + const walletPtr = await getSymbol("WalletManager_openWallet")( walletManagerPtr, CString(path), CString(password), @@ -129,7 +133,7 @@ export class Wallet { // We assign holder of the pointer in Wallet constructor const walletManagerPtr = walletManager.getPointer(); - const walletPtr = await dylib.symbols.MONERO_WalletManager_recoveryWallet( + const walletPtr = await getSymbol("WalletManager_recoveryWallet")( walletManagerPtr, CString(path), CString(password), @@ -148,7 +152,7 @@ export class Wallet { } async address(accountIndex = 0n, addressIndex = 0n): Promise { - const address = await dylib.symbols.MONERO_Wallet_address(this.#walletPtr, accountIndex, addressIndex); + const address = await getSymbol("Wallet_address")(this.#walletPtr, accountIndex, addressIndex); if (!address) { const error = await this.errorString(); throw new Error(`Failed getting address from a wallet: ${error ?? ""}`); @@ -157,21 +161,21 @@ export class Wallet { } async balance(accountIndex = 0): Promise { - return await dylib.symbols.MONERO_Wallet_balance(this.#walletPtr, accountIndex); + return await getSymbol("Wallet_balance")(this.#walletPtr, accountIndex); } async unlockedBalance(accountIndex = 0): Promise { - return await dylib.symbols.MONERO_Wallet_unlockedBalance(this.#walletPtr, accountIndex); + return await getSymbol("Wallet_unlockedBalance")(this.#walletPtr, accountIndex); } status(): Promise { - return dylib.symbols.MONERO_Wallet_status(this.#walletPtr); + return getSymbol("Wallet_status")(this.#walletPtr); } async errorString(): Promise { if (!await this.status()) return null; - const error = await dylib.symbols.MONERO_Wallet_errorString(this.#walletPtr); + const error = await getSymbol("Wallet_errorString")(this.#walletPtr); if (!error) return null; return await readCString(error) || null; @@ -186,37 +190,37 @@ export class Wallet { } async synchronized(): Promise { - const synchronized = await dylib.symbols.MONERO_Wallet_synchronized(this.#walletPtr); + const synchronized = await getSymbol("Wallet_synchronized")(this.#walletPtr); await this.throwIfError(); return synchronized; } async blockChainHeight(): Promise { - const height = await dylib.symbols.MONERO_Wallet_blockChainHeight(this.#walletPtr); + const height = await getSymbol("Wallet_blockChainHeight")(this.#walletPtr); await this.throwIfError(); return height; } async daemonBlockChainHeight(): Promise { - const height = await dylib.symbols.MONERO_Wallet_daemonBlockChainHeight(this.#walletPtr); + const height = await getSymbol("Wallet_daemonBlockChainHeight")(this.#walletPtr); await this.throwIfError(); return height; } async managerBlockChainHeight(): Promise { - const height = await dylib.symbols.MONERO_WalletManager_blockchainHeight(this.#walletManagerPtr); + const height = await getSymbol("WalletManager_blockchainHeight")(this.#walletManagerPtr); await this.throwIfError(); return height; } async managerTargetBlockChainHeight(): Promise { - const height = await dylib.symbols.MONERO_WalletManager_blockchainTargetHeight(this.#walletManagerPtr); + const height = await getSymbol("WalletManager_blockchainTargetHeight")(this.#walletManagerPtr); await this.throwIfError(); return height; } async addSubaddressAccount(label: string): Promise { - await dylib.symbols.MONERO_Wallet_addSubaddressAccount( + await getSymbol("Wallet_addSubaddressAccount")( this.#walletPtr, CString(label), ); @@ -224,13 +228,13 @@ export class Wallet { } async numSubaddressAccounts(): Promise { - const accountsLen = await dylib.symbols.MONERO_Wallet_numSubaddressAccounts(this.#walletPtr); + const accountsLen = await getSymbol("Wallet_numSubaddressAccounts")(this.#walletPtr); await this.throwIfError(); return accountsLen; } async addSubaddress(accountIndex: number, label: string): Promise { - await dylib.symbols.MONERO_Wallet_addSubaddress( + await getSymbol("Wallet_addSubaddress")( this.#walletPtr, accountIndex, CString(label), @@ -239,7 +243,7 @@ export class Wallet { } async numSubaddresses(accountIndex: number): Promise { - const address = await dylib.symbols.MONERO_Wallet_numSubaddresses( + const address = await getSymbol("Wallet_numSubaddresses")( this.#walletPtr, accountIndex, ); @@ -248,7 +252,7 @@ export class Wallet { } async getSubaddressLabel(accountIndex: number, addressIndex: number): Promise { - const label = await dylib.symbols.MONERO_Wallet_getSubaddressLabel(this.#walletPtr, accountIndex, addressIndex); + const label = await getSymbol("Wallet_getSubaddressLabel")(this.#walletPtr, accountIndex, addressIndex); if (!label) { const error = await this.errorString(); throw new Error(`Failed getting subaddress label from a wallet: ${error ?? ""}`); @@ -257,7 +261,7 @@ export class Wallet { } async setSubaddressLabel(accountIndex: number, addressIndex: number, label: string): Promise { - await dylib.symbols.MONERO_Wallet_setSubaddressLabel( + await getSymbol("Wallet_setSubaddressLabel")( this.#walletPtr, accountIndex, addressIndex, @@ -267,7 +271,7 @@ export class Wallet { } async getHistory(): Promise { - const transactionHistoryPointer = await dylib.symbols.MONERO_Wallet_history(this.#walletPtr); + const transactionHistoryPointer = await getSymbol("Wallet_history")(this.#walletPtr); await this.throwIfError(); return new TransactionHistory(transactionHistoryPointer as TransactionHistoryPtr); } @@ -283,7 +287,7 @@ export class Wallet { paymentId = "", separator = ",", ): Promise { - const pendingTxPtr = await dylib.symbols.MONERO_Wallet_createTransaction( + const pendingTxPtr = await getSymbol("Wallet_createTransaction")( this.#walletPtr, CString(destinationAddress), CString(paymentId), @@ -299,6 +303,6 @@ export class Wallet { } async amountFromString(amount: string): Promise { - return await dylib.symbols.MONERO_Wallet_amountFromString(CString(amount)); + return await getSymbol("Wallet_amountFromString")(CString(amount)); } } diff --git a/impls/monero.ts/src/wallet_manager.ts b/impls/monero.ts/src/wallet_manager.ts index ad9cf315..b1fafec3 100644 --- a/impls/monero.ts/src/wallet_manager.ts +++ b/impls/monero.ts/src/wallet_manager.ts @@ -1,5 +1,4 @@ -import { dylib } from "./bindings.ts"; -import { Sanitizer } from "./utils.ts"; +import { getSymbol, Sanitizer } from "./utils.ts"; export type WalletManagerPtr = Deno.PointerObject<"walletManager">; @@ -17,7 +16,7 @@ export class WalletManager { } static async new(sanitizer?: Sanitizer) { - const ptr = await dylib.symbols.MONERO_WalletManagerFactory_getWalletManager(); + const ptr = await getSymbol("WalletManagerFactory_getWalletManager")(); if (!ptr) { sanitizer?.(); throw new Error("Failed retrieving wallet manager"); diff --git a/monero_libwallet2_api_c/CMakeLists.txt b/monero_libwallet2_api_c/CMakeLists.txt index eb1714ef..60be91cf 100644 --- a/monero_libwallet2_api_c/CMakeLists.txt +++ b/monero_libwallet2_api_c/CMakeLists.txt @@ -32,6 +32,7 @@ if(${HOST_ABI} STREQUAL "x86_64-linux-android" OR ${HOST_ABI} STREQUAL "aarch64-linux-android" OR ${HOST_ABI} STREQUAL "armv7a-linux-androideabi") add_link_options(-stdlib=libc++ -static-libstdc++) + set(EXTRA_LIBS_ANDROID log) endif() add_library( wallet2_api_c diff --git a/monero_libwallet2_api_c/src/main/cpp/helpers.cpp b/monero_libwallet2_api_c/src/main/cpp/helpers.cpp index d6928793..8e45eba9 100644 --- a/monero_libwallet2_api_c/src/main/cpp/helpers.cpp +++ b/monero_libwallet2_api_c/src/main/cpp/helpers.cpp @@ -9,6 +9,71 @@ #include #include #include +#include + +#ifdef __ANDROID__ +#include + +#define LOG_TAG "moneroc" +#define BUFFER_SIZE 1024*32 + +static int stdoutToLogcat(const char *buf, int size) { + __android_log_write(ANDROID_LOG_INFO, LOG_TAG, buf); + return size; +} + +static int stderrToLogcat(const char *buf, int size) { + __android_log_write(ANDROID_LOG_ERROR, LOG_TAG, buf); + return size; +} + +void redirectStdoutThread(int pipe_stdout[2]) { + char bufferStdout[BUFFER_SIZE]; + while (true) { + int read_size = read(pipe_stdout[0], bufferStdout, sizeof(bufferStdout) - 1); + if (read_size > 0) { + bufferStdout[read_size] = '\0'; + stdoutToLogcat(bufferStdout, read_size); + } + } +} + +void redirectStderrThread(int pipe_stderr[2]) { + char bufferStderr[BUFFER_SIZE]; + while (true) { + int read_size = read(pipe_stderr[0], bufferStderr, sizeof(bufferStderr) - 1); + if (read_size > 0) { + bufferStderr[read_size] = '\0'; + stderrToLogcat(bufferStderr, read_size); + } + } +} + +void setupAndroidLogging() { + static int pfdStdout[2]; + static int pfdStderr[2]; + + pipe(pfdStdout); + pipe(pfdStderr); + + dup2(pfdStdout[1], STDOUT_FILENO); + dup2(pfdStderr[1], STDERR_FILENO); + + std::thread stdoutThread(redirectStdoutThread, pfdStdout); + std::thread stderrThread(redirectStderrThread, pfdStderr); + + stdoutThread.detach(); + stderrThread.detach(); +} + +#endif // __ANDROID__ + +__attribute__((constructor)) +void library_init() { +#ifdef __ANDROID__ + setupAndroidLogging(); // This will now run automatically when the library is loaded +#endif +} const char* vectorToString(const std::vector& vec, const std::string separator) { // Check if the vector is empty @@ -195,4 +260,4 @@ std::vector splitStringUint(const std::string& str, const std::string& } tokens.push_back(std::stoull(content)); // Inserting the last token return tokens; -} \ No newline at end of file +} diff --git a/patches/monero/0019-fix-for-coin-control-patch.patch b/patches/monero/0019-fix-for-coin-control-patch.patch new file mode 100644 index 00000000..b7ff7f99 --- /dev/null +++ b/patches/monero/0019-fix-for-coin-control-patch.patch @@ -0,0 +1,97 @@ +From 8f93306ed526e0e573b33fc7dd40abbba7e7a00a Mon Sep 17 00:00:00 2001 +From: Czarek Nakamoto +Date: Tue, 15 Oct 2024 18:00:05 +0200 +Subject: [PATCH] fix for coin control patch + +--- + src/wallet/api/coins.cpp | 1 + + src/wallet/api/wallet.cpp | 36 +++++++++++++++++++++++++++++++++++- + 2 files changed, 36 insertions(+), 1 deletion(-) + +diff --git a/src/wallet/api/coins.cpp b/src/wallet/api/coins.cpp +index 2321c638d..ef12141cf 100644 +--- a/src/wallet/api/coins.cpp ++++ b/src/wallet/api/coins.cpp +@@ -114,6 +114,7 @@ void CoinsImpl::setFrozen(int index) + { + try + { ++ LOG_ERROR("Freezing coin: " << index); + m_wallet->m_wallet->freeze(index); + refresh(); + } +diff --git a/src/wallet/api/wallet.cpp b/src/wallet/api/wallet.cpp +index ec7d60ec0..db127dae4 100644 +--- a/src/wallet/api/wallet.cpp ++++ b/src/wallet/api/wallet.cpp +@@ -2116,6 +2116,7 @@ PendingTransaction *WalletImpl::createTransactionMultDest(const std::vectornettype(), dst_addr[i])) { + // TODO: copy-paste 'if treating as an address fails, try as url' from simplewallet.cpp:1982 +@@ -2137,6 +2138,7 @@ PendingTransaction *WalletImpl::createTransactionMultDest(const std::vectorunlocked_balance(subaddr_account, true); ++ // if (maxAllowedSpend < amountSum) { ++ // error = true; ++ // setStatusError(tr("Amount you are trying to spend is larger than unlocked amount")); ++ // break; ++ // } + std::vector preferred_input_list; + if (!preferred_inputs.empty()) { ++ LOG_ERROR("empty"); ++ + for (const auto &public_key : preferred_inputs) { + crypto::key_image keyImage; + bool r = epee::string_tools::hex_to_pod(public_key, keyImage); +- if (!r) { ++ if (!r) { + error = true; + setStatusError(tr("failed to parse key image")); + break; + } ++ if (m_wallet->frozen(keyImage)) { ++ error = true; ++ setStatusError(tr("refusing to spend frozen coin")); ++ break; ++ } ++ + preferred_input_list.push_back(keyImage); + } ++ } else { ++ LOG_ERROR("not empty"); ++ ++ boost::shared_lock transfers_lock(m_wallet->m_transfers_mutex); ++ for (size_t i = 0; i < m_wallet->get_num_transfer_details(); ++i) { ++ const tools::wallet2::transfer_details &td = m_wallet->get_transfer_details(i); ++ LOG_ERROR("COIN: " << i << ": " << td.amount() << "; "<frozen(td)); ++ if (td.m_spent) continue; ++ LOG_ERROR("is frozen"); ++ if (!td.m_frozen) { ++ LOG_ERROR("isn't:"); ++ LOG_ERROR("hash: " << td.m_key_image << "; " << td.amount()); ++ preferred_input_list.push_back(td.m_key_image); ++ } ++ } ++ } ++ for (const auto &de : preferred_input_list) { ++ LOG_ERROR("preferred input: " << de); + } + if (error) { + break; +-- +2.39.5 (Apple Git-154) + diff --git a/tests/compare.ts b/tests/compare.ts new file mode 100755 index 00000000..d09bdd93 --- /dev/null +++ b/tests/compare.ts @@ -0,0 +1,80 @@ +import { moneroSymbols as symbols, type MoneroTsDylib, type WowneroTsDylib } from "../impls/monero.ts/src/symbols.ts"; +import { loadMoneroDylib, loadWowneroDylib } from "../impls/monero.ts/src/bindings.ts"; +import { Wallet, WalletManager } from "../impls/monero.ts/mod.ts"; +import { readCString } from "../impls/monero.ts/src/utils.ts"; +import { assertEquals } from "jsr:@std/assert"; + +const coin = Deno.args[0] as "monero" | "wownero"; +const version = Deno.args[1]; +const walletInfo = JSON.parse(Deno.args[2]); + +const moneroSymbols = { + ...symbols, + + "MONERO_Wallet_secretViewKey": { + nonblocking: true, + // void* wallet_ptr + parameters: ["pointer"], + // const char* + result: "pointer", + }, + "MONERO_Wallet_publicViewKey": { + nonblocking: true, + // void* wallet_ptr + parameters: ["pointer"], + // const char* + result: "pointer", + }, + + "MONERO_Wallet_secretSpendKey": { + nonblocking: true, + // void* wallet_ptr + parameters: ["pointer"], + // const char* + result: "pointer", + }, + "MONERO_Wallet_publicSpendKey": { + nonblocking: true, + // void* wallet_ptr + parameters: ["pointer"], + // const char* + result: "pointer", + }, +} as const; + +type ReplaceMonero = T extends `MONERO${infer Y}` ? `WOWNERO${Y}` : never; +type WowneroSymbols = { [Key in keyof typeof moneroSymbols as ReplaceMonero]: (typeof moneroSymbols)[Key] }; +const wowneroSymbols = Object.fromEntries( + Object.entries(moneroSymbols).map(([key, value]) => [key.replace("MONERO", "WOWNERO"), value]), +) as WowneroSymbols; + +let getKey: (wallet: Wallet, type: `${"secret" | "public"}${"Spend" | "View"}Key`) => Promise; + +if (coin === "monero") { + const dylib = Deno.dlopen(`tests/libs/${version}/monero_libwallet2_api_c.so`, moneroSymbols); + loadMoneroDylib(dylib as MoneroTsDylib); + + getKey = async (wallet, type) => + await readCString(await dylib.symbols[`MONERO_Wallet_${type}` as const](wallet.getPointer())); +} else { + const dylib = Deno.dlopen(`tests/libs/${version}/wownero_libwallet2_api_c.so`, wowneroSymbols); + loadWowneroDylib(dylib as WowneroTsDylib); + + getKey = async (wallet, type) => + await readCString( + await dylib.symbols[`WOWNERO_Wallet_${type}` as const](wallet.getPointer()), + ); +} + +const walletManager = await WalletManager.new(); +const wallet = await Wallet.open(walletManager, walletInfo.path, walletInfo.password); + +assertEquals(await wallet.address(), walletInfo.address); + +assertEquals(await getKey(wallet, "publicSpendKey"), walletInfo.publicSpendKey); +assertEquals(await getKey(wallet, "secretSpendKey"), walletInfo.secretSpendKey); + +assertEquals(await getKey(wallet, "publicViewKey"), walletInfo.publicViewKey); +assertEquals(await getKey(wallet, "secretViewKey"), walletInfo.secretViewKey); + +await wallet.store(walletInfo.path); diff --git a/tests/deno.jsonc b/tests/deno.jsonc new file mode 100755 index 00000000..a7b75eca --- /dev/null +++ b/tests/deno.jsonc @@ -0,0 +1,5 @@ +{ + "fmt": { + "lineWidth": 120 + } +} diff --git a/tests/deno.lock b/tests/deno.lock new file mode 100755 index 00000000..02d189fe --- /dev/null +++ b/tests/deno.lock @@ -0,0 +1,90 @@ +{ + "version": "4", + "specifiers": { + "jsr:@david/dax@*": "0.42.0", + "jsr:@david/path@0.2": "0.2.0", + "jsr:@david/which@~0.4.1": "0.4.1", + "jsr:@std/assert@*": "0.221.0", + "jsr:@std/assert@0.221": "0.221.0", + "jsr:@std/bytes@0.221": "0.221.0", + "jsr:@std/fmt@0.221": "0.221.0", + "jsr:@std/fmt@1": "1.0.2", + "jsr:@std/fs@1": "1.0.4", + "jsr:@std/io@0.221": "0.221.0", + "jsr:@std/path@1": "1.0.6", + "jsr:@std/path@^1.0.6": "1.0.6", + "jsr:@std/streams@0.221": "0.221.0", + "jsr:@std/streams@^1.0.7": "1.0.7", + "jsr:@std/tar@*": "0.1.2" + }, + "jsr": { + "@david/dax@0.42.0": { + "integrity": "0c547c9a20577a6072b90def194c159c9ddab82280285ebfd8268a4ebefbd80b", + "dependencies": [ + "jsr:@david/path", + "jsr:@david/which", + "jsr:@std/fmt@1", + "jsr:@std/fs", + "jsr:@std/io", + "jsr:@std/path@1", + "jsr:@std/streams@0.221" + ] + }, + "@david/path@0.2.0": { + "integrity": "f2d7aa7f02ce5a55e27c09f9f1381794acb09d328f8d3c8a2e3ab3ffc294dccd", + "dependencies": [ + "jsr:@std/fs", + "jsr:@std/path@1" + ] + }, + "@david/which@0.4.1": { + "integrity": "896a682b111f92ab866cc70c5b4afab2f5899d2f9bde31ed00203b9c250f225e" + }, + "@std/assert@0.221.0": { + "integrity": "a5f1aa6e7909dbea271754fd4ab3f4e687aeff4873b4cef9a320af813adb489a", + "dependencies": [ + "jsr:@std/fmt@0.221" + ] + }, + "@std/bytes@0.221.0": { + "integrity": "64a047011cf833890a4a2ab7293ac55a1b4f5a050624ebc6a0159c357de91966" + }, + "@std/fmt@0.221.0": { + "integrity": "379fed69bdd9731110f26b9085aeb740606b20428ce6af31ef6bd45ef8efa62a" + }, + "@std/fmt@1.0.2": { + "integrity": "87e9dfcdd3ca7c066e0c3c657c1f987c82888eb8103a3a3baa62684ffeb0f7a7" + }, + "@std/fs@1.0.4": { + "integrity": "2907d32d8d1d9e540588fd5fe0ec21ee638134bd51df327ad4e443aaef07123c", + "dependencies": [ + "jsr:@std/path@^1.0.6" + ] + }, + "@std/io@0.221.0": { + "integrity": "faf7f8700d46ab527fa05cc6167f4b97701a06c413024431c6b4d207caa010da", + "dependencies": [ + "jsr:@std/assert@0.221", + "jsr:@std/bytes" + ] + }, + "@std/path@1.0.6": { + "integrity": "ab2c55f902b380cf28e0eec501b4906e4c1960d13f00e11cfbcd21de15f18fed" + }, + "@std/streams@0.221.0": { + "integrity": "47f2f74634b47449277c0ee79fe878da4424b66bd8975c032e3afdca88986e61", + "dependencies": [ + "jsr:@std/io" + ] + }, + "@std/streams@1.0.7": { + "integrity": "1a93917ca0c58c01b2bfb93647189229b1702677f169b6fb61ad6241cd2e499b" + }, + "@std/tar@0.1.2": { + "integrity": "98183102395decd6268253996177804f818580ef547a25b81da0e7cc334db708", + "dependencies": [ + "jsr:@std/streams@^1.0.7" + ] + } + } +} diff --git a/tests/regression.test.ts b/tests/regression.test.ts new file mode 100755 index 00000000..82a9f955 --- /dev/null +++ b/tests/regression.test.ts @@ -0,0 +1,39 @@ +import { $, createWalletViaCli, downloadCli, getMoneroC, getMoneroCTags } from "./utils.ts"; + +const coin = Deno.env.get("COIN"); +if (coin !== "monero" && coin !== "wownero") { + throw new Error("COIN env var invalid or missing"); +} + +Deno.test(`Regression tests (${coin})`, async (t) => { + await Deno.remove("./tests/wallets", { recursive: true }).catch(() => {}); + await Deno.mkdir("./tests/wallets", { recursive: true }); + + const tags = await getMoneroCTags(); + const latestTag = tags[0]; + await Promise.all([getMoneroC(coin, "next"), await getMoneroC(coin, latestTag), downloadCli(coin)]); + + await t.step("Simple (next, latest, next)", async () => { + const walletInfo = await createWalletViaCli(coin, "dog", "sobaka"); + + for (const version of ["next", latestTag, "next"]) { + await $`deno run -A ./tests/compare.ts ${coin} ${version} ${JSON.stringify(walletInfo)}`; + } + }); + + await t.step("All releases sequentially (all tags in the release order, next)", async () => { + tags.unshift("next"); + + const walletInfo = await createWalletViaCli(coin, "cat", "koshka"); + + for (const version of tags.toReversed()) { + if (version !== "next" && version !== tags[0]) await getMoneroC(coin, version); + await $`deno run -A ./tests/compare.ts ${coin} ${version} ${JSON.stringify(walletInfo)}`; + } + + await Deno.remove("./tests/wallets", { recursive: true }).catch(() => {}); + }); + + await Deno.remove("./tests/wallets", { recursive: true }).catch(() => {}); + await Deno.remove("./tests/libs", { recursive: true }).catch(() => {}); +}); diff --git a/tests/utils.ts b/tests/utils.ts new file mode 100755 index 00000000..028e0ff8 --- /dev/null +++ b/tests/utils.ts @@ -0,0 +1,131 @@ +import { build$, CommandBuilder } from "jsr:@david/dax"; + +export const $ = build$({ + commandBuilder: new CommandBuilder() + .printCommand(true) + .stdin("inherit") + .stdout("inherit") + .stderr("inherit"), +}); + +type Coin = "monero" | "wownero"; + +export async function downloadMoneroCli() { + const MONERO_CLI_FILE_NAME = "monero-linux-x64-v0.18.3.4"; + const MONERO_WALLET_CLI_URL = `https://downloads.getmonero.org/cli/${MONERO_CLI_FILE_NAME}.tar.bz2`; + + await $`wget ${MONERO_WALLET_CLI_URL}`; + await $ + .raw`tar -xvf ${MONERO_CLI_FILE_NAME}.tar.bz2 --one-top-level=monero-cli --strip-components=1 -C tests`; + await $.raw`rm ${MONERO_CLI_FILE_NAME}.tar.bz2`; +} + +export async function downloadWowneroCli() { + const WOWNERO_CLI_FILE_NAME = "wownero-x86_64-linux-gnu-59db3fe8d"; + const WOWNERO_WALLET_CLI_URL = + `https://codeberg.org/wownero/wownero/releases/download/v0.11.2.0/wownero-x86_64-linux-gnu-59db3fe8d.tar.bz2`; + + await $`wget ${WOWNERO_WALLET_CLI_URL}`; + await $ + .raw`tar -xvf ${WOWNERO_CLI_FILE_NAME}.tar.bz2 --one-top-level=wownero-cli --strip-components=1 -C tests`; + await $.raw`rm ${WOWNERO_CLI_FILE_NAME}.tar.bz2`; +} + +export function downloadCli(coin: Coin) { + if (coin === "wownero") { + return downloadWowneroCli(); + } + return downloadMoneroCli(); +} + +interface WalletInfo { + path: string; + password: string; + address: string; + secretSpendKey: string; + publicSpendKey: string; + secretViewKey: string; + publicViewKey: string; +} + +export async function createWalletViaCli( + coin: Coin, + name: string, + password: string, +): Promise { + const path = `./tests/wallets/${name}`; + const cliPath = `./tests/${coin}-cli/${coin}-wallet-cli`; + + await $ + .raw`${cliPath} --generate-new-wallet ${path} --password ${password} --mnemonic-language English --command exit` + .stdout("null"); + + const address = (await $.raw`${cliPath} --wallet-file ${path} --password ${password} --command address` + .stdinText(`${password}\n`) + .lines()) + .at(-1)! + .split(/\s+/)[1]; + + const retrieveKeys = (lines: string[]) => + lines.slice(-2) + .map((line) => line.split(": ")[1]); + + const [secretSpendKey, publicSpendKey] = retrieveKeys( + await $.raw`${cliPath} --wallet-file ${path} --password ${password} --command spendkey` + .stdinText(`${password}\n`) + .lines(), + ); + + const [secretViewKey, publicViewKey] = retrieveKeys( + await $.raw`${cliPath} --wallet-file ${path} --password ${password} --command viewkey` + .stdinText(`${password}\n`) + .lines(), + ); + + return { + path, + password, + address, + secretSpendKey, + publicSpendKey, + secretViewKey, + publicViewKey, + }; +} + +// deno-lint-ignore ban-types +export type MoneroCVersion = "next" | (string & {}); + +export async function getMoneroCTags(): Promise { + return (( + await (await fetch( + "https://api.github.com/repos/MrCyjanek/monero_c/releases", + )).json() + ) as { tag_name: string }[]) + .map(({ tag_name }) => tag_name); +} +export async function getMoneroC(coin: Coin, version: MoneroCVersion) { + const dylibName = `${coin}_x86_64-linux-gnu_libwallet2_api_c.so`; + const endpointDylibName = `${coin}_libwallet2_api_c.so`; + const releaseDylibName = dylibName.slice(`${coin}_`.length); + + if (version === "next") { + await $.raw`xz -kd release/${coin}/${releaseDylibName}.xz`; + await $`mkdir -p tests/libs/next`; + await $`mv release/${coin}/${releaseDylibName} tests/libs/next/${endpointDylibName}`; + } else { + const downloadUrl = `https://github.com/MrCyjaneK/monero_c/releases/download/${version}/${dylibName}.xz`; + + const file = await Deno.open(`./tests/${dylibName}.xz`, { + create: true, + write: true, + }); + file.write(await (await fetch(downloadUrl)).bytes()); + file.close(); + + await $.raw`xz -d ./tests/${dylibName}.xz`; + await $.raw`mkdir -p ./tests/libs/${version}`; + await $ + .raw`mv ./tests/${dylibName} ./tests/libs/${version}/${endpointDylibName}`; + } +}