run setup script

Author: samuelvanderwaal

.github/workflows/build-rust-client.yml

@@ -67,5 +67,5 @@ jobs:
         with:
           name: rust-client-builds
           # First wildcard ensures exported paths are consistently under the clients folder.
-          path: ./targe*/release/*project_name*
+          path: ./targe*/release/*amm*
           if-no-files-found: error

CONTRIBUTING.md

@@ -1,6 +1,6 @@
-# Contributing to Project Name
+# Contributing to Amm
 
-This is a quick guide to help you contribute to Project Name.
+This is a quick guide to help you contribute to Amm.
 
 ## Getting started
 

Cargo.lock

@@ -1,53 +1,22 @@
-<h1 align="center">
-  Anchor Project Template
-</h1>
-<p align="center">
-  <img width="400" alt="Anchor Template" src="https://github.com/tensor-foundation/anchor-project-template/assets/729235/e4a818f8-b144-4347-a7df-9123c6fdd707" />
-</p>
-
-<p align="center">
-  A template for Anchor-based programs with generated clients.
-</p>
-
-## Features
-
-- **Generate IDLs** using [Anchor](https://github.com/coral-xyz/anchor) + [Shank](https://github.com/metaplex-foundation/shank)
-- **Generate clients** for one or more programs using [Kinobi](https://github.com/metaplex-foundation/kinobi)
-- Configure **local validators** using [Amman](https://github.com/metaplex-foundation/amman)
-- **Build, test and lint** programs and clients using GitHub Actions.
-- **Publish** your `web3.js 2.0` JavaScript client and its TypeScript documentation by dispatching a GitHub workflow.
-- **Publish** your Rust client SDK to [crates.io](https://crates.io) by dispatching a GitHub workflow.
-
-## Getting started
-
-1. [Use this template](https://github.com/new?template_name=anchor-project-template&template_owner=tensor-foundation) to create a new repository.
-
-2. Open the `setup.sh` script and update the following variables.
-   ```sh
-   NAME="project-name"
-   ORGANIZATION="organization"
-   AUTHOR="author <author@email.com>"
-   DESCRIPTION="My project description"
-   PUBLIC_KEY="MyProgram1111111111111111111111111111111111"
-   ```
-3. Run the `setup.sh` script to initialize the project. This will find/replace the variable above, rename some files/folders, update the README and, finally, remove the `setup.sh` script.
-   ```bash
-   ./setup.sh
-   ```
-4. [Read the `CONTRIBUTING.md` file](./CONTRIBUTING.md) to learn more about how to use the project.
-
-## License
-
-Copyright (c) 2024 Tensor Protocol Foundation
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
+# Amm
+
+Version 2 of the Tensor AMM program..
+
+## Programs
+
+This project contains the following programs:
+
+- [Amm](./programs/amm/README.md) `TAMMqgJYcquwwj2tCdNUerh4C2bJjmghijVziSEf5tA`
+
+You will need a Rust version compatible with BPF to compile the program, currently we recommend using Rust 1.75.0.
+
+## Clients
+
+This project contains the following clients:
+
+- [JavaScript](./clients/js/README.md)
+- [Rust](./clients/rust/README.md)
+
+## Contributing
+
+Check out the [Contributing Guide](./CONTRIBUTING.md) the learn more about how to contribute to this project.

PROJECT_README.md

@@ -1,6 +1,6 @@
 # Contributing to the JavaScript client
 
-This is a quick guide to help you contribute to the JavaScript client of Project Name.
+This is a quick guide to help you contribute to the JavaScript client of Amm.
 
 ## Getting started
 
@@ -44,12 +44,12 @@ To publish JavaScript clients using GitHub actions, we first need the following
 
 - `NPM_TOKEN` — An access token that can publish your packages to NPM.
 - `VERCEL_TOKEN` — An access token that can deploy to Vercel.
-- `VERCEL_ORG_ID` — The ID of the Vercel organization you want to deploy to.
+- `VERCEL_ORG_ID` — The ID of the Vercel tensor-foundation you want to deploy to.
 
 Then, we'll need to create a new GitHub environment called `js-client-documentation` for the generated documentation of the JavaScript client. We can then select the `main` branch only and add the following secret variable to this specific environment.
 
 - `VERCEL_PROJECT_ID` — The ID of the Vercel project you want to deploy to.
-  The convention is to create a new Vercel project named `project-name-js-docs` with the following deployment settings:
+  The convention is to create a new Vercel project named `amm-js-docs` with the following deployment settings:
 
   - Build Command: `pnpm run build:docs`
   - Output Directory: `docs`

README.md

@@ -1,15 +1,15 @@
-# JavaScript client for Project Name
+# JavaScript client for Amm
 
 A web3.js 2.0 compatible JavaScript library for the project.
 
 ## Getting started
 
 Install this library using the package manager of your choice.
 ```sh
-npm install @organization/project-name
+npm install @tensor-foundation/amm
 ```
 
-You can learn more about this library's API by reading its generated [TypeDoc documentation](https://project-name-js-docs.vercel.app).
+You can learn more about this library's API by reading its generated [TypeDoc documentation](https://amm-js-docs.vercel.app).
 
 ## Contributing
 

clients/js/CONTRIBUTING.md

@@ -1,7 +1,7 @@
 {
-  "name": "@organization/project-name",
+  "name": "@tensor-foundation/amm",
   "version": "0.0.0",
-  "description": "My project description",
+  "description": "Version 2 of the Tensor AMM program.",
   "main": "dist/src/index.js",
   "types": "dist/src/index.d.ts",
   "scripts": {
@@ -20,9 +20,9 @@
     "access": "public",
     "registry": "https://registry.npmjs.org"
   },
-  "homepage": "https://github.com/organization",
-  "repository": "https://github.com/organization/project-name.git",
-  "author": "author <author@email.com>",
+  "homepage": "https://github.com/tensor-foundation",
+  "repository": "https://github.com/tensor-foundation/amm.git",
+  "author": "Tensor Protocol Foundation <maintainers.foundation>",
   "license": "Apache-2.0",
   "dependencies": {
     "@solana/accounts": "2.0.0-experimental.dbe6a73",

clients/js/README.md

@@ -6,20 +6,20 @@
  * @see https://github.com/metaplex-foundation/kinobi
  */
 
