https://github.com/vulpemventures/nigiri-travis

Travis template for adding 🍣 Nigiri Bitcoin to your CI pipeline.
https://github.com/vulpemventures/nigiri-travis

Last synced: about 1 month ago
JSON representation

Travis template for adding 🍣 Nigiri Bitcoin to your CI pipeline.

• Host: GitHub
• URL: https://github.com/vulpemventures/nigiri-travis
• Owner: vulpemventures
• License: mit
• Archived: true
• Created: 2020-02-28T19:42:52.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2022-09-28T12:55:06.000Z (about 2 years ago)
• Last Synced: 2024-08-03T11:08:42.066Z (4 months ago)
• Language: Shell
• Size: 20.5 KB
• Stars: 2
• Watchers: 3
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-taproot - Nigiri in Travis - Travis template for adding Nigiri to your Travis (or Github Action) pipeline. (Utilities)

README

        
# Deprecation notice

The only supported CI is Github Action. Please use this instead https://github.com/vulpemventures/nigiri-github-action

# nigiri-travis

Travis and Github Action template for adding 🍣 [Nigiri Bitcoin](https://nigiri.vulpem.com) to your CI pipeline. 

## Installer

You can spin up a `regtest` development box in any Travis pipeline by running

```sh

curl https://travis.nigiri.network | bash

```

> NOTICE: You'll need to enable **docker** 

## Example for Travis

Create a `.travis.yml` in your root folder and add the installer script in the `before_install` step

```yaml

services:

  - docker

 

before_install:

  - curl https://travis.nigiri.network | bash

  

install:

  - docker-compose up -d

script:

  - docker ps -a

  # Get all blocks in Bitcoin

  - curl http://localhost:3000/blocks

  # Get the current block height in Liquid

  - curl http://localhost:3001//blocks/tip/height

  # Get some Liquid Bitcoins with faucet

  - curl -X POST --data '{"address":"2MsnWskyHaHvcZUHA4gnR3G95EnUmZQjzM8"}' http://localhost:3001/faucet`

  # Push raw TX with automatic mining

  - curl -X POST --data `xxx` http://localhost:3001/tx`

after_script:

  - docker-compose down

```

## NEW Example for Github Action

```yaml

name: Nigiri pipeline

on:

  push:

    branches: [master]

  pull_request:

    branches: [master]

jobs:

  integration:

    name: Integration Tests

    runs-on: ubuntu-latest

    steps:

      - name: Install Nigiri

        run: |

          mkdir ~/.nigiri; cd ~/.nigiri

          curl https://travis.nigiri.network | bash; cd

          docker-compose -f ~/.nigiri/docker-compose.yml up -d

```

## Services

* Electrs

  * REST `localhost:3000`

  * Faucet `localhost:3000/faucet`

* Electrs for Liquid 

  * REST `localhost:3001`

  * Faucet `localhost:3001/faucet`

* Bitcoin 

  * RPC host:port `localhost:18443`

  * RPC user `admin1`

  * RPC password `123`

* Liquid 

  * RPC host:port `localhost:18884`

  * RPC user `admin1`

  * RPC password `123`

Full documentation of  [Electrs REST API](https://github.com/Blockstream/esplora/blob/master/API.md)