HTTP Client

An easy way to interact with liquidity Pools, Farms, and Vaults or query on-chain information is by using Solana Farms HTTP RPC service. Under the hood, it wraps Rust Client and serves its methods over HTTP.

HTTP RPC service is a part of Farms suite, and to use it, existing deployment of Farm programs and metadata must be present per Quick Start Guide.

To communicate with the service, use any tool or language that supports HTTP requests, for example:

curl 'http://127.0.0.1:9090/api/v1/token_account_balance?wallet_address=9wsC5hx5JopG5VwoDiUGrvgM2NaYz6tS3uyhuneRKgcN&token_name=RAY'

You can also use SwaggerHub to call any method interactively. Swagger schema is available in farms/farm-rpc/swagger.yaml.

The default endpoint port is 9000 and route prefix /api/v1/, e.g. http://localhost:9000/api/v1. A static page with descriptions and links to all methods will be displayed if the endpoint is opened in a browser without a particular method.

Signing Transactions

While HTTP RPC service supports POST requests to interact with liquidity Pools, Farms, and Vaults, it is recommended for internal use or testing only because you will have to include a keypair with your request. Instead, you can sign a transaction locally with a wallet app and send it as usual via @solana/web3.js. To do so, you need to call an instruction building method (anything that starts with new_instruction_ or all_instructions_) to receive a plain instruction in JSON, convert it, sign and send. Here is how it can be done in Javascript and Phantom:

const json_data = await (
  await fetch(
    "http://127.0.0.1:9090/api/v1/new_instruction_add_liquidity_vault?wallet_address=9wsC5hx5JopG5VwoDiUGrvgM2NaYz6tS3uyhuneRKgcN&vault_name=RDM.STC.RAY-SRM&max_token_a_ui_amount=0.1&max_token_b_ui_amount=0.0"
  )
).json();

json_data.accounts.forEach(function (item, index) {
  let acc = {
    isSigner: item.is_signer ? true : false,
    isWritable: item.is_writable ? true : false,
    pubkey: new PublicKey(item.pubkey),
  };
  accounts.push(acc);
});

const instruction = new TransactionInstruction({
  programId: new PublicKey(json_data.program_id),
  data: json_data.data,
  keys: accounts,
});

let transaction = new Transaction({
  recentBlockhash: (await this.connection.getRecentBlockhash()).blockhash,
  feePayer: this.state.provider.publicKey,
});
transaction.add(instruction);

let signed = await this.state.provider.signTransaction(transaction);
let signature = await this.connection.sendRawTransaction(signed.serialize());

No additional JS bindings or other dependencies are required for the above to work besides standard @solana/web3.js.

The result will be a Signature object or 404 status code with error description.

Files

http_client.md

Latest commit

History

http_client.md

File metadata and controls

HTTP Client

Signing Transactions

Methods

Get

Post

(GET) protocols

Parameters:

Results:

(GET) admins

Parameters:

Results:

(GET) program_admins

Parameters:

Results:

(GET) git_token

Parameters:

Results:

(GET) git_tokens

Parameters:

Results:

(GET) fund

Parameters:

Results:

(GET) funds

Parameters:

Results:

(GET) fund_ref

Parameters:

Results:

(GET) fund_refs

Parameters:

Results:

(GET) fund_by_ref

Parameters:

Results:

(GET) fund_name

Parameters:

Results:

(GET) find_funds

Parameters:

Results:

(GET) vault

Parameters:

Results:

(GET) vaults

Parameters:

Results:

(GET) vault_ref

Parameters:

Results:

(GET) vault_refs

Parameters:

Results:

(GET) vault_by_ref

Parameters:

Results:

(GET) vault_name

Parameters:

Results:

(GET) find_vaults

Parameters:

Results:

(GET) find_vaults_with_vt

Parameters:

Results:

(GET) pool

Parameters:

Results:

(GET) pools

Parameters:

Results:

(GET) pool_ref

Parameters:

Results: