Grid

https://grid.squads.xyz/grid/v1
Admin
Grid is a developer platform offering secure, fault-tolerant, and cost-efficient Grid Accounts on...
Tokens:139,181
Snippets:1,065
Trust Score:7.6
Update:6 months ago
Show doc for...
Tokens:
Raw
### Getting Started

Source: https://grid.squads.xyz/grid/v1/accounts/passkeys/introduction

Guidance on integrating passkey flows, including hosted UI integration and advanced custom domain setups.

```APIDOC
## Getting Started

**Hosted UI Integration**: See the [Passkey Integration Guide](/grid/v1/accounts/passkeys/integration-guide) for complete implementation examples with iframe and WebBrowser integration.

**Need Your Own Custom Domain?** If you need to host passkey flows on your own domain (e.g., `auth.yourcompany.com`) for branding or compliance requirements, see [Advanced Integration](/grid/v1/accounts/passkeys/advanced-integration).
```

--------------------------------

### Initialize Grid Client Setup Prompt

Source: https://grid.squads.xyz/grid/v1/accounts/quickstart

Use this prompt to instruct an LLM on setting up the Grid SDK client. It includes installation, import, configuration options, and a complete initialization example.

```markdown
# IMPLEMENT GRID ACCOUNTS CLIENT SETUP

## TASK OVERVIEW
Set up Grid SDK client initialization in my application following my existing patterns.

## MY APPLICATION CONTEXT
**Tech Stack:**
- Framework: [React/Next.js/Express/Django/etc.]
- Environment management: [How you handle config/env vars]
- Service architecture: [How you organize API services]
- Error handling: [Your current error handling approach]

## GRID V1 CLIENT REQUIREMENTS
**Installation:** npm install @sqds/grid

**Import:** import { GridClient } from '@sqds/grid';

**Configuration Options:**
- environment: 'sandbox' | 'production'
- apiKey: string (from Grid dashboard at https://grid.squads.xyz/dashboard)

**Complete Initialization Example:**
const gridClient = new GridClient({
  environment: process.env.NODE_ENV === 'production' ? 'production' : 'sandbox',
  apiKey: process.env.GRID_API_KEY!,
  baseUrl: "https://grid.squads.xyz",
});

## IMPLEMENTATION REQUEST
Create a Grid client service that:
1. Follows my application's service patterns
2. Handles environment configuration properly
3. Includes comprehensive error handling
4. Provides a clean interface for other parts of my app
5. Includes proper TypeScript types if I'm using TypeScript

Show me the complete implementation with file structure and code.

## DOCUMENTATION REFERENCES
- Grid SDK Documentation: https://www.npmjs.com/package/@sqds/grid
- API Dashboard: https://grid.squads.xyz/dashboard

```

--------------------------------

### Install project dependencies

Source: https://grid.squads.xyz/grid/v1/examples/neobank

Navigate to the project directory and install required packages.

```bash
cd neobank-example-app
npm install
```

--------------------------------

### Install Grid React SDK

Source: https://grid.squads.xyz/grid/v1/sdk-reference/react/reference/latest/quickstart

Install the required package via npm.

```bash
npm install @sqds/grid-react
```

--------------------------------

### Start the development server

Source: https://grid.squads.xyz/grid/v1/examples/neobank

Launch the Expo development environment.

```bash
npx expo start
```

--------------------------------

### Install Grid SDK

Source: https://grid.squads.xyz/grid/v1/accounts/quickstart

Install the official Grid SDK via npm to enable TypeScript support and automated API communication.

```bash
npm install @sqds/grid
```

--------------------------------

### Install React Native SDK

Source: https://grid.squads.xyz/grid/v1/sdk-reference/react-native/reference/latest/quickstart

Install the core Grid React Native package via npm.

```bash
npm install @sqds/grid-react-native
```

--------------------------------

### Update Package Installation

Source: https://grid.squads.xyz/grid/v1/accounts/migration-from-grid-sdk

Uninstall the legacy package and install the new SDK using npm.

```bash
npm uninstall grid-sdk
npm install @sqds/grid
```

--------------------------------

### Get Trade Smart Transaction Example

Source: https://grid.squads.xyz/grid/v1/sdk-reference/react-native/reference/latest/interfaces/GetTradeSmartTransactionResponse

Example of how to use the client to get a trade smart transaction and access its data.

```APIDOC
## GET /grid/v1/trade-smart-transactions/{smartTransactionAddress}

### Description
Retrieves the details of a specific trade smart transaction.

### Method
GET

### Endpoint
`/grid/v1/trade-smart-transactions/{smartTransactionAddress}`

### Parameters
#### Path Parameters
- **smartTransactionAddress** (string) - Required - The address of the smart transaction.
- **accountAddress** (string) - Required - The address of the account.

### Request Example
```typescript
const response = await client.getTradeSmartTransaction(
  accountAddress,
  smartTransactionAddress
);
console.log(response.data.tradableAssets);
console.log(response.data.status);
```

### Response
#### Success Response (200)
- **data** (object) - The trade smart transaction details.
  - **tradableAssets** (array) - List of tradable assets.
  - **status** (string) - The status of the transaction.
- **lastResponse** (object) - Metadata about the request.

#### Response Example
```json
{
  "data": {
    "tradableAssets": [
      {
        "assetId": "string",
        "quantity": "string"
      }
    ],
    "status": "string"
  },
  "lastResponse": {
    "request": {
      "url": "string",
      "method": "string",
      "headers": {},
      "body": {}
    },
    "response": {
      "status": 200,
      "headers": {}
    }
  }
}
```
```

--------------------------------

### Install Grid v3.0.0

Source: https://grid.squads.xyz/grid/v1/sdk-reference/typescript/migration-to-v3

Update your project to use the latest version of the Grid package.

```bash
npm install @sqds/grid@3.0.0
```

--------------------------------

### Initialize and Authenticate with GridClient

