Documentation Index
Fetch the complete documentation index at: https://docs.lucid.foundation/llms.txt
Use this file to discover all available pages before exploring further.
Payoutscrosschain SDK
Cross-chain payout operations.
Operations
| Method | Description |
|---|
lucidExecutePayoutOnChain | Execute payout on-chain |
lucidGetPayoutExecution | Get payout execution status |
Generated Reference
Overview
Available Operations
lucidExecutePayoutOnChain
Execute a payout split on-chain via USDC transfers.
Example Usage
import { RaijinLabsLucidAi } from "raijin-labs-lucid-ai";
const raijinLabsLucidAi = new RaijinLabsLucidAi();
async function run() {
const result = await raijinLabsLucidAi.payouts.crosschain.lucidExecutePayoutOnChain({
runId: "<id>",
chainId: "<id>",
});
console.log(result);
}
run();
Standalone function
The standalone function version of this method:
import { RaijinLabsLucidAiCore } from "raijin-labs-lucid-ai/core.js";
import { payoutsCrosschainLucidExecutePayoutOnChain } from "raijin-labs-lucid-ai/funcs/payoutsCrosschainLucidExecutePayoutOnChain.js";
// Use `RaijinLabsLucidAiCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const raijinLabsLucidAi = new RaijinLabsLucidAiCore();
async function run() {
const res = await payoutsCrosschainLucidExecutePayoutOnChain(raijinLabsLucidAi, {
runId: "<id>",
chainId: "<id>",
});
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("payoutsCrosschainLucidExecutePayoutOnChain failed:", res.error);
}
}
run();
Parameters
| Parameter | Type | Required | Description |
|---|
request | operations.LucidExecutePayoutOnChainRequest | :heavy_check_mark: | The request object to use for the request. |
options | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
options.fetchOptions | RequestInit | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed. |
options.retries | RetryConfig | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
Response
Promise<operations.LucidExecutePayoutOnChainResponse>
Errors
| Error Type | Status Code | Content Type |
|---|
| errors.ErrorResponse | 400 | application/json |
| errors.ErrorResponse | 500 | application/json |
| errors.RaijinLabsLucidAiDefaultError | 4XX, 5XX | */* |
lucidGetPayoutExecution
Get the execution status and details for a specific payout.
Example Usage
import { RaijinLabsLucidAi } from "raijin-labs-lucid-ai";
const raijinLabsLucidAi = new RaijinLabsLucidAi();
async function run() {
const result = await raijinLabsLucidAi.payouts.crosschain.lucidGetPayoutExecution({
runId: "<id>",
chainId: "<id>",
});
console.log(result);
}
run();
Standalone function
The standalone function version of this method:
import { RaijinLabsLucidAiCore } from "raijin-labs-lucid-ai/core.js";
import { payoutsCrosschainLucidGetPayoutExecution } from "raijin-labs-lucid-ai/funcs/payoutsCrosschainLucidGetPayoutExecution.js";
// Use `RaijinLabsLucidAiCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const raijinLabsLucidAi = new RaijinLabsLucidAiCore();
async function run() {
const res = await payoutsCrosschainLucidGetPayoutExecution(raijinLabsLucidAi, {
runId: "<id>",
chainId: "<id>",
});
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("payoutsCrosschainLucidGetPayoutExecution failed:", res.error);
}
}
run();
Parameters
| Parameter | Type | Required | Description |
|---|
request | operations.LucidGetPayoutExecutionRequest | :heavy_check_mark: | The request object to use for the request. |
options | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
options.fetchOptions | RequestInit | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed. |
options.retries | RetryConfig | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
Response
Promise<operations.LucidGetPayoutExecutionResponse>
Errors
| Error Type | Status Code | Content Type |
|---|
| errors.ErrorResponse | 400, 404 | application/json |
| errors.ErrorResponse | 500 | application/json |
| errors.RaijinLabsLucidAiDefaultError | 4XX, 5XX | */* |