Arkade Asset Exploration

Makefile

@@ -64,6 +64,31 @@ run-light: clean
 	$(call setup_env, envs/arkd.light.env)
 	@go run ./cmd/arkd
 
+## run-local: run arkd locally with explicit env vars (no container hostnames)
+run-local: clean
+	@echo "Running arkd locally with explicit environment variables..."
+	@ARKD_LOG_LEVEL=6 \
+	 ARKD_NO_MACAROONS=true \
+	 ARKD_VTXO_TREE_EXPIRY=511 \
+	 ARKD_SCHEDULER_TYPE=block \
+	 ARKD_UNILATERAL_EXIT_DELAY=512 \
+	 ARKD_BOARDING_EXIT_DELAY=1024 \
+	 ARKD_CHECKPOINT_EXIT_DELAY=10 \
+	 ARKD_DATADIR=./data/regtest \
+	 ARKD_WALLET_ADDR=127.0.0.1:6060 \
+	 ARKD_ESPLORA_URL=http://localhost:3000 \
+	 ARKD_ROUND_MIN_PARTICIPANTS_COUNT=$${ARKD_ROUND_MIN_PARTICIPANTS_COUNT:-1} \
+	 ARKD_ROUND_MAX_PARTICIPANTS_COUNT=$${ARKD_ROUND_MAX_PARTICIPANTS_COUNT:-128} \
+	 ARKD_VTXO_MIN_AMOUNT=1 \
+	 ARKD_LIVE_STORE_TYPE=inmemory \
+	 ARKD_EVENT_DB_TYPE=badger \
+	 ARKD_DB_TYPE=sqlite \
+	 ARKD_SESSION_DURATION=$${ARKD_SESSION_DURATION:-10} \
+	 ARKD_ROUND_REPORT_ENABLED=$${ARKD_ROUND_REPORT_ENABLED:-true} \
+	 ARKD_BAN_THRESHOLD=1 \
+	 ARKD_ONCHAIN_OUTPUT_FEE=100 \
+	 go run ./cmd/arkd
+
 ## test: runs unit and component tests
 test: pgtest redis-up
 	@sleep 2
@@ -217,4 +242,4 @@ run-simulation:
 ## pprof: run pprof tool (e.g. make pprof PROFILE=heap)
 pprof:
 	@echo "Running pprof..."
-	@go tool pprof -http=:8080 http://localhost:7071/debug/pprof/$(PROFILE)
+	@go tool pprof -http=:8080 http://localhost:7071/debug/pprof/$(PROFILE)

api-spec/openapi/swagger/ark/v1/indexer.openapi.json

@@ -5,6 +5,47 @@
     "version": "version not set"
   },
   "paths": {
+    "/v1/indexer/assetGroup/{asset_id}": {
+      "get": {
+        "tags": [
+          "IndexerService"
+        ],
+        "description": "GetAsset returns the asset information and metadata for the specified asset ID.",
+        "operationId": "IndexerService_GetAssetGroup",
+        "parameters": [
+          {
+            "name": "assetId",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "a successful response.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/GetAssetGroupResponse"
+                }
+              }
+            }
+          },
+          "default": {
+            "description": "An unexpected error response.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Status"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
     "/v1/indexer/batch/{batch_outpoint.txid}/{batch_outpoint.vout}/sweepTxs": {
       "get": {
         "tags": [
@@ -465,6 +506,88 @@
         }
       }
     },
+    "/v1/indexer/teleport/subscribe": {
+      "post": {
+        "tags": [
+          "IndexerService"
+        ],
+        "description": "SubscribeForTeleportHash allows to subscribe for tx notifications related to the provided\nteleport hashes. It can also be used to update an existing subscribtion by adding new hashes to it.",
+        "operationId": "IndexerService_SubscribeForTeleportHash",
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/SubscribeForTeleportHashRequest"
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "200": {
+            "description": "a successful response.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/SubscribeForTeleportHashResponse"
+                }
+              }
+            }
+          },
+          "default": {
+            "description": "An unexpected error response.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Status"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/v1/indexer/teleport/unsubscribe": {
+      "post": {
+        "tags": [
+          "IndexerService"
+        ],
+        "description": "UnsubscribeForTeleportHash allows to remove teleport hashes from an existing subscription.",
+        "operationId": "IndexerService_UnsubscribeForTeleportHash",
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/UnsubscribeForTeleportHashRequest"
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "200": {
+            "description": "a successful response.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/UnsubscribeForTeleportHashResponse"
+                }
+              }
+            }
+          },
+          "default": {
+            "description": "An unexpected error response.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Status"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
     "/v1/indexer/virtualTx/{txids}": {
       "get": {
         "tags": [
@@ -731,6 +854,61 @@
           }
         }
       },
+      "AssetGroup": {
+        "title": "AssetGroup",
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string"
+          },
+          "immutable": {
+            "type": "boolean"
+          },
+          "metadata": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/AssetMetadata"
+            }
+          },
+          "quantity": {
+            "type": "integer",
+            "format": "uint64"
+          }
+        }
+      },
+      "AssetMetadata": {
+        "title": "AssetMetadata",
+        "type": "object",
+        "properties": {
+          "key": {
+            "type": "string"
+          },
+          "value": {
+            "type": "string"
+          }
+        }
+      },
+      "GetAssetGroupRequest": {
+        "title": "GetAssetGroupRequest",
+        "type": "object",
+        "properties": {
+          "assetId": {
+            "type": "string"
+          }
+        }
+      },
+      "GetAssetGroupResponse": {
+        "title": "GetAssetGroupResponse",
+        "type": "object",
+        "properties": {
+          "assetGroup": {
+            "$ref": "#/components/schemas/AssetGroup"
+          },
+          "assetId": {
+            "type": "string"
+          }
+        }
+      },
       "GetBatchSweepTransactionsRequest": {
         "title": "GetBatchSweepTransactionsRequest",
         "type": "object",
@@ -1047,6 +1225,19 @@
           }
         }
       },