Source: https://grid.squads.xyz/grid/v1/sdk-reference/typescript/reference/latest/quickstart

Example showing client initialization, account creation, and authentication flow using OTP.

```typescript
import { GridClient } from '@sqds/grid';

const client = new GridClient({
  apiKey: 'your-api-key',
  environment: 'sandbox',
});

try {
  const sessionSecrets = await client.generateSessionSecrets();

  await client.createAccount({
    email: 'user@example.com'
  });

  const otpCode = '123456';

  const response = await client.completeAuthAndCreateAccount({
    email: 'user@example.com',
    code: otpCode,
    sessionSecrets
  });

  const balances = await client.getBalances({
    accountAddress: response.data.address,
  });

  console.log('Balances:', balances.data);
} catch (error) {
  console.error('Error:', error.message);
}
```

--------------------------------

### Install Polyfill Dependencies

Source: https://grid.squads.xyz/grid/v1/sdk-reference/react-native/reference/latest/quickstart

Install required polyfill packages for React Native compatibility.

```bash
npm install text-encoding react-native-get-random-values buffer @ethersproject/shims
```

--------------------------------

### Create Standing Order

Source: https://grid.squads.xyz/grid/v1/sdk-reference/react-native/reference/latest/classes/GridClient

Example of creating a new standing order.

```APIDOC
## POST /api/standing-orders

### Description
Creates a new standing order for recurring payments.

### Method
POST

### Endpoint
/api/standing-orders

### Request Body
- **amount** (string) - Required - The amount for each payment.
- **gridUserId** (string) - Required - The ID of the grid user.
- **source** (object) - Required - The source account details.
  - **account** (string) - Required - The source account address.
  - **currency** (string) - Required - The source currency.
- **destination** (object) - Required - The destination account details.
  - **address** (string) - Required - The destination address.
  - **currency** (string) - Required - The destination currency.
- **frequency** (string) - Required - The frequency of the payment (e.g., "weekly").
- **startDate** (string) - Required - The start date and time of the standing order.
- **endDate** (string) - Required - The end date and time of the standing order.

### Request Example
{
  "amount": "500000",
  "gridUserId": "grid-user-id",
  "source": {
    "account": "source-address",
    "currency": "usdc"
  },
  "destination": {
    "address": "destination-address",
    "currency": "usdc"
  },
  "frequency": "weekly",
  "startDate": "2024-12-02T10:00:00Z",
  "endDate": "2025-12-31T23:59:59Z"
}

### Response
#### Success Response (200)
- **standingOrder** (object) - Details of the created standing order.
```

--------------------------------

### Initiate a Passkey Session

Source: https://grid.squads.xyz/grid/v1/sdk-reference/react-native/reference/latest/classes/GridClient

Starts the authentication flow by preparing challenge and session data.

```typescript
await gridClient.createPasskeySession({
  action: 'create',
  sessionKey: 'session-public-key-base58',
  env: 'production',
}, 'production');
```

--------------------------------

### Update Account Settings

Source: https://grid.squads.xyz/grid/v1/sdk-reference/react-native/reference/latest/classes/GridClient

Signature and usage examples for updating account policies and configurations.

```ts
updateAccount(
   accountAddress,
   request,
admin?): Promise<TransactionResponse>;
```

```typescript
const updateTx = await gridClient.updateAccount(accountAddress, {
  policies: {
    threshold: 2
  }
});

const adminUpdateTx = await gridClient.updateAccount(
  accountAddress,
  { policies: { threshold: 1 } },
  true
);
```

--------------------------------

### Configure Custom Domain Session

Source: https://grid.squads.xyz/grid/v1/accounts/passkeys/advanced-integration

Example configuration object for initializing a passkey session with a custom base URL and metadata.

```json
{
  "meta_info": {
    "appName": "YourCompany App",
    "redirectUrl": "https://yourapp.com/auth-callback"
  },
  "sessionKey": {
    "key": "your-session-key",
    "expiration": 900
  },
  "baseUrl": "https://auth.yourcompany.com"
}
```

--------------------------------

### Account Creation API

Source: https://grid.squads.xyz/grid/v1/sdk-reference/typescript/reference/latest/classes/GridClient

Examples of creating new accounts using different methods: email-based, signer-based, and multi-signer with permissions.

```APIDOC
## Account Creation Examples

### Email Account Creation

```typescript
const emailAccount = await gridClient.createAccount({
  email: 'user@example.com'
});
```

### Signer Account Creation

```typescript
const signerAccount = await gridClient.createAccount({
  signer: 'BKKjHs7kKsWFm8GKuFz3HzNKBjH4K4HhjhwxDHrRfKjj'
});
```

### Multi-Signer Account Creation

```typescript
const signerAccount = await gridClient.createAccount({
  signers: [
    {
      address: 'BKKjHs7kKsWFm8GKuFz3HzNKBjH4K4HhjhwxDHrRfKjj',
      permissions: ['CAN_INITIATE', 'CAN_VOTE']
    }
  ],
  threshold: 1,
  timeLock: null,
  adminAddress: null
});
```
```

--------------------------------

### Initiate Authentication

Source: https://grid.squads.xyz/grid/v1/api-reference/endpoint/authentication/post

Starts the authentication process by sending an OTP to a provided email address. This endpoint is for existing users; new users should use the 'Create Account' endpoint.

```APIDOC
## POST /grid/v1/auth/initiate

### Description
Initiates the authentication process by sending an One-Time Password (OTP) to the provided email address.

### Method
POST

### Endpoint
/grid/v1/auth/initiate

### Parameters
#### Request Body
- **email** (string) - Required - The email address to send the OTP to.

### Request Example
{
  "email": "user@example.com"
}

### Response
#### Success Response (200)
- **message** (string) - Indicates that the OTP has been sent successfully.

#### Response Example
{
  "message": "OTP sent successfully to user@example.com"
}
```

--------------------------------

### API Response Examples

Source: https://grid.squads.xyz/grid/v1/sdk-reference/typescript/reference/latest/interfaces/StandingOrderResponse

Illustrates how to use the StandingOrderResponse in TypeScript, including accessing data, metadata, and handling errors.

```APIDOC
## Examples

```typescript
const response = await gridClient.getAccount(accountAddress);

console.log(response.data.address);
console.log(response.data.policies);
```

```typescript
const response = await gridClient.createAccount({ email: 'user@example.com' });

console.log('Request ID:', response.lastResponse?.requestId);
console.log('Status:', response.lastResponse?.statusCode);
console.log('Idempotency Key:', response.lastResponse?.idempotencyKey);
```

```typescript
try {
  const response = await gridClient.getAccount(accountAddress);
  console.log('Success:', response.data);
} catch (error) {
  if (error instanceof GridError) {
    console.error('Error:', error.message);
    console.error('Request ID:', error.lastResponse?.requestId);
  }
}
```
```

--------------------------------

### AccountSigner Example

Source: https://grid.squads.xyz/grid/v1/sdk-reference/react-native/reference/latest/interfaces/AccountSigner

Example usage of the AccountSigner type in TypeScript.

```APIDOC
## Example

```typescript  theme={null}
const signer: AccountSigner = {
  address: '5FHwkrdxntdK24hgQU8qgBjn35Y1zwhz1GZwCkP2UJnM',
  permissions: ['CAN_INITIATE', 'CAN_EXECUTE', 'CAN_VOTE']
};
const backupSigner: AccountSigner = {
  address: '...',
  role: 'backup',
  permissions: ['CAN_VOTE'],
  provider: 'turnkey'
};
```
```

--------------------------------

### Initialize Grid Client

Source: https://grid.squads.xyz/grid/v1/accounts/quickstart

Set up the Grid SDK client with environment configuration and API credentials.

```typescript
import { GridClient } from '@sqds/grid';

const gridClient = new GridClient({
  environment: 'sandbox', // Use 'production' for live applications
  apiKey: process.env.GRID_API_KEY!,
  baseUrl: "https://grid.squads.xyz",
});
```

--------------------------------

### GridClient Initialization and Account Management

Source: https://grid.squads.xyz/grid/v1/sdk-reference/typescript/reference/latest/classes/GridClient

Demonstrates how to initialize the GridClient and manage account state, including subscribing to changes.

```APIDOC
## GridClient Initialization and Account Management

### Description
Initialize the Grid SDK client and access account management functionalities. This includes getting the current account state and subscribing to account changes.

### Method
`new GridClient(config: GridClientConfig)`

### Endpoint
N/A (Client-side SDK)

### Parameters
#### Request Body (for constructor)
- **apiKey** (string) - Required - Your API key for authentication.
- **environment** (string) - Required - The environment to connect to (e.g., 'sandbox', 'production').

### Request Example
```typescript
import { GridClient } from '@sqds/grid';

const client = new GridClient({
  apiKey: 'your-api-key',
  environment: 'sandbox'
});
```

### Account Manager Accessor

#### account

##### Description
Provides access to the `AccountManager` for reactive state management of the account.

##### Returns
`AccountManager` - An instance of the AccountManager.

##### Example
```typescript
client.account.on('change', (state) => {
  console.log('Account updated:', state);
});

const currentAccount = client.account.get();
console.log(currentAccount.accountAddress, currentAccount.isConnected);

client.account.set('account-address', 'grid-user-id');
client.account.disconnect();
```
```

--------------------------------

### Complete Account Setup with REST API

Source: https://grid.squads.xyz/grid/v1/accounts/authentication-methods

Verify the OTP code and complete account creation using the REST API. This step requires the email, OTP code, and your session encryption public key. Ensure the 'x-grid-environment' header is set correctly.

```bash
curl -X POST https://grid.squads.xyz/api/grid/v1/accounts/verify \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "x-grid-environment: sandbox" \
  -H "Content-Type: application/json" \
  -H "x-idempotency-key: $(uuidgen)" \
  -d '{
    "email": "user@example.com",
    "otp_code": "123456",
    "kms_provider_config": {
      "encryption_public_key": "YOUR_SESSION_ENCRYPTION_PUBLIC_KEY"
    }
  }'
```

--------------------------------

### Get Environment Configuration

Source: https://grid.squads.xyz/grid/v1/sdk-reference/react-native/reference/latest/classes/GridClient

Gets the current environment configuration of the SDK. Use this to determine if operations target the devnet or mainnet.

```typescript
const env = gridClient.getEnvironment();
console.log(env); / 'sandbox' or 'production'
```

--------------------------------

### Complete Authentication and Create Account

Source: https://grid.squads.xyz/grid/v1/sdk-reference/typescript/reference/latest/classes/GridClient

Streamlines onboarding by completing authentication and creating an account simultaneously. Requires OTP code, user object, and session secrets.

```typescript
const sessionSecrets = await gridClient.generateSessionSecrets();
const account = await gridClient.completeAuthAndCreateAccount({
  otpCode: '123456',
  user,
  sessionSecrets
});
```

--------------------------------

### Get Environment

Source: https://grid.squads.xyz/grid/v1/sdk-reference/react-native/reference/latest/classes/GridClient

Retrieves the current environment configuration of the SDK.

```APIDOC
## GET /environment

### Description
Get the current environment configuration.

### Method
GET

### Endpoint
/environment

### Parameters
None

### Request Example
```typescript
const env = gridClient.getEnvironment();
console.log(env);
```

### Response
#### Success Response (200)
- **environment** (string) - The current environment ('sandbox' for devnet, 'production' for mainnet)

#### Response Example
```json
{
  "environment": "sandbox"
}
```
```

--------------------------------

### Configure Polyfills

Source: https://grid.squads.xyz/grid/v1/sdk-reference/react-native/reference/latest/quickstart

Import polyfills at the app's entry point before any other code.

