migrator 0.1.0

A Solana program for deploying and upgrading programs.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158

//! Instructions callable by the approver.

use crate::account_contexts::*;
use anchor_lang::prelude::*;
use solana_program::bpf_loader_upgradeable;
use solana_program::{
    loader_upgradeable_instruction::UpgradeableLoaderInstruction, system_program, sysvar,
};
use vipers::unwrap_int;

/// Creates a new [Migrator].
pub fn new_migrator(
    ctx: Context<NewMigrator>,
    bump: u8,
    name: String,
    description: String,
) -> ProgramResult {
    let migrator = &mut ctx.accounts.migrator;
    migrator.program_id = ctx.accounts.program.key();
    migrator.bump = bump;

    migrator.approver = ctx.accounts.approver.key();
    migrator.pending_migration = Pubkey::default();
    migrator.approval_expires_at = -1;

    migrator.num_migrations = 0;
    migrator.name = name;
    migrator.description = description;

    Ok(())
}

/// Deploys a program with a migration.
pub fn deploy_program(ctx: Context<DeployProgram>) -> ProgramResult {
    let migrator = &ctx.accounts.approved_migration.migrator;
    let seeds = gen_migrator_signer_seeds!(migrator);

    // assign the account to bpf_loader_upgradeable
    solana_program::program::invoke_signed(
        &solana_program::system_instruction::assign(
            &migrator.program_id,
            &bpf_loader_upgradeable::ID,
        ),
        &[
            ctx.accounts.system_program.to_account_info(),
            ctx.accounts
                .bpf_loader_upgradeable_program
                .to_account_info(),
        ],
        &[&seeds[..]],
    )?;

    // deploy the migration
    // for the first deploy, we will use a max data len of 2x the buffer.
    let buffer_size: usize = ctx
        .accounts
        .approved_migration
        .buffer
        .to_account_info()
        .data_len();
    let max_data_len = unwrap_int!(buffer_size.checked_mul(2));

    let deploy_ix = solana_program::instruction::Instruction::new_with_bincode(
        bpf_loader_upgradeable::ID,
        &UpgradeableLoaderInstruction::DeployWithMaxDataLen { max_data_len },
        vec![
            AccountMeta::new(migrator.key(), true),
            AccountMeta::new(ctx.accounts.program.program_data.key(), false),
            AccountMeta::new(ctx.accounts.program.program.key(), false),
            AccountMeta::new(ctx.accounts.approved_migration.buffer.key(), false),
            AccountMeta::new_readonly(sysvar::rent::id(), false),
            AccountMeta::new_readonly(sysvar::clock::id(), false),
            AccountMeta::new_readonly(system_program::id(), false),
            AccountMeta::new_readonly(migrator.key(), true),
        ],
    );
    solana_program::program::invoke_signed(
        &deploy_ix,
        &[
            migrator.to_account_info(),
            ctx.accounts.program.program_data.to_account_info(),
            ctx.accounts.program.program.to_account_info(),
            ctx.accounts.approved_migration.buffer.to_account_info(),
            ctx.accounts.rent.to_account_info(),
            ctx.accounts.clock.to_account_info(),
            ctx.accounts.system_program.to_account_info(),
            migrator.to_account_info(),
        ],
        &[&seeds[..]],
    )?;

    ctx.accounts.approved_migration.commit()?;
    Ok(())
}

/// Upgrades a program.
pub fn upgrade_program(ctx: Context<UpgradeProgram>) -> ProgramResult {
    let migrator = &ctx.accounts.approved_migration.migrator;

    // upgrade the program
    let seeds = gen_migrator_signer_seeds!(migrator);
    let upgrade_ix = solana_program::bpf_loader_upgradeable::upgrade(
        ctx.accounts.program.program.to_account_info().key,
        ctx.accounts.approved_migration.buffer.to_account_info().key,
        migrator.to_account_info().key,
        migrator.to_account_info().key,
    );
    solana_program::program::invoke_signed(
        &upgrade_ix,
        &[
            ctx.accounts.program.program_data.to_account_info(),
            ctx.accounts.program.program.to_account_info(),
            ctx.accounts.approved_migration.buffer.to_account_info(),
            migrator.to_account_info(),
            ctx.accounts.rent.to_account_info(),
            ctx.accounts.clock.to_account_info(),
            migrator.to_account_info(),
        ],
        &[&seeds[..]],
    )?;

    ctx.accounts.approved_migration.commit()?;
    Ok(())
}

/// Approves a [Migration].
pub fn approve_migration(ctx: Context<ApproveMigration>, deadline: i64) -> ProgramResult {
    require!(
        deadline > Clock::get()?.unix_timestamp,
        ExpiryMustBeInFuture
    );

    // un-reject if the migration was rejected.
    let migration = &mut ctx.accounts.migration;
    if migration.rejected_at != -1 {
        migration.rejected_at = -1;
    }

    let migrator = &mut ctx.accounts.migrator;
    migrator.pending_migration = ctx.accounts.migration.key();
    migrator.approval_expires_at = deadline;
    Ok(())
}

/// Rejects the current [Migration].
pub fn reject_migration(ctx: Context<RejectMigration>) -> ProgramResult {
    let migration = &mut ctx.accounts.migration;
    migration.rejected_at = Clock::get()?.unix_timestamp;

    // cancel migration if it's the pending one
    let migrator = &mut ctx.accounts.migrator;
    if migrator.pending_migration.key() == migration.key() {
        migrator.pending_migration = Pubkey::default();
        migrator.approval_expires_at = -1;
    }

    Ok(())
}