feat(transaction-builder): Add gas station support (#260)

* feat(transaction-builder): Add gas station support

improve API

Add example and fix gas station impl

fix env

path

oops

augh

add env

clippy and try with url

try creating both env and an address

I dunno

move env creation

flip

try this

reorder again

say --yes

logs

fix sed

bindings

use jq

raw

try quotes

rename

debug

use pipes

get the keypair

oop

debug

try another host

tweaks

try printing err

try moving auth

caps

one more time

oh 🤦‍♀️

try not waiting

ffs

100 retries

* tweak the github CI

* rename token

* error when out of retries

* digest in err

Author: DaughterOfMars

.github/actions/start-local-network/action.yml

@@ -21,3 +21,26 @@ runs:
         echo "$(pwd)" >> $GITHUB_PATH
         ./iota start --force-regenesis --with-faucet --with-indexer --with-graphql --pg-port 5432 --pg-db-name iota_indexer_v2 --epoch-duration-ms $EPOCH_DURATION_MS &
         sleep $((EPOCH_DURATION_MS / 1000)) # wait for the first epoch to end
+
+    - name: Start gas station and request faucet coins
+      shell: bash
+      env:
+        GAS_STATION_AUTH: "test"
+      run: |
+        ./iota client -y new-env --alias localnet --rpc http://127.0.0.1:9000 --graphql http://0.0.0.0:9125 --faucet http://127.0.0.1:9123/v1/gas
+        ./iota keytool update-alias $(./iota client active-address) gas_station
+
+        echo "Getting keypair"
+        private_key="$(./iota keytool export gas_station --json | jq -r '.["exportedPrivateKey"]')"
+        key="$(./iota keytool convert $private_key --json | jq -r '.["base64WithFlag"]')"
+
+        echo "Setting keypair in config"
+        sed -i "s|<keypair>|$key|g" ./.github/actions/start-local-network/config.yaml
+
+        echo "Requesting faucet coins"
+        ./iota client faucet --address gas_station
+
+        echo "Starting Gas Station"
+        docker compose -f ./.github/actions/start-local-network/gas_station_compose.yml up -d
+
+        docker logs iota-gas-station & sleep 10

.github/actions/start-local-network/config.yaml

@@ -0,0 +1,17 @@
+---
+signer-config:
+  local:
+    keypair: <keypair>
+rpc-host-ip: 0.0.0.0
+rpc-port: 9527
+metrics-port: 9185
+storage-config:
+  redis:
+    redis_url: "redis://localhost:6379"
+fullnode-url: "http://localhost:9000"
+coin-init-config:
+  target-init-balance: 100000000
+  refresh-interval-sec: 86400
+daily-gas-usage-cap: 1500000000000
+access-controller:
+  access-policy: disabled

.github/actions/start-local-network/gas_station_compose.yml

@@ -0,0 +1,35 @@
+# Docker Compose configuration file for running the IOTA Gas Station in a container together with a Redis instance.
+# The intention of this docker-compose setup is to get up and running quickly in a development environment.
+# Please be aware that this setup is foundational and should be adjusted to your specific needs required for production.
+services:
+  redis:
+    image: redis:latest
+    container_name: gas-station-redis
+    volumes:
+      - redis_data:/data
+    network_mode: host
+  iota-gas-station:
+    image: "${DOCKER_IMAGE:-iotaledger/gas-station:latest}"
+    build:
+      context: ..
+      args:
+        - BUILD_DATE=${BUILD_DATE:-latest}
+        - GIT_REVISION=${GIT_REVISION:-latest}
+      dockerfile: docker/Dockerfile
+    container_name: iota-gas-station
+    command: ["--config-path", "/app/config.yaml"]
+    depends_on:
+      - redis
+    ports:
+      - "9527:9527" # RPC port
+      - "9185:9185" # Metrics port
+    environment:
+      - CONFIG_PATH=/app/config.yaml
+      - RUST_BACKTRACE=1
+      - GAS_STATION_AUTH=${GAS_STATION_AUTH:-}
+    volumes:
+      - ${LOCAL_CONFIG_PATH:-./config.yaml}:/app/config.yaml
+    network_mode: host
+
+volumes:
+  redis_data:

bindings/go/examples/gas_station/main.go

@@ -0,0 +1,50 @@
+// Copyright (c) 2025 IOTA Stiftung
+// SPDX-License-Identifier: Apache-2.0
+
+package main
+
+import (
+	sdk "bindings/iota_sdk_ffi"
+	"fmt"
+	"log"
+)
+
+func main() {
+	client := sdk.GraphQlClientNewLocalnet()
+	gasStationUrl := "http://0.0.0.0:9527"
+	gasStationAuthToken := "test"
+	keypair := sdk.Ed25519PrivateKeyGenerate()
+	sender := keypair.PublicKey().DeriveAddress()
+	simpleKey := sdk.SimpleKeypairFromEd25519(keypair)
+
+	builder := sdk.TransactionBuilderInit(sender, client)
+
+	package_id, _ := sdk.AddressFromHex("0x1")
+	module_name, _ := sdk.NewIdentifier("u64")
+	function_name, _ := sdk.NewIdentifier("sqrt")
+
+	builder.MoveCall(
+		package_id,
+		module_name,
+		function_name,
+		[]*sdk.PtbArgument{sdk.PtbArgumentU64(64)},
+		nil,
+		nil,
+	)
+
+	headers := make(map[string][]string)
+	headers["Authorization"] = []string{fmt.Sprintf("Bearer %v", gasStationAuthToken)}
+
+	builder.GasStationSponsor(gasStationUrl, nil, &headers)
+
+	res, err := builder.Execute(simpleKey, true)
+	if err.(*sdk.SdkFfiError) != nil {
+		log.Fatalf("Failed to sponsor transaction: %v", err)
+	}
+
+	if res != nil {
+		log.Printf("%v", *res)
+	}
+
+	fmt.Print("Sponsored transaction was successful!")
+}