```js
import 'text-encoding';
import 'react-native-get-random-values';

import { Buffer } from 'buffer';
global.Buffer = Buffer;

import '@ethersproject/shims';

import 'expo-router/entry';
```

--------------------------------

### GET /kyc/status

Source: https://grid.squads.xyz/grid/v1/api-reference/endpoint/kyc-operations/get

Retrieve the current status of a KYC verification.

```APIDOC
## GET /kyc/status

### Description
Check the current verification status of a KYC request to monitor progress and determine account compliance status.

### Method
GET

### Endpoint
/kyc/status

### Response
#### Success Response (200)
- **status** (string) - The current verification status: not_started, under_review, incomplete, approved, or rejected.
- **tos_status** (string) - The terms of service acceptance status: pending or approved.
```

--------------------------------

### Configure environment variables

Source: https://grid.squads.xyz/grid/v1/examples/neobank

Prepare the environment configuration file for API credentials.

```bash
cp example.env .env
```

--------------------------------

### Open Hosted UI in Browser

Source: https://grid.squads.xyz/grid/v1/accounts/passkeys/integration-guide

Launch the Passkey UI using the device browser.

```javascript
const result = await WebBrowser.openAuthSessionAsync(data.url, redirectUri);
```

--------------------------------

### Get Passkey Account Details - OpenAPI Spec

Source: https://grid.squads.xyz/grid/v1/api-reference/endpoint/passkeys/get-account

Defines the GET /api/grid/v1/passkeys/account/{passkey_account_address} endpoint for retrieving passkey account details. Requires the passkey account address and the Grid environment header. Returns passkey details or error codes for invalid input or not found scenarios.

```yaml
openapi: 3.1.0
info:
  title: Grid v1 API
  description: Grid v1 REST API for Solana-based smart account system
  contact:
    name: Grid API Support
    url: https://squads.so
    email: support@squads.so
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://grid.squads.xyz
    description: Production server
security:
  - bearer_auth: []
tags:
  - name: accounts
    description: Smart account management operations
  - name: spending-limits
    description: Spending limit management
  - name: standing-orders
    description: Standing order operations
  - name: transactions
    description: Transaction management
  - name: trade
    description: Trade operations and management
  - name: payments
    description: Payment intent operations
  - name: passkeys
    description: Passkey management
  - name: kyc
    description: Know Your Customer operations
  - name: external-accounts
    description: External bank account management
  - name: virtual-accounts
    description: Virtual account management
  - name: auth
    description: Authentication operations
  - name: proposals
    description: Proposal management for multi-sig operations
  - name: compliance
    description: Compliance entity management and KYB/KYC operations
paths:
  /api/grid/v1/passkeys/account/{passkey_account_address}:
    get:
      tags:
        - passkeys
      summary: Get passkey account
      description: >-
        Retrieve passkey account details by address. Returns the relying party
        ID, public key, and optional session key if not expired.
      operationId: handler
      parameters:
        - name: passkey_account_address
          in: path
          description: Passkey account address (Solana public key)
          required: true
          schema:
            type: string
        - name: x-grid-environment
          in: header
          description: Solana network environment (sandbox, devnet, mainnet)
          required: true
          schema:
            type: string
          example: sandbox
      responses:
        '200':
          description: Passkey account retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPasskeyAccountResponsePayload'
        '400':
          description: Invalid passkey account address
        '404':
          description: Passkey account not found
        '500':
          description: Internal server error
      security:
        - bearer_auth: []
components:
  schemas:
    GetPasskeyAccountResponsePayload:
      type: object
      required:
        - relyingPartyId
        - pubkey
      properties:
        pubkey:
          type: string
        relyingPartyId:
          type: string
        sessionKey:
          oneOf:
            - type: 'null'
            - $ref: '#/components/schemas/SessionKey'
    SessionKey:
      type: object
      description: >-
        Grid v1 API SessionKey type that supports backward-compatible
        deserialization

        from both raw bytes array (old format) and base58 string (new format).

        Always serializes to base58 string format.
      required:
        - key
        - expiration
      properties:
        expiration:
          type: integer
          format: int64
          minimum: 0
        key:
          type: string
          example: '11111111111111111111111111111111'
  securitySchemes:
    bearer_auth:
      type: http
      scheme: bearer
      description: Your Grid API key from the Grid Dashboard

```

--------------------------------

### Create Account with REST API

Source: https://grid.squads.xyz/grid/v1/accounts/authentication-methods

Initiate account creation via the REST API by providing an email address. An OTP will be sent to the email. Remember to replace YOUR_API_KEY with your actual API key and use a unique idempotency key for each request.

```bash
curl -X POST https://grid.squads.xyz/api/grid/v1/accounts \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "x-grid-environment: sandbox" \
  -H "Content-Type: application/json" \
  -H "x-idempotency-key: $(uuidgen)" \
  -d '{
    "type": "email",
    "email": "user@example.com",
    "memo": "My Grid Account" // Optional
  }'
```

--------------------------------

### Retrieve All Spending Limits

Source: https://grid.squads.xyz/grid/v1/sdk-reference/typescript/reference/latest/classes/GridClient

Example of iterating through all spending limits for an account.

```typescript
const limits = await gridClient.getSpendingLimits(accountAddress);
limits.forEach(limit => {
  console.log(`Limit: ${limit.amount}, Remaining: ${limit.remainingAmount}`);
});
```

--------------------------------

### Complete Authentication and Create Account

Source: https://grid.squads.xyz/grid/v1/sdk-reference/react-native/reference/latest/classes/GridClient

Streamlines the onboarding process by completing authentication and creating an account in a single call.

```typescript
completeAuthAndCreateAccount(request): Promise<CompleteAuthAndCreateAccountResponse>;
```

```typescript
const sessionSecrets = await gridClient.generateSessionSecrets();
const account = await gridClient.completeAuthAndCreateAccount({
  otpCode: '123456',
  user,
  sessionSecrets
});
```

--------------------------------

### Get Account Details

