Skip to content

feat(wrw): added api key for full node txn #6581

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 30, 2025
Merged

feat(wrw): added api key for full node txn #6581

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
229 changes: 130 additions & 99 deletions modules/sdk-coin-sol/src/sol.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,7 @@ export interface SolRecoveryOptions extends MPCRecoveryOptions {
// destination address where token should be sent before closing the ATA address
recoveryDestinationAtaAddress?: string;
programId?: string; // programId of the token
apiKey?: string; // API key for node requests
Copy link

Copilot AI Jul 30, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nitpick] The comment should be more descriptive. Consider: '// Optional Alchemy API key for enhanced rate limits and reliability'

Suggested change
apiKey?: string; // API key for node requests
apiKey?: string; // Optional Alchemy API key for enhanced rate limits and reliability

Copilot uses AI. Check for mistakes.
}

export interface SolConsolidationRecoveryOptions extends MPCConsolidationRecoveryOptions {
Expand All @@ -165,6 +166,7 @@ export interface SolConsolidationRecoveryOptions extends MPCConsolidationRecover
secretKey: string;
};
tokenContractAddress?: string;
apiKey?: string; // API key for node requests
Copy link

Copilot AI Jul 30, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nitpick] The comment should be more descriptive and consistent with the interface above. Consider: '// Optional Alchemy API key for enhanced rate limits and reliability'

Suggested change
apiKey?: string; // API key for node requests
apiKey?: string; // Optional Alchemy API key for enhanced rate limits and reliability

Copilot uses AI. Check for mistakes.
}

const HEX_REGEX = /^[0-9a-fA-F]+$/;
Expand Down Expand Up @@ -534,16 +536,22 @@ export class Sol extends BaseCoin {
});
}

