blockworks-foundation
/
solana
mirror of https://github.com/blockworks-foundation/solana.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

deploy doc updates (#15109)

This commit is contained in:
Jack May 2021-02-04 16:18:14 -08:00 committed by GitHub
parent bba1b49663
commit 82350f9350
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 28 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/sidebars.js
View File

@ -53,8 +53,8 @@ module.exports = {
"cli/choose-a-cluster", "cli/choose-a-cluster",
"cli/transfer-tokens", "cli/transfer-tokens",
"cli/delegate-stake", "cli/delegate-stake",
"cli/manage-stake-accounts", "cli/manage-stake-accounts",
"cli/deploy-a-program", "cli/deploy-a-program",
"offline-signing", "offline-signing",
"offline-signing/durable-nonce", "offline-signing/durable-nonce",
"cli/usage", "cli/usage",

52
docs/src/cli/deploy-a-program.md
View File

@ -48,8 +48,9 @@ If the program id is not specified on the command line the tools will first look
for a keypair file matching the `<PROGRAM_FILEPATH>`, or internally generate a for a keypair file matching the `<PROGRAM_FILEPATH>`, or internally generate a
new keypair. new keypair.
A matching program/keypair file is generated automatically by the program build A matching program keypair file is in the same directory as the program's shared
tools and looks like: object, and named <PROGRAM_NAME>-keypair.json. Matching program keypairs are
generated automatically by the program build tools:
```bash ```bash
./path-to-program/program.so ./path-to-program/program.so
@ -61,7 +62,7 @@ tools and looks like:
To get information about a deployed program: To get information about a deployed program:
```bash ```bash
solana show <ACCOUNT_ADDRESS> solana program show <ACCOUNT_ADDRESS>
``` ```
An example output looks like: An example output looks like:
@ -70,8 +71,8 @@ An example output looks like:
Program Id: 3KS2k14CmtnuVv2fvYcvdrNgC94Y11WETBpMUGgXyWZL Program Id: 3KS2k14CmtnuVv2fvYcvdrNgC94Y11WETBpMUGgXyWZL
ProgramData Address: EHsACWBhgmw8iq5dmUZzTA1esRqcTognhKNHUkPi4q4g ProgramData Address: EHsACWBhgmw8iq5dmUZzTA1esRqcTognhKNHUkPi4q4g
Authority: FwoGJNUaJN2zfVEex9BB11Dqb3NJKy3e9oY3KTh9XzCU Authority: FwoGJNUaJN2zfVEex9BB11Dqb3NJKy3e9oY3KTh9XzCU
Last Upgraded In Slot: 63890568 Last Deployed In Slot: 63890568
Program Length: 5216 (0x1460) bytes Data Length: 5216 (0x1460) bytes
``` ```
- `Program Id` is the address that can be referenced in an instruction's - `Program Id` is the address that can be referenced in an instruction's
@ -96,18 +97,18 @@ solana program deploy <PROGRAM_FILEPATH>
``` ```
By default, programs are deployed to accounts that are twice the size of the By default, programs are deployed to accounts that are twice the size of the
original deployment. Doing so leaves room for further redeployments. But, if original deployment. Doing so leaves room for program growth in future
the initially deployed program is very small (like a simple helloworld program) redeployments. But, if the initially deployed program is very small (like a
and then later grows substantially, the redeployment may fail. To avoid this, simple helloworld program) and then later grows substantially, the redeployment
specify a `max_len` that is at least the size (in bytes) that the program is may fail. To avoid this, specify a `max_len` that is at least the size (in
expected to become (plus some wiggle room). bytes) that the program is expected to become (plus some wiggle room).
```bash ```bash
solana program deploy --max-len 200000 <PROGRAM_FILEPATH> solana program deploy --max-len 200000 <PROGRAM_FILEPATH>
``` ```
Note that program accounts are required to be Note that program accounts are required to be
[rent-excempt](developing/programming-model/accounts.md#rent-exemption), and the [rent-exempt](developing/programming-model/accounts.md#rent-exemption), and the
`max-len` is fixed after initial deployment, so any SOL in the program accounts `max-len` is fixed after initial deployment, so any SOL in the program accounts
is locked up permanently. is locked up permanently.
@ -138,7 +139,7 @@ solana program set-upgrade-authority <PROGRAM_ADDRESS> --upgrade-authority <UPGR
### Immutable programs ### Immutable programs
A program can be marked immutable, which prevents all further redeployments by A program can be marked immutable, which prevents all further redeployments, by
specifying the `--final` flag during deployment: specifying the `--final` flag during deployment:
```bash ```bash
@ -151,6 +152,16 @@ Or anytime after:
solana program set-upgrade-authority <PROGRAM_ADDRESS> --final solana program set-upgrade-authority <PROGRAM_ADDRESS> --final
``` ```
`solana program deploy ...` utilizes Solana's upgradeable loader, but there is
another way to deploy immutable programs using the original on-chain loader:
```bash
solana deploy <PROGRAM_FILEPATH>
```
Programs deployed with `solana deploy ...` are not redeployable and are not
compatible with the `solana program ...` commands.
### Dumping a program to a file ### Dumping a program to a file
The deployed program may be dumped back to a local file: The deployed program may be dumped back to a local file:
@ -177,8 +188,9 @@ $ sha256sum extended.so dump.so
### Using an intermediary Buffer account ### Using an intermediary Buffer account
Instead of deploying directly to the program account, the program can be written Instead of deploying directly to the program account, the program can be written
to an intermediary buffer account. Doing so can be useful for things like to an intermediary buffer account. Intermediary accounts can useful for things
multi-entity governed programs. like multi-entity governed programs where the governing members fist verify the
intermediary buffer contents and then vote to allow an upgrade using it.
```bash ```bash
solana progrma write-buffer <PROGRAM_FILEPATH> solana progrma write-buffer <PROGRAM_FILEPATH>
@ -203,15 +215,3 @@ solana program deploy --program-id <PROGRAM_ADDRESS> --buffer <BUFFER_ADDRESS>
Note, the buffer's authority must match the program's upgrade authority. Note, the buffer's authority must match the program's upgrade authority.
Buffers also support `show` and `dump` just like programs do. Buffers also support `show` and `dump` just like programs do.
### Non-redeployable programs
Using `solana program ...` utilizes Solana's upgradeable loader, but there is
another way to deploy programs using the original on-chain loader.
```bash
solana deploy <PROGRAM_FILEPATH>
```
Programs deployed with `solana deploy ...` are not upgradeable and are not
compatible with the `solana program ...` commands.