Source: https://grid.squads.xyz/grid/v1/sdk-reference/typescript/reference/latest/classes/GridClient

Retrieve detailed information about a specific account.

```APIDOC
## GET /accounts/{accountAddress}

### Description
Retrieves comprehensive account details including account type, policies, signers, thresholds, and metadata for a given account address.

### Method
`GET`

### Endpoint
`/accounts/{accountAddress}`

### Parameters
#### Path Parameters
- **accountAddress** (string) - Required - The account address to retrieve information for.

### Returns
`Promise<GetAccountResponse>` - Promise resolving to account details or error information.

### Request Example
```typescript
const account = await gridClient.getAccount('account-address');
```
```

--------------------------------

### Get Standing Orders

Source: https://grid.squads.xyz/grid/v1/sdk-reference/react-native/reference/latest/classes/GridClient

Retrieves all standing orders associated with an account.

```APIDOC
## GET /api/standing-orders

### Description
Retrieves all standing orders associated with an account, including active, paused, and completed recurring payment schedules.

### Method
GET

### Endpoint
/api/standing-orders

### Parameters
#### Query Parameters
- **accountAddress** (string) - Required - The account address to get standing orders for.
- **queryParams** (object) - Optional - Query parameters for filtering and pagination.

### Response
#### Success Response (200)
- **standingOrders** (array) - An array of standing order objects.

### Response Example
{
  "standingOrders": [
    {
      "id": "order-id-1",
      "amount": "500000",
      "status": "active",
      "frequency": "weekly"
    },
    {
      "id": "order-id-2",
      "amount": "100000",
      "status": "paused",
      "frequency": "monthly"
    }
  ]
}

### Example
```typescript
const standingOrders = await gridClient.getStandingOrders(accountAddress);
```
```

--------------------------------

### Clone the neobank repository

Source: https://grid.squads.xyz/grid/v1/examples/neobank

Initial step to download the reference implementation source code.

```bash
git clone https://github.com/Squads-Grid/neobank-example-app.git
```

--------------------------------

### Get Client Configuration

Source: https://grid.squads.xyz/grid/v1/sdk-reference/react-native/reference/latest/classes/GridClient

Retrieves the current API configuration for the client.

```ts
getConfig(): GridApiConfig;
```

```typescript
const config = client.getConfig();
console.log(config.environment, config.baseUrl);
```

--------------------------------

### Initialize Grid Client and Authenticate

Source: https://grid.squads.xyz/grid/v1/sdk-reference/react-native/reference/latest/quickstart

Initialize the GridClient and perform the authentication flow using session secrets and OTP verification.

```typescript
import { GridClient } from '@sqds/grid-react-native';

const gridClient = new GridClient({
  environment: 'sandbox',
  apiKey: '<your api key>'
});

try {
  const sessionSecrets = await gridClient.generateSessionSecrets();

  await gridClient.createAccount({
    email: 'user@example.com'
  });

  const otpCode = '123456';

  const response = await gridClient.completeAuthAndCreateAccount({
    email: 'user@example.com',
    code: otpCode,
    sessionSecrets
  });

  console.log('Authentication successful:', response.data);
} catch (error) {
  console.error('Authentication failed:', error.message);
}
```

--------------------------------

### Get Standing Order API Endpoint

Source: https://grid.squads.xyz/grid/v1/api-reference/endpoint/standing-orders/get

This OpenAPI specification defines the GET endpoint for retrieving a standing order. It includes path parameters for the account address and standing order ID, and a header parameter for the environment. The response schema details the structure of the returned standing order information.

```yaml
GET /api/grid/v1/accounts/{address}/standing-order/{standing_order_id}
openapi: 3.1.0
info:
  title: Grid v1 API
  description: Grid v1 REST API for Solana-based smart account system
  contact:
    name: Grid API Support
    url: https://squads.so
    email: support@squads.so
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://grid.squads.xyz
    description: Production server
security:
  - bearer_auth: []
tags:
  - name: accounts
    description: Smart account management operations
  - name: spending-limits
    description: Spending limit management
  - name: standing-orders
    description: Standing order operations
  - name: transactions
    description: Transaction management
  - name: trade
    description: Trade operations and management
  - name: payments
    description: Payment intent operations
  - name: passkeys
    description: Passkey management
  - name: kyc
    description: Know Your Customer operations
  - name: external-accounts
    description: External bank account management
  - name: virtual-accounts
    description: Virtual account management
  - name: auth
    description: Authentication operations
  - name: proposals
    description: Proposal management for multi-sig operations
  - name: compliance
    description: Compliance entity management and KYB/KYC operations
paths:
  /api/grid/v1/accounts/{address}/standing-order/{standing_order_id}:
    get:
      tags:
        - standing-orders
      summary: Get a standing order
      description: Retrieve details of a specific standing order by ID
      operationId: handler
      parameters:
        - name: address
          in: path
          description: Smart account address
          required: true
          schema:
            type: string
        - name: standing_order_id
          in: path
          description: Standing order UUID
          required: true
          schema:
            type: string
        - name: x-grid-environment
          in: header
          description: Solana network environment (sandbox, devnet, mainnet)
          required: true
          schema:
            type: string
          example: sandbox
      responses:
        '200':
          description: Standing order retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetStandingOrderResponse'
        '404':
          description: Standing order or smart account not found
        '500':
          description: Internal server error
      security:
        - bearer_auth: []
components:
  schemas:
    GetStandingOrderResponse:
      type: object
      required:
        - id
        - amount
        - currency
        - period
        - destinations
        - status
        - next_execution_date
        - created_at
      properties:
        amount:
          type: string
        created_at:
          type: string
          format: date-time
        currency:
          type: string
        destinations:
          type: array
          items:
            type: string
        id:
          type: string
          format: uuid
        last_execution_date:
          type:
            - string
            - 'null'
          format: date-time
        next_execution_date:
          type: string
          format: date-time
        period:
          type: string
        status:
          type: string
  securitySchemes:
    bearer_auth:
      type: http
      scheme: bearer
      description: Your Grid API key from the Grid Dashboard

```