protected getPublicNodeUrl(): string {
protected getPublicNodeUrl(apiKey?: string): string {
if (apiKey) {
return Environments[this.bitgo.getEnv()].solAlchemyNodeUrl + `/${apiKey}`;
}
return Environments[this.bitgo.getEnv()].solNodeUrl;
}

/**
* Make a request to one of the public SOL nodes available
* @param params.payload
*/
protected async getDataFromNode(params: { payload?: Record<string, unknown> }): Promise<request.Response> {
const nodeUrl = this.getPublicNodeUrl();
protected async getDataFromNode(
params: { payload?: Record<string, unknown> },
apiKey?: string
): Promise<request.Response> {
const nodeUrl = this.getPublicNodeUrl(apiKey);
try {
return await request.post(nodeUrl).send(params.payload);
} catch (e) {
Expand All @@ -552,92 +560,107 @@ export class Sol extends BaseCoin {
throw new Error(`Unable to call endpoint: '/' from node: ${nodeUrl}`);
}

protected async getBlockhash(): Promise<string> {
const response = await this.getDataFromNode({
payload: {
id: '1',
jsonrpc: '2.0',
method: 'getLatestBlockhash',
params: [
{
commitment: 'finalized',
},
],
protected async getBlockhash(apiKey?: string): Promise<string> {
const response = await this.getDataFromNode(
{
payload: {
id: '1',
jsonrpc: '2.0',
method: 'getLatestBlockhash',
params: [
{
commitment: 'finalized',
},
],
},
},
});
apiKey
);
if (response.status !== 200) {
throw new Error('Account not found');
}

return response.body.result.value.blockhash;
}

protected async getFeeForMessage(message: string): Promise<number> {
const response = await this.getDataFromNode({
payload: {
id: '1',
jsonrpc: '2.0',
method: 'getFeeForMessage',
params: [
message,
{
commitment: 'finalized',
},
],
protected async getFeeForMessage(message: string, apiKey?: string): Promise<number> {
const response = await this.getDataFromNode(
{
payload: {
id: '1',
jsonrpc: '2.0',
method: 'getFeeForMessage',
params: [
message,
{
commitment: 'finalized',
},
],
},
},
});
apiKey
);
if (response.status !== 200) {
throw new Error('Account not found');
}

return response.body.result.value;
}

protected async getRentExemptAmount(): Promise<number> {
const response = await this.getDataFromNode({
payload: {
jsonrpc: '2.0',
id: '1',
method: 'getMinimumBalanceForRentExemption',
params: [165],
protected async getRentExemptAmount(apiKey?: string): Promise<number> {
const response = await this.getDataFromNode(
{
payload: {
jsonrpc: '2.0',
id: '1',
method: 'getMinimumBalanceForRentExemption',
params: [165],
},
},
});
apiKey
);
if (response.status !== 200 || response.error) {
throw new Error(JSON.stringify(response.error));
}

return response.body.result;
}

protected async getAccountBalance(pubKey: string): Promise<number> {
const response = await this.getDataFromNode({
payload: {
id: '1',
jsonrpc: '2.0',
method: 'getBalance',
params: [pubKey],
protected async getAccountBalance(pubKey: string, apiKey?: string): Promise<number> {
const response = await this.getDataFromNode(
{
payload: {
id: '1',
jsonrpc: '2.0',
method: 'getBalance',
params: [pubKey],
},
},
});
apiKey
);
if (response.status !== 200) {
throw new Error('Account not found');
}
return response.body.result.value;
}

protected async getAccountInfo(pubKey: string): Promise<SolDurableNonceFromNode> {
const response = await this.getDataFromNode({
payload: {
id: '1',
jsonrpc: '2.0',
method: 'getAccountInfo',
params: [
pubKey,
{
encoding: 'jsonParsed',
},
],
protected async getAccountInfo(pubKey: string, apiKey?: string): Promise<SolDurableNonceFromNode> {
const response = await this.getDataFromNode(
{
payload: {
id: '1',
jsonrpc: '2.0',
method: 'getAccountInfo',
params: [
pubKey,
{
encoding: 'jsonParsed',
},
],
},
},
});
apiKey
);
if (response.status !== 200) {
throw new Error('Account not found');
}
Expand All @@ -647,26 +670,29 @@ export class Sol extends BaseCoin {
};
}

protected async getTokenAccountsByOwner(pubKey = '', programId = ''): Promise<[] | TokenAccount[]> {
const response = await this.getDataFromNode({
payload: {
id: '1',
jsonrpc: '2.0',
method: 'getTokenAccountsByOwner',
params: [
pubKey,
{
programId:
programId.toString().toLowerCase() === TOKEN_2022_PROGRAM_ID.toString().toLowerCase()
? TOKEN_2022_PROGRAM_ID.toString()
: TOKEN_PROGRAM_ID.toString(),
},
{
encoding: 'jsonParsed',
},
],
protected async getTokenAccountsByOwner(pubKey = '', programId = '', apiKey?: string): Promise<[] | TokenAccount[]> {
const response = await this.getDataFromNode(
{
payload: {
id: '1',
jsonrpc: '2.0',
method: 'getTokenAccountsByOwner',
params: [
pubKey,
{
programId:
programId.toString().toLowerCase() === TOKEN_2022_PROGRAM_ID.toString().toLowerCase()
? TOKEN_2022_PROGRAM_ID.toString()
: TOKEN_PROGRAM_ID.toString(),
},
{
encoding: 'jsonParsed',
},
],
},
},
});
apiKey
);
if (response.status !== 200) {
throw new Error('Account not found');
}
Expand All @@ -682,20 +708,23 @@ export class Sol extends BaseCoin {
return [];
}

protected async getTokenAccountInfo(pubKey: string): Promise<TokenAccount> {
const response = await this.getDataFromNode({
payload: {
id: '1',
jsonrpc: '2.0',
method: 'getAccountInfo',
params: [
pubKey,
{
encoding: 'jsonParsed',
},
],
protected async getTokenAccountInfo(pubKey: string, apiKey?: string): Promise<TokenAccount> {
const response = await this.getDataFromNode(
{
payload: {
id: '1',
jsonrpc: '2.0',
method: 'getAccountInfo',
params: [
pubKey,
{
encoding: 'jsonParsed',
},
],
},
},
});
apiKey
);
if (response.status !== 200) {
throw new Error('Account not found');
}
Expand Down Expand Up @@ -791,21 +820,21 @@ export class Sol extends BaseCoin {
const accountId = MPC.deriveUnhardened(bitgoKey, currPath).slice(0, 64);
const bs58EncodedPublicKey = new SolKeyPair({ pub: accountId }).getAddress();

balance = await this.getAccountBalance(bs58EncodedPublicKey);
balance = await this.getAccountBalance(bs58EncodedPublicKey, params.apiKey);

const factory = this.getBuilder();
const walletCoin = this.getChain();

let txBuilder;
let blockhash = await this.getBlockhash();
let blockhash = await this.getBlockhash(params.apiKey);
let rentExemptAmount;
let authority = '';
let totalFee = new BigNumber(0);
let totalFeeForTokenRecovery = new BigNumber(0);

// check for possible token recovery, recover the token provide by user
if (params.tokenContractAddress) {
const tokenAccounts = await this.getTokenAccountsByOwner(bs58EncodedPublicKey, params.programId);
const tokenAccounts = await this.getTokenAccountsByOwner(bs58EncodedPublicKey, params.programId, params.apiKey);
if (tokenAccounts.length !== 0) {
// there exists token accounts on the given address, but need to check certain conditions:
// 1. if there is a recoverable balance
Expand All @@ -826,7 +855,7 @@ export class Sol extends BaseCoin {
}

if (recovereableTokenAccounts.length !== 0) {
rentExemptAmount = await this.getRentExemptAmount();
rentExemptAmount = await this.getRentExemptAmount(params.apiKey);

txBuilder = factory
.getTokenTransferBuilder()
Expand All @@ -838,7 +867,8 @@ export class Sol extends BaseCoin {
// need to get all token accounts of the recipient address and need to create them if they do not exist
const recipientTokenAccounts = await this.getTokenAccountsByOwner(
params.recoveryDestination,
params.programId
params.programId,
params.apiKey
);

for (const tokenAccount of recovereableTokenAccounts) {
Expand Down Expand Up @@ -894,7 +924,7 @@ export class Sol extends BaseCoin {
}

if (params.durableNonce) {
const durableNonceInfo = await this.getAccountInfo(params.durableNonce.publicKey);
const durableNonceInfo = await this.getAccountInfo(params.durableNonce.publicKey, params.apiKey);
blockhash = durableNonceInfo.blockhash;
authority = durableNonceInfo.authority;

Expand All @@ -908,7 +938,7 @@ export class Sol extends BaseCoin {
const unsignedTransactionWithoutFee = (await txBuilder.build()) as Transaction;
const serializedMessage = unsignedTransactionWithoutFee.solTransaction.serializeMessage().toString('base64');

const baseFee = await this.getFeeForMessage(serializedMessage);
const baseFee = await this.getFeeForMessage(serializedMessage, params.apiKey);
const feePerSignature = params.durableNonce ? baseFee / 2 : baseFee;
totalFee = totalFee.plus(new BigNumber(baseFee));
totalFeeForTokenRecovery = totalFeeForTokenRecovery.plus(new BigNumber(baseFee));
Expand Down Expand Up @@ -1118,7 +1148,7 @@ export class Sol extends BaseCoin {
throw new Error('invalid recoveryDestinationAtaAddress');
}

blockhash = await this.getBlockhash();
blockhash = await this.getBlockhash(params.apiKey);

txBuilder = factory
.getTokenTransferBuilder()
Expand All @@ -1128,7 +1158,7 @@ export class Sol extends BaseCoin {
.feePayer(bs58EncodedPublicKey);
const unsignedTransaction = (await txBuilder.build()) as Transaction;
const serializedMessage = unsignedTransaction.solTransaction.serializeMessage().toString('base64');
const feePerSignature = await this.getFeeForMessage(serializedMessage);
const feePerSignature = await this.getFeeForMessage(serializedMessage, params.apiKey);
const baseFee = params.durableNonce ? feePerSignature * 2 : feePerSignature;
const totalFee = new BigNumber(baseFee);
if (totalFee.gt(accountBalance)) {
Expand Down Expand Up @@ -1159,7 +1189,7 @@ export class Sol extends BaseCoin {

// after recovering the token amount, attempting to close the ATA address
if (params.closeAtaAddress) {
blockhash = await this.getBlockhash();
blockhash = await this.getBlockhash(params.apiKey);

const ataCloseBuilder = () => {
const txBuilder = factory.getCloseAtaInitializationBuilder();
Expand Down Expand Up @@ -1316,6 +1346,7 @@ export class Sol extends BaseCoin {
secretKey: params.durableNonces.secretKey,
},
tokenContractAddress: params.tokenContractAddress,
apiKey: params.apiKey,
};

let recoveryTransaction;
Expand Down
Loading