# Vulcan Forge ## Docs - [Introduction](https://vulcan-forge-docs.alphaledger.com/introduction.md): - [Getting Started](https://vulcan-forge-docs.alphaledger.com/getting-started.md): - [Authentication & Authorization](https://vulcan-forge-docs.alphaledger.com/authentication-and-authorization.md): - Core Concepts [Terminology](https://vulcan-forge-docs.alphaledger.com/core-concepts/terminology.md): - Core Concepts [Regulated Assets](https://vulcan-forge-docs.alphaledger.com/core-concepts/regulated-assets.md): - Core Concepts [Tenants](https://vulcan-forge-docs.alphaledger.com/core-concepts/tenants.md): - Core Concepts [Mapping & Labelling](https://vulcan-forge-docs.alphaledger.com/core-concepts/mapping-and-labelling.md): - Core Concepts [Solana Networks](https://vulcan-forge-docs.alphaledger.com/core-concepts/solana-networks.md): - Core Concepts [Transaction Processing](https://vulcan-forge-docs.alphaledger.com/core-concepts/transaction-processing.md): - Core Concepts [Key Management](https://vulcan-forge-docs.alphaledger.com/core-concepts/key-management.md): - Core Concepts [Read Layer](https://vulcan-forge-docs.alphaledger.com/core-concepts/read-endpoints.md): - [API Reference](https://vulcan-forge-docs.alphaledger.com/api.md): - API Reference [Blockchain Accounts](https://vulcan-forge-docs.alphaledger.com/api/v1/accounts.md): Endpoints for managing and reading Vulcan Forge Accounts. - API Reference [Financial Instruments](https://vulcan-forge-docs.alphaledger.com/financial-instruments-4963439f0.md): - API Reference [Positions](https://vulcan-forge-docs.alphaledger.com/api/v1/positions.md): - API Reference > Positions [State](https://vulcan-forge-docs.alphaledger.com/state-5421406f0.md): - API Reference > Positions [Movements](https://vulcan-forge-docs.alphaledger.com/api/v1/positions/movements.md): - API Reference > Positions [Trades](https://vulcan-forge-docs.alphaledger.com/api/v1/positions/trades.md): - API Reference > Positions [History](https://vulcan-forge-docs.alphaledger.com/api/v1/positions/history.md): - API Reference [Loans](https://vulcan-forge-docs.alphaledger.com/loans.md): - API Reference [Blockchain Transactions](https://vulcan-forge-docs.alphaledger.com/api/transactions.md): Transactions submission, signing and configurations. - API Reference > Blockchain Transactions [Processing](https://vulcan-forge-docs.alphaledger.com/api/transactions/processing.md): Endpoints for viewing missing signatures, signing prepared transactions, submitting prepared transactions and resubmitting transactions that errored out. - API Reference > Blockchain Transactions [Durable Nonces](https://vulcan-forge-docs.alphaledger.com/api/transactions/durable-nonces.md): Configure nonce authorities and nonce accounts. - API Reference > Blockchain Transactions [Address Lookup Tables](https://vulcan-forge-docs.alphaledger.com/address-lookup-tables-5684128f0.md): ## API Docs - API Reference > Blockchain Accounts [Create Account](https://vulcan-forge-docs.alphaledger.com/api/v1/accounts/create.md): Creates/onboards a Solana Account on the Vulcan Forge system and onchain (optional). Use the itemData.alreadyOnchain=true setting to only onboard the account into Vulcan Forge but not submit a Solana transaction to create the account on the network (because the account would already be on the network). - API Reference > Blockchain Accounts [Fetch Account Details](https://vulcan-forge-docs.alphaledger.com/api/v1/accounts/fetch-single.md): Fetches the details for a single blockchain account. - API Reference > Blockchain Accounts [Fetch Account Balance](https://vulcan-forge-docs.alphaledger.com/api/v1/accounts/fetch-single-balance.md): Fetches the current (offchain and/or onchain) or a past (offchain) SOL/lamports balances for an account. - API Reference > Blockchain Accounts [Fetch Account Private Key](https://vulcan-forge-docs.alphaledger.com/api/v1/accounts/fetch-single-private-key.md): Fetches the private key for an account. Requires elevated permissions - the API key needs to be associated with the VULCAN_FORGE_SENSITIVE_DATA_ACCESS role to fetch this data. - API Reference > Blockchain Accounts [Fetch Accounts](https://vulcan-forge-docs.alphaledger.com/api/v1/accounts/fetch-bulk.md): Fetches a list of accounts based on the provided query. Please note that the output fields will be trimmed to a smaller set of fields if the format path parameter is set to _identifiers_ or _compact_. - API Reference > Blockchain Accounts [Update Account](https://vulcan-forge-docs.alphaledger.com/api/v1/accounts/update.md): Update certain attributes on the specified account. This functions as a patch. Only fields specified in the request body will be updated. The rest of the fields already present on the account remain unchanged. - API Reference > Blockchain Accounts [Inactivate Account](https://vulcan-forge-docs.alphaledger.com/api/v1/accounts/inactivate.md): Closes the Account in Solana and it inactivates it on Alphaledger's platform. It refunds remaining SOL to the desired destination (if provided) otherwise the refund goes to the configured fee payer in the solanaTransactionConfig. - API Reference > Financial Instruments [Create Financial Instrument](https://vulcan-forge-docs.alphaledger.com/api/v1/financial-instruments/create.md): Creates/onboards a financial instrument on the Vulcan Forge system and onchain (optional). Use the itemData.alreadyOnchain=true setting to only onboard the financial instrument into Vulcan Forge but not submit a Solana transaction to create the financial instrument on the network (because the token/financial instrument is already full setup on the network). - API Reference > Financial Instruments [Update Financial Instrument](https://vulcan-forge-docs.alphaledger.com/api/v1/financial-instruments/update.md): Updates for financial instrument. - API Reference > Financial Instruments [Fetch Financial Instrument Details](https://vulcan-forge-docs.alphaledger.com/api/v1/financial-instruments/fetch-single.md): - API Reference > Financial Instruments [Fetch Financial Instruments](https://vulcan-forge-docs.alphaledger.com/api/v1/financial-instruments/fetch-bulk.md): - API Reference > Financial Instruments [Token Extensions Calculator](https://vulcan-forge-docs.alphaledger.com/api/v1/financial-instruments/token-extensions-calculator.md): Calculates the following inputs needed to setup a new mintAccount: - API Reference > Positions > State [Initialize Position](https://vulcan-forge-docs.alphaledger.com/api/v1/positions/state/initialize.md): It creates a position offchain and onchain (optional). Use the itemData.alreadyOnchain=true setting to only onboard the position into Vulcan Forge but not submit a Solana transaction to create the position/token account on the network (because the token account would already be on the network). - API Reference > Positions > State [Close Position](https://vulcan-forge-docs.alphaledger.com/api/v1/positions/state/close.md): Closes the Token Account / Position in Solana and on the Vulcan Forge platform. It refunds remaining SOL to the desired destination: the feePayer or a provided itemData.refundDestination wallet. - API Reference > Positions > State [Freeze Position](https://vulcan-forge-docs.alphaledger.com/api/v1/positions/state/freeze.md): Freezes the Token Account / Position in Solana to prevent any position movements to be posted against this position.. Some text. - API Reference > Positions > State [Unfreeze Position](https://vulcan-forge-docs.alphaledger.com/api/v1/positions/state/unfreeze.md): Unfreezes the Token Account / Position in Solana to allow position movements against this position.. - API Reference > Positions > Movements [Mint](https://vulcan-forge-docs.alphaledger.com/api/v1/positions/movements/mint.md): Mints the specified amount into the mintTo position. The position needs to be unfrozen. - API Reference > Positions > Movements [Burn](https://vulcan-forge-docs.alphaledger.com/api/v1/positions/movements/burn.md): Burns the specified amount from the burnFrom position. The position needs to be unfrozen and have a sufficient balance to support the burn. - API Reference > Positions > Movements [Transfer Financial Instrument](https://vulcan-forge-docs.alphaledger.com/api/v1/positions/movements/transfer.md): Transfer the specified amount from the source position to the destination position. The financial instrument on the 2 positions needs to match. The source position needs to have a sufficient balance to support the transfer and has to be unfrozen. - API Reference > Positions > Movements [Transfer SOL](https://vulcan-forge-docs.alphaledger.com/api/v1/positions/movements/transfer-sol.md): Transfer the specified amount of SOL or lamports. The source account needs to have a sufficient balance to support the transfer. - API Reference > Positions > Trades [Trade](https://vulcan-forge-docs.alphaledger.com/api/v1/positions/trades/trade.md): Processes the array of position movements as an atomic Solana transaction. See each of [the endpoints](/api/v1/positions/movements) for the different position movements types for how each one functions and what signers are required. - API Reference > Positions > History [Fetch Positions](https://vulcan-forge-docs.alphaledger.com/api/v1/positions/history/fetch-bulk.md): - API Reference > Positions > History [Fetch Position Details](https://vulcan-forge-docs.alphaledger.com/api/v1/positions/history/fetch-single.md): - API Reference > Positions > History [Fetch Position Balance](https://vulcan-forge-docs.alphaledger.com/api/v1/positions/history/fetch-single-balance.md): Fetches the current (offchain and/or onchain) or past (offchain) token balances (as a amount and amount in lamports - i.e. amount multiplied by 10^token decimals) for an account. - API Reference > Loans [Create Loan](https://vulcan-forge-docs.alphaledger.com/api/v1/loans/create.md): Creates a loan and establishes a new onchain escrow wallet for it. The pledged items are deposited into this escrow and the borrowed items are transferred from the lender to the fee payer. - API Reference > Loans [Fetch Loan Details](https://vulcan-forge-docs.alphaledger.com/api/v1/loans/fetch-single.md): Gets details associated with a single onchain loan. - API Reference > Loans [Fetch Loans](https://vulcan-forge-docs.alphaledger.com/api/v1/loans/fetch-bulk.md): Gets details associated with multiple loans that meet the query criteria. - API Reference > Loans [Swap Collateral](https://vulcan-forge-docs.alphaledger.com/api/v1/loans/swap-collateral.md): Swaps a set of collateral items (referred to as deposited collateral) against another set of collateral items (referred to as withdrawn collateral). - API Reference > Loans [Repay Loan](https://vulcan-forge-docs.alphaledger.com/api/v1/loans/repay.md): Repays a loan. Use the itemsToRepay to specify the items from the borrower wallet to payoff the debts with and the itemsToRelease to specify what items to release from the loan back to the borrower wallet. - API Reference > Loans [Close Loan](https://vulcan-forge-docs.alphaledger.com/api/v1/loans/close.md): Closes a loan and it refunds the rent fee SOL from the onchain loan back to the borrower's wallet. - API Reference > Loans [Refinance Loan](https://vulcan-forge-docs.alphaledger.com/refinance-loan-23641613e0.md): Refinance / rollover an existing loan. If the fromLender and toLender are the same, the toLender does not need to be specified - in this case the endpoint just does a new rollover of the existing loan using the market rates in place at the time the request is executed. - API Reference > Blockchain Transactions > Processing [Fetch Transaction Status](https://vulcan-forge-docs.alphaledger.com/api/v1/transactions/processing/fetch-single-status.md): - API Reference > Blockchain Transactions > Processing [Sign Transaction](https://vulcan-forge-docs.alphaledger.com/api/v1/transactions/processing/sign.md): - API Reference > Blockchain Transactions > Processing [Submit Transaction](https://vulcan-forge-docs.alphaledger.com/api/v1/transactions/processing/submit.md): - API Reference > Blockchain Transactions > Durable Nonces [Create Durable Nonce Accounts](https://vulcan-forge-docs.alphaledger.com/api/v1/transactions/durable-nonces/create.md): Creates one or moe durable nonce account to be added to the pool of durable nonce accounts that can be used for processing transactions with a messageLifetimeStrategy of DURABLE_NONCE. Go to [Transaction Processing](https://vulcan-forge-docs.alphaledger.com/core-concepts/transaction-processing#durable-nonces) for additional details. - API Reference > Blockchain Transactions > Durable Nonces [Fetch Durable Nonce Account Details](https://vulcan-forge-docs.alphaledger.com/api/v1/transactions/durable-nonce-accounts/fetch-single.md): - API Reference > Blockchain Transactions > Durable Nonces [Fetch Durable Nonce Accounts](https://vulcan-forge-docs.alphaledger.com/api/v1/transactions/durable-nonce-accounts/fetch-bulk.md): Fetches available nonce accounts that have been setup. - API Reference > Blockchain Transactions > Address Lookup Tables [Create Address Lookup Table](https://vulcan-forge-docs.alphaledger.com/api/v1/transactions/address-lookup-tables/create.md): Creates an [Address Lookup Table](https://solana.com/developers/guides/advanced/lookup-tables). Please note that once component addresses are added to an address lookup table, they cannot be removed from it. - API Reference > Blockchain Transactions > Address Lookup Tables [Fetch Address Lookup Table Details](https://vulcan-forge-docs.alphaledger.com/api/v1/transactions/address-lookup-tables/fetch-single.md): Fetches details for a single address lookup table - API Reference > Blockchain Transactions > Address Lookup Tables [Fetch Address Lookup Tables](https://vulcan-forge-docs.alphaledger.com/api/v1/transactions/address-lookup-tables/fetch-bulk.md): Fetches a list of account lookup tables that meet the query criteria. - API Reference > Blockchain Transactions > Address Lookup Tables [Extend Address Lookup Table](https://vulcan-forge-docs.alphaledger.com/api/v1/transactions/address-lookup-tables/extend.md): Extends the address lookup table by adding new addresses to the existing list. - API Reference > Blockchain Transactions > Address Lookup Tables [Update Address Lookup Table](https://vulcan-forge-docs.alphaledger.com/api/v1/transactions/address-lookup-tables/update.md): Updates the address lookup table to manage its lifecycle. Only applies to address lookup tables that are managed on the platform. - API Reference > Blockchain Transactions > History [Fetch Transactions](https://vulcan-forge-docs.alphaledger.com/api/v1/transactions/history/fetch-bulk.md): - API Reference > Blockchain Transactions > History [Fetch Transaction Details](https://vulcan-forge-docs.alphaledger.com/api/v1/transactions/history/fetch-single.md): - API Reference > Market Data [Update Feed](https://vulcan-forge-docs.alphaledger.com/api/v1/maket-data/update-feed.md): Updates an Oracle feed with the most up to date data. The only defi protocol supported currently is Switchboard. ## Schemas - Accounts > DKG [DKG Key Setup](https://vulcan-forge-docs.alphaledger.com/dkg-key-setup-11398827d0.md): - Accounts [Offchain References](https://vulcan-forge-docs.alphaledger.com/offchain-references-9625545d0.md): - Accounts [Account Lookup](https://vulcan-forge-docs.alphaledger.com/account-lookup-9625494d0.md): - Accounts [New Account](https://vulcan-forge-docs.alphaledger.com/new-account-9627173d0.md): - Accounts [Tenancy Config](https://vulcan-forge-docs.alphaledger.com/tenancy-config-9653950d0.md): - Accounts [Account Balance](https://vulcan-forge-docs.alphaledger.com/account-balance-10458531d0.md): - Accounts [Offchain File](https://vulcan-forge-docs.alphaledger.com/offchain-file-10475755d0.md): - Transactions [Solana Transaction Config](https://vulcan-forge-docs.alphaledger.com/solana-transaction-config-9625546d0.md): - Transactions [Commitment Config](https://vulcan-forge-docs.alphaledger.com/commitment-config-9625547d0.md): - Transactions [Transaction Lookup](https://vulcan-forge-docs.alphaledger.com/transaction-lookup-11323545d0.md): - Query > Query Components [Sort Model](https://vulcan-forge-docs.alphaledger.com/sort-model-9657891d0.md): - Query > Query Components [Field Value Filter](https://vulcan-forge-docs.alphaledger.com/field-value-filter-9659102d0.md): - Query > Query Components [Filter Model](https://vulcan-forge-docs.alphaledger.com/filter-model-9658577d0.md): - Query [Items Query](https://vulcan-forge-docs.alphaledger.com/items-query-9657792d0.md): - Reponses > Errors [Individual Error](https://vulcan-forge-docs.alphaledger.com/individual-error-9660378d0.md): - Reponses > Errors [Error Response](https://vulcan-forge-docs.alphaledger.com/error-response-9660386d0.md): - Reponses > Accounts > Private Keys [Private Key Details](https://vulcan-forge-docs.alphaledger.com/private-key-details-9662675d0.md): - Reponses > Accounts > Private Keys [Database Private Key Details](https://vulcan-forge-docs.alphaledger.com/database-private-key-details-9662674d0.md): - Reponses > Accounts > Private Keys [Cloud Provider Resource Location](https://vulcan-forge-docs.alphaledger.com/cloud-provider-resource-location-9663073d0.md): - Reponses > Accounts > Private Keys [DKG Private Key Details](https://vulcan-forge-docs.alphaledger.com/dkg-private-key-details-11451892d0.md): - Reponses > Accounts [Account Response Detailed](https://vulcan-forge-docs.alphaledger.com/account-response-detailed-9660497d0.md): - Reponses > Accounts [Account Onchain Detailed](https://vulcan-forge-docs.alphaledger.com/account-onchain-detailed-9660506d0.md): - Reponses > Accounts [Account Offchain Detailed](https://vulcan-forge-docs.alphaledger.com/account-offchain-detailed-9660697d0.md): - Reponses > Accounts [Account Response Identifiers](https://vulcan-forge-docs.alphaledger.com/account-response-identifiers-9660712d0.md): - Reponses > Accounts [Account Offchain Compact](https://vulcan-forge-docs.alphaledger.com/account-offchain-compact-10576794d0.md): - Reponses > Accounts [Account Response Compact](https://vulcan-forge-docs.alphaledger.com/account-response-compact-10576074d0.md): - Reponses > Accounts [Account Onchain Compact](https://vulcan-forge-docs.alphaledger.com/account-onchain-compact-10576793d0.md): - Reponses > Transactions [Solana Transaction Result](https://vulcan-forge-docs.alphaledger.com/solana-transaction-result-9859294d0.md): - Reponses > Transactions [Solana Entity Result](https://vulcan-forge-docs.alphaledger.com/solana-entity-result-9859866d0.md): - Reponses > Positions [Position Offchain Result](https://vulcan-forge-docs.alphaledger.com/position-offchain-result-9861161d0.md): - Positions [Position Lookup](https://vulcan-forge-docs.alphaledger.com/position-lookup-9791906d0.md): - Positions [Transfer Financial Instrument Definition](https://vulcan-forge-docs.alphaledger.com/transfer-financial-instrument-definition-9858844d0.md): - Positions [Burn Definition](https://vulcan-forge-docs.alphaledger.com/burn-definition-9826072d0.md): - Positions [Mint Definition](https://vulcan-forge-docs.alphaledger.com/mint-definition-9826007d0.md): - Positions [Transfer SOL Definition](https://vulcan-forge-docs.alphaledger.com/transfer-sol-definition-9858852d0.md): - Positions [Position Balance](https://vulcan-forge-docs.alphaledger.com/position-balance-10459291d0.md): - Loans [Loan Duration](https://vulcan-forge-docs.alphaledger.com/loan-duration-11297039d0.md):