--------------------------------

### Implement Account Creation Flow Prompt

Source: https://grid.squads.xyz/grid/v1/accounts/quickstart

This prompt is for an LLM to implement the Grid account creation flow, specifically with email authentication. It outlines the task and provides context for the LLM.

```markdown
# IMPLEMENT GRID ACCOUNT CREATION WITH EMAIL AUTHENTICATION

```

--------------------------------

### Get KYC Status

Source: https://grid.squads.xyz/grid/v1/sdk-reference/react-native/reference/latest/classes/GridClient

Retrieves the current status of a KYC verification process.

```ts
getKycStatus(accountAddress, kycId): Promise<KycStatusResponse>;
```

```typescript
const kycStatus = await gridClient.getKycStatus(accountAddress, kycId);
if (kycStatus.success) {
  console.log(kycStatus.data.status); / 'pending', 'approved', 'rejected'
  console.log(kycStatus.data.verificationLevel); / Verification tier achieved
}
```

--------------------------------

### Retrieve Spending Limit Usage

Source: https://grid.squads.xyz/grid/v1/sdk-reference/typescript/reference/latest/classes/GridClient

Example of fetching and accessing spending limit details.

```typescript
const spendingLimit = await gridClient.getSpendingLimit(
  accountAddress,
  spendingLimitAddress
);
console.log(spendingLimit.amount);
console.log(spendingLimit.remainingAmount);
```

--------------------------------

### POST /auth/init

Source: https://grid.squads.xyz/grid/v1/sdk-reference/typescript/reference/latest/classes/GridClient

Initialize authentication for an existing user. This is the first step in the authentication process.

```APIDOC
## POST /auth/init

### Description
Initialize authentication for an existing user. This is the first step in the authentication process.

<Note>
  Note: For new users, you must call createAccount first to create an account before initializing authentication. This method is only for authenticating existing users.
</Note>

### Method
POST

### Endpoint
/auth/init

### Parameters
#### Request Body
- **request** (InitAuthRequest | AuthenticationRequest) - Required - Authentication request containing email, keypair, or passkey information

### Response
#### Success Response (200)
- **data** (InitAuthResponse) - Promise resolving to authentication initialization response with OTP details

### Request Example
```typescript
const response = await gridClient.initAuth({
  email: 'user@example.com'
});
```

### Response Example
```json
{
  "data": {
    "otpDetails": {
      "userId": "user123",
      "expiresIn": 300
    }
  }
}
```
```

--------------------------------

### POST /passkeys

Source: https://grid.squads.xyz/grid/v1/api-reference/endpoint/passkeys/post

Initializes a new passkey creation session and returns a URL for the hosted WebAuthn UI.

```APIDOC
## POST /passkeys

### Description
Creates a new passkey session for registering a passkey on a user's device. Returns a URL to the hosted UI where the WebAuthn passkey creation ceremony takes place.

### Method
POST

### Endpoint
/passkeys

### Parameters
#### Request Body
- **meta_info** (object) - Required - Configuration for the hosted UI
  - **appName** (string) - Required - Display name shown to users
  - **redirectUrl** (string) - Optional - URL to redirect after completion
- **sessionKey** (object) - Optional - Session key configuration
  - **key** (string) - Required - Solana public key in base58 format
  - **expiration** (number) - Required - Seconds from now until expiration
- **baseUrl** (string) - Optional - Custom domain for hosting the passkey flow

### Request Example
{
  "meta_info": {
    "appName": "My App",
    "redirectUrl": "https://myapp.com/callback"
  },
  "sessionKey": {
    "key": "5wV...",
    "expiration": 900
  }
}

### Response
#### Success Response (200)
- **url** (string) - The URL for the passkey creation ceremony

#### Response Example
{
  "url": "https://passkey.grid.squads.xyz/create?challenge=..."
}
```

--------------------------------

### GET /spending-limits

Source: https://grid.squads.xyz/grid/v1/sdk-reference/typescript/reference/latest/classes/GridClient

Retrieves a specific spending limit by its address or all spending limits for an account.

```APIDOC
## GET /spending-limits/{spendingLimitAddress}

### Description
Retrieves a spending limit by its address.

### Method
GET

### Endpoint
/spending-limits/{spendingLimitAddress}

### Parameters
#### Path Parameters
- **spendingLimitAddress** (string) - Required - The address of the spending limit to retrieve

### Request Example
```json
{
  "accountAddress": "0x123...",
  "spendingLimitAddress": "0xabc..."
}
```

### Response
#### Success Response (200)
- **amount** (string) - The total spending limit amount.
- **remainingAmount** (string) - The remaining amount that can be spent.

#### Response Example
```json
{
  "amount": "1000000",
  "remainingAmount": "500000"
}
```

## GET /spending-limits

### Description
Retrieves all spending limits for an account.

### Method
GET

### Endpoint
/spending-limits

### Parameters
#### Query Parameters
- **accountAddress** (string) - Required - The account address to get spending limits for

### Request Example
```json
{
  "accountAddress": "0x123..."
}
```

### Response
#### Success Response (200)
- **Array of SpendingLimitResponse objects** - Each object contains amount and remainingAmount.

#### Response Example
```json
[
  {
    "amount": "1000000",
    "remainingAmount": "500000"
  },
  {
    "amount": "500000",
    "remainingAmount": "250000"
  }
]
```
```

--------------------------------

### Smart Account Creation Response

Source: https://grid.squads.xyz/grid/v1/api-reference/endpoint/passkeys/create-account

This is an example JSON response after successfully creating a passkey and smart account. It includes the account address, type, status, policies, authentication details, and timestamps.

