/*
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
*/
import { constructionConstructionCombine } from "../funcs/constructionConstructionCombine.js";
import { constructionConstructionDerive } from "../funcs/constructionConstructionDerive.js";
import { constructionConstructionHash } from "../funcs/constructionConstructionHash.js";
import { constructionConstructionMetadata } from "../funcs/constructionConstructionMetadata.js";
import { constructionConstructionParse } from "../funcs/constructionConstructionParse.js";
import { constructionConstructionPayloads } from "../funcs/constructionConstructionPayloads.js";
import { constructionConstructionPreprocess } from "../funcs/constructionConstructionPreprocess.js";
import { constructionConstructionSubmit } from "../funcs/constructionConstructionSubmit.js";
import { ClientSDK, RequestOptions } from "../lib/sdks.js";
import * as models from "../models/index.js";
import { unwrapAsync } from "../types/fp.js";
export class Construction extends ClientSDK {
/**
* Derive an AccountIdentifier from a PublicKey
*
* @remarks
* Derive returns the AccountIdentifier associated with a public key. Blockchains that require an on-chain action to create an account should not implement this method.
*/
async constructionDerive(
request: models.ConstructionDeriveRequest,
options?: RequestOptions,
): Promise<models.ConstructionDeriveResponse> {
return unwrapAsync(constructionConstructionDerive(
this,
request,
options,
));
}
/**
* Create a Request to Fetch Metadata
*
* @remarks
* Preprocess is called prior to `/construction/payloads` to construct a request for any metadata that is needed for transaction construction given (i.e. account nonce). The `options` object returned from this endpoint will be sent to the `/construction/metadata` endpoint UNMODIFIED by the caller (in an offline execution environment). If your Construction API implementation has configuration options, they MUST be specified in the `/construction/preprocess` request (in the `metadata` field).
*/
async constructionPreprocess(
request: models.ConstructionPreprocessRequest,
options?: RequestOptions,
): Promise<models.ConstructionPreprocessResponse> {
return unwrapAsync(constructionConstructionPreprocess(
this,
request,
options,
));
}
/**
* Get Metadata for Transaction Construction
*
* @remarks
* Get any information required to construct a transaction for a specific network. Metadata returned here could be a recent hash to use, an account sequence number, or even arbitrary chain state. The request used when calling this endpoint is created by calling `/construction/preprocess` in an offline environment. You should NEVER assume that the request sent to this endpoint will be created by the caller or populated with any custom parameters. This must occur in `/construction/preprocess`. It is important to clarify that this endpoint should not pre-construct any transactions for the client (this should happen in `/construction/payloads`). This endpoint is left purposely unstructured because of the wide scope of metadata that could be required.
*/
async constructionMetadata(
request: models.ConstructionMetadataRequest,
options?: RequestOptions,
): Promise<models.ConstructionMetadataResponse> {
return unwrapAsync(constructionConstructionMetadata(
this,
request,
options,
));
}
/**
* Generate an Unsigned Transaction and Signing Payloads
*
* @remarks
* Payloads is called with an array of operations and the response from `/construction/metadata`. It returns an unsigned transaction blob and a collection of payloads that must be signed by particular AccountIdentifiers using a certain SignatureType. The array of operations provided in transaction construction often times can not specify all "effects" of a transaction (consider invoked transactions in Ethereum). However, they can deterministically specify the "intent" of the transaction, which is sufficient for construction. For this reason, parsing the corresponding transaction in the Data API (when it lands on chain) will contain a superset of whatever operations were provided during construction.
*/
async constructionPayloads(
request: models.ConstructionPayloadsRequest,
options?: RequestOptions,
): Promise<models.ConstructionPayloadsResponse> {
return unwrapAsync(constructionConstructionPayloads(
this,
request,
options,
));
}
/**
* Create Network Transaction from Signatures
*
* @remarks
* Combine creates a network-specific transaction from an unsigned transaction and an array of provided signatures. The signed transaction returned from this method will be sent to the `/construction/submit` endpoint by the caller.
*/
async constructionCombine(
request: models.ConstructionCombineRequest,
options?: RequestOptions,
): Promise<models.ConstructionCombineResponse> {
return unwrapAsync(constructionConstructionCombine(
this,
request,
options,
));
}
/**
* Parse a Transaction
*
* @remarks
* Parse is called on both unsigned and signed transactions to understand the intent of the formulated transaction. This is run as a sanity check before signing (after `/construction/payloads`) and before broadcast (after `/construction/combine`).
*/
async constructionParse(
request: models.ConstructionParseRequest,
options?: RequestOptions,
): Promise<models.ConstructionParseResponse> {
return unwrapAsync(constructionConstructionParse(
this,
request,
options,
));
}
/**
* Get the Hash of a Signed Transaction
*
* @remarks
* TransactionHash returns the network-specific transaction hash for a signed transaction.
*/
async constructionHash(
request: models.ConstructionHashRequest,
options?: RequestOptions,
): Promise<models.TransactionIdentifierResponse> {
return unwrapAsync(constructionConstructionHash(
this,
request,
options,
));
}
/**
* Submit a Signed Transaction
*
* @remarks
* Submit a pre-signed transaction to the node. This call should not block on the transaction being included in a block. Rather, it should return immediately with an indication of whether or not the transaction was included in the mempool. The transaction submission response should only return a 200 status if the submitted transaction could be included in the mempool. Otherwise, it should return an error.
*/
async constructionSubmit(
request: models.ConstructionSubmitRequest,
options?: RequestOptions,
): Promise<models.TransactionIdentifierResponse> {
return unwrapAsync(constructionConstructionSubmit(
this,
request,
options,
));
}
}
