Skip to content
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.

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

feat: add compute budget instructions #1

Merged
merged 3 commits into from
Aug 31, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
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
2 changes: 1 addition & 1 deletion src/associated_token_account.zig
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
const std = @import("std");
const sol = @import("sol");
const bincode = @import("bincode");
const sol = @import("solana-program-sdk");
sonicfromnewyoke marked this conversation as resolved.
Show resolved Hide resolved

pub const program_id = sol.PublicKey.comptimeFromBase58("ATokenGPvbdGVxr1b2hvZbsiqW5xWH25efTNsLJA8knL");

Expand Down
130 changes: 130 additions & 0 deletions src/compute_budget.zig
Original file line number Diff line number Diff line change
@@ -0,0 +1,130 @@
const std = @import("std");
const sol = @import("solana-program-sdk");
const bincode = @import("bincode");

const Account = sol.Account;

const ComputeBudget = @This();

pub const id = sol.PublicKey.comptimeFromBase58("ComputeBudget111111111111111111111111111111");

pub fn requestHeapFrame(allocator: std.mem.Allocator, bytes: u32) !sol.Instruction {
const data = try bincode.writeAlloc(allocator, ComputeBudget.Instruction{
.request_heap_frame = .{ .bytes = bytes },
}, .{});

return sol.Instruction.from(.{
.program_id = &id,
.accounts = &[_]Account.Param{},
.data = data,
});
}

pub fn setComputeUnitLimit(allocator: std.mem.Allocator, units: u32) !sol.Instruction {
const data = try bincode.writeAlloc(allocator, ComputeBudget.Instruction{
.set_compute_unit_limit = .{ .units = units },
}, .{});

return sol.Instruction.from(.{
.program_id = &id,
.accounts = &[_]Account.Param{},
.data = data,
});
}

pub fn setComputeUnitPrice(allocator: std.mem.Allocator, micro_lamports: u64) !sol.Instruction {
const data = try bincode.writeAlloc(allocator, ComputeBudget.Instruction{
.set_compute_unit_price = .{ .micro_lamports = micro_lamports },
}, .{});

return sol.Instruction.from(.{
.program_id = &id,
.accounts = &[_]Account.Param{},
.data = data,
});
}

pub fn setLoadedAccountsDataSizeLimit(allocator: std.mem.Allocator, bytes: u32) !sol.Instruction {
const data = try bincode.writeAlloc(allocator, ComputeBudget.Instruction{
.set_loaded_accounts_data_size_limit = .{ .bytes = bytes },
}, .{});

return sol.Instruction.from(.{
.program_id = &id,
.accounts = &[_]Account.Param{},
.data = data,
});
}

pub const Instruction = union(enum(u8)) {
// deprecated variant, reserved value.
unused,
/// Request a specific transaction-wide program heap region size in bytes.
/// The value requested must be a multiple of 1024. This new heap region
/// size applies to each program executed in the transaction, including all
/// calls to CPIs.
request_heap_frame: struct {
bytes: u32,
},
/// Set a specific compute unit limit that the transaction is allowed to consume.
set_compute_unit_limit: struct {
units: u32,
Copy link
Owner

Choose a reason for hiding this comment

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

nit: can this be renamed to compute_units for total clarity?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

renamed units -> compute_units

regarding avoiding allocations for program instructions, Ito not blowing up that thread I'd prefer to open the issue under the solana-program-sdk and describe a couple of possible allocation strategies:

  1. create & destroy
  2. comptime-based
  3. etc.

Copy link
Owner

Choose a reason for hiding this comment

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

Please, that would be perfect

},
/// Set a compute unit price in "micro-lamports" to pay a higher transaction
/// fee for higher transaction prioritization.
set_compute_unit_price: struct {
micro_lamports: u64,
},
/// Set a specific transaction-wide account data size limit, in bytes, is allowed to load.
set_loaded_accounts_data_size_limit: struct {
bytes: u32,
},
};

test "build request heap frame ix" {
const ix = try requestHeapFrame(std.testing.allocator, 4000);

defer std.testing.allocator.free(ix.data[0..ix.data_len]);
sonicfromnewyoke marked this conversation as resolved.
Show resolved Hide resolved

try std.testing.expect(ix.program_id.equals(id));
try std.testing.expectEqual(0, ix.accounts_len);
try std.testing.expectEqual(5, ix.data_len);

try std.testing.expect(std.mem.eql(u8, &.{ 0x1, 0xa0, 0xf, 0x0, 0x0 }, ix.data[0..ix.data_len]));
}

test "build set compute limit ix" {
const ix = try setComputeUnitLimit(std.testing.allocator, 1_400_000);

defer std.testing.allocator.free(ix.data[0..ix.data_len]);

try std.testing.expect(ix.program_id.equals(id));
try std.testing.expectEqual(0, ix.accounts_len);
try std.testing.expectEqual(5, ix.data_len);

try std.testing.expect(std.mem.eql(u8, &.{ 0x2, 0xc0, 0x5c, 0x15, 0x0 }, ix.data[0..ix.data_len]));
}

test "build set compute unit price ix" {
const ix = try setComputeUnitPrice(std.testing.allocator, 1000);

defer std.testing.allocator.free(ix.data[0..ix.data_len]);

try std.testing.expect(ix.program_id.equals(id));
try std.testing.expectEqual(0, ix.accounts_len);
try std.testing.expectEqual(9, ix.data_len);

try std.testing.expect(std.mem.eql(u8, &.{ 0x3, 0xe8, 0x3, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0 }, ix.data[0..ix.data_len]));
}

test "build set loaded accounts data-size limit ix" {
const ix = try setLoadedAccountsDataSizeLimit(std.testing.allocator, 1200);

defer std.testing.allocator.free(ix.data[0..ix.data_len]);

try std.testing.expect(ix.program_id.equals(id));
try std.testing.expectEqual(0, ix.accounts_len);
try std.testing.expectEqual(5, ix.data_len);

try std.testing.expect(std.mem.eql(u8, &.{ 0x4, 0xb0, 0x4, 0x0, 0x0 }, ix.data[0..ix.data_len]));
}
1 change: 1 addition & 0 deletions src/root.zig
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
const std = @import("std");

pub const associated_token_account = @import("associated_token_account.zig");
pub const compute_budget = @import("compute_budget.zig");
pub const system = @import("system.zig");
pub const token = @import("token.zig");

Expand Down
Loading