```json
{
  "address": "5nPmK...smartAccountAddress",
  "type": "passkey",
  "status": "active",
  "policies": {
    "threshold": 1,
    "admin_address": null
  },
  "authentication": [
    {
      "provider": "passkey",
      "session": {
        "Passkey": {
          "passkey_account": "7xK2...passkeyAddress",
          "pubkey": "base58EncodedPublicKey",
          "relying_party_id": "grid.squads.xyz",
          "session_key": {
            "key": "sessionPublicKey",
            "expiration": 1706832000
          }
        }
      }
    }
  ],
  "created_at": "2025-02-01T12:00:00Z",
  "updated_at": "2025-02-01T12:00:00Z"
}

```

--------------------------------

### Get Standing Orders Definition

Source: https://grid.squads.xyz/grid/v1/sdk-reference/typescript/reference/latest/classes/GridClient

Method signature for retrieving all standing orders for an account.

```ts
getStandingOrders(accountAddress, queryParams?): Promise<StandingOrdersResponse>;
```

--------------------------------

### Initialize GridClient

Source: https://grid.squads.xyz/grid/v1/sdk-reference/react-native/reference/latest/classes/GridClient

Initialize the GridClient with an API key and environment configuration.

```typescript
import { GridClient } from '@sqds/grid';

const client = new GridClient({
  apiKey: 'your-api-key',
  environment: 'sandbox'
});

const state = client.account.get();
client.account.on('change', (state) => console.log('Changed:', state));
```

--------------------------------

### Get Passkey Account Definition

Source: https://grid.squads.xyz/grid/v1/sdk-reference/typescript/reference/latest/classes/GridClient

Interface definition for retrieving passkey account details.

```ts
getPasskeyAccount(passkeyAddress, environment): Promise<GetPasskeyAccountResponse>;
```

--------------------------------

### Create a Passkey Account

Source: https://grid.squads.xyz/grid/v1/sdk-reference/react-native/reference/latest/classes/GridClient

Initializes a new smart account linked to a passkey and a session key.

```typescript
const sessionKeyObject = {
  key: sessionKeyPubkey,
  expiration: Date.now() + 900000
};

const account = await gridClient.createPasskeyAccount({
  sessionKey: sessionKeyObject,
  slotNumber: 123,
  authenticatorResponse: webauthnResponse,
  adminAddress: 'admin-public-key',
  memo: 'My passkey account'
}, 'sandbox');
console.log('Smart account address:', account.data.address);
console.log('Passkey account:', account.data.passkey.passkeyAccount);
console.log('Session key:', account.data.passkey.sessionKey);
```

--------------------------------

### Get Account Passkeys

Source: https://grid.squads.xyz/grid/v1/sdk-reference/typescript/reference/latest/classes/GridClient

Fetches all registered passkeys associated with a specific account address.

```ts
getPasskeys(accountAddress): Promise<GetPasskeysResponse>;
```

```typescript
const passkeys = await gridClient.getPasskeys(accountAddress);
```

--------------------------------

### Get Account Transfers

Source: https://grid.squads.xyz/grid/v1/sdk-reference/typescript/reference/latest/classes/GridClient

Retrieves transaction history for an account, supporting filtering and pagination.

```typescript
const transfers = await gridClient.getTransfers(accountAddress);
```

--------------------------------

### Get Specific Standing Order

Source: https://grid.squads.xyz/grid/v1/sdk-reference/react-native/reference/latest/classes/GridClient

Retrieves detailed information about a specific standing order.

```APIDOC
## GET /api/standing-orders/{standingOrderId}

### Description
Retrieves detailed information about a specific standing order, including its current status, execution history, and next payment date.

### Method
GET

### Endpoint
/api/standing-orders/{standingOrderId}

### Parameters
#### Path Parameters
- **accountAddress** (string) - Required - The account address that owns the standing order.
- **standingOrderId** (string) - Required - The unique identifier of the standing order.

### Response
#### Success Response (200)
- **standingOrder** (object) - Detailed information about the specific standing order.

### Response Example
{
  "id": "order-id-1",
  "amount": "500000",
  "status": "active",
  "frequency": "weekly",
  "startDate": "2024-12-02T10:00:00Z",
  "endDate": "2025-12-31T23:59:59Z",
  "nextPaymentDate": "2024-12-09T10:00:00Z"
}

### Example
```typescript
const order = await gridClient.getStandingOrder(accountAddress, orderId);
```
```

--------------------------------

### Set Entry Point in package.json

Source: https://grid.squads.xyz/grid/v1/sdk-reference/react-native/reference/latest/quickstart

Update the main entry point in your package.json file.

```json
{
  "name": "your-app-name",
  "main": "entrypoint.js"
}
```

--------------------------------

### GetTradeQuoteResponse Structure

Source: https://grid.squads.xyz/grid/v1/sdk-reference/react-native/reference/latest/interfaces/GetTradeQuoteResponse

The response structure for getting a trade quote, following the BaseResponse wrapper.

```APIDOC
# GetTradeQuoteResponse

Response from getting a trade quote

This response follows the standard [BaseResponse](/grid/v1/sdk-reference/typescript/reference/v2.0.0/interfaces/BaseResponse) wrapper with `data` (response payload) and `lastResponse` (request metadata).

## Properties

| Property | Type | Description |
| -------- | ---- | ----------- |

Built with [Mintlify](https://mintlify.com).
```

--------------------------------

### Create Account with SDK (TypeScript)

Source: https://grid.squads.xyz/grid/v1/accounts/authentication-methods

Use the SDK to create an account with an email address. This method handles key generation and encryption automatically. Ensure your GRID_API_KEY is set in the environment variables.

```typescript
import { GridClient } from "@sqds/grid";

const gridClient = new GridClient({
  environment: "sandbox",
  apiKey: process.env.GRID_API_KEY!,
});

// Create account with email
const user = await gridClient.createAccount({
  email: "user@example.com",
});

// Generate session secrets
const sessionSecrets = await gridClient.generateSessionSecrets();

// Complete authentication with OTP
const account = await gridClient.completeAuthAndCreateAccount({
  user,
  otpCode: "123456",
  sessionSecrets,
});
```

