initial api commit

Author: JamesLawton

.github/scripts/update-chains-fees.js

@@ -0,0 +1,46 @@
+name: Convert OpenAPI YAML to JSON
+
+on:
+  push:
+    paths:
+      - 'api-reference/trails-api.gen.yaml'
+    branches:
+      - '**'
+
+jobs:
+  convert:
+    runs-on: ubuntu-latest
+    
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          fetch-depth: 0
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '18'
+          cache: 'npm'
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Convert YAML to JSON
+        run: npm run convert-openapi
+
+      - name: Check for changes
+        id: check_changes
+        run: |
+          git diff --exit-code api-reference/trails-api.gen.json || echo "changes=true" >> $GITHUB_OUTPUT
+
+      - name: Commit and push if changed
+        if: steps.check_changes.outputs.changes == 'true'
+        run: |
+          git config --local user.email "github-actions[bot]@users.noreply.github.com"
+          git config --local user.name "github-actions[bot]"
+          git add api-reference/trails-api.gen.json
+          git commit -m "chore: auto-convert OpenAPI YAML to JSON"
+          git push
+

.github/workflows/convert-openapi.yml

@@ -0,0 +1,86 @@
+---
+title: CommitIntent
+openapi: ../trails-api.gen.json post /rpc/Trails/CommitIntent
+---
+
+## Overview
+
+The `CommitIntent` endpoint commits an intent to the Trails system, reserving the quote and preparing it for execution. This is a required step between getting a quote and executing the transaction.
+
+## Use Cases
+
+- Lock in a quote before execution
+- Reserve liquidity for the transaction
+- Prepare the intent for signing and execution
+- Transition from quoted to committed state
+
+## Request Parameters
+
+### Required Fields
+
+- **intent** (Intent): The complete intent object returned from `QuoteIntent`
+
+## Response
+
+The response includes:
+
+- **intentId** (string): Unique identifier for the committed intent
+
+## Intent Lifecycle
+
+```
+QuoteIntent → CommitIntent → ExecuteIntent → Receipt
+```
+
+The `CommitIntent` step is crucial because it:
+1. Reserves the quoted rates
+2. Locks in the gas fee estimates
+3. Validates the intent parameters
+4. Creates a unique intent ID for tracking
+
+## Example
+
+```typescript
+// First, get a quote
+const quoteResponse = await fetch('https://api.trails.sequence.app/rpc/Trails/QuoteIntent', {
+  method: 'POST',
+  headers: {
+    'Content-Type': 'application/json',
+    'X-Access-Key': 'YOUR_ACCESS_KEY'
+  },
+  body: JSON.stringify(quoteRequest)
+});
+
+const { intent, gasFeeOptions } = await quoteResponse.json();
+
+// Then commit the intent
+const commitResponse = await fetch('https://api.trails.sequence.app/rpc/Trails/CommitIntent', {
+  method: 'POST',
+  headers: {
+    'Content-Type': 'application/json',
+    'X-Access-Key': 'YOUR_ACCESS_KEY'
+  },
+  body: JSON.stringify({ intent })
+});
+
+const { intentId } = await commitResponse.json();
+console.log('Intent committed:', intentId);
+```
+
+## Important Notes
+
+<Warning>
+Committed intents have an expiration time. Make sure to execute the intent before it expires, or you'll need to get a new quote.
+</Warning>
+
+<Info>
+The intent object from `QuoteIntent` can be modified before committing if you need to adjust parameters, but be aware that this may invalidate the quote.
+</Info>
+
+## Next Steps
+
+After committing an intent:
+1. Prepare the transaction signature using the provided intent details
+2. Execute the transaction with `ExecuteIntent`
+3. Monitor the transaction status with `GetIntentReceipt`
+