diff --git a/package-docs/.nojekyll b/package-docs/.nojekyll deleted file mode 100644 index e2ac6616ad..0000000000 --- a/package-docs/.nojekyll +++ /dev/null @@ -1 +0,0 @@ -TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false. \ No newline at end of file diff --git a/package-docs/README.md b/package-docs/README.md deleted file mode 100644 index 394e84f963..0000000000 --- a/package-docs/README.md +++ /dev/null @@ -1,70 +0,0 @@ -sanguine / [Exports](modules.md) - -# Sanguine - -[![Go Workflows](https://github.com/synapsecns/sanguine/actions/workflows/go.yml/badge.svg)](https://github.com/synapsecns/sanguine/actions/workflows/go.yml) -[![Foundry Tests](https://github.com/synapsecns/sanguine/actions/workflows/foundry-tests.yml/badge.svg)](https://github.com/synapsecns/sanguine/actions/workflows/foundry-tests.yml) - -## Contributing - -Read through [CONTRIBUTING.md](./CONTRIBUTING.md) for a general overview of our contribution process. -Then check out our list of [good first issues](https://github.com/ethereum-optimism/optimism/contribute) to find something fun to work on! - -## Directory Structure - -
-root
-├── agents: agents contain all the agents used in optimistic messaging
-├── charts: The helm charts used for deploying sanguine related services
-├── contrib: Devops related tools
-│   ├── git-changes-action: Github action for identifying changes in dependent modules in a go workspace
-│   ├── release-copier-action: Github action for copying releases from one repo to another
-│   ├── terraform-provider-iap: Terraform provider used for bastion proxy tunneling
-│   ├── terraform-provider-helmproxy: Terraform provider that allows helm to be proxied through an iap bastion proxy
-│   ├── terraform-provider-kubeproxy: Terraform provider that allows kube to be proxied through an iap bastion proxy
-│   ├── tfcore: Terraform core utilities + iap utilities
-├── core: The Go core library with common utilities for use across the monorepo
-├── ethergo: Go-based ethereum testing + common library
-├── packages
-│   ├── contracts-core: Core contracts used for synapse, powered by Foundry
-│   ├── explorer-ui: Explorer UI
-├── services
-│   ├── explorer: Bridge/messaging explorer backend
-│   ├── omnirpc: Latency aware RPC Client used across multiple-chains at once
-│   ├── scribe: Generalized ethereum event logger
-├── tools
-│   ├── abigen: Used to generate abigen bindings for go
-│   ├── bundle: Modified version of  go bundler  with improved shadowing support
-│   ├── module copier: Used to copy internal modules and export methods for testing
-
- -## Setup - -Clone the repository, open it, and install nodejs packages with `yarn`: - -```bash -git clone https://github.com/synapsecns/sanguine -cd sanguine -yarn install -``` - -### Install the Correct Version of NodeJS - -Using `nvm`, install the correct version of NodeJS. - -``` -nvm use -``` - -### Building the TypeScript packages - -To build all of the [TypeScript packages](./packages), run: - -```bash -yarn clean -yarn build -``` - -Packages compiled when on one branch may not be compatible with packages on a different branch. -**You should recompile all packages whenever you move from one branch to another.** -Use the above commands to recompile the packages. diff --git a/package-docs/classes/SynapseSDK.md b/package-docs/classes/SynapseSDK.md deleted file mode 100644 index 34d6473140..0000000000 --- a/package-docs/classes/SynapseSDK.md +++ /dev/null @@ -1,105 +0,0 @@ -[sanguine](../README.md) / [Exports](../modules.md) / SynapseSDK - -# Class: SynapseSDK - -## Table of contents - -### Constructors - -- [constructor](SynapseSDK.md#constructor) - -### Properties - -- [synapseRouters](SynapseSDK.md#synapserouters) - -### Methods - -- [bridge](SynapseSDK.md#bridge) -- [bridgeQuote](SynapseSDK.md#bridgequote) - -## Constructors - -### constructor - -• **new SynapseSDK**(`chainIds`, `providers`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `chainIds` | `number`[] | -| `providers` | `Provider`[] | - -#### Defined in - -[sdk.ts:13](https://github.com/synapsecns/sanguine/blob/561a8e25/packages/sdk-router/src/sdk.ts#L13) - -## Properties - -### synapseRouters - -• **synapseRouters**: `any` - -#### Defined in - -[sdk.ts:11](https://github.com/synapsecns/sanguine/blob/561a8e25/packages/sdk-router/src/sdk.ts#L11) - -## Methods - -### bridge - -▸ **bridge**(`to`, `originChainId`, `destChainId`, `token`, `amount`, `originQuery`, `destQuery`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `to` | `string` | -| `originChainId` | `number` | -| `destChainId` | `number` | -| `token` | `string` | -| `amount` | `BigintIsh` | -| `originQuery` | `Object` | -| `originQuery.deadline` | `BigintIsh` | -| `originQuery.minAmountOut` | `BigintIsh` | -| `originQuery.rawParams` | `BytesLike` | -| `originQuery.swapAdapter` | `string` | -| `originQuery.tokenOut` | `string` | -| `destQuery` | `Object` | -| `destQuery.deadline` | `BigintIsh` | -| `destQuery.minAmountOut` | `BigintIsh` | -| `destQuery.rawParams` | `BytesLike` | -| `destQuery.swapAdapter` | `string` | -| `destQuery.tokenOut` | `string` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -[sdk.ts:99](https://github.com/synapsecns/sanguine/blob/561a8e25/packages/sdk-router/src/sdk.ts#L99) - -___ - -### bridgeQuote - -▸ **bridgeQuote**(`originChainId`, `destChainId`, `tokenIn`, `tokenOut`, `amountIn`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `originChainId` | `number` | -| `destChainId` | `number` | -| `tokenIn` | `string` | -| `tokenOut` | `string` | -| `amountIn` | `BigintIsh` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -[sdk.ts:27](https://github.com/synapsecns/sanguine/blob/561a8e25/packages/sdk-router/src/sdk.ts#L27) diff --git a/package-docs/modules.md b/package-docs/modules.md deleted file mode 100644 index f120e34dbf..0000000000 --- a/package-docs/modules.md +++ /dev/null @@ -1,9 +0,0 @@ -[sanguine](README.md) / Exports - -# sanguine - -## Table of contents - -### Classes - -- [SynapseSDK](classes/SynapseSDK.md) diff --git a/package.json b/package.json index dfa903bbd8..d0d6d2733c 100644 --- a/package.json +++ b/package.json @@ -32,8 +32,7 @@ "clean": "yarn lerna run clean --parallel", "test:coverage": "yarn cover-all && yarn collect && nyc report --reporter lcov --report-dir=lcov", "cover-all": "yarn lerna exec npm run test:coverage --parallel", - "collect": "rm -rf .nyc_output && mkdir -p .nyc_output && aggregate-coverage collectFiles --pattern='packages/**/!(node_modules)/**/coverage-final.json' --target='.nyc_output'", - "generate:docs": "typedoc --plugin typedoc-plugin-markdown --out package-docs" + "collect": "rm -rf .nyc_output && mkdir -p .nyc_output && aggregate-coverage collectFiles --pattern='packages/**/!(node_modules)/**/coverage-final.json' --target='.nyc_output'" }, "devDependencies": { "@babel/eslint-parser": "^7.18.2",