removed token from program names, added security.txt

Author: CodeWallet Engineering

README.md

@@ -6,7 +6,7 @@ const fs = require('fs');
 // Run `yarn run build` to generate the `.js` file
 
 const localDeployDir = path.join(__dirname, 'target', 'deploy');
-const PROGRAM_ADDRESS_SPLITTER = require("./client/idl/splitter_token.json").metadata.address;
+const PROGRAM_ADDRESS_SPLITTER = require("./client/idl/splitter.json").metadata.address;
 
 function localDeployPath(programName) {
     return path.join(localDeployDir, `${programName}.so`);
@@ -16,7 +16,7 @@ const programs = {
     splitter: {
         label: 'Splitter Program',
         programId: PROGRAM_ADDRESS_SPLITTER,
-        deployPath: localDeployPath('splitter_token')
+        deployPath: localDeployPath('splitter')
     },
 };
 

SECURITY.md

@@ -2,10 +2,10 @@
 seeds = false
 
 [programs.localnet]
-splitter_token = "spLit2eb13Tz93if6aJM136nUWki5PVUsoEjcUjwpwW"
+splitter = "spLit2eb13Tz93if6aJM136nUWki5PVUsoEjcUjwpwW"
 
 [programs.devnet]
-splitter_token = "spLit2eb13Tz93if6aJM136nUWki5PVUsoEjcUjwpwW"
+splitter = "spLit2eb13Tz93if6aJM136nUWki5PVUsoEjcUjwpwW"
 
 [registry]
 url = "https://anchor.projectserum.com"
@@ -19,5 +19,5 @@ test = "yarn run ts-mocha -p ./tsconfig.json -t 1000000 tests/**/*.ts"
 
 [workspace]
 members = [
-  "programs/splitter-token",
+  "programs/splitter",
 ]

splitter-token/.ammanrc.js renamed to splitter/.ammanrc.js

@@ -1,4 +1,4 @@
-package splitter_token
+package splitter
 
 import (
 	"bytes"

splitter-token/.gitignore renamed to splitter/.gitignore

@@ -1,4 +1,4 @@
-package splitter_token
+package splitter
 
 import (
 	"bytes"

splitter-token/.prettierignore renamed to splitter/.prettierignore

@@ -1,4 +1,4 @@
-package splitter_token
+package splitter
 
 import (
 	"crypto/ed25519"

splitter-token/Anchor.toml renamed to splitter/Anchor.toml

@@ -1,10 +1,10 @@
-package splitter_token
+package splitter
 
-type SplitterTokenError uint32
+type SplitterError uint32
 
 const (
 	// Invalid pool state for this instruction
-	ErrInvalidPoolState SplitterTokenError = iota + 0x1770
+	ErrInvalidPoolState SplitterError = iota + 0x1770
 
 	//Invalid commitment state for this instruction
 	ErrInvalidCommitmentState

splitter-token/Cargo.toml renamed to splitter/Cargo.toml

@@ -1,4 +1,4 @@
-package splitter_token
+package splitter
 
 import (
 	"bytes"

splitter-token/README.md renamed to splitter/README.md

@@ -1,4 +1,4 @@
-package splitter_token
+package splitter
 
 import (
 	"bytes"

splitter-token/client/golang/.gitkeep renamed to splitter/client/golang/.gitkeep

@@ -1,4 +1,4 @@
-package splitter_token
+package splitter
 
 import (
 	"bytes"

splitter-token/client/golang/go.mod renamed to splitter/client/golang/go.mod

@@ -1,4 +1,4 @@
-package splitter_token
+package splitter
 
 import (
 	"bytes"

splitter-token/client/golang/go.sum renamed to splitter/client/golang/go.sum

@@ -1,4 +1,4 @@
-package splitter_token
+package splitter
 
 import (
 	"bytes"

splitter-token/client/golang/pkg/accounts_pool.go renamed to splitter/client/golang/pkg/accounts_pool.go

@@ -1,4 +1,4 @@
-package splitter_token
+package splitter
 
 import (
 	"bytes"

splitter-token/client/golang/pkg/accounts_proof.go renamed to splitter/client/golang/pkg/accounts_proof.go

@@ -1,4 +1,4 @@
-package splitter_token
+package splitter
 
 import (
 	"bytes"

splitter-token/client/golang/pkg/address.go renamed to splitter/client/golang/pkg/address.go

@@ -1,4 +1,4 @@
-package splitter_token
+package splitter
 
 import (
 	"bytes"

splitter-token/client/golang/pkg/errors.go renamed to splitter/client/golang/pkg/errors.go

@@ -1,4 +1,4 @@
-package splitter_token
+package splitter
 
 import (
 	"bytes"

splitter-token/client/golang/pkg/instructions_close_proof.go renamed to splitter/client/golang/pkg/instructions_close_proof.go

@@ -1,4 +1,4 @@
-package splitter_token
+package splitter
 
 import (
 	"crypto/ed25519"

splitter-token/client/golang/pkg/instructions_close_token_account.go renamed to splitter/client/golang/pkg/instructions_close_token_account.go

@@ -1,4 +1,4 @@
-package splitter_token
+package splitter
 
 type DataVersion uint8
 

splitter-token/client/golang/pkg/instructions_initialize_pool.go renamed to splitter/client/golang/pkg/instructions_initialize_pool.go

@@ -1,4 +1,4 @@
-package splitter_token
+package splitter
 
 import "fmt"
 

splitter-token/client/golang/pkg/instructions_initialize_proof.go renamed to splitter/client/golang/pkg/instructions_initialize_proof.go

@@ -1,4 +1,4 @@
-package splitter_token
+package splitter
 
 import (
 	"errors"

splitter-token/client/golang/pkg/instructions_open_token_account.go renamed to splitter/client/golang/pkg/instructions_open_token_account.go

@@ -1,4 +1,4 @@
-package splitter_token
+package splitter
 
 import (
 	"crypto/ed25519"

splitter-token/client/golang/pkg/instructions_save_recent_root.go renamed to splitter/client/golang/pkg/instructions_save_recent_root.go

@@ -1,6 +1,6 @@
 {
   "version": "0.1.0",
-  "name": "splitter_token",
+  "name": "splitter",
   "instructions": [
     {
       "name": "initializePool",
@@ -104,7 +104,15 @@
         {
           "name": "commitment",
           "isMut": false,
-          "isSigner": false
+          "isSigner": false,
+          "docs": [
+            "If everything is successful, this commitment is added as a leaf node to",
+            "the program merkle tree.",
+            "",
+            "Note: this value is hashed with itself internally to discern between",
+            "leaf and intermediate nodes; to prevent trivial second pre-image attacks.",
+            "https://flawed.net.nz/2018/02/21/attacking-merkle-trees-with-a-second-preimage-attack)."
+          ]
         },
         {
           "name": "authority",
@@ -172,7 +180,10 @@
         {
           "name": "proof",
           "isMut": true,
-          "isSigner": false
+          "isSigner": false,
+          "docs": [
+            "The location of our merkle proof state."
+          ]
         },
         {
           "name": "authority",

splitter-token/client/golang/pkg/instructions_transfer_with_commitment.go renamed to splitter/client/golang/pkg/instructions_transfer_with_commitment.go

@@ -1,5 +1,5 @@
 {
-  "name": "splitter-token",
+  "name": "splitter",
   "version": "0.1.0",
   "description": "",
   "main": "dist/src/splitter.js",

splitter-token/client/golang/pkg/instructions_update_proof.go renamed to splitter/client/golang/pkg/instructions_update_proof.go

@@ -1,12 +1,12 @@
 [package]
-name = "splitter-token"
+name = "splitter"
 version = "0.1.0"
 description = "Created with Anchor"
 edition = "2021"
 
 [lib]
 crate-type = ["cdylib", "lib"]
-name = "splitter_token"
+name = "splitter"
 
 [features]
 no-entrypoint = []
@@ -23,3 +23,4 @@ anchor-lang = "=0.24.2"
 anchor-spl = "=0.24.2"
 spl-token = "=3.2.0"
 solana-program = "=1.9.29"
+solana-security-txt = "1.1.0"

splitter-token/client/golang/pkg/instructions_verify_proof.go renamed to splitter/client/golang/pkg/instructions_verify_proof.go

@@ -16,10 +16,24 @@ pub mod error;
 pub mod state;
 pub mod utils;
 
+#[cfg(not(feature = "no-entrypoint"))]
+use {solana_security_txt::security_txt};
+
+#[cfg(not(feature = "no-entrypoint"))]
+security_txt! {
+    name: "Splitter",
+    project_url: "https://getcode.com",
+    contacts: "email:[email protected],email:[email protected]",
+    policy: "https://github.com/code-wallet/code-program-library/blob/main/SECURITY.md",
+    preferred_languages: "en",
+    source_code: "https://github.com/code-wallet/code-program-library",
+    auditors: "OtterSec"
+}
+
 declare_id!("spLit2eb13Tz93if6aJM136nUWki5PVUsoEjcUjwpwW");
 
 #[program]
-pub mod splitter_token {
+pub mod splitter {
 use super::*;
 
     pub fn initialize_pool(

splitter-token/client/golang/pkg/program.go renamed to splitter/client/golang/pkg/program.go

@@ -1,2 +1,2 @@
-exports.PROGRAM_NAME = 'splitter_token';
+exports.PROGRAM_NAME = 'splitter';
 exports.PROGRAM_ID = 'spLit2eb13Tz93if6aJM136nUWki5PVUsoEjcUjwpwW';

splitter-token/client/golang/pkg/types.go renamed to splitter/client/golang/pkg/types.go

@@ -1,6 +1,6 @@
 import * as anchor from "@project-serum/anchor";
 import { Program } from "@project-serum/anchor";
-import { TimelockToken } from "../../target/types/timelock_token";
+import { Timelock } from "../../target/types/timelock";
 import { TOKEN_PROGRAM_ID, Token } from "@solana/spl-token";
 import { Keypair, PublicKey } from "@solana/web3.js";
 import { logEnvironment, TestEnv } from "../utils/test-env";
@@ -10,7 +10,7 @@ import { PREFIX_MERKLE_TREE } from "../utils/config";
 import { MerkleTree } from "../utils/merkle-tree";
 
 export async function newTestEnv(provider: anchor.AnchorProvider): Promise<TestEnv> {
-  const program = anchor.workspace.TimelockToken as Program<TimelockToken>;
+  const program = anchor.workspace.Timelock as Program<Timelock>;
   const mintAuthority = Keypair.generate();
 
   const payer = Keypair.generate();

splitter-token/client/golang/pkg/types_hash.go renamed to splitter/client/golang/pkg/types_hash.go

@@ -5,7 +5,7 @@ import { setEnvironment } from "./utils/config";
 
 setEnvironment();
 
-describe("timelock-token", () => {
+describe("timelock", () => {
   const provider = anchor.AnchorProvider.env()
   anchor.setProvider(provider);
 

splitter-token/client/golang/pkg/types_merkletree.go renamed to splitter/client/golang/pkg/types_merkletree.go

@@ -1,5 +1,5 @@
 import * as anchor from "@project-serum/anchor";
-import { TimelockToken } from "../../target/types/timelock_token";
+import { Timelock } from "../../target/types/timelock";
 import { PublicKey, Keypair } from "@solana/web3.js";
 import { MerkleTree } from "./merkle-tree";
 
@@ -19,7 +19,7 @@ export interface Pool {
 
 export interface TestEnv {
   provider: anchor.AnchorProvider;
-  program: anchor.Program<TimelockToken>;
+  program: anchor.Program<Timelock>;
   mint: PublicKey;
   mintTo: (dest: PublicKey, amount: number) => Promise<void>;
 

splitter-token/client/golang/pkg/utils.go renamed to splitter/client/golang/pkg/utils.go

@@ -7,7 +7,7 @@ const fs = require('fs');
 const accountProviders = require("./client/typescript/dist/generated/accounts")
 
 const localDeployDir = path.join(__dirname, 'target', 'deploy');
-const PROGRAM_ADDRESS = require("./client/idl/timelock_token.json").metadata.address;
+const PROGRAM_ADDRESS = require("./client/idl/timelock.json").metadata.address;
 
 function localDeployPath(programName) {
     return path.join(localDeployDir, `${programName}.so`);
@@ -17,7 +17,7 @@ const programs = {
     timelock: {
         label: 'Timelock Program',
         programId: PROGRAM_ADDRESS,
-        deployPath: localDeployPath('timelock_token')
+        deployPath: localDeployPath('timelock')
     },
 };
 

splitter-token/client/idl/splitter_token.json renamed to splitter/client/idl/splitter.json

@@ -2,10 +2,10 @@
 seeds = false
 
 [programs.localnet]
-timelock_token = "time2Z2SCnn3qYg3ULKVtdkh8YmZ5jFdKicnA1W2YnJ"
+timelock = "time2Z2SCnn3qYg3ULKVtdkh8YmZ5jFdKicnA1W2YnJ"
 
 [programs.devnet]
-timelock_token = "time2Z2SCnn3qYg3ULKVtdkh8YmZ5jFdKicnA1W2YnJ"
+timelock = "time2Z2SCnn3qYg3ULKVtdkh8YmZ5jFdKicnA1W2YnJ"
 
 [registry]
 url = "https://anchor.projectserum.com"