--------------------------------

### GET /api/grid/v1/accounts/{address}

Source: https://grid.squads.xyz/grid/v1/api-reference/endpoint/account-management/get

Retrieves details for a specific smart account using its address.

```APIDOC
## GET /api/grid/v1/accounts/{address}

### Description
Retrieves details for a specific smart account using its address.

### Method
GET

### Endpoint
/api/grid/v1/accounts/{address}

### Parameters
#### Path Parameters
- **address** (string) - Required - Smart account address (Solana public key)

#### Query Parameters
- **x-grid-environment** (string) - Required - Solana network environment (sandbox, devnet, mainnet)

### Request Example
```json
{
  "example": ""
}
```

### Response
#### Success Response (200)
- **data** (object) - Response payload matching verify_otp structure (minus authentication field)
  - **address** (string) - The smart account address.
  - **grid_user_id** (string) - The unique identifier for the Grid user.
  - **policies** (object | null) - Account policies, if any.
  - **settings_address** (string | null) - Address of the account settings.
  - **status** (string) - "active" if on-chain (has policies), "pending" if not yet on-chain.
- **metadata** (object) - Metadata about the request.
  - **request_id** (string) - Unique identifier for the request.
  - **timestamp** (string) - Timestamp of the request.

#### Response Example
```json
{
  "data": {
    "address": "HfXoLWUUdDw8Cm2N19UFAyisX8Din31bhkREYdKB5FKP",
    "grid_user_id": "user-123",
    "policies": {
      "admin_address": null,
      "signers": [
        {
          "address": "signer-address-1",
          "role": "primary",
          "permissions": ["CAN_INITIATE", "CAN_VOTE", "CAN_EXECUTE"],
          "provider": "privy"
        }
      ],
      "threshold": 1,
      "time_lock": null
    },
    "settings_address": null,
    "status": "active"
  },
  "metadata": {
    "request_id": "req-abc",
    "timestamp": "2023-10-27T10:00:00Z"
  }
}
```

#### Error Responses
- **400** - Invalid request parameters
- **404** - Smart account not found
- **500** - Internal server error
```

--------------------------------

### Create and Verify Grid Account

Source: https://grid.squads.xyz/grid/v1/accounts/quickstart

Methods for initializing a new account and completing authentication using an OTP.

```javascript
const accountData = await gridClient.createAccount({
  email: 'user@example.com',
});
// Returns: { address: string, ... }
// Automatically sends OTP to email
```

```javascript
const verifiedAccount = await gridClient.completeAuthAndCreateAccount({
  user: user,
  otpCode: '123456', // From user email
  sessionSecrets: sessionSecrets,
});
// Returns verified account session
```

--------------------------------

### Initialize Grid Client

Source: https://grid.squads.xyz/grid/v1/accounts/quickstart

Configure the Grid client using your API credentials. Ensure API keys are stored in environment variables and never exposed in client-side code.

```typescript
import { GridClient } from "@sqds/grid";

// Initialize the Grid client
const gridClient = new GridClient({
  environment: "sandbox", // Use 'production' for live applications
  apiKey: process.env.GRID_API_KEY!, // Your API key from the dashboard
  baseUrl: "https://grid.squads.xyz", // Base URL of the Grid API
});

// Verify the connection
console.log("Grid client initialized successfully");
```

```typescript
// .env file
GRID_API_KEY = your_sandbox_api_key_here;

// For production:
// GRID_API_KEY=your_production_api_key_here
// GRID_ENVIRONMENT=production

// gridClient.ts
import { GridClient } from "@sqds/grid";

if (!process.env.GRID_API_KEY) {
  throw new Error("GRID_API_KEY environment variable is required");
}

export const gridClient = new GridClient({
  environment:
    process.env.GRID_ENVIRONMENT === "production" ? "production" : "sandbox",
  apiKey: process.env.GRID_API_KEY,
  baseUrl: "https://grid.squads.xyz",
});
```

--------------------------------

### Get Virtual Accounts Definition

Source: https://grid.squads.xyz/grid/v1/sdk-reference/typescript/reference/latest/classes/GridClient

Signature for the method used to retrieve virtual bank accounts.

```ts
getVirtualAccounts(accountAddress, queryParams?): Promise<VirtualAccountsResponse>;
```

--------------------------------

### Create Account

Source: https://grid.squads.xyz/grid/v1/sdk-reference/react-native/reference/latest/classes/GridClient

Initializes an email-based or signer-based account.

```typescript
createAccount(input): Promise<CreateAccountResponse>;
```

--------------------------------

### Get Spending Limits Definition

Source: https://grid.squads.xyz/grid/v1/sdk-reference/typescript/reference/latest/classes/GridClient

Method signature for retrieving all spending limits associated with an account.

```ts
getSpendingLimits(accountAddress): Promise<SpendingLimitsResponse>;
```

--------------------------------

### Get Spending Limit Definition

Source: https://grid.squads.xyz/grid/v1/sdk-reference/typescript/reference/latest/classes/GridClient

Method signature for retrieving a specific spending limit by address.

```ts
getSpendingLimit(accountAddress, spendingLimitAddress): Promise<SpendingLimitResponse>;
```

--------------------------------

### createPasskeySession()

Source: https://grid.squads.xyz/grid/v1/sdk-reference/typescript/reference/latest/classes/GridClient

Initializes a new passkey session.

```APIDOC
## createPasskeySession()

### Description
Creates a new passkey session for authentication.

### Parameters
#### Request Body
- **params** (CreatePasskeySessionRequest) - Required - Passkey session creation parameters
- **environment** (string) - Required - Target environment ('sandbox' or 'production')

### Request Example
```typescript
await gridClient.createPasskeySession({
  action: 'create',
  sessionKey: 'session-public-key-base58',
  env: 'production',
}, 'production');
```

### Response
- **Promise** (CreatePasskeySessionResponse) - Promise resolving to passkey session creation response
```
Tokens:
Raw