+      "IndexerAsset": {
+        "title": "IndexerAsset",
+        "type": "object",
+        "properties": {
+          "amount": {
+            "type": "integer",
+            "format": "uint64"
+          },
+          "assetId": {
+            "type": "string"
+          }
+        }
+      },
       "IndexerBatch": {
         "title": "IndexerBatch",
         "type": "object",
@@ -1103,6 +1294,15 @@
         "type": "string",
         "default": "INDEXER_CHAINED_TX_TYPE_UNSPECIFIED"
       },
+      "IndexerExtension": {
+        "title": "IndexerExtension",
+        "type": "object",
+        "properties": {
+          "asset": {
+            "$ref": "#/components/schemas/IndexerAsset"
+          }
+        }
+      },
       "IndexerHeartbeat": {
         "title": "IndexerHeartbeat",
         "type": "object"
@@ -1202,6 +1402,19 @@
               "$ref": "#/components/schemas/IndexerVtxo"
             }
           },
+          "teleportEvents": {
+            "type": "array",
+            "description": "List of teleport events involved in the transaction",
+            "items": {
+              "$ref": "#/components/schemas/TeleportEvent"
+            }
+          },
+          "teleportHashes": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          },
           "tx": {
             "type": "string"
           },
@@ -1286,6 +1499,12 @@
             "type": "integer",
             "format": "int64"
           },
+          "extensions": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/IndexerExtension"
+            }
+          },
           "isPreconfirmed": {
             "type": "boolean"
           },
@@ -1356,6 +1575,62 @@
           }
         }
       },
+      "SubscribeForTeleportHashRequest": {
+        "title": "SubscribeForTeleportHashRequest",
+        "type": "object",
+        "properties": {
+          "subscriptionId": {
+            "type": "string",
+            "description": "If set, update an existing subscription"
+          },
+          "teleportHashes": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          }
+        }
+      },
+      "SubscribeForTeleportHashResponse": {
+        "title": "SubscribeForTeleportHashResponse",
+        "type": "object",
+        "properties": {
+          "subscriptionId": {
+            "type": "string"
+          }
+        }
+      },
+      "TeleportEvent": {
+        "title": "TeleportEvent",
+        "type": "object",
+        "properties": {
+          "amount": {
+            "type": "integer",
+            "format": "uint64"
+          },
+          "anchorOutpoint": {
+            "type": "string"
+          },
+          "assetId": {
+            "type": "string"
+          },
+          "createdAt": {
+            "type": "integer",
+            "format": "int64"
+          },
+          "expiresAt": {
+            "type": "integer",
+            "format": "int64"
+          },
+          "outputVout": {
+            "type": "integer",
+            "format": "uint32"
+          },
+          "teleportHash": {
+            "type": "string"
+          }
+        }
+      },
       "UnsubscribeForScriptsRequest": {
         "title": "UnsubscribeForScriptsRequest",
         "type": "object",
@@ -1375,6 +1650,26 @@
       "UnsubscribeForScriptsResponse": {
         "title": "UnsubscribeForScriptsResponse",
         "type": "object"
+      },
+      "UnsubscribeForTeleportHashRequest": {
+        "title": "UnsubscribeForTeleportHashRequest",
+        "type": "object",
+        "properties": {
+          "subscriptionId": {
+            "type": "string"
+          },
+          "teleportHashes": {
+            "type": "array",
+            "description": "If empty, unsubscribe all teleport hashes",
+            "items": {
+              "type": "string"
+            }
+          }
+        }
+      },
+      "UnsubscribeForTeleportHashResponse": {
+        "title": "UnsubscribeForTeleportHashResponse",
+        "type": "object"
       }
     }
   },