No Description

Jon C e279b4b522 CI: Add "interface" as a publishable target (#79) 2 months ago
.github e279b4b522 CI: Add "interface" as a publishable target (#79) 2 months ago
clients 7433164b2a Publish JS client v0.5.1 7 months ago
interface 2f4fd18f65 deps: Bump sdk to v3, decouple from token program (#78) 2 months ago
p-interface 8b7a81aeea p-interface: Change name for Pinocchio interface crate (#73) 2 months ago
p-token 8b7a81aeea p-interface: Change name for Pinocchio interface crate (#73) 2 months ago
program 2f4fd18f65 deps: Bump sdk to v3, decouple from token program (#78) 2 months ago
scripts da8d9bd364 p-token: Add `spl-token` test fixtures (#39) 6 months ago
.gitattributes 8fa926bde8 Initial commit 1 year ago
.gitignore 8fa926bde8 Initial commit 1 year ago
.prettierrc a7ca79e32f Update repo from latest `create-solana-program` (#5) 1 year ago
Cargo.lock 2f4fd18f65 deps: Bump sdk to v3, decouple from token program (#78) 2 months ago
Cargo.toml 2f4fd18f65 deps: Bump sdk to v3, decouple from token program (#78) 2 months ago
LICENSE f476906122 Update License 1 year ago
README.md 3a8dcea8f0 delete idl generation from readme (#70) 2 months ago
SECURITY.md 8921377ea5 Create SECURITY.md 4 months ago
package.json e1400276bb interface: Split out instructions, state, errors from program (#76) 2 months ago
pnpm-lock.yaml 06677863f6 Bump Codama to 1.2.8 and use @solana/kit (#29) 7 months ago
rust-toolchain.toml 17f59a8cc2 deps: Update Solana v2.3.4 and rust toolchain (#69) 2 months ago
rustfmt.toml f8bbbb7a5f CI: Add program and all extra steps (#13) 9 months ago

README.md

SPL Token

This template should help get you started developing Solana programs. Let's walk through this generated program repository and see what's included.

Project setup

The first thing you'll want to do is install NPM dependencies which will allow you to access all the scripts and tools provided by this template.

pnpm install

Managing programs

You'll notice a program folder in the root of this repository. This is where your generated Solana program is located.

Whilst only one program gets generated, note that you can have as many programs as you like in this repository. Whenever you add a new program folder to this repository, remember to add it to the members array of your root Cargo.toml file. That way, your programs will be recognized by the following scripts that allow you to build, test, format and lint your programs respectively.

pnpm programs:build
pnpm programs:test
pnpm programs:format
pnpm programs:lint

Generating clients

Once your programs' IDLs have been generated, you can generate clients for them using the following command.

pnpm generate:clients

Alternatively, you can use the generate script to generate both the IDLs and the clients at once.

pnpm generate

Managing clients

The following clients are available for your programs. You may use the following links to learn more about each client.

Starting and stopping the local validator

The following script is available to start your local validator.

pnpm validator:start

By default, if a local validator is already running, the script will be skipped. You may use the validator:restart script instead to force the validator to restart.

pnpm validator:restart

Finally, you may stop the local validator using the following command.

pnpm validator:stop

Using external programs in your validator

If your program requires any external programs to be running, you'll want to add them to your local validator.

You can do this by adding their program addresses to the program-dependencies array in the Cargo.toml of your program.

program-dependencies = [
  "metaqbxxUerdq28cj1RbAWkYQm3ybzjb6a8bt518x1s",
  "noopb9bkMVfRPU8AsbpTUg8AQkHtKwMYZiFUjNRtMmV",
]

Next time you build your program and run your validator, these external programs will automatically be fetched from mainnet and used in your local validator.

pnpm programs:build
pnpm validator:restart