Class AlignedContract

constructor

• new AlignedContract(
      stream: DecodedStream,
      alignedProxy: {
          buffer: number[];
          bump: number;
          endTime: BN;
          initialAmountPerPeriod: BN;
          initialNetAmount: BN;
          initialPrice: BN;
          lastAmountUpdateTime: BN;
          lastPrice: BN;
          maxPercentage: BN;
          maxPrice: BN;
          minPercentage: BN;
          minPrice: BN;
          mint: PublicKey;
          period: BN;
          priceOracle: PublicKey;
          priceOracleType: DecodeEnum<
              {
                  kind: "enum";
                  variants: [
                      { name: "none" },
                      { name: "test" },
                      { name: "pyth" },
                      { name: "switchboard" },
                  ];
              },
              DecodedHelper<
                  [
                      {
                          name: "changeOracleParams";
                          type: {
                              fields: [
                                  { name: "oracleType"; type: { defined: { name: "oracleType" } } },
                              ];
                              kind: "struct";
                          };
                      },
                      {
                          name: "contract";
                          type: {
                              fields: [
                                  {
                                      docs: ["Bump Seed used to sign transactions"];
                                      name: "bump";
                                      type: "u8";
                                  },
                                  {
                                      docs: ["Original Contract sender"];
                                      name: "sender";
                                      type: "pubkey";
                                  },
                                  {
                                      docs: ["Original Contract sender tokens address"];
                                      name: "senderTokens";
                                      type: "pubkey";
                                  },
                                  { docs: ["Vesting Stream address"]; name: "stream"; type: "pubkey" },
                                  {
                                      docs: ["Type of the Oracle used to derive Token Price"];
                                      name: "priceOracleType";
                                      type: { defined: { name: "oracleType" } };
                                  },
                              ];
                              kind: "struct";
                          };
                      },
                      {
                          name: "createParams";
                          type: {
                              fields: [
                                  {
                                      docs: ["Timestamp when the tokens start vesting"];
                                      name: "startTime";
                                      type: "u64";
                                  },
                                  {
                                      docs: ["Deposited amount of tokens"];
                                      name: "netAmountDeposited";
                                      type: "u64";
                                  },
                                  {
                                      docs: [
                                          "Time step (period) in seconds per which the vesting/release occurs",
                                      ];
                                      name: "period";
                                      type: "u64";
                                  },
                                  {
                                      docs: [
                                          "Base Amount released per period. Combined with `period`, we get a release rate.",
                                      ];
                                      name: "amountPerPeriod";
                                      type: "u64";
                                  },
                                  {
                                      docs: ["Vesting contract \"cliff\" timestamp"];
                                      name: "cliff";
                                      type: "u64";
                                  },
                              ];
                              kind: "struct";
                          };
                      },
                      {
                          name: "createTestOracleParams";
                          type: {
                              fields: [
                                  { name: "price"; type: "u64" },
                                  { name: "expo"; type: "i32" },
                                  { name: "conf"; type: "u64" },
                                  { name: "publishTime"; type: "i64" },
                              ];
                              kind: "struct";
                          };
                      },
                  ],
                  EmptyDefined,
              >,
          >;
          sender: PublicKey;
          senderTokens: PublicKey;
          startTime: BN;
          stream: PublicKey;
          streamCanceledTime: BN;
          tickSize: BN;
      },
  ): AlignedContract

  Parameters

  • stream: DecodedStream
  • alignedProxy: {
        buffer: number[];
        bump: number;
        endTime: BN;
        initialAmountPerPeriod: BN;
        initialNetAmount: BN;
        initialPrice: BN;
        lastAmountUpdateTime: BN;
        lastPrice: BN;
        maxPercentage: BN;
        maxPrice: BN;
        minPercentage: BN;
        minPrice: BN;
        mint: PublicKey;
        period: BN;
        priceOracle: PublicKey;
        priceOracleType: DecodeEnum<
            {
                kind: "enum";
                variants: [
                    { name: "none" },
                    { name: "test" },
                    { name: "pyth" },
                    { name: "switchboard" },
                ];
            },
            DecodedHelper<
                [
                    {
                        name: "changeOracleParams";
                        type: {
                            fields: [
                                { name: "oracleType"; type: { defined: { name: "oracleType" } } },
                            ];
                            kind: "struct";
                        };
                    },
                    {
                        name: "contract";
                        type: {
                            fields: [
                                {
                                    docs: ["Bump Seed used to sign transactions"];
                                    name: "bump";
                                    type: "u8";
                                },
                                {
                                    docs: ["Original Contract sender"];
                                    name: "sender";
                                    type: "pubkey";
                                },
                                {
                                    docs: ["Original Contract sender tokens address"];
                                    name: "senderTokens";
                                    type: "pubkey";
                                },
                                { docs: ["Vesting Stream address"]; name: "stream"; type: "pubkey" },
                                {
                                    docs: ["Type of the Oracle used to derive Token Price"];
                                    name: "priceOracleType";
                                    type: { defined: { name: "oracleType" } };
                                },
                            ];
                            kind: "struct";
                        };
                    },
                    {
                        name: "createParams";
                        type: {
                            fields: [
                                {
                                    docs: ["Timestamp when the tokens start vesting"];
                                    name: "startTime";
                                    type: "u64";
                                },
                                {
                                    docs: ["Deposited amount of tokens"];
                                    name: "netAmountDeposited";
                                    type: "u64";
                                },
                                {
                                    docs: [
                                        "Time step (period) in seconds per which the vesting/release occurs",
                                    ];
                                    name: "period";
                                    type: "u64";
                                },
                                {
                                    docs: [
                                        "Base Amount released per period. Combined with `period`, we get a release rate.",
                                    ];
                                    name: "amountPerPeriod";
                                    type: "u64";
                                },
                                {
                                    docs: ["Vesting contract \"cliff\" timestamp"];
                                    name: "cliff";
                                    type: "u64";
                                },
                            ];
                            kind: "struct";
                        };
                    },
                    {
                        name: "createTestOracleParams";
                        type: {
                            fields: [
                                { name: "price"; type: "u64" },
                                { name: "expo"; type: "i32" },
                                { name: "conf"; type: "u64" },
                                { name: "publishTime"; type: "i64" },
                            ];
                            kind: "struct";
                        };
                    },
                ],
                EmptyDefined,
            >,
        >;
        sender: PublicKey;
        senderTokens: PublicKey;
        startTime: BN;
        stream: PublicKey;
        streamCanceledTime: BN;
        tickSize: BN;
    }

  Returns AlignedContract

initialAmountPerPeriod

initialNetAmount

initialPrice

lastAmountUpdateTime

lastPrice

maxPercentage

maxPrice

minPercentage

minPrice

oracleType

priceOracle

proxyAddress

tickSize