-export const enum ProjectNameProgramErrorCode {
+export const enum AmmProgramErrorCode {
   /** InvalidAuthority: Invalid authority for account */
   INVALID_AUTHORITY = 0x1770, // 6000
 }
 
-export class ProjectNameProgramError extends Error {
-  override readonly name = 'ProjectNameProgramError';
+export class AmmProgramError extends Error {
+  override readonly name = 'AmmProgramError';
 
-  readonly code: ProjectNameProgramErrorCode;
+  readonly code: AmmProgramErrorCode;
 
   readonly cause: Error | undefined;
 
   constructor(
-    code: ProjectNameProgramErrorCode,
+    code: AmmProgramErrorCode,
     name: string,
     message: string,
     cause?: Error
@@ -30,36 +30,36 @@ export class ProjectNameProgramError extends Error {
   }
 }
 
-let projectNameProgramErrorCodeMap:
-  | Record<ProjectNameProgramErrorCode, [string, string]>
+let ammProgramErrorCodeMap:
+  | Record<AmmProgramErrorCode, [string, string]>
   | undefined;
 if (__DEV__) {
-  projectNameProgramErrorCodeMap = {
-    [ProjectNameProgramErrorCode.INVALID_AUTHORITY]: [
+  ammProgramErrorCodeMap = {
+    [AmmProgramErrorCode.INVALID_AUTHORITY]: [
       'InvalidAuthority',
       `Invalid authority for account`,
     ],
   };
 }
 
-export function getProjectNameProgramErrorFromCode(
-  code: ProjectNameProgramErrorCode,
+export function getAmmProgramErrorFromCode(
+  code: AmmProgramErrorCode,
   cause?: Error
-): ProjectNameProgramError {
+): AmmProgramError {
   if (__DEV__) {
-    return new ProjectNameProgramError(
+    return new AmmProgramError(
       code,
       ...(
-        projectNameProgramErrorCodeMap as Record<
-          ProjectNameProgramErrorCode,
+        ammProgramErrorCodeMap as Record<
+          AmmProgramErrorCode,
           [string, string]
         >
       )[code],
       cause
     );
   }
 
-  return new ProjectNameProgramError(
+  return new AmmProgramError(
     code,
     'Unknown',
     'Error message not available in production bundles. Compile with __DEV__ set to true to see more information.',

clients/js/package.json

@@ -6,4 +6,4 @@
  * @see https://github.com/metaplex-foundation/kinobi
  */
 
-export * from './projectName';
+export * from './amm';