瀏覽代碼

p-interface: Change name for Pinocchio interface crate (#73)

* p-interface: Change name for Pinocchio interface crate

#### Problem

As part of https://github.com/orgs/anza-xyz/projects/27, we want to
separate interfaces from programs for Agave.

The token repo already has `spl-token-interface`, but it's
Pinocchio-only, which means it'll be currently difficult to start using
in Agave.

#### Summary of changes

Change the crate name to `pinocchio-token-interface` and directory name
to `p-interface` so that we can add `interface` in a future PR.

* Rename spl_token_interface -> pinocchio_token_interface
Jon C 2 月之前
父節點
當前提交
8b7a81aeea
共有 46 個文件被更改,包括 53 次插入53 次删除
  1. 6 6
      .github/workflows/main.yml
  2. 1 1
      .github/workflows/publish-rust.yml
  3. 11 11
      Cargo.lock
  4. 1 1
      Cargo.toml
  5. 2 2
      p-interface/Cargo.toml
  6. 0 0
      p-interface/README.md
  7. 0 0
      p-interface/src/error.rs
  8. 0 0
      p-interface/src/instruction.rs
  9. 0 0
      p-interface/src/lib.rs
  10. 0 0
      p-interface/src/native_mint.rs
  11. 0 0
      p-interface/src/state/account.rs
  12. 0 0
      p-interface/src/state/account_state.rs
  13. 0 0
      p-interface/src/state/mint.rs
  14. 0 0
      p-interface/src/state/mod.rs
  15. 0 0
      p-interface/src/state/multisig.rs
  16. 1 1
      p-token/Cargo.toml
  17. 1 1
      p-token/src/entrypoint.rs
  18. 1 1
      p-token/src/processor/amount_to_ui_amount.rs
  19. 1 1
      p-token/src/processor/batch.rs
  20. 1 1
      p-token/src/processor/close_account.rs
  21. 1 1
      p-token/src/processor/get_account_data_size.rs
  22. 1 1
      p-token/src/processor/initialize_account2.rs
  23. 1 1
      p-token/src/processor/initialize_account3.rs
  24. 1 1
      p-token/src/processor/initialize_immutable_owner.rs
  25. 1 1
      p-token/src/processor/initialize_multisig.rs
  26. 1 1
      p-token/src/processor/initialize_multisig2.rs
  27. 1 1
      p-token/src/processor/mod.rs
  28. 1 1
      p-token/src/processor/revoke.rs
  29. 1 1
      p-token/src/processor/set_authority.rs
  30. 1 1
      p-token/src/processor/shared/approve.rs
  31. 1 1
      p-token/src/processor/shared/burn.rs
  32. 1 1
      p-token/src/processor/shared/initialize_account.rs
  33. 1 1
      p-token/src/processor/shared/initialize_mint.rs
  34. 1 1
      p-token/src/processor/shared/initialize_multisig.rs
  35. 1 1
      p-token/src/processor/shared/mint_to.rs
  36. 1 1
      p-token/src/processor/shared/toggle_account_state.rs
  37. 1 1
      p-token/src/processor/shared/transfer.rs
  38. 1 1
      p-token/src/processor/sync_native.rs
  39. 1 1
      p-token/src/processor/ui_amount_to_amount.rs
  40. 1 1
      p-token/src/processor/withdraw_excess_lamports.rs
  41. 1 1
      p-token/tests/initialize_mint.rs
  42. 1 1
      p-token/tests/initialize_mint2.rs
  43. 1 1
      p-token/tests/setup/mint.rs
  44. 1 1
      p-token/tests/setup/mod.rs
  45. 1 1
      p-token/tests/withdraw_excess_lamports.rs
  46. 2 2
      package.json

+ 6 - 6
.github/workflows/main.yml

@@ -61,8 +61,8 @@ jobs:
       - name: Lint
         run: pnpm programs:lint
 
-  format_and_lint_interface:
-    name: Format & Lint Interface
+  format_and_lint_pinterface:
+    name: Format & Lint P-Interface
     runs-on: ubuntu-latest
     steps:
       - name: Git Checkout
@@ -75,10 +75,10 @@ jobs:
           rustfmt: true
 
       - name: Format
-        run: pnpm interface:format
+        run: pnpm p-interface:format
 
       - name: Lint
-        run: pnpm interface:lint
+        run: pnpm p-interface:lint
 
   format_and_lint_ptoken:
     name: Format & Lint p-token
@@ -98,7 +98,7 @@ jobs:
 
       - name: Lint
         run: pnpm p-token:lint
-              
+
   audit_rust:
     name: Audit Rust
     runs-on: ubuntu-latest
@@ -192,7 +192,7 @@ jobs:
   build_ptoken:
     name: Build p-token
     runs-on: ubuntu-latest
-    needs: [format_and_lint_interface, format_and_lint_ptoken]
+    needs: [format_and_lint_pinterface, format_and_lint_ptoken]
     steps:
       - name: Git Checkout
         uses: actions/checkout@v4

+ 1 - 1
.github/workflows/publish-rust.yml

@@ -10,7 +10,7 @@ on:
         type: choice
         options:
           - clients/rust
-          - interface
+          - p-interface
           - program
           - p-token
       level:

+ 11 - 11
Cargo.lock

@@ -3057,6 +3057,16 @@ dependencies = [
  "sha2-const-stable",
 ]
 
+[[package]]
+name = "pinocchio-token-interface"
+version = "0.0.0"
+dependencies = [
+ "pinocchio",
+ "pinocchio-pubkey",
+ "strum 0.27.1",
+ "strum_macros 0.27.1",
+]
+
 [[package]]
 name = "pinocchio-token-program"
 version = "0.0.0"
@@ -3065,6 +3075,7 @@ dependencies = [
  "num-traits",
  "pinocchio",
  "pinocchio-log",
+ "pinocchio-token-interface",
  "solana-instruction",
  "solana-keypair",
  "solana-program-error",
@@ -3079,7 +3090,6 @@ dependencies = [
  "solana-transaction-error",
  "spl-token 8.0.0 (registry+https://github.com/rust-lang/crates.io-index)",
  "spl-token-2022",
- "spl-token-interface",
 ]
 
 [[package]]
@@ -7412,16 +7422,6 @@ dependencies = [
  "thiserror 2.0.12",
 ]
 
-[[package]]
-name = "spl-token-interface"
-version = "0.0.0"
-dependencies = [
- "pinocchio",
- "pinocchio-pubkey",
- "strum 0.27.1",
- "strum_macros 0.27.1",
-]
-
 [[package]]
 name = "spl-token-metadata-interface"
 version = "0.7.0"

+ 1 - 1
Cargo.toml

@@ -1,6 +1,6 @@
 [workspace]
 resolver = "2"
-members = ["interface", "p-token", "program"]
+members = ["p-interface", "p-token", "program"]
 
 [workspace.package]
 authors = ["Anza Maintainers <maintainers@anza.xyz>"]

+ 2 - 2
interface/Cargo.toml → p-interface/Cargo.toml

@@ -1,7 +1,7 @@
 [package]
-name = "spl-token-interface"
+name = "pinocchio-token-interface"
 version = "0.0.0"
-description = "Instructions and types for interacting with SPL Token program"
+description = "Pinocchio instructions and types for interacting with SPL Token program"
 authors = { workspace = true}
 repository = { workspace = true}
 license = { workspace = true}

+ 0 - 0
interface/README.md → p-interface/README.md


+ 0 - 0
interface/src/error.rs → p-interface/src/error.rs


+ 0 - 0
interface/src/instruction.rs → p-interface/src/instruction.rs


+ 0 - 0
interface/src/lib.rs → p-interface/src/lib.rs


+ 0 - 0
interface/src/native_mint.rs → p-interface/src/native_mint.rs


+ 0 - 0
interface/src/state/account.rs → p-interface/src/state/account.rs


+ 0 - 0
interface/src/state/account_state.rs → p-interface/src/state/account_state.rs


+ 0 - 0
interface/src/state/mint.rs → p-interface/src/state/mint.rs


+ 0 - 0
interface/src/state/mod.rs → p-interface/src/state/mod.rs


+ 0 - 0
interface/src/state/multisig.rs → p-interface/src/state/multisig.rs


+ 1 - 1
p-token/Cargo.toml

@@ -17,7 +17,7 @@ logging = []
 [dependencies]
 pinocchio = { workspace = true }
 pinocchio-log = { version = "0.5", default-features = false }
-spl-token-interface = { version = "^0", path = "../interface" }
+pinocchio-token-interface = { version = "^0", path = "../p-interface" }
 
 [dev-dependencies]
 assert_matches = "1.5.0"

+ 1 - 1
p-token/src/entrypoint.rs

@@ -7,7 +7,7 @@ use {
         pubkey::Pubkey,
         ProgramResult,
     },
-    spl_token_interface::error::TokenError,
+    pinocchio_token_interface::error::TokenError,
 };
 
 program_entrypoint!(process_instruction);

+ 1 - 1
p-token/src/processor/amount_to_ui_amount.rs

@@ -6,7 +6,7 @@ use {
         ProgramResult,
     },
     pinocchio_log::logger::{Argument, Logger},
-    spl_token_interface::{
+    pinocchio_token_interface::{
         error::TokenError,
         state::{load, mint::Mint},
     },

+ 1 - 1
p-token/src/processor/batch.rs

@@ -1,7 +1,7 @@
 use {
     crate::entrypoint::inner_process_instruction,
     pinocchio::{account_info::AccountInfo, program_error::ProgramError, ProgramResult},
-    spl_token_interface::error::TokenError,
+    pinocchio_token_interface::error::TokenError,
 };
 
 /// The size of the batch instruction header.

+ 1 - 1
p-token/src/processor/close_account.rs

@@ -1,7 +1,7 @@
 use {
     super::validate_owner,
     pinocchio::{account_info::AccountInfo, program_error::ProgramError, ProgramResult},
-    spl_token_interface::{
+    pinocchio_token_interface::{
         error::TokenError,
         state::{
             account::{Account, INCINERATOR_ID},

+ 1 - 1
p-token/src/processor/get_account_data_size.rs

@@ -4,7 +4,7 @@ use {
         account_info::AccountInfo, program::set_return_data, program_error::ProgramError,
         ProgramResult,
     },
-    spl_token_interface::{
+    pinocchio_token_interface::{
         error::TokenError,
         state::{account::Account, load, mint::Mint, Transmutable},
     },

+ 1 - 1
p-token/src/processor/initialize_account2.rs

@@ -5,7 +5,7 @@ use {
         pubkey::{Pubkey, PUBKEY_BYTES},
         ProgramResult,
     },
-    spl_token_interface::error::TokenError,
+    pinocchio_token_interface::error::TokenError,
 };
 
 #[inline(always)]

+ 1 - 1
p-token/src/processor/initialize_account3.rs

@@ -5,7 +5,7 @@ use {
         pubkey::{Pubkey, PUBKEY_BYTES},
         ProgramResult,
     },
-    spl_token_interface::error::TokenError,
+    pinocchio_token_interface::error::TokenError,
 };
 
 #[inline(always)]

+ 1 - 1
p-token/src/processor/initialize_immutable_owner.rs

@@ -1,6 +1,6 @@
 use {
     pinocchio::{account_info::AccountInfo, program_error::ProgramError, ProgramResult},
-    spl_token_interface::{
+    pinocchio_token_interface::{
         error::TokenError,
         state::{account::Account, load_unchecked, Initializable},
     },

+ 1 - 1
p-token/src/processor/initialize_multisig.rs

@@ -1,7 +1,7 @@
 use {
     super::shared,
     pinocchio::{account_info::AccountInfo, ProgramResult},
-    spl_token_interface::error::TokenError,
+    pinocchio_token_interface::error::TokenError,
 };
 
 #[inline(always)]

+ 1 - 1
p-token/src/processor/initialize_multisig2.rs

@@ -1,7 +1,7 @@
 use {
     super::shared,
     pinocchio::{account_info::AccountInfo, ProgramResult},
-    spl_token_interface::error::TokenError,
+    pinocchio_token_interface::error::TokenError,
 };
 
 pub fn process_initialize_multisig2(

+ 1 - 1
p-token/src/processor/mod.rs

@@ -4,7 +4,7 @@ use {
         account_info::AccountInfo, program_error::ProgramError, pubkey::Pubkey,
         syscalls::sol_memcpy_, ProgramResult,
     },
-    spl_token_interface::{
+    pinocchio_token_interface::{
         error::TokenError,
         program::ID as TOKEN_PROGRAM_ID,
         state::{

+ 1 - 1
p-token/src/processor/revoke.rs

@@ -1,7 +1,7 @@
 use {
     super::validate_owner,
     pinocchio::{account_info::AccountInfo, program_error::ProgramError, ProgramResult},
-    spl_token_interface::{
+    pinocchio_token_interface::{
         error::TokenError,
         state::{account::Account, load_mut},
     },

+ 1 - 1
p-token/src/processor/set_authority.rs

@@ -3,7 +3,7 @@ use {
     pinocchio::{
         account_info::AccountInfo, program_error::ProgramError, pubkey::Pubkey, ProgramResult,
     },
-    spl_token_interface::{
+    pinocchio_token_interface::{
         error::TokenError,
         instruction::AuthorityType,
         state::{account::Account, load_mut, mint::Mint, Transmutable},

+ 1 - 1
p-token/src/processor/shared/approve.rs

@@ -1,7 +1,7 @@
 use {
     crate::processor::validate_owner,
     pinocchio::{account_info::AccountInfo, program_error::ProgramError, ProgramResult},
-    spl_token_interface::{
+    pinocchio_token_interface::{
         error::TokenError,
         state::{account::Account, load, load_mut, mint::Mint},
     },

+ 1 - 1
p-token/src/processor/shared/burn.rs

@@ -1,7 +1,7 @@
 use {
     crate::processor::{check_account_owner, validate_owner},
     pinocchio::{account_info::AccountInfo, program_error::ProgramError, ProgramResult},
-    spl_token_interface::{
+    pinocchio_token_interface::{
         error::TokenError,
         state::{account::Account, load_mut, mint::Mint},
     },

+ 1 - 1
p-token/src/processor/shared/initialize_account.rs

@@ -7,7 +7,7 @@ use {
         sysvars::{rent::Rent, Sysvar},
         ProgramResult,
     },
-    spl_token_interface::{
+    pinocchio_token_interface::{
         error::TokenError,
         native_mint::is_native_mint,
         state::{

+ 1 - 1
p-token/src/processor/shared/initialize_mint.rs

@@ -6,7 +6,7 @@ use {
         sysvars::{rent::Rent, Sysvar},
         ProgramResult,
     },
-    spl_token_interface::{
+    pinocchio_token_interface::{
         error::TokenError,
         state::{load_mut_unchecked, mint::Mint, Initializable},
     },

+ 1 - 1
p-token/src/processor/shared/initialize_multisig.rs

@@ -5,7 +5,7 @@ use {
         sysvars::{rent::Rent, Sysvar},
         ProgramResult,
     },
-    spl_token_interface::{
+    pinocchio_token_interface::{
         error::TokenError,
         state::{load_mut_unchecked, multisig::Multisig, Initializable},
     },

+ 1 - 1
p-token/src/processor/shared/mint_to.rs

@@ -1,7 +1,7 @@
 use {
     crate::processor::{check_account_owner, validate_owner},
     pinocchio::{account_info::AccountInfo, program_error::ProgramError, ProgramResult},
-    spl_token_interface::{
+    pinocchio_token_interface::{
         error::TokenError,
         state::{account::Account, load_mut, mint::Mint},
     },

+ 1 - 1
p-token/src/processor/shared/toggle_account_state.rs

@@ -1,7 +1,7 @@
 use {
     crate::processor::validate_owner,
     pinocchio::{account_info::AccountInfo, program_error::ProgramError, ProgramResult},
-    spl_token_interface::{
+    pinocchio_token_interface::{
         error::TokenError,
         state::{account::Account, account_state::AccountState, load, load_mut, mint::Mint},
     },

+ 1 - 1
p-token/src/processor/shared/transfer.rs

@@ -1,7 +1,7 @@
 use {
     crate::processor::{check_account_owner, validate_owner},
     pinocchio::{account_info::AccountInfo, program_error::ProgramError, ProgramResult},
-    spl_token_interface::{
+    pinocchio_token_interface::{
         error::TokenError,
         state::{account::Account, load, load_mut, load_mut_unchecked, mint::Mint},
     },

+ 1 - 1
p-token/src/processor/sync_native.rs

@@ -1,7 +1,7 @@
 use {
     super::check_account_owner,
     pinocchio::{account_info::AccountInfo, program_error::ProgramError, ProgramResult},
-    spl_token_interface::{
+    pinocchio_token_interface::{
         error::TokenError,
         state::{account::Account, load_mut},
     },

+ 1 - 1
p-token/src/processor/ui_amount_to_amount.rs

@@ -5,7 +5,7 @@ use {
         account_info::AccountInfo, program::set_return_data, program_error::ProgramError,
         ProgramResult,
     },
-    spl_token_interface::{
+    pinocchio_token_interface::{
         error::TokenError,
         state::{load, mint::Mint},
     },

+ 1 - 1
p-token/src/processor/withdraw_excess_lamports.rs

@@ -6,7 +6,7 @@ use {
         sysvars::{rent::Rent, Sysvar},
         ProgramResult,
     },
-    spl_token_interface::{
+    pinocchio_token_interface::{
         error::TokenError,
         state::{account::Account, load, mint::Mint, multisig::Multisig, Transmutable},
     },

+ 1 - 1
p-token/tests/initialize_mint.rs

@@ -1,6 +1,7 @@
 mod setup;
 
 use {
+    pinocchio_token_interface::state::mint::Mint,
     setup::TOKEN_PROGRAM_ID,
     solana_keypair::Keypair,
     solana_program_option::COption,
@@ -10,7 +11,6 @@ use {
     solana_signer::Signer,
     solana_system_interface::instruction::create_account,
     solana_transaction::Transaction,
-    spl_token_interface::state::mint::Mint,
     std::mem::size_of,
 };
 

+ 1 - 1
p-token/tests/initialize_mint2.rs

@@ -1,6 +1,7 @@
 mod setup;
 
 use {
+    pinocchio_token_interface::state::mint::Mint,
     setup::TOKEN_PROGRAM_ID,
     solana_keypair::Keypair,
     solana_program_option::COption,
@@ -10,7 +11,6 @@ use {
     solana_signer::Signer,
     solana_system_interface::instruction::create_account,
     solana_transaction::Transaction,
-    spl_token_interface::state::mint::Mint,
     std::mem::size_of,
 };
 

+ 1 - 1
p-token/tests/setup/mint.rs

@@ -1,4 +1,5 @@
 use {
+    pinocchio_token_interface::state::mint::Mint,
     solana_keypair::Keypair,
     solana_program_error::ProgramError,
     solana_program_test::{BanksClientError, ProgramTestContext},
@@ -6,7 +7,6 @@ use {
     solana_signer::Signer,
     solana_system_interface::instruction::create_account,
     solana_transaction::Transaction,
-    spl_token_interface::state::mint::Mint,
     std::mem::size_of,
 };
 

+ 1 - 1
p-token/tests/setup/mod.rs

@@ -5,4 +5,4 @@ pub mod account;
 #[allow(dead_code)]
 pub mod mint;
 
-pub const TOKEN_PROGRAM_ID: Pubkey = Pubkey::new_from_array(spl_token_interface::program::ID);
+pub const TOKEN_PROGRAM_ID: Pubkey = Pubkey::new_from_array(pinocchio_token_interface::program::ID);

+ 1 - 1
p-token/tests/withdraw_excess_lamports.rs

@@ -4,6 +4,7 @@ mod setup;
 
 use {
     assert_matches::assert_matches,
+    pinocchio_token_interface::state::{account::Account, mint::Mint, multisig::Multisig},
     setup::{mint, TOKEN_PROGRAM_ID},
     solana_instruction::error::InstructionError,
     solana_keypair::Keypair,
@@ -14,7 +15,6 @@ use {
     solana_system_interface::instruction::create_account,
     solana_transaction::Transaction,
     solana_transaction_error::TransactionError,
-    spl_token_interface::state::{account::Account, mint::Mint, multisig::Multisig},
     std::mem::size_of,
 };
 

+ 2 - 2
package.json

@@ -31,8 +31,8 @@
     "fixtures:clean": "zx ./scripts/rust/fixtures.mjs clean",
     "fixtures:generate": "zx ./scripts/rust/fixtures.mjs generate",
     "fixtures:run": "zx ./scripts/rust/fixtures.mjs run",
-    "interface:format": "zx ./scripts/rust/format.mjs interface",
-    "interface:lint": "zx ./scripts/rust/lint.mjs interface"
+    "p-interface:format": "zx ./scripts/rust/format.mjs p-interface",
+    "p-interface:lint": "zx ./scripts/rust/lint.mjs p-interface"
   },
   "devDependencies": {
     "@codama/renderers-js": "